ExtPackManagerImpl.cpp@ 75663

Last change on this file since 75663 was 75663, checked in by vboxsync, 7 years ago
Main/ExtPackManager+CloudProviderManager+VirtualBox: Handle runtime install and uninstall of extension packs containing cloud providers. This is a safeguard against uninstalling active cloud providers (which would cause crashes), and makes the install more convcenient. At the same time it eliminated the need to have a special "detect all cloud providers" logic when VBoxSVC is started. It achieves perfect singleton property of the per-extpack CloudProviderManager and the related CloudProvider objects. Nothing is ever created twice (which would cause trouble with coordinating e.g. the profile file updates).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 121.3 KB

Line
1	/* $Id: ExtPackManagerImpl.cpp 75663 2018-11-22 14:00:59Z vboxsync $ */
2	/** @file
3	* VirtualBox Main - interface for Extension Packs, VBoxSVC & VBoxC.
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.215389.xyz. 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	#include "ExtPackManagerImpl.h"
23	#include "CloudProviderManagerImpl.h"
24	#include "ExtPackUtil.h"
25	#include "ThreadTask.h"
26
27	#include <iprt/buildconfig.h>
28	#include <iprt/ctype.h>
29	#include <iprt/dir.h>
30	#include <iprt/env.h>
31	#include <iprt/file.h>
32	#include <iprt/ldr.h>
33	#include <iprt/manifest.h>
34	#include <iprt/param.h>
35	#include <iprt/path.h>
36	#include <iprt/pipe.h>
37	#include <iprt/process.h>
38	#include <iprt/string.h>
39
40	#include <VBox/com/array.h>
41	#include <VBox/com/ErrorInfo.h>
42	#include <VBox/err.h>
43	#include <VBox/log.h>
44	#include <VBox/sup.h>
45	#include <VBox/version.h>
46	#include "AutoCaller.h"
47	#include "Global.h"
48	#include "ProgressImpl.h"
49	#ifdef VBOX_COM_INPROC
50	# include "ConsoleImpl.h"
51	#else
52	# include "VirtualBoxImpl.h"
53	#endif
54
55
56	/*********************************************************************************************************************************
57	* Defined Constants And Macros *
58	*********************************************************************************************************************************/
59	/** @def VBOX_EXTPACK_HELPER_NAME
60	* The name of the utility application we employ to install and uninstall the
61	* extension packs. This is a set-uid-to-root binary on unixy platforms, which
62	* is why it has to be a separate application.
63	*/
64	#if defined(RT_OS_WINDOWS) \|\| defined(RT_OS_OS2)
65	# define VBOX_EXTPACK_HELPER_NAME "VBoxExtPackHelperApp.exe"
66	#else
67	# define VBOX_EXTPACK_HELPER_NAME "VBoxExtPackHelperApp"
68	#endif
69
70
71	/*********************************************************************************************************************************
72	* Structures and Typedefs *
73	*********************************************************************************************************************************/
74	struct ExtPackBaseData
75	{
76	public:
77	/** The extension pack descriptor (loaded from the XML, mostly). */
78	VBOXEXTPACKDESC Desc;
79	/** The file system object info of the XML file.
80	* This is for detecting changes and save time in refresh(). */
81	RTFSOBJINFO ObjInfoDesc;
82	/** Whether it's usable or not. */
83	bool fUsable;
84	/** Why it is unusable. */
85	Utf8Str strWhyUnusable;
86	};
87
88	#ifndef VBOX_COM_INPROC
89	/**
90	* Private extension pack data.
91	*/
92	struct ExtPackFile::Data : public ExtPackBaseData
93	{
94	public:
95	/** The path to the tarball. */
96	Utf8Str strExtPackFile;
97	/** The SHA-256 hash of the file (as string). */
98	Utf8Str strDigest;
99	/** The file handle of the extension pack file. */
100	RTFILE hExtPackFile;
101	/** Our manifest for the tarball. */
102	RTMANIFEST hOurManifest;
103	/** Pointer to the extension pack manager. */
104	ComObjPtr<ExtPackManager> ptrExtPackMgr;
105	/** Pointer to the VirtualBox object so we can create a progress object. */
106	VirtualBox *pVirtualBox;
107
108	RTMEMEF_NEW_AND_DELETE_OPERATORS();
109	};
110	#endif
111
112	/**
113	* Private extension pack data.
114	*/
115	struct ExtPack::Data : public ExtPackBaseData
116	{
117	public:
118	/** Where the extension pack is located. */
119	Utf8Str strExtPackPath;
120	/** The file system object info of the extension pack directory.
121	* This is for detecting changes and save time in refresh(). */
122	RTFSOBJINFO ObjInfoExtPack;
123	/** The full path to the main module. */
124	Utf8Str strMainModPath;
125	/** The file system object info of the main module.
126	* This is used to determin whether to bother try reload it. */
127	RTFSOBJINFO ObjInfoMainMod;
128	/** The module handle of the main extension pack module. */
129	RTLDRMOD hMainMod;
130
131	/** The helper callbacks for the extension pack. */
132	VBOXEXTPACKHLP Hlp;
133	/** Pointer back to the extension pack object (for Hlp methods). */
134	ExtPack *pThis;
135	#ifndef VBOX_COM_INPROC
136	/** The extension pack main registration structure. */
137	PCVBOXEXTPACKREG pReg;
138	#else
139	/** The extension pack main VM registration structure. */
140	PCVBOXEXTPACKVMREG pReg;
141	#endif
142	/** The current context. */
143	VBOXEXTPACKCTX enmContext;
144	/** Set if we've made the pfnVirtualBoxReady or pfnConsoleReady call. */
145	bool fMadeReadyCall;
146	#ifndef VBOX_COM_INPROC
147	/** Pointer to the VirtualBox object so we can create a progress object. */
148	VirtualBox *pVirtualBox;
149	#endif
150
151	RTMEMEF_NEW_AND_DELETE_OPERATORS();
152	};
153
154	/** List of extension packs. */
155	typedef std::list< ComObjPtr<ExtPack> > ExtPackList;
156
157	/**
158	* Private extension pack manager data.
159	*/
160	struct ExtPackManager::Data
161	{
162	Data()
163	: cUpdate(0)
164	{}
165
166	/** The directory where the extension packs are installed. */
167	Utf8Str strBaseDir;
168	/** The directory where the certificates this installation recognizes are
169	* stored. */
170	Utf8Str strCertificatDirPath;
171	/** The list of installed extension packs. */
172	ExtPackList llInstalledExtPacks;
173	#ifndef VBOX_COM_INPROC
174	/** Pointer to the VirtualBox object, our parent. */
175	VirtualBox *pVirtualBox;
176	#endif
177	/** The current context. */
178	VBOXEXTPACKCTX enmContext;
179	/** Update counter for the installed extension packs, increased in every list update. */
180	uint64_t cUpdate;
181
182	RTMEMEF_NEW_AND_DELETE_OPERATORS();
183	};
184
185	#ifndef VBOX_COM_INPROC
186
187	/**
188	* Extension pack installation job.
189	*/
190	class ExtPackInstallTask : public ThreadTask
191	{
192	public:
193	explicit ExtPackInstallTask() : ThreadTask("ExtPackInst") { }
194	~ExtPackInstallTask() { }
195
196	void handler()
197	{
198	HRESULT hrc = ptrExtPackMgr->i_doInstall(ptrExtPackFile, fReplace, &strDisplayInfo);
199	ptrProgress->i_notifyComplete(hrc);
200	}
201
202	HRESULT Init(const ComPtr<ExtPackFile> &a_strExtPackFile, bool a_fReplace,
203	const Utf8Str &strDispInfo, const ComPtr<ExtPackManager> &a_ptrExtPackMgr)
204	{
205	ptrExtPackFile = a_strExtPackFile;
206	fReplace = a_fReplace;
207	strDisplayInfo = strDispInfo;
208	ptrExtPackMgr = a_ptrExtPackMgr;
209
210	HRESULT hrc = ptrProgress.createObject();
211	if (SUCCEEDED(hrc))
212	{
213	Bstr bstrDescription("Installing extension pack");
214	hrc = ptrProgress->init(ptrExtPackFile->m->pVirtualBox,
215	static_cast<IExtPackFile *>(ptrExtPackFile),
216	bstrDescription.raw(),
217	FALSE /aCancelable/);
218	}
219
220	return hrc;
221	}
222
223	/** Smart pointer to the progress object for this job. */
224	ComObjPtr<Progress> ptrProgress;
225	private:
226	/** Smart pointer to the extension pack file. */
227	ComPtr<ExtPackFile> ptrExtPackFile;
228	/** The replace argument. */
229	bool fReplace;
230	/** The display info argument. */
231	Utf8Str strDisplayInfo;
232	/** Smart pointer to the extension manager. */
233	ComPtr<ExtPackManager> ptrExtPackMgr;
234	};
235
236	/**
237	* Extension pack uninstallation job.
238	*/
239	class ExtPackUninstallTask : public ThreadTask
240	{
241	public:
242	explicit ExtPackUninstallTask() : ThreadTask("ExtPackUninst") { }
243	~ExtPackUninstallTask() { }
244
245	void handler()
246	{
247	HRESULT hrc = ptrExtPackMgr->i_doUninstall(&strName, fForcedRemoval, &strDisplayInfo);
248	ptrProgress->i_notifyComplete(hrc);
249	}
250
251	HRESULT Init(const ComPtr<ExtPackManager> &a_ptrExtPackMgr, const Utf8Str &a_strName,
252	bool a_fForcedRemoval, const Utf8Str &a_strDisplayInfo)
253	{
254	ptrExtPackMgr = a_ptrExtPackMgr;
255	strName = a_strName;
256	fForcedRemoval = a_fForcedRemoval;
257	strDisplayInfo = a_strDisplayInfo;
258
259	HRESULT hrc = ptrProgress.createObject();
260	if (SUCCEEDED(hrc))
261	{
262	Bstr bstrDescription("Uninstalling extension pack");
263	hrc = ptrProgress->init(ptrExtPackMgr->m->pVirtualBox,
264	static_cast<IExtPackManager *>(ptrExtPackMgr),
265	bstrDescription.raw(),
266	FALSE /aCancelable/);
267	}
268
269	return hrc;
270	}
271
272	/** Smart pointer to the progress object for this job. */
273	ComObjPtr<Progress> ptrProgress;
274	private:
275	/** Smart pointer to the extension manager. */
276	ComPtr<ExtPackManager> ptrExtPackMgr;
277	/** The name of the extension pack. */
278	Utf8Str strName;
279	/** The replace argument. */
280	bool fForcedRemoval;
281	/** The display info argument. */
282	Utf8Str strDisplayInfo;
283	};
284
285	DEFINE_EMPTY_CTOR_DTOR(ExtPackFile)
286
287	/**
288	* Called by ComObjPtr::createObject when creating the object.
289	*
290	* Just initialize the basic object state, do the rest in initWithDir().
291	*
292	* @returns S_OK.
293	*/
294	HRESULT ExtPackFile::FinalConstruct()
295	{
296	m = NULL;
297	return BaseFinalConstruct();
298	}
299
300	/**
301	* Initializes the extension pack by reading its file.
302	*
303	* @returns COM status code.
304	* @param a_pszFile The path to the extension pack file.
305	* @param a_pszDigest The SHA-256 digest of the file. Or an empty string.
306	* @param a_pExtPackMgr Pointer to the extension pack manager.
307	* @param a_pVirtualBox Pointer to the VirtualBox object.
308	*/
309	HRESULT ExtPackFile::initWithFile(const char a_pszFile, const char a_pszDigest, ExtPackManager *a_pExtPackMgr,
310	VirtualBox *a_pVirtualBox)
311	{
312	AutoInitSpan autoInitSpan(this);
313	AssertReturn(autoInitSpan.isOk(), E_FAIL);
314
315	/*
316	* Allocate + initialize our private data.
317	*/
318	m = new ExtPackFile::Data;
319	VBoxExtPackInitDesc(&m->Desc);
320	RT_ZERO(m->ObjInfoDesc);
321	m->fUsable = false;
322	m->strWhyUnusable = tr("ExtPack::init failed");
323	m->strExtPackFile = a_pszFile;
324	m->strDigest = a_pszDigest;
325	m->hExtPackFile = NIL_RTFILE;
326	m->hOurManifest = NIL_RTMANIFEST;
327	m->ptrExtPackMgr = a_pExtPackMgr;
328	m->pVirtualBox = a_pVirtualBox;
329
330	RTCString *pstrTarName = VBoxExtPackExtractNameFromTarballPath(a_pszFile);
331	if (pstrTarName)
332	{
333	m->Desc.strName = *pstrTarName;
334	delete pstrTarName;
335	pstrTarName = NULL;
336	}
337
338	autoInitSpan.setSucceeded();
339
340	/*
341	* Try open the extension pack and check that it is a regular file.
342	*/
343	int vrc = RTFileOpen(&m->hExtPackFile, a_pszFile,
344	RTFILE_O_READ \| RTFILE_O_DENY_WRITE \| RTFILE_O_OPEN);
345	if (RT_FAILURE(vrc))
346	{
347	if (vrc == VERR_FILE_NOT_FOUND \|\| vrc == VERR_PATH_NOT_FOUND)
348	return initFailed(tr("'%s' file not found"), a_pszFile);
349	return initFailed(tr("RTFileOpen('%s',,) failed with %Rrc"), a_pszFile, vrc);
350	}
351
352	RTFSOBJINFO ObjInfo;
353	vrc = RTFileQueryInfo(m->hExtPackFile, &ObjInfo, RTFSOBJATTRADD_UNIX);
354	if (RT_FAILURE(vrc))
355	return initFailed(tr("RTFileQueryInfo failed with %Rrc on '%s'"), vrc, a_pszFile);
356	if (!RTFS_IS_FILE(ObjInfo.Attr.fMode))
357	return initFailed(tr("Not a regular file: %s"), a_pszFile);
358
359	/*
360	* Validate the tarball and extract the XML file.
361	*/
362	char szError[8192];
363	RTVFSFILE hXmlFile;
364	vrc = VBoxExtPackValidateTarball(m->hExtPackFile, NULL /pszExtPackName/, a_pszFile, a_pszDigest,
365	szError, sizeof(szError), &m->hOurManifest, &hXmlFile, &m->strDigest);
366	if (RT_FAILURE(vrc))
367	return initFailed(tr("%s"), szError);
368
369	/*
370	* Parse the XML.
371	*/
372	RTCString strSavedName(m->Desc.strName);
373	RTCString *pStrLoadErr = VBoxExtPackLoadDescFromVfsFile(hXmlFile, &m->Desc, &m->ObjInfoDesc);
374	RTVfsFileRelease(hXmlFile);
375	if (pStrLoadErr != NULL)
376	{
377	m->strWhyUnusable.printf(tr("Failed to the xml file: %s"), pStrLoadErr->c_str());
378	m->Desc.strName = strSavedName;
379	delete pStrLoadErr;
380	return S_OK;
381	}
382
383	/*
384	* Match the tarball name with the name from the XML.
385	*/
386	/** @todo drop this restriction after the old install interface is
387	* dropped. */
388	if (!strSavedName.equalsIgnoreCase(m->Desc.strName))
389	return initFailed(tr("Extension pack name mismatch between the downloaded file and the XML inside it (xml='%s' file='%s')"),
390	m->Desc.strName.c_str(), strSavedName.c_str());
391
392
393	m->fUsable = true;
394	m->strWhyUnusable.setNull();
395	return S_OK;
396	}
397
398	/**
399	* Protected helper that formats the strWhyUnusable value.
400	*
401	* @returns S_OK
402	* @param a_pszWhyFmt Why it failed, format string.
403	* @param ... The format arguments.
404	*/
405	HRESULT ExtPackFile::initFailed(const char *a_pszWhyFmt, ...)
406	{
407	va_list va;
408	va_start(va, a_pszWhyFmt);
409	m->strWhyUnusable.printfV(a_pszWhyFmt, va);
410	va_end(va);
411	return S_OK;
412	}
413
414	/**
415	* COM cruft.
416	*/
417	void ExtPackFile::FinalRelease()
418	{
419	uninit();
420	BaseFinalRelease();
421	}
422
423	/**
424	* Do the actual cleanup.
425	*/
426	void ExtPackFile::uninit()
427	{
428	/* Enclose the state transition Ready->InUninit->NotReady */
429	AutoUninitSpan autoUninitSpan(this);
430	if (!autoUninitSpan.uninitDone() && m != NULL)
431	{
432	VBoxExtPackFreeDesc(&m->Desc);
433	RTFileClose(m->hExtPackFile);
434	m->hExtPackFile = NIL_RTFILE;
435	RTManifestRelease(m->hOurManifest);
436	m->hOurManifest = NIL_RTMANIFEST;
437
438	delete m;
439	m = NULL;
440	}
441	}
442
443	HRESULT ExtPackFile::getName(com::Utf8Str &aName)
444	{
445	aName = m->Desc.strName;
446	return S_OK;
447	}
448
449	HRESULT ExtPackFile::getDescription(com::Utf8Str &aDescription)
450	{
451	aDescription = m->Desc.strDescription;
452	return S_OK;
453	}
454
455	HRESULT ExtPackFile::getVersion(com::Utf8Str &aVersion)
456	{
457	aVersion = m->Desc.strVersion;
458	return S_OK;
459	}
460
461	HRESULT ExtPackFile::getEdition(com::Utf8Str &aEdition)
462	{
463	aEdition = m->Desc.strEdition;
464	return S_OK;
465	}
466
467	HRESULT ExtPackFile::getRevision(ULONG *aRevision)
468	{
469	*aRevision = m->Desc.uRevision;
470	return S_OK;
471	}
472
473	HRESULT ExtPackFile::getVRDEModule(com::Utf8Str &aVRDEModule)
474	{
475	aVRDEModule = m->Desc.strVrdeModule;
476	return S_OK;
477	}
478
479	HRESULT ExtPackFile::getPlugIns(std::vector<ComPtr<IExtPackPlugIn> > &aPlugIns)
480	{
481	/** @todo implement plug-ins. */
482	#ifdef VBOX_WITH_XPCOM
483	NOREF(aPlugIns);
484	#endif
485	NOREF(aPlugIns);
486	ReturnComNotImplemented();
487	}
488
489	HRESULT ExtPackFile::getUsable(BOOL *aUsable)
490	{
491	*aUsable = m->fUsable;
492	return S_OK;
493	}
494
495	HRESULT ExtPackFile::getWhyUnusable(com::Utf8Str &aWhyUnusable)
496	{
497	aWhyUnusable = m->strWhyUnusable;
498	return S_OK;
499	}
500
501	HRESULT ExtPackFile::getShowLicense(BOOL *aShowLicense)
502	{
503	*aShowLicense = m->Desc.fShowLicense;
504	return S_OK;
505	}
506
507	HRESULT ExtPackFile::getLicense(com::Utf8Str &aLicense)
508	{
509	Utf8Str strHtml("html");
510	Utf8Str str("");
511	return queryLicense(str, str, strHtml, aLicense);
512	}
513
514	/* Same as ExtPack::QueryLicense, should really explore the subject of base classes here... */
515	HRESULT ExtPackFile::queryLicense(const com::Utf8Str &aPreferredLocale, const com::Utf8Str &aPreferredLanguage,
516	const com::Utf8Str &aFormat, com::Utf8Str &aLicenseText)
517	{
518	HRESULT hrc = S_OK;
519
520	/*
521	* Validate input.
522	*/
523
524	if (aPreferredLocale.length() != 2 && aPreferredLocale.length() != 0)
525	return setError(E_FAIL, tr("The preferred locale is a two character string or empty."));
526
527	if (aPreferredLanguage.length() != 2 && aPreferredLanguage.length() != 0)
528	return setError(E_FAIL, tr("The preferred lanuage is a two character string or empty."));
529
530	if ( !aFormat.equals("html")
531	&& !aFormat.equals("rtf")
532	&& !aFormat.equals("txt"))
533	return setError(E_FAIL, tr("The license format can only have the values 'html', 'rtf' and 'txt'."));
534
535	/*
536	* Combine the options to form a file name before locking down anything.
537	*/
538	char szName[sizeof(VBOX_EXTPACK_LICENSE_NAME_PREFIX "-de_DE.html") + 2];
539	if (aPreferredLocale.isNotEmpty() && aPreferredLanguage.isNotEmpty())
540	RTStrPrintf(szName, sizeof(szName), VBOX_EXTPACK_LICENSE_NAME_PREFIX "-%s_%s.%s",
541	aPreferredLocale.c_str(), aPreferredLanguage.c_str(), aFormat.c_str());
542	else if (aPreferredLocale.isNotEmpty())
543	RTStrPrintf(szName, sizeof(szName), VBOX_EXTPACK_LICENSE_NAME_PREFIX "-%s.%s",
544	aPreferredLocale.c_str(), aFormat.c_str());
545	else if (aPreferredLanguage.isNotEmpty())
546	RTStrPrintf(szName, sizeof(szName), VBOX_EXTPACK_LICENSE_NAME_PREFIX "-_%s.%s",
547	aPreferredLocale.c_str(), aFormat.c_str());
548	else
549	RTStrPrintf(szName, sizeof(szName), VBOX_EXTPACK_LICENSE_NAME_PREFIX ".%s",
550	aFormat.c_str());
551	/*
552	* Lock the extension pack. We need a write lock here as there must not be
553	* concurrent accesses to the tar file handle.
554	*/
555	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
556
557	/*
558	* Do not permit this query on a pack that isn't considered usable (could
559	* be marked so because of bad license files).
560	*/
561	if (!m->fUsable)
562	hrc = setError(E_FAIL, tr("%s"), m->strWhyUnusable.c_str());
563	else
564	{
565	/*
566	* Look it up in the manifest before scanning the tarball for it
567	*/
568	if (RTManifestEntryExists(m->hOurManifest, szName))
569	{
570	RTVFSFSSTREAM hTarFss;
571	char szError[8192];
572	int vrc = VBoxExtPackOpenTarFss(m->hExtPackFile, szError, sizeof(szError), &hTarFss, NULL);
573	if (RT_SUCCESS(vrc))
574	{
575	for (;;)
576	{
577	/* Get the first/next. */
578	char *pszName;
579	RTVFSOBJ hVfsObj;
580	RTVFSOBJTYPE enmType;
581	vrc = RTVfsFsStrmNext(hTarFss, &pszName, &enmType, &hVfsObj);
582	if (RT_FAILURE(vrc))
583	{
584	if (vrc != VERR_EOF)
585	hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("RTVfsFsStrmNext failed: %Rrc"), vrc);
586	else
587	hrc = setErrorBoth(E_UNEXPECTED, vrc, tr("'%s' was found in the manifest but not in the tarball"), szName);
588	break;
589	}
590
591	/* Is this it? */
592	const char *pszAdjName = pszName[0] == '.' && pszName[1] == '/' ? &pszName[2] : pszName;
593	if ( !strcmp(pszAdjName, szName)
594	&& ( enmType == RTVFSOBJTYPE_IO_STREAM
595	\|\| enmType == RTVFSOBJTYPE_FILE))
596	{
597	RTVFSIOSTREAM hVfsIos = RTVfsObjToIoStream(hVfsObj);
598	RTVfsObjRelease(hVfsObj);
599	RTStrFree(pszName);
600
601	/* Load the file into memory. */
602	RTFSOBJINFO ObjInfo;
603	vrc = RTVfsIoStrmQueryInfo(hVfsIos, &ObjInfo, RTFSOBJATTRADD_NOTHING);
604	if (RT_SUCCESS(vrc))
605	{
606	size_t cbFile = (size_t)ObjInfo.cbObject;
607	void *pvFile = RTMemAllocZ(cbFile + 1);
608	if (pvFile)
609	{
610	vrc = RTVfsIoStrmRead(hVfsIos, pvFile, cbFile, true /fBlocking/, NULL);
611	if (RT_SUCCESS(vrc))
612	{
613	/* try translate it into a string we can return. */
614	Bstr bstrLicense((const char *)pvFile, cbFile);
615	if (bstrLicense.isNotEmpty())
616	{
617	aLicenseText = Utf8Str(bstrLicense);
618	hrc = S_OK;
619	}
620	else
621	hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc,
622	tr("The license file '%s' is empty or contains invalid UTF-8 encoding"),
623	szName);
624	}
625	else
626	hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("Failed to read '%s': %Rrc"), szName, vrc);
627	RTMemFree(pvFile);
628	}
629	else
630	hrc = setError(E_OUTOFMEMORY, tr("Failed to allocate %zu bytes for '%s'"), cbFile, szName);
631	}
632	else
633	hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("RTVfsIoStrmQueryInfo on '%s': %Rrc"), szName, vrc);
634	RTVfsIoStrmRelease(hVfsIos);
635	break;
636	}
637
638	/* Release current. */
639	RTVfsObjRelease(hVfsObj);
640	RTStrFree(pszName);
641	}
642	RTVfsFsStrmRelease(hTarFss);
643	}
644	else
645	hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("%s"), szError);
646	}
647	else
648	hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("The license file '%s' was not found in '%s'"),
649	szName, m->strExtPackFile.c_str());
650	}
651	return hrc;
652	}
653
654	HRESULT ExtPackFile::getFilePath(com::Utf8Str &aFilePath)
655	{
656
657	aFilePath = m->strExtPackFile;
658	return S_OK;
659	}
660
661	HRESULT ExtPackFile::install(BOOL aReplace, const com::Utf8Str &aDisplayInfo, ComPtr<IProgress> &aProgress)
662	{
663	HRESULT hrc;
664	if (m->fUsable)
665	{
666	ExtPackInstallTask *pTask = NULL;
667	try
668	{
669	pTask = new ExtPackInstallTask();
670	hrc = pTask->Init(this, aReplace != FALSE, aDisplayInfo, m->ptrExtPackMgr);
671	if (SUCCEEDED(hrc))
672	{
673	ComPtr<Progress> ptrProgress = pTask->ptrProgress;
674	hrc = pTask->createThreadWithType(RTTHREADTYPE_DEFAULT);
675	pTask = NULL; /* The _completely_ _undocumented_ createThread method always consumes pTask. */
676	if (SUCCEEDED(hrc))
677	hrc = ptrProgress.queryInterfaceTo(aProgress.asOutParam());
678	else
679	hrc = setError(VBOX_E_IPRT_ERROR,
680	tr("Starting thread for an extension pack installation failed with %Rrc"), hrc);
681	}
682	else
683	hrc = setError(VBOX_E_IPRT_ERROR,
684	tr("Looks like creating a progress object for ExtraPackInstallTask object failed"));
685	}
686	catch (std::bad_alloc &)
687	{
688	hrc = E_OUTOFMEMORY;
689	}
690	catch (HRESULT hrcXcpt)
691	{
692	LogFlowThisFunc(("Exception was caught in the function ExtPackFile::install() \n"));
693	hrc = hrcXcpt;
694	}
695	if (pTask)
696	delete pTask;
697	}
698	else
699	hrc = setError(E_FAIL, "%s", m->strWhyUnusable.c_str());
700	return hrc;
701	}
702
703	#endif /* !VBOX_COM_INPROC */
704
705
706
707
708	DEFINE_EMPTY_CTOR_DTOR(ExtPack)
709
710	/**
711	* Called by ComObjPtr::createObject when creating the object.
712	*
713	* Just initialize the basic object state, do the rest in initWithDir().
714	*
715	* @returns S_OK.
716	*/
717	HRESULT ExtPack::FinalConstruct()
718	{
719	m = NULL;
720	return BaseFinalConstruct();
721	}
722
723	/**
724	* Initializes the extension pack by reading its file.
725	*
726	* @returns COM status code.
727	* @param a_pVirtualBox The VirtualBox object.
728	* @param a_enmContext The context we're in.
729	* @param a_pszName The name of the extension pack. This is also the
730	* name of the subdirector under @a a_pszParentDir
731	* where the extension pack is installed.
732	* @param a_pszDir The extension pack directory name.
733	*/
734	HRESULT ExtPack::initWithDir(VirtualBox a_pVirtualBox, VBOXEXTPACKCTX a_enmContext, const char a_pszName, const char *a_pszDir)
735	{
736	AutoInitSpan autoInitSpan(this);
737	AssertReturn(autoInitSpan.isOk(), E_FAIL);
738
739	static const VBOXEXTPACKHLP s_HlpTmpl =
740	{
741	/* u32Version = */ VBOXEXTPACKHLP_VERSION,
742	/* uVBoxFullVersion = */ VBOX_FULL_VERSION,
743	/* uVBoxVersionRevision = */ 0,
744	/* u32Padding = */ 0,
745	/* pszVBoxVersion = */ "",
746	/* pfnFindModule = */ ExtPack::i_hlpFindModule,
747	/* pfnGetFilePath = */ ExtPack::i_hlpGetFilePath,
748	/* pfnGetContext = */ ExtPack::i_hlpGetContext,
749	/* pfnLoadHGCMService = */ ExtPack::i_hlpLoadHGCMService,
750	/* pfnLoadVDPlugin = */ ExtPack::i_hlpLoadVDPlugin,
751	/* pfnUnloadVDPlugin = */ ExtPack::i_hlpUnloadVDPlugin,
752	/* pfnCreateProgress = */ ExtPack::i_hlpCreateProgress,
753	/* pfnGetCanceledProgress = */ ExtPack::i_hlpGetCanceledProgress,
754	/* pfnUpdateProgress = */ ExtPack::i_hlpUpdateProgress,
755	/* pfnNextOperationProgress = */ ExtPack::i_hlpNextOperationProgress,
756	/* pfnWaitOtherProgress = */ ExtPack::i_hlpWaitOtherProgress,
757	/* pfnCompleteProgress = */ ExtPack::i_hlpCompleteProgress,
758	/* pfnReserved1 = */ ExtPack::i_hlpReservedN,
759	/* pfnReserved2 = */ ExtPack::i_hlpReservedN,
760	/* pfnReserved3 = */ ExtPack::i_hlpReservedN,
761	/* pfnReserved4 = */ ExtPack::i_hlpReservedN,
762	/* pfnReserved5 = */ ExtPack::i_hlpReservedN,
763	/* pfnReserved6 = */ ExtPack::i_hlpReservedN,
764	/* u32EndMarker = */ VBOXEXTPACKHLP_VERSION
765	};
766
767	/*
768	* Allocate + initialize our private data.
769	*/
770	m = new Data;
771	VBoxExtPackInitDesc(&m->Desc);
772	m->Desc.strName = a_pszName;
773	RT_ZERO(m->ObjInfoDesc);
774	m->fUsable = false;
775	m->strWhyUnusable = tr("ExtPack::init failed");
776	m->strExtPackPath = a_pszDir;
777	RT_ZERO(m->ObjInfoExtPack);
778	m->strMainModPath.setNull();
779	RT_ZERO(m->ObjInfoMainMod);
780	m->hMainMod = NIL_RTLDRMOD;
781	m->Hlp = s_HlpTmpl;
782	m->Hlp.pszVBoxVersion = RTBldCfgVersion();
783	m->Hlp.uVBoxInternalRevision = RTBldCfgRevision();
784	m->pThis = this;
785	m->pReg = NULL;
786	m->enmContext = a_enmContext;
787	m->fMadeReadyCall = false;
788	#ifndef VBOX_COM_INPROC
789	m->pVirtualBox = a_pVirtualBox;
790	#else
791	RT_NOREF(a_pVirtualBox);
792	#endif
793
794	/*
795	* Make sure the SUPR3Hardened API works (ignoring errors for now).
796	*/
797	int rc = SUPR3HardenedVerifyInit();
798	if (RT_FAILURE(rc))
799	LogRel(("SUPR3HardenedVerifyInit failed: %Rrc\n", rc));
800
801	/*
802	* Probe the extension pack (this code is shared with refresh()).
803	*/
804	i_probeAndLoad();
805
806	autoInitSpan.setSucceeded();
807	return S_OK;
808	}
809
810	/**
811	* COM cruft.
812	*/
813	void ExtPack::FinalRelease()
814	{
815	uninit();
816	BaseFinalRelease();
817	}
818
819	/**
820	* Do the actual cleanup.
821	*/
822	void ExtPack::uninit()
823	{
824	/* Enclose the state transition Ready->InUninit->NotReady */
825	AutoUninitSpan autoUninitSpan(this);
826	if (!autoUninitSpan.uninitDone() && m != NULL)
827	{
828	if (m->hMainMod != NIL_RTLDRMOD)
829	{
830	AssertPtr(m->pReg);
831	if (m->pReg->pfnUnload != NULL)
832	m->pReg->pfnUnload(m->pReg);
833
834	RTLdrClose(m->hMainMod);
835	m->hMainMod = NIL_RTLDRMOD;
836	m->pReg = NULL;
837	}
838
839	VBoxExtPackFreeDesc(&m->Desc);
840
841	delete m;
842	m = NULL;
843	}
844	}
845
846
847	#ifndef VBOX_COM_INPROC
848	/**
849	* Calls the installed hook.
850	*
851	* @returns true if we left the lock, false if we didn't.
852	* @param a_pVirtualBox The VirtualBox interface.
853	* @param a_pLock The write lock held by the caller.
854	* @param pErrInfo Where to return error information.
855	*/
856	bool ExtPack::i_callInstalledHook(IVirtualBox a_pVirtualBox, AutoWriteLock a_pLock, PRTERRINFO pErrInfo)
857	{
858	if ( m != NULL
859	&& m->hMainMod != NIL_RTLDRMOD)
860	{
861	if (m->pReg->pfnInstalled)
862	{
863	ComPtr<ExtPack> ptrSelfRef = this;
864	a_pLock->release();
865	pErrInfo->rc = m->pReg->pfnInstalled(m->pReg, a_pVirtualBox, pErrInfo);
866	a_pLock->acquire();
867	return true;
868	}
869	}
870	pErrInfo->rc = VINF_SUCCESS;
871	return false;
872	}
873
874	/**
875	* Calls the uninstall hook and closes the module.
876	*
877	* @returns S_OK or COM error status with error information.
878	* @param a_pVirtualBox The VirtualBox interface.
879	* @param a_fForcedRemoval When set, we'll ignore complaints from the
880	* uninstall hook.
881	* @remarks The caller holds the manager's write lock, not released.
882	*/
883	HRESULT ExtPack::i_callUninstallHookAndClose(IVirtualBox *a_pVirtualBox, bool a_fForcedRemoval)
884	{
885	HRESULT hrc = S_OK;
886
887	if ( m != NULL
888	&& m->hMainMod != NIL_RTLDRMOD)
889	{
890	if (m->pReg->pfnUninstall && !a_fForcedRemoval)
891	{
892	int vrc = m->pReg->pfnUninstall(m->pReg, a_pVirtualBox);
893	if (RT_FAILURE(vrc))
894	{
895	LogRel(("ExtPack pfnUninstall returned %Rrc for %s\n", vrc, m->Desc.strName.c_str()));
896	if (!a_fForcedRemoval)
897	hrc = setErrorBoth(E_FAIL, vrc, tr("pfnUninstall returned %Rrc"), vrc);
898	}
899	}
900	if (SUCCEEDED(hrc))
901	{
902	RTLdrClose(m->hMainMod);
903	m->hMainMod = NIL_RTLDRMOD;
904	m->pReg = NULL;
905	}
906	}
907
908	return hrc;
909	}
910
911	/**
912	* Calls the pfnVirtualBoxReady hook.
913	*
914	* @returns true if we left the lock, false if we didn't.
915	* @param a_pVirtualBox The VirtualBox interface.
916	* @param a_pLock The write lock held by the caller.
917	*/
918	bool ExtPack::i_callVirtualBoxReadyHook(IVirtualBox a_pVirtualBox, AutoWriteLock a_pLock)
919	{
920	if ( m != NULL
921	&& m->fUsable
922	&& m->hMainMod != NIL_RTLDRMOD
923	&& !m->fMadeReadyCall)
924	{
925	m->fMadeReadyCall = true;
926	if (m->pReg->pfnVirtualBoxReady)
927	{
928	ComPtr<ExtPack> ptrSelfRef = this;
929	a_pLock->release();
930	m->pReg->pfnVirtualBoxReady(m->pReg, a_pVirtualBox);
931	i_notifyCloudProviderManager();
932	a_pLock->acquire();
933	return true;
934	}
935	}
936	return false;
937	}
938	#endif /* !VBOX_COM_INPROC */
939
940	#ifdef VBOX_COM_INPROC
941	/**
942	* Calls the pfnConsoleReady hook.
943	*
944	* @returns true if we left the lock, false if we didn't.
945	* @param a_pConsole The Console interface.
946	* @param a_pLock The write lock held by the caller.
947	*/
948	bool ExtPack::i_callConsoleReadyHook(IConsole a_pConsole, AutoWriteLock a_pLock)
949	{
950	if ( m != NULL
951	&& m->fUsable
952	&& m->hMainMod != NIL_RTLDRMOD
953	&& !m->fMadeReadyCall)
954	{
955	m->fMadeReadyCall = true;
956	if (m->pReg->pfnConsoleReady)
957	{
958	ComPtr<ExtPack> ptrSelfRef = this;
959	a_pLock->release();
960	m->pReg->pfnConsoleReady(m->pReg, a_pConsole);
961	a_pLock->acquire();
962	return true;
963	}
964	}
965	return false;
966	}
967	#endif /* VBOX_COM_INPROC */
968
969	#ifndef VBOX_COM_INPROC
970	/**
971	* Calls the pfnVMCreate hook.
972	*
973	* @returns true if we left the lock, false if we didn't.
974	* @param a_pVirtualBox The VirtualBox interface.
975	* @param a_pMachine The machine interface of the new VM.
976	* @param a_pLock The write lock held by the caller.
977	*/
978	bool ExtPack::i_callVmCreatedHook(IVirtualBox a_pVirtualBox, IMachine a_pMachine, AutoWriteLock *a_pLock)
979	{
980	if ( m != NULL
981	&& m->hMainMod != NIL_RTLDRMOD
982	&& m->fUsable)
983	{
984	if (m->pReg->pfnVMCreated)
985	{
986	ComPtr<ExtPack> ptrSelfRef = this;
987	a_pLock->release();
988	m->pReg->pfnVMCreated(m->pReg, a_pVirtualBox, a_pMachine);
989	a_pLock->acquire();
990	return true;
991	}
992	}
993	return false;
994	}
995	#endif /* !VBOX_COM_INPROC */
996
997	#ifdef VBOX_COM_INPROC
998	/**
999	* Calls the pfnVMConfigureVMM hook.
1000	*
1001	* @returns true if we left the lock, false if we didn't.
1002	* @param a_pConsole The console interface.
1003	* @param a_pVM The VM handle.
1004	* @param a_pLock The write lock held by the caller.
1005	* @param a_pvrc Where to return the status code of the
1006	* callback. This is always set. LogRel is
1007	* called on if a failure status is returned.
1008	*/
1009	bool ExtPack::i_callVmConfigureVmmHook(IConsole a_pConsole, PVM a_pVM, AutoWriteLock a_pLock, int *a_pvrc)
1010	{
1011	*a_pvrc = VINF_SUCCESS;
1012	if ( m != NULL
1013	&& m->hMainMod != NIL_RTLDRMOD
1014	&& m->fUsable)
1015	{
1016	if (m->pReg->pfnVMConfigureVMM)
1017	{
1018	ComPtr<ExtPack> ptrSelfRef = this;
1019	a_pLock->release();
1020	int vrc = m->pReg->pfnVMConfigureVMM(m->pReg, a_pConsole, a_pVM);
1021	*a_pvrc = vrc;
1022	a_pLock->acquire();
1023	if (RT_FAILURE(vrc))
1024	LogRel(("ExtPack pfnVMConfigureVMM returned %Rrc for %s\n", vrc, m->Desc.strName.c_str()));
1025	return true;
1026	}
1027	}
1028	return false;
1029	}
1030
1031	/**
1032	* Calls the pfnVMPowerOn hook.
1033	*
1034	* @returns true if we left the lock, false if we didn't.
1035	* @param a_pConsole The console interface.
1036	* @param a_pVM The VM handle.
1037	* @param a_pLock The write lock held by the caller.
1038	* @param a_pvrc Where to return the status code of the
1039	* callback. This is always set. LogRel is
1040	* called on if a failure status is returned.
1041	*/
1042	bool ExtPack::i_callVmPowerOnHook(IConsole a_pConsole, PVM a_pVM, AutoWriteLock a_pLock, int *a_pvrc)
1043	{
1044	*a_pvrc = VINF_SUCCESS;
1045	if ( m != NULL
1046	&& m->hMainMod != NIL_RTLDRMOD
1047	&& m->fUsable)
1048	{
1049	if (m->pReg->pfnVMPowerOn)
1050	{
1051	ComPtr<ExtPack> ptrSelfRef = this;
1052	a_pLock->release();
1053	int vrc = m->pReg->pfnVMPowerOn(m->pReg, a_pConsole, a_pVM);
1054	*a_pvrc = vrc;
1055	a_pLock->acquire();
1056	if (RT_FAILURE(vrc))
1057	LogRel(("ExtPack pfnVMPowerOn returned %Rrc for %s\n", vrc, m->Desc.strName.c_str()));
1058	return true;
1059	}
1060	}
1061	return false;
1062	}
1063
1064	/**
1065	* Calls the pfnVMPowerOff hook.
1066	*
1067	* @returns true if we left the lock, false if we didn't.
1068	* @param a_pConsole The console interface.
1069	* @param a_pVM The VM handle.
1070	* @param a_pLock The write lock held by the caller.
1071	*/
1072	bool ExtPack::i_callVmPowerOffHook(IConsole a_pConsole, PVM a_pVM, AutoWriteLock a_pLock)
1073	{
1074	if ( m != NULL
1075	&& m->hMainMod != NIL_RTLDRMOD
1076	&& m->fUsable)
1077	{
1078	if (m->pReg->pfnVMPowerOff)
1079	{
1080	ComPtr<ExtPack> ptrSelfRef = this;
1081	a_pLock->release();
1082	m->pReg->pfnVMPowerOff(m->pReg, a_pConsole, a_pVM);
1083	a_pLock->acquire();
1084	return true;
1085	}
1086	}
1087	return false;
1088	}
1089	#endif /* VBOX_COM_INPROC */
1090
1091	/**
1092	* Check if the extension pack is usable and has an VRDE module.
1093	*
1094	* @returns S_OK or COM error status with error information.
1095	*
1096	* @remarks Caller holds the extension manager lock for reading, no locking
1097	* necessary.
1098	*/
1099	HRESULT ExtPack::i_checkVrde(void)
1100	{
1101	HRESULT hrc;
1102	if ( m != NULL
1103	&& m->fUsable)
1104	{
1105	if (m->Desc.strVrdeModule.isNotEmpty())
1106	hrc = S_OK;
1107	else
1108	hrc = setError(E_FAIL, tr("The extension pack '%s' does not include a VRDE module"), m->Desc.strName.c_str());
1109	}
1110	else
1111	hrc = setError(E_FAIL, tr("%s"), m->strWhyUnusable.c_str());
1112	return hrc;
1113	}
1114
1115	/**
1116	* Same as checkVrde(), except that it also resolves the path to the module.
1117	*
1118	* @returns S_OK or COM error status with error information.
1119	* @param a_pstrVrdeLibrary Where to return the path on success.
1120	*
1121	* @remarks Caller holds the extension manager lock for reading, no locking
1122	* necessary.
1123	*/
1124	HRESULT ExtPack::i_getVrdpLibraryName(Utf8Str *a_pstrVrdeLibrary)
1125	{
1126	HRESULT hrc = i_checkVrde();
1127	if (SUCCEEDED(hrc))
1128	{
1129	if (i_findModule(m->Desc.strVrdeModule.c_str(), NULL, VBOXEXTPACKMODKIND_R3,
1130	a_pstrVrdeLibrary, NULL /a_pfNative/, NULL /a_pObjInfo/))
1131	hrc = S_OK;
1132	else
1133	hrc = setError(E_FAIL, tr("Failed to locate the VRDE module '%s' in extension pack '%s'"),
1134	m->Desc.strVrdeModule.c_str(), m->Desc.strName.c_str());
1135	}
1136	return hrc;
1137	}
1138
1139	/**
1140	* Resolves the path to the module.
1141	*
1142	* @returns S_OK or COM error status with error information.
1143	* @param a_pszModuleName The library.
1144	* @param a_pstrLibrary Where to return the path on success.
1145	*
1146	* @remarks Caller holds the extension manager lock for reading, no locking
1147	* necessary.
1148	*/
1149	HRESULT ExtPack::i_getLibraryName(const char a_pszModuleName, Utf8Str a_pstrLibrary)
1150	{
1151	HRESULT hrc;
1152	if (i_findModule(a_pszModuleName, NULL, VBOXEXTPACKMODKIND_R3,
1153	a_pstrLibrary, NULL /a_pfNative/, NULL /a_pObjInfo/))
1154	hrc = S_OK;
1155	else
1156	hrc = setError(E_FAIL, tr("Failed to locate the module '%s' in extension pack '%s'"),
1157	a_pszModuleName, m->Desc.strName.c_str());
1158	return hrc;
1159	}
1160
1161	/**
1162	* Check if this extension pack wishes to be the default VRDE provider.
1163	*
1164	* @returns @c true if it wants to and it is in a usable state, otherwise
1165	* @c false.
1166	*
1167	* @remarks Caller holds the extension manager lock for reading, no locking
1168	* necessary.
1169	*/
1170	bool ExtPack::i_wantsToBeDefaultVrde(void) const
1171	{
1172	return m->fUsable
1173	&& m->Desc.strVrdeModule.isNotEmpty();
1174	}
1175
1176	/**
1177	* Refreshes the extension pack state.
1178	*
1179	* This is called by the manager so that the on disk changes are picked up.
1180	*
1181	* @returns S_OK or COM error status with error information.
1182	*
1183	* @param a_pfCanDelete Optional can-delete-this-object output indicator.
1184	*
1185	* @remarks Caller holds the extension manager lock for writing.
1186	* @remarks Only called in VBoxSVC.
1187	*/
1188	HRESULT ExtPack::i_refresh(bool *a_pfCanDelete)
1189	{
1190	if (a_pfCanDelete)
1191	*a_pfCanDelete = false;
1192
1193	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS); /* for the COMGETTERs */
1194
1195	/*
1196	* Has the module been deleted?
1197	*/
1198	RTFSOBJINFO ObjInfoExtPack;
1199	int vrc = RTPathQueryInfoEx(m->strExtPackPath.c_str(), &ObjInfoExtPack, RTFSOBJATTRADD_UNIX, RTPATH_F_ON_LINK);
1200	if ( RT_FAILURE(vrc)
1201	\|\| !RTFS_IS_DIRECTORY(ObjInfoExtPack.Attr.fMode))
1202	{
1203	if (a_pfCanDelete)
1204	*a_pfCanDelete = true;
1205	return S_OK;
1206	}
1207
1208	/*
1209	* We've got a directory, so try query file system object info for the
1210	* files we are interested in as well.
1211	*/
1212	RTFSOBJINFO ObjInfoDesc;
1213	char szDescFilePath[RTPATH_MAX];
1214	vrc = RTPathJoin(szDescFilePath, sizeof(szDescFilePath), m->strExtPackPath.c_str(), VBOX_EXTPACK_DESCRIPTION_NAME);
1215	if (RT_SUCCESS(vrc))
1216	vrc = RTPathQueryInfoEx(szDescFilePath, &ObjInfoDesc, RTFSOBJATTRADD_UNIX, RTPATH_F_ON_LINK);
1217	if (RT_FAILURE(vrc))
1218	RT_ZERO(ObjInfoDesc);
1219
1220	RTFSOBJINFO ObjInfoMainMod;
1221	if (m->strMainModPath.isNotEmpty())
1222	vrc = RTPathQueryInfoEx(m->strMainModPath.c_str(), &ObjInfoMainMod, RTFSOBJATTRADD_UNIX, RTPATH_F_ON_LINK);
1223	if (m->strMainModPath.isEmpty() \|\| RT_FAILURE(vrc))
1224	RT_ZERO(ObjInfoMainMod);
1225
1226	/*
1227	* If we have a usable module already, just verify that things haven't
1228	* changed since we loaded it.
1229	*/
1230	if (m->fUsable)
1231	{
1232	if (m->hMainMod == NIL_RTLDRMOD)
1233	i_probeAndLoad();
1234	else if ( !i_objinfoIsEqual(&ObjInfoDesc, &m->ObjInfoDesc)
1235	\|\| !i_objinfoIsEqual(&ObjInfoMainMod, &m->ObjInfoMainMod)
1236	\|\| !i_objinfoIsEqual(&ObjInfoExtPack, &m->ObjInfoExtPack) )
1237	{
1238	/** @todo not important, so it can wait. */
1239	}
1240	}
1241	/*
1242	* Ok, it is currently not usable. If anything has changed since last time
1243	* reprobe the extension pack.
1244	*/
1245	else if ( !i_objinfoIsEqual(&ObjInfoDesc, &m->ObjInfoDesc)
1246	\|\| !i_objinfoIsEqual(&ObjInfoMainMod, &m->ObjInfoMainMod)
1247	\|\| !i_objinfoIsEqual(&ObjInfoExtPack, &m->ObjInfoExtPack) )
1248	i_probeAndLoad();
1249
1250	return S_OK;
1251	}
1252
1253	#ifndef VBOX_COM_INPROC
1254	/**
1255	* Checks if there are cloud providers vetoing extension pack uninstall.
1256	*
1257	* This needs going through the cloud provider singleton in VirtualBox,
1258	* the job cannot be done purely by using the code in the extension pack).
1259	* It cannot be integrated into i_callUninstallHookAndClose, because it
1260	* can only do its job when the extpack lock is not held, whereas the
1261	* actual uninstall must be done with the lock held all the time for
1262	* consistency reasons.
1263	*
1264	* This is called when uninstalling or replacing an extension pack.
1265	*
1266	* @returns true / false
1267	*/
1268	bool ExtPack::i_areThereCloudProviderUninstallVetos()
1269	{
1270	Assert(m->pVirtualBox != NULL); /* Only called from VBoxSVC. */
1271
1272	ComObjPtr<CloudProviderManager> cpm(m->pVirtualBox->i_getCloudProviderManager());
1273	AssertReturn(!cpm.isNull(), false);
1274
1275	return !cpm->i_canRemoveExtPack(static_cast<IExtPack *>(this));
1276	}
1277
1278	/**
1279	* Notifies the Cloud Provider Manager that there is a new extension pack.
1280	*
1281	* This is called when installing an extension pack.
1282	*
1283	* @param a_pExtPack The extension pack to be added.
1284	*/
1285	void ExtPack::i_notifyCloudProviderManager()
1286	{
1287	Assert(m->pVirtualBox != NULL); /* Only called from VBoxSVC. */
1288
1289	ComObjPtr<CloudProviderManager> cpm(m->pVirtualBox->i_getCloudProviderManager());
1290	AssertReturnVoid(!cpm.isNull());
1291
1292	cpm->i_addExtPack(static_cast<IExtPack *>(this));
1293	}
1294
1295	#endif /* !VBOX_COM_INPROC */
1296
1297	/**
1298	* Probes the extension pack, loading the main dll and calling its registration
1299	* entry point.
1300	*
1301	* This updates the state accordingly, the strWhyUnusable and fUnusable members
1302	* being the most important ones.
1303	*/
1304	void ExtPack::i_probeAndLoad(void)
1305	{
1306	m->fUsable = false;
1307	m->fMadeReadyCall = false;
1308
1309	/*
1310	* Query the file system info for the extension pack directory. This and
1311	* all other file system info we save is for the benefit of refresh().
1312	*/
1313	int vrc = RTPathQueryInfoEx(m->strExtPackPath.c_str(), &m->ObjInfoExtPack, RTFSOBJATTRADD_UNIX, RTPATH_F_ON_LINK);
1314	if (RT_FAILURE(vrc))
1315	{
1316	m->strWhyUnusable.printf(tr("RTPathQueryInfoEx on '%s' failed: %Rrc"), m->strExtPackPath.c_str(), vrc);
1317	return;
1318	}
1319	if (!RTFS_IS_DIRECTORY(m->ObjInfoExtPack.Attr.fMode))
1320	{
1321	if (RTFS_IS_SYMLINK(m->ObjInfoExtPack.Attr.fMode))
1322	m->strWhyUnusable.printf(tr("'%s' is a symbolic link, this is not allowed"),
1323	m->strExtPackPath.c_str(), vrc);
1324	else if (RTFS_IS_FILE(m->ObjInfoExtPack.Attr.fMode))
1325	m->strWhyUnusable.printf(tr("'%s' is a symbolic file, not a directory"),
1326	m->strExtPackPath.c_str(), vrc);
1327	else
1328	m->strWhyUnusable.printf(tr("'%s' is not a directory (fMode=%#x)"),
1329	m->strExtPackPath.c_str(), m->ObjInfoExtPack.Attr.fMode);
1330	return;
1331	}
1332
1333	RTERRINFOSTATIC ErrInfo;
1334	RTErrInfoInitStatic(&ErrInfo);
1335	vrc = SUPR3HardenedVerifyDir(m->strExtPackPath.c_str(), true /fRecursive/, true /fCheckFiles/, &ErrInfo.Core);
1336	if (RT_FAILURE(vrc))
1337	{
1338	m->strWhyUnusable.printf(tr("%s (rc=%Rrc)"), ErrInfo.Core.pszMsg, vrc);
1339	return;
1340	}
1341
1342	/*
1343	* Read the description file.
1344	*/
1345	RTCString strSavedName(m->Desc.strName);
1346	RTCString *pStrLoadErr = VBoxExtPackLoadDesc(m->strExtPackPath.c_str(), &m->Desc, &m->ObjInfoDesc);
1347	if (pStrLoadErr != NULL)
1348	{
1349	m->strWhyUnusable.printf(tr("Failed to load '%s/%s': %s"),
1350	m->strExtPackPath.c_str(), VBOX_EXTPACK_DESCRIPTION_NAME, pStrLoadErr->c_str());
1351	m->Desc.strName = strSavedName;
1352	delete pStrLoadErr;
1353	return;
1354	}
1355
1356	/*
1357	* Make sure the XML name and directory matches.
1358	*/
1359	if (!m->Desc.strName.equalsIgnoreCase(strSavedName))
1360	{
1361	m->strWhyUnusable.printf(tr("The description name ('%s') and directory name ('%s') does not match"),
1362	m->Desc.strName.c_str(), strSavedName.c_str());
1363	m->Desc.strName = strSavedName;
1364	return;
1365	}
1366
1367	/*
1368	* Load the main DLL and call the predefined entry point.
1369	*/
1370	#ifndef VBOX_COM_INPROC
1371	const char *pszMainModule = m->Desc.strMainModule.c_str();
1372	#else
1373	const char *pszMainModule = m->Desc.strMainVMModule.c_str();
1374	if (m->Desc.strMainVMModule.isEmpty())
1375	{
1376	/*
1377	* We're good! The main module for VM processes is optional.
1378	*/
1379	m->fUsable = true;
1380	m->strWhyUnusable.setNull();
1381	return;
1382	}
1383	#endif
1384	bool fIsNative;
1385	if (!i_findModule(pszMainModule, NULL /* default extension */, VBOXEXTPACKMODKIND_R3,
1386	&m->strMainModPath, &fIsNative, &m->ObjInfoMainMod))
1387	{
1388	m->strWhyUnusable.printf(tr("Failed to locate the main module ('%s')"), pszMainModule);
1389	return;
1390	}
1391
1392	vrc = SUPR3HardenedVerifyPlugIn(m->strMainModPath.c_str(), &ErrInfo.Core);
1393	if (RT_FAILURE(vrc))
1394	{
1395	m->strWhyUnusable.printf(tr("%s"), ErrInfo.Core.pszMsg);
1396	return;
1397	}
1398
1399	if (fIsNative)
1400	{
1401	vrc = SUPR3HardenedLdrLoadPlugIn(m->strMainModPath.c_str(), &m->hMainMod, &ErrInfo.Core);
1402	if (RT_FAILURE(vrc))
1403	{
1404	m->hMainMod = NIL_RTLDRMOD;
1405	m->strWhyUnusable.printf(tr("Failed to load the main module ('%s'): %Rrc - %s"),
1406	m->strMainModPath.c_str(), vrc, ErrInfo.Core.pszMsg);
1407	return;
1408	}
1409	}
1410	else
1411	{
1412	m->strWhyUnusable.printf(tr("Only native main modules are currently supported"));
1413	return;
1414	}
1415
1416	/*
1417	* Resolve the predefined entry point.
1418	*/
1419	#ifndef VBOX_COM_INPROC
1420	const char *pszMainEntryPoint = VBOX_EXTPACK_MAIN_MOD_ENTRY_POINT;
1421	PFNVBOXEXTPACKREGISTER pfnRegistration;
1422	uint32_t uVersion = VBOXEXTPACKREG_VERSION;
1423	#else
1424	const char *pszMainEntryPoint = VBOX_EXTPACK_MAIN_VM_MOD_ENTRY_POINT;
1425	PFNVBOXEXTPACKVMREGISTER pfnRegistration;
1426	uint32_t uVersion = VBOXEXTPACKVMREG_VERSION;
1427	#endif
1428	vrc = RTLdrGetSymbol(m->hMainMod, pszMainEntryPoint, (void **)&pfnRegistration);
1429	if (RT_SUCCESS(vrc))
1430	{
1431	RTErrInfoClear(&ErrInfo.Core);
1432	vrc = pfnRegistration(&m->Hlp, &m->pReg, &ErrInfo.Core);
1433	if ( RT_SUCCESS(vrc)
1434	&& !RTErrInfoIsSet(&ErrInfo.Core)
1435	&& VALID_PTR(m->pReg))
1436	{
1437	if ( VBOXEXTPACK_IS_MAJOR_VER_EQUAL(m->pReg->u32Version, uVersion)
1438	&& m->pReg->u32EndMarker == m->pReg->u32Version)
1439	{
1440	#ifndef VBOX_COM_INPROC
1441	if ( (!m->pReg->pfnInstalled \|\| RT_VALID_PTR(m->pReg->pfnInstalled))
1442	&& (!m->pReg->pfnUninstall \|\| RT_VALID_PTR(m->pReg->pfnUninstall))
1443	&& (!m->pReg->pfnVirtualBoxReady \|\| RT_VALID_PTR(m->pReg->pfnVirtualBoxReady))
1444	&& (!m->pReg->pfnUnload \|\| RT_VALID_PTR(m->pReg->pfnUnload))
1445	&& (!m->pReg->pfnVMCreated \|\| RT_VALID_PTR(m->pReg->pfnVMCreated))
1446	&& (!m->pReg->pfnQueryObject \|\| RT_VALID_PTR(m->pReg->pfnQueryObject))
1447	)
1448	{
1449	/*
1450	* We're good!
1451	*/
1452	m->fUsable = true;
1453	m->strWhyUnusable.setNull();
1454	return;
1455	}
1456	#else
1457	if ( (!m->pReg->pfnConsoleReady \|\| RT_VALID_PTR(m->pReg->pfnConsoleReady))
1458	&& (!m->pReg->pfnUnload \|\| RT_VALID_PTR(m->pReg->pfnUnload))
1459	&& (!m->pReg->pfnVMConfigureVMM \|\| RT_VALID_PTR(m->pReg->pfnVMConfigureVMM))
1460	&& (!m->pReg->pfnVMPowerOn \|\| RT_VALID_PTR(m->pReg->pfnVMPowerOn))
1461	&& (!m->pReg->pfnVMPowerOff \|\| RT_VALID_PTR(m->pReg->pfnVMPowerOff))
1462	&& (!m->pReg->pfnQueryObject \|\| RT_VALID_PTR(m->pReg->pfnQueryObject))
1463	)
1464	{
1465	/*
1466	* We're good!
1467	*/
1468	m->fUsable = true;
1469	m->strWhyUnusable.setNull();
1470	return;
1471	}
1472	#endif
1473
1474	m->strWhyUnusable = tr("The registration structure contains one or more invalid function pointers");
1475	}
1476	else
1477	m->strWhyUnusable.printf(tr("Unsupported registration structure version %u.%u"),
1478	RT_HIWORD(m->pReg->u32Version), RT_LOWORD(m->pReg->u32Version));
1479	}
1480	else
1481	m->strWhyUnusable.printf(tr("%s returned %Rrc, pReg=%p ErrInfo='%s'"),
1482	pszMainEntryPoint, vrc, m->pReg, ErrInfo.Core.pszMsg);
1483	m->pReg = NULL;
1484	}
1485	else
1486	m->strWhyUnusable.printf(tr("Failed to resolve exported symbol '%s' in the main module: %Rrc"),
1487	pszMainEntryPoint, vrc);
1488
1489	RTLdrClose(m->hMainMod);
1490	m->hMainMod = NIL_RTLDRMOD;
1491	}
1492
1493	/**
1494	* Finds a module.
1495	*
1496	* @returns true if found, false if not.
1497	* @param a_pszName The module base name (no extension).
1498	* @param a_pszExt The extension. If NULL we use default
1499	* extensions.
1500	* @param a_enmKind The kind of module to locate.
1501	* @param a_pStrFound Where to return the path to the module we've
1502	* found.
1503	* @param a_pfNative Where to return whether this is a native module
1504	* or an agnostic one. Optional.
1505	* @param a_pObjInfo Where to return the file system object info for
1506	* the module. Optional.
1507	*/
1508	bool ExtPack::i_findModule(const char a_pszName, const char a_pszExt, VBOXEXTPACKMODKIND a_enmKind,
1509	Utf8Str a_pStrFound, bool a_pfNative, PRTFSOBJINFO a_pObjInfo) const
1510	{
1511	/*
1512	* Try the native path first.
1513	*/
1514	char szPath[RTPATH_MAX];
1515	int vrc = RTPathJoin(szPath, sizeof(szPath), m->strExtPackPath.c_str(), RTBldCfgTargetDotArch());
1516	AssertLogRelRCReturn(vrc, false);
1517	vrc = RTPathAppend(szPath, sizeof(szPath), a_pszName);
1518	AssertLogRelRCReturn(vrc, false);
1519	if (!a_pszExt)
1520	{
1521	const char *pszDefExt;
1522	switch (a_enmKind)
1523	{
1524	case VBOXEXTPACKMODKIND_RC: pszDefExt = ".rc"; break;
1525	case VBOXEXTPACKMODKIND_R0: pszDefExt = ".r0"; break;
1526	case VBOXEXTPACKMODKIND_R3: pszDefExt = RTLdrGetSuff(); break;
1527	default:
1528	AssertFailedReturn(false);
1529	}
1530	vrc = RTStrCat(szPath, sizeof(szPath), pszDefExt);
1531	AssertLogRelRCReturn(vrc, false);
1532	}
1533
1534	RTFSOBJINFO ObjInfo;
1535	if (!a_pObjInfo)
1536	a_pObjInfo = &ObjInfo;
1537	vrc = RTPathQueryInfo(szPath, a_pObjInfo, RTFSOBJATTRADD_UNIX);
1538	if (RT_SUCCESS(vrc) && RTFS_IS_FILE(a_pObjInfo->Attr.fMode))
1539	{
1540	if (a_pfNative)
1541	*a_pfNative = true;
1542	*a_pStrFound = szPath;
1543	return true;
1544	}
1545
1546	/*
1547	* Try the platform agnostic modules.
1548	*/
1549	/* gcc.x86/module.rel */
1550	char szSubDir[32];
1551	RTStrPrintf(szSubDir, sizeof(szSubDir), "%s.%s", RTBldCfgCompiler(), RTBldCfgTargetArch());
1552	vrc = RTPathJoin(szPath, sizeof(szPath), m->strExtPackPath.c_str(), szSubDir);
1553	AssertLogRelRCReturn(vrc, false);
1554	vrc = RTPathAppend(szPath, sizeof(szPath), a_pszName);
1555	AssertLogRelRCReturn(vrc, false);
1556	if (!a_pszExt)
1557	{
1558	vrc = RTStrCat(szPath, sizeof(szPath), ".rel");
1559	AssertLogRelRCReturn(vrc, false);
1560	}
1561	vrc = RTPathQueryInfo(szPath, a_pObjInfo, RTFSOBJATTRADD_UNIX);
1562	if (RT_SUCCESS(vrc) && RTFS_IS_FILE(a_pObjInfo->Attr.fMode))
1563	{
1564	if (a_pfNative)
1565	*a_pfNative = false;
1566	*a_pStrFound = szPath;
1567	return true;
1568	}
1569
1570	/* x86/module.rel */
1571	vrc = RTPathJoin(szPath, sizeof(szPath), m->strExtPackPath.c_str(), RTBldCfgTargetArch());
1572	AssertLogRelRCReturn(vrc, false);
1573	vrc = RTPathAppend(szPath, sizeof(szPath), a_pszName);
1574	AssertLogRelRCReturn(vrc, false);
1575	if (!a_pszExt)
1576	{
1577	vrc = RTStrCat(szPath, sizeof(szPath), ".rel");
1578	AssertLogRelRCReturn(vrc, false);
1579	}
1580	vrc = RTPathQueryInfo(szPath, a_pObjInfo, RTFSOBJATTRADD_UNIX);
1581	if (RT_SUCCESS(vrc) && RTFS_IS_FILE(a_pObjInfo->Attr.fMode))
1582	{
1583	if (a_pfNative)
1584	*a_pfNative = false;
1585	*a_pStrFound = szPath;
1586	return true;
1587	}
1588
1589	return false;
1590	}
1591
1592	/**
1593	* Compares two file system object info structures.
1594	*
1595	* @returns true if equal, false if not.
1596	* @param pObjInfo1 The first.
1597	* @param pObjInfo2 The second.
1598	* @todo IPRT should do this, really.
1599	*/
1600	/* static */ bool ExtPack::i_objinfoIsEqual(PCRTFSOBJINFO pObjInfo1, PCRTFSOBJINFO pObjInfo2)
1601	{
1602	if (!RTTimeSpecIsEqual(&pObjInfo1->ModificationTime, &pObjInfo2->ModificationTime))
1603	return false;
1604	if (!RTTimeSpecIsEqual(&pObjInfo1->ChangeTime, &pObjInfo2->ChangeTime))
1605	return false;
1606	if (!RTTimeSpecIsEqual(&pObjInfo1->BirthTime, &pObjInfo2->BirthTime))
1607	return false;
1608	if (pObjInfo1->cbObject != pObjInfo2->cbObject)
1609	return false;
1610	if (pObjInfo1->Attr.fMode != pObjInfo2->Attr.fMode)
1611	return false;
1612	if (pObjInfo1->Attr.enmAdditional == pObjInfo2->Attr.enmAdditional)
1613	{
1614	switch (pObjInfo1->Attr.enmAdditional)
1615	{
1616	case RTFSOBJATTRADD_UNIX:
1617	if (pObjInfo1->Attr.u.Unix.uid != pObjInfo2->Attr.u.Unix.uid)
1618	return false;
1619	if (pObjInfo1->Attr.u.Unix.gid != pObjInfo2->Attr.u.Unix.gid)
1620	return false;
1621	if (pObjInfo1->Attr.u.Unix.INodeIdDevice != pObjInfo2->Attr.u.Unix.INodeIdDevice)
1622	return false;
1623	if (pObjInfo1->Attr.u.Unix.INodeId != pObjInfo2->Attr.u.Unix.INodeId)
1624	return false;
1625	if (pObjInfo1->Attr.u.Unix.GenerationId != pObjInfo2->Attr.u.Unix.GenerationId)
1626	return false;
1627	break;
1628	default:
1629	break;
1630	}
1631	}
1632	return true;
1633	}
1634
1635
1636	/**
1637	* @interface_method_impl{VBOXEXTPACKHLP,pfnFindModule}
1638	*/
1639	/static/ DECLCALLBACK(int)
1640	ExtPack::i_hlpFindModule(PCVBOXEXTPACKHLP pHlp, const char pszName, const char pszExt, VBOXEXTPACKMODKIND enmKind,
1641	char pszFound, size_t cbFound, bool pfNative)
1642	{
1643	/*
1644	* Validate the input and get our bearings.
1645	*/
1646	AssertPtrReturn(pszName, VERR_INVALID_POINTER);
1647	AssertPtrNullReturn(pszExt, VERR_INVALID_POINTER);
1648	AssertPtrReturn(pszFound, VERR_INVALID_POINTER);
1649	AssertPtrNullReturn(pfNative, VERR_INVALID_POINTER);
1650	AssertReturn(enmKind > VBOXEXTPACKMODKIND_INVALID && enmKind < VBOXEXTPACKMODKIND_END, VERR_INVALID_PARAMETER);
1651
1652	AssertPtrReturn(pHlp, VERR_INVALID_POINTER);
1653	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, VERR_INVALID_POINTER);
1654	ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
1655	AssertPtrReturn(m, VERR_INVALID_POINTER);
1656	ExtPack *pThis = m->pThis;
1657	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1658
1659	/*
1660	* This is just a wrapper around findModule.
1661	*/
1662	Utf8Str strFound;
1663	if (pThis->i_findModule(pszName, pszExt, enmKind, &strFound, pfNative, NULL))
1664	return RTStrCopy(pszFound, cbFound, strFound.c_str());
1665	return VERR_FILE_NOT_FOUND;
1666	}
1667
1668	/static/ DECLCALLBACK(int)
1669	ExtPack::i_hlpGetFilePath(PCVBOXEXTPACKHLP pHlp, const char pszFilename, char pszPath, size_t cbPath)
1670	{
1671	/*
1672	* Validate the input and get our bearings.
1673	*/
1674	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1675	AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1676	AssertReturn(cbPath > 0, VERR_BUFFER_OVERFLOW);
1677
1678	AssertPtrReturn(pHlp, VERR_INVALID_POINTER);
1679	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, VERR_INVALID_POINTER);
1680	ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
1681	AssertPtrReturn(m, VERR_INVALID_POINTER);
1682	ExtPack *pThis = m->pThis;
1683	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1684
1685	/*
1686	* This is a simple RTPathJoin, no checking if things exists or anything.
1687	*/
1688	int vrc = RTPathJoin(pszPath, cbPath, pThis->m->strExtPackPath.c_str(), pszFilename);
1689	if (RT_FAILURE(vrc))
1690	RT_BZERO(pszPath, cbPath);
1691	return vrc;
1692	}
1693
1694	/static/ DECLCALLBACK(VBOXEXTPACKCTX)
1695	ExtPack::i_hlpGetContext(PCVBOXEXTPACKHLP pHlp)
1696	{
1697	/*
1698	* Validate the input and get our bearings.
1699	*/
1700	AssertPtrReturn(pHlp, VBOXEXTPACKCTX_INVALID);
1701	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, VBOXEXTPACKCTX_INVALID);
1702	ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
1703	AssertPtrReturn(m, VBOXEXTPACKCTX_INVALID);
1704	ExtPack *pThis = m->pThis;
1705	AssertPtrReturn(pThis, VBOXEXTPACKCTX_INVALID);
1706
1707	return pThis->m->enmContext;
1708	}
1709
1710	/static/ DECLCALLBACK(int)
1711	ExtPack::i_hlpLoadHGCMService(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IConsole) *pConsole,
1712	const char pszServiceLibrary, const char pszServiceName)
1713	{
1714	#ifdef VBOX_COM_INPROC
1715	/*
1716	* Validate the input and get our bearings.
1717	*/
1718	AssertPtrReturn(pszServiceLibrary, VERR_INVALID_POINTER);
1719	AssertPtrReturn(pszServiceName, VERR_INVALID_POINTER);
1720
1721	AssertPtrReturn(pHlp, VERR_INVALID_POINTER);
1722	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, VERR_INVALID_POINTER);
1723	ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
1724	AssertPtrReturn(m, VERR_INVALID_POINTER);
1725	ExtPack *pThis = m->pThis;
1726	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1727	AssertPtrReturn(pConsole, VERR_INVALID_POINTER);
1728
1729	Console pCon = (Console )pConsole;
1730	return pCon->i_hgcmLoadService(pszServiceLibrary, pszServiceName);
1731	#else
1732	NOREF(pHlp); NOREF(pConsole); NOREF(pszServiceLibrary); NOREF(pszServiceName);
1733	return VERR_INVALID_STATE;
1734	#endif
1735	}
1736
1737	/static/ DECLCALLBACK(int)
1738	ExtPack::i_hlpLoadVDPlugin(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IVirtualBox) pVirtualBox, const char pszPluginLibrary)
1739	{
1740	#ifndef VBOX_COM_INPROC
1741	/*
1742	* Validate the input and get our bearings.
1743	*/
1744	AssertPtrReturn(pszPluginLibrary, VERR_INVALID_POINTER);
1745
1746	AssertPtrReturn(pHlp, VERR_INVALID_POINTER);
1747	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, VERR_INVALID_POINTER);
1748	ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
1749	AssertPtrReturn(m, VERR_INVALID_POINTER);
1750	ExtPack *pThis = m->pThis;
1751	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1752	AssertPtrReturn(pVirtualBox, VERR_INVALID_POINTER);
1753
1754	VirtualBox pVBox = (VirtualBox )pVirtualBox;
1755	return pVBox->i_loadVDPlugin(pszPluginLibrary);
1756	#else
1757	NOREF(pHlp); NOREF(pVirtualBox); NOREF(pszPluginLibrary);
1758	return VERR_INVALID_STATE;
1759	#endif
1760	}
1761
1762	/static/ DECLCALLBACK(int)
1763	ExtPack::i_hlpUnloadVDPlugin(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IVirtualBox) pVirtualBox, const char pszPluginLibrary)
1764	{
1765	#ifndef VBOX_COM_INPROC
1766	/*
1767	* Validate the input and get our bearings.
1768	*/
1769	AssertPtrReturn(pszPluginLibrary, VERR_INVALID_POINTER);
1770
1771	AssertPtrReturn(pHlp, VERR_INVALID_POINTER);
1772	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, VERR_INVALID_POINTER);
1773	ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
1774	AssertPtrReturn(m, VERR_INVALID_POINTER);
1775	ExtPack *pThis = m->pThis;
1776	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1777	AssertPtrReturn(pVirtualBox, VERR_INVALID_POINTER);
1778
1779	VirtualBox pVBox = (VirtualBox )pVirtualBox;
1780	return pVBox->i_unloadVDPlugin(pszPluginLibrary);
1781	#else
1782	NOREF(pHlp); NOREF(pVirtualBox); NOREF(pszPluginLibrary);
1783	return VERR_INVALID_STATE;
1784	#endif
1785	}
1786
1787	/static/ DECLCALLBACK(uint32_t)
1788	ExtPack::i_hlpCreateProgress(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IUnknown) *pInitiator,
1789	const char *pcszDescription, uint32_t cOperations,
1790	uint32_t uTotalOperationsWeight, const char *pcszFirstOperationDescription,
1791	uint32_t uFirstOperationWeight, VBOXEXTPACK_IF_CS(IProgress) **ppProgressOut)
1792	{
1793	/*
1794	* Validate the input and get our bearings.
1795	*/
1796	AssertPtrReturn(pcszDescription, (uint32_t)E_INVALIDARG);
1797	AssertReturn(cOperations >= 1, (uint32_t)E_INVALIDARG);
1798	AssertReturn(uTotalOperationsWeight >= 1, (uint32_t)E_INVALIDARG);
1799	AssertPtrReturn(pcszFirstOperationDescription, (uint32_t)E_INVALIDARG);
1800	AssertReturn(uFirstOperationWeight >= 1, (uint32_t)E_INVALIDARG);
1801	AssertPtrReturn(ppProgressOut, (uint32_t)E_INVALIDARG);
1802
1803	AssertPtrReturn(pHlp, (uint32_t)E_INVALIDARG);
1804	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, (uint32_t)E_INVALIDARG);
1805	#ifndef VBOX_COM_INPROC
1806	ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
1807	#endif
1808
1809	ComObjPtr<Progress> pProgress;
1810	HRESULT hrc = pProgress.createObject();
1811	if (FAILED(hrc))
1812	return hrc;
1813	hrc = pProgress->init(
1814	#ifndef VBOX_COM_INPROC
1815	m->pVirtualBox,
1816	#endif
1817	pInitiator, pcszDescription, TRUE /* aCancelable */,
1818	cOperations, uTotalOperationsWeight,
1819	pcszFirstOperationDescription, uFirstOperationWeight);
1820	if (FAILED(hrc))
1821	return hrc;
1822
1823	return pProgress.queryInterfaceTo(ppProgressOut);
1824	}
1825
1826	/static/ DECLCALLBACK(uint32_t)
1827	ExtPack::i_hlpGetCanceledProgress(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IProgress) *pProgress,
1828	bool *pfCanceled)
1829	{
1830	/*
1831	* Validate the input and get our bearings.
1832	*/
1833	AssertPtrReturn(pProgress, (uint32_t)E_INVALIDARG);
1834	AssertPtrReturn(pfCanceled, (uint32_t)E_INVALIDARG);
1835
1836	AssertPtrReturn(pHlp, (uint32_t)E_INVALIDARG);
1837	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, (uint32_t)E_INVALIDARG);
1838
1839	BOOL fCanceled = FALSE;
1840	HRESULT hrc = pProgress->COMGETTER(Canceled)(&fCanceled);
1841	*pfCanceled = !!fCanceled;
1842	return hrc;
1843	}
1844
1845	/static/ DECLCALLBACK(uint32_t)
1846	ExtPack::i_hlpUpdateProgress(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IProgress) *pProgress,
1847	uint32_t uPercent)
1848	{
1849	/*
1850	* Validate the input and get our bearings.
1851	*/
1852	AssertPtrReturn(pProgress, (uint32_t)E_INVALIDARG);
1853	AssertReturn(uPercent <= 100, (uint32_t)E_INVALIDARG);
1854
1855	AssertPtrReturn(pHlp, (uint32_t)E_INVALIDARG);
1856	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, (uint32_t)E_INVALIDARG);
1857
1858	ComPtr<IInternalProgressControl> pProgressControl(pProgress);
1859	AssertReturn(!!pProgressControl, (uint32_t)E_INVALIDARG);
1860	return pProgressControl->SetCurrentOperationProgress(uPercent);
1861	}
1862
1863	/static/ DECLCALLBACK(uint32_t)
1864	ExtPack::i_hlpNextOperationProgress(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IProgress) *pProgress,
1865	const char *pcszNextOperationDescription,
1866	uint32_t uNextOperationWeight)
1867	{
1868	/*
1869	* Validate the input and get our bearings.
1870	*/
1871	AssertPtrReturn(pProgress, (uint32_t)E_INVALIDARG);
1872	AssertPtrReturn(pcszNextOperationDescription, (uint32_t)E_INVALIDARG);
1873	AssertReturn(uNextOperationWeight >= 1, (uint32_t)E_INVALIDARG);
1874
1875	AssertPtrReturn(pHlp, (uint32_t)E_INVALIDARG);
1876	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, (uint32_t)E_INVALIDARG);
1877
1878	ComPtr<IInternalProgressControl> pProgressControl(pProgress);
1879	AssertReturn(!!pProgressControl, (uint32_t)E_INVALIDARG);
1880	return pProgressControl->SetNextOperation(Bstr(pcszNextOperationDescription).raw(), uNextOperationWeight);
1881	}
1882
1883	/static/ DECLCALLBACK(uint32_t)
1884	ExtPack::i_hlpWaitOtherProgress(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IProgress) *pProgress,
1885	VBOXEXTPACK_IF_CS(IProgress) *pProgressOther, uint32_t cTimeoutMS)
1886	{
1887	/*
1888	* Validate the input and get our bearings.
1889	*/
1890	AssertPtrReturn(pProgress, (uint32_t)E_INVALIDARG);
1891	AssertPtrReturn(pProgressOther, (uint32_t)E_INVALIDARG);
1892
1893	AssertPtrReturn(pHlp, (uint32_t)E_INVALIDARG);
1894	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, (uint32_t)E_INVALIDARG);
1895
1896	ComPtr<IInternalProgressControl> pProgressControl(pProgress);
1897	AssertReturn(!!pProgressControl, (uint32_t)E_INVALIDARG);
1898	return pProgressControl->WaitForOtherProgressCompletion(pProgressOther, cTimeoutMS);
1899	}
1900
1901	/static/ DECLCALLBACK(uint32_t)
1902	ExtPack::i_hlpCompleteProgress(PCVBOXEXTPACKHLP pHlp, VBOXEXTPACK_IF_CS(IProgress) *pProgress,
1903	uint32_t uResultCode)
1904	{
1905	/*
1906	* Validate the input and get our bearings.
1907	*/
1908	AssertPtrReturn(pProgress, (uint32_t)E_INVALIDARG);
1909
1910	AssertPtrReturn(pHlp, (uint32_t)E_INVALIDARG);
1911	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, (uint32_t)E_INVALIDARG);
1912
1913	ComPtr<IInternalProgressControl> pProgressControl(pProgress);
1914	AssertReturn(!!pProgressControl, (uint32_t)E_INVALIDARG);
1915
1916	ComPtr<IVirtualBoxErrorInfo> errorInfo;
1917	if (FAILED((HRESULT)uResultCode))
1918	{
1919	ErrorInfoKeeper eik;
1920	eik.getVirtualBoxErrorInfo(errorInfo);
1921	}
1922	return pProgressControl->NotifyComplete(uResultCode, errorInfo);
1923	}
1924
1925	/static/ DECLCALLBACK(int)
1926	ExtPack::i_hlpReservedN(PCVBOXEXTPACKHLP pHlp)
1927	{
1928	/*
1929	* Validate the input and get our bearings.
1930	*/
1931	AssertPtrReturn(pHlp, VERR_INVALID_POINTER);
1932	AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, VERR_INVALID_POINTER);
1933	ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
1934	AssertPtrReturn(m, VERR_INVALID_POINTER);
1935	ExtPack *pThis = m->pThis;
1936	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1937
1938	return VERR_NOT_IMPLEMENTED;
1939	}
1940
1941
1942
1943
1944	HRESULT ExtPack::getName(com::Utf8Str &aName)
1945	{
1946	aName = m->Desc.strName;
1947	return S_OK;
1948	}
1949
1950	HRESULT ExtPack::getDescription(com::Utf8Str &aDescription)
1951	{
1952	aDescription = m->Desc.strDescription;
1953	return S_OK;
1954	}
1955
1956	HRESULT ExtPack::getVersion(com::Utf8Str &aVersion)
1957	{
1958	aVersion = m->Desc.strVersion;
1959	return S_OK;
1960	}
1961
1962	HRESULT ExtPack::getRevision(ULONG *aRevision)
1963	{
1964	*aRevision = m->Desc.uRevision;
1965	return S_OK;
1966	}
1967
1968	HRESULT ExtPack::getEdition(com::Utf8Str &aEdition)
1969	{
1970	aEdition = m->Desc.strEdition;
1971	return S_OK;
1972	}
1973
1974	HRESULT ExtPack::getVRDEModule(com::Utf8Str &aVRDEModule)
1975	{
1976	aVRDEModule = m->Desc.strVrdeModule;
1977	return S_OK;
1978	}
1979
1980	HRESULT ExtPack::getPlugIns(std::vector<ComPtr<IExtPackPlugIn> > &aPlugIns)
1981	{
1982	/** @todo implement plug-ins. */
1983	NOREF(aPlugIns);
1984	ReturnComNotImplemented();
1985	}
1986
1987	HRESULT ExtPack::getUsable(BOOL *aUsable)
1988	{
1989	*aUsable = m->fUsable;
1990	return S_OK;
1991	}
1992
1993	HRESULT ExtPack::getWhyUnusable(com::Utf8Str &aWhyUnusable)
1994	{
1995	aWhyUnusable = m->strWhyUnusable;
1996	return S_OK;
1997	}
1998
1999	HRESULT ExtPack::getShowLicense(BOOL *aShowLicense)
2000	{
2001	*aShowLicense = m->Desc.fShowLicense;
2002	return S_OK;
2003	}
2004
2005	HRESULT ExtPack::getLicense(com::Utf8Str &aLicense)
2006	{
2007	Utf8Str strHtml("html");
2008	Utf8Str str("");
2009	return queryLicense(str, str, strHtml, aLicense);
2010	}
2011
2012	HRESULT ExtPack::queryLicense(const com::Utf8Str &aPreferredLocale, const com::Utf8Str &aPreferredLanguage,
2013	const com::Utf8Str &aFormat, com::Utf8Str &aLicenseText)
2014	{
2015	HRESULT hrc = S_OK;
2016
2017	/*
2018	* Validate input.
2019	*/
2020	if (aPreferredLocale.length() != 2 && aPreferredLocale.length() != 0)
2021	return setError(E_FAIL, tr("The preferred locale is a two character string or empty."));
2022
2023	if (aPreferredLanguage.length() != 2 && aPreferredLanguage.length() != 0)
2024	return setError(E_FAIL, tr("The preferred lanuage is a two character string or empty."));
2025
2026	if ( !aFormat.equals("html")
2027	&& !aFormat.equals("rtf")
2028	&& !aFormat.equals("txt"))
2029	return setError(E_FAIL, tr("The license format can only have the values 'html', 'rtf' and 'txt'."));
2030
2031	/*
2032	* Combine the options to form a file name before locking down anything.
2033	*/
2034	char szName[sizeof(VBOX_EXTPACK_LICENSE_NAME_PREFIX "-de_DE.html") + 2];
2035	if (aPreferredLocale.isNotEmpty() && aPreferredLanguage.isNotEmpty())
2036	RTStrPrintf(szName, sizeof(szName), VBOX_EXTPACK_LICENSE_NAME_PREFIX "-%s_%s.%s",
2037	aPreferredLocale.c_str(), aPreferredLanguage.c_str(), aFormat.c_str());
2038	else if (aPreferredLocale.isNotEmpty())
2039	RTStrPrintf(szName, sizeof(szName), VBOX_EXTPACK_LICENSE_NAME_PREFIX "-%s.%s",
2040	aPreferredLocale.c_str(), aFormat.c_str());
2041	else if (aPreferredLanguage.isNotEmpty())
2042	RTStrPrintf(szName, sizeof(szName), VBOX_EXTPACK_LICENSE_NAME_PREFIX "-_%s.%s",
2043	aPreferredLocale.c_str(), aFormat.c_str());
2044	else
2045	RTStrPrintf(szName, sizeof(szName), VBOX_EXTPACK_LICENSE_NAME_PREFIX ".%s",
2046	aFormat.c_str());
2047
2048	/*
2049	* Effectuate the query.
2050	*/
2051	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS); /* paranoia */
2052
2053	if (!m->fUsable)
2054	hrc = setError(E_FAIL, tr("%s"), m->strWhyUnusable.c_str());
2055	else
2056	{
2057	char szPath[RTPATH_MAX];
2058	int vrc = RTPathJoin(szPath, sizeof(szPath), m->strExtPackPath.c_str(), szName);
2059	if (RT_SUCCESS(vrc))
2060	{
2061	void *pvFile;
2062	size_t cbFile;
2063	vrc = RTFileReadAllEx(szPath, 0, RTFOFF_MAX, RTFILE_RDALL_O_DENY_READ, &pvFile, &cbFile);
2064	if (RT_SUCCESS(vrc))
2065	{
2066	Bstr bstrLicense((const char *)pvFile, cbFile);
2067	if (bstrLicense.isNotEmpty())
2068	{
2069	aLicenseText = Utf8Str(bstrLicense);
2070	hrc = S_OK;
2071	}
2072	else
2073	hrc = setError(VBOX_E_IPRT_ERROR, tr("The license file '%s' is empty or contains invalid UTF-8 encoding"),
2074	szPath);
2075	RTFileReadAllFree(pvFile, cbFile);
2076	}
2077	else if (vrc == VERR_FILE_NOT_FOUND \|\| vrc == VERR_PATH_NOT_FOUND)
2078	hrc = setErrorBoth(VBOX_E_OBJECT_NOT_FOUND, vrc, tr("The license file '%s' was not found in extension pack '%s'"),
2079	szName, m->Desc.strName.c_str());
2080	else
2081	hrc = setErrorBoth(VBOX_E_FILE_ERROR, vrc, tr("Failed to open the license file '%s': %Rrc"), szPath, vrc);
2082	}
2083	else
2084	hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("RTPathJoin failed: %Rrc"), vrc);
2085	}
2086	return hrc;
2087	}
2088
2089	HRESULT ExtPack::queryObject(const com::Utf8Str &aObjUuid, ComPtr<IUnknown> &aReturnInterface)
2090	{
2091	com::Guid ObjectId;
2092	CheckComArgGuid(aObjUuid, ObjectId);
2093
2094	HRESULT hrc S_OK;
2095
2096	if ( m->pReg
2097	&& m->pReg->pfnQueryObject)
2098	{
2099	void *pvUnknown = m->pReg->pfnQueryObject(m->pReg, ObjectId.raw());
2100	if (pvUnknown)
2101	aReturnInterface = (IUnknown *)pvUnknown;
2102	else
2103	hrc = E_NOINTERFACE;
2104	}
2105	else
2106	hrc = E_NOINTERFACE;
2107	return hrc;
2108	}
2109
2110	DEFINE_EMPTY_CTOR_DTOR(ExtPackManager)
2111
2112	/**
2113	* Called by ComObjPtr::createObject when creating the object.
2114	*
2115	* Just initialize the basic object state, do the rest in init().
2116	*
2117	* @returns S_OK.
2118	*/
2119	HRESULT ExtPackManager::FinalConstruct()
2120	{
2121	m = NULL;
2122	return BaseFinalConstruct();
2123	}
2124
2125	/**
2126	* Initializes the extension pack manager.
2127	*
2128	* @returns COM status code.
2129	* @param a_pVirtualBox Pointer to the VirtualBox object.
2130	* @param a_enmContext The context we're in.
2131	*/
2132	HRESULT ExtPackManager::initExtPackManager(VirtualBox *a_pVirtualBox, VBOXEXTPACKCTX a_enmContext)
2133	{
2134	AutoInitSpan autoInitSpan(this);
2135	AssertReturn(autoInitSpan.isOk(), E_FAIL);
2136
2137	/*
2138	* Figure some stuff out before creating the instance data.
2139	*/
2140	char szBaseDir[RTPATH_MAX];
2141	int rc = RTPathAppPrivateArchTop(szBaseDir, sizeof(szBaseDir));
2142	AssertLogRelRCReturn(rc, E_FAIL);
2143	rc = RTPathAppend(szBaseDir, sizeof(szBaseDir), VBOX_EXTPACK_INSTALL_DIR);
2144	AssertLogRelRCReturn(rc, E_FAIL);
2145
2146	char szCertificatDir[RTPATH_MAX];
2147	rc = RTPathAppPrivateNoArch(szCertificatDir, sizeof(szCertificatDir));
2148	AssertLogRelRCReturn(rc, E_FAIL);
2149	rc = RTPathAppend(szCertificatDir, sizeof(szCertificatDir), VBOX_EXTPACK_CERT_DIR);
2150	AssertLogRelRCReturn(rc, E_FAIL);
2151
2152	/*
2153	* Allocate and initialize the instance data.
2154	*/
2155	m = new Data;
2156	m->strBaseDir = szBaseDir;
2157	m->strCertificatDirPath = szCertificatDir;
2158	m->enmContext = a_enmContext;
2159	#ifndef VBOX_COM_INPROC
2160	m->pVirtualBox = a_pVirtualBox;
2161	#else
2162	RT_NOREF_PV(a_pVirtualBox);
2163	#endif
2164
2165	/*
2166	* Go looking for extensions. The RTDirOpen may fail if nothing has been
2167	* installed yet, or if root is paranoid and has revoked our access to them.
2168	*
2169	* We ASSUME that there are no files, directories or stuff in the directory
2170	* that exceed the max name length in RTDIRENTRYEX.
2171	*/
2172	HRESULT hrc = S_OK;
2173	RTDIR hDir;
2174	int vrc = RTDirOpen(&hDir, szBaseDir);
2175	if (RT_SUCCESS(vrc))
2176	{
2177	for (;;)
2178	{
2179	RTDIRENTRYEX Entry;
2180	vrc = RTDirReadEx(hDir, &Entry, NULL /pcbDirEntry/, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK);
2181	if (RT_FAILURE(vrc))
2182	{
2183	AssertLogRelMsg(vrc == VERR_NO_MORE_FILES, ("%Rrc\n", vrc));
2184	break;
2185	}
2186	if ( RTFS_IS_DIRECTORY(Entry.Info.Attr.fMode)
2187	&& strcmp(Entry.szName, ".") != 0
2188	&& strcmp(Entry.szName, "..") != 0
2189	&& VBoxExtPackIsValidMangledName(Entry.szName) )
2190	{
2191	/*
2192	* All directories are extensions, the shall be nothing but
2193	* extensions in this subdirectory.
2194	*/
2195	char szExtPackDir[RTPATH_MAX];
2196	vrc = RTPathJoin(szExtPackDir, sizeof(szExtPackDir), m->strBaseDir.c_str(), Entry.szName);
2197	AssertLogRelRC(vrc);
2198	if (RT_SUCCESS(vrc))
2199	{
2200	RTCString *pstrName = VBoxExtPackUnmangleName(Entry.szName, RTSTR_MAX);
2201	AssertLogRel(pstrName);
2202	if (pstrName)
2203	{
2204	ComObjPtr<ExtPack> NewExtPack;
2205	HRESULT hrc2 = NewExtPack.createObject();
2206	if (SUCCEEDED(hrc2))
2207	hrc2 = NewExtPack->initWithDir(a_pVirtualBox, a_enmContext, pstrName->c_str(), szExtPackDir);
2208	delete pstrName;
2209	if (SUCCEEDED(hrc2))
2210	{
2211	m->llInstalledExtPacks.push_back(NewExtPack);
2212	/* Paranoia, there should be no API clients before this method is finished. */
2213
2214	m->cUpdate++;
2215	}
2216	else if (SUCCEEDED(rc))
2217	hrc = hrc2;
2218	}
2219	else
2220	hrc = E_UNEXPECTED;
2221	}
2222	else
2223	hrc = E_UNEXPECTED;
2224	}
2225	}
2226	RTDirClose(hDir);
2227	}
2228	/* else: ignore, the directory probably does not exist or something. */
2229
2230	if (SUCCEEDED(hrc))
2231	autoInitSpan.setSucceeded();
2232	return hrc;
2233	}
2234
2235	/**
2236	* COM cruft.
2237	*/
2238	void ExtPackManager::FinalRelease()
2239	{
2240	uninit();
2241	BaseFinalRelease();
2242	}
2243
2244	/**
2245	* Do the actual cleanup.
2246	*/
2247	void ExtPackManager::uninit()
2248	{
2249	/* Enclose the state transition Ready->InUninit->NotReady */
2250	AutoUninitSpan autoUninitSpan(this);
2251	if (!autoUninitSpan.uninitDone() && m != NULL)
2252	{
2253	delete m;
2254	m = NULL;
2255	}
2256	}
2257
2258	HRESULT ExtPackManager::getInstalledExtPacks(std::vector<ComPtr<IExtPack> > &aInstalledExtPacks)
2259	{
2260	Assert(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON);
2261
2262	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
2263
2264
2265	SafeIfaceArray<IExtPack> SaExtPacks(m->llInstalledExtPacks);
2266	aInstalledExtPacks.resize(SaExtPacks.size());
2267	for(size_t i = 0; i < SaExtPacks.size(); ++i)
2268	aInstalledExtPacks[i] = SaExtPacks[i];
2269
2270	return S_OK;
2271	}
2272
2273	HRESULT ExtPackManager::find(const com::Utf8Str &aName, ComPtr<IExtPack> &aReturnData)
2274	{
2275	HRESULT hrc = S_OK;
2276
2277	Assert(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON);
2278
2279	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
2280
2281	ComPtr<ExtPack> ptrExtPack = i_findExtPack(aName.c_str());
2282	if (!ptrExtPack.isNull())
2283	ptrExtPack.queryInterfaceTo(aReturnData.asOutParam());
2284	else
2285	hrc = VBOX_E_OBJECT_NOT_FOUND;
2286
2287	return hrc;
2288	}
2289
2290	HRESULT ExtPackManager::openExtPackFile(const com::Utf8Str &aPath, ComPtr<IExtPackFile> &aFile)
2291	{
2292	AssertReturn(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON, E_UNEXPECTED);
2293
2294	#ifndef VBOX_COM_INPROC
2295	/* The API can optionally take a ::SHA-256=<hex-digest> attribute at the
2296	end of the file name. This is just a temporary measure for
2297	backporting, in 4.2 we'll add another parameter to the method. */
2298	Utf8Str strTarball;
2299	Utf8Str strDigest;
2300	size_t offSha256 = aPath.find("::SHA-256=");
2301	if (offSha256 == Utf8Str::npos)
2302	strTarball = aPath;
2303	else
2304	{
2305	strTarball = aPath.substr(0, offSha256);
2306	strDigest = aPath.substr(offSha256 + sizeof("::SHA-256=") - 1);
2307	}
2308
2309	ComObjPtr<ExtPackFile> NewExtPackFile;
2310	HRESULT hrc = NewExtPackFile.createObject();
2311	if (SUCCEEDED(hrc))
2312	hrc = NewExtPackFile->initWithFile(strTarball.c_str(), strDigest.c_str(), this, m->pVirtualBox);
2313	if (SUCCEEDED(hrc))
2314	NewExtPackFile.queryInterfaceTo(aFile.asOutParam());
2315
2316	return hrc;
2317	#else
2318	RT_NOREF(aPath, aFile);
2319	return E_NOTIMPL;
2320	#endif
2321	}
2322
2323	HRESULT ExtPackManager::uninstall(const com::Utf8Str &aName, BOOL aForcedRemoval,
2324	const com::Utf8Str &aDisplayInfo, ComPtr<IProgress> &aProgress)
2325	{
2326	Assert(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON);
2327
2328	#ifndef VBOX_COM_INPROC
2329
2330	HRESULT hrc;
2331	ExtPackUninstallTask *pTask = NULL;
2332	try
2333	{
2334	pTask = new ExtPackUninstallTask();
2335	hrc = pTask->Init(this, aName, aForcedRemoval != FALSE, aDisplayInfo);
2336	if (SUCCEEDED(hrc))
2337	{
2338	ComPtr<Progress> ptrProgress = pTask->ptrProgress;
2339	hrc = pTask->createThreadWithType(RTTHREADTYPE_DEFAULT);
2340	pTask = NULL; /* always consumed by createThread */
2341	if (SUCCEEDED(hrc))
2342	hrc = ptrProgress.queryInterfaceTo(aProgress.asOutParam());
2343	else
2344	hrc = setError(VBOX_E_IPRT_ERROR,
2345	tr("Starting thread for an extension pack uninstallation failed with %Rrc"), hrc);
2346	}
2347	else
2348	hrc = setError(hrc, tr("Looks like creating a progress object for ExtraPackUninstallTask object failed"));
2349	}
2350	catch (std::bad_alloc &)
2351	{
2352	hrc = E_OUTOFMEMORY;
2353	}
2354	catch (HRESULT hrcXcpt)
2355	{
2356	LogFlowThisFunc(("Exception was caught in the function ExtPackManager::uninstall()\n"));
2357	hrc = hrcXcpt;
2358	}
2359	if (pTask)
2360	delete pTask;
2361	return hrc;
2362	#else
2363	RT_NOREF(aName, aForcedRemoval, aDisplayInfo, aProgress);
2364	return E_NOTIMPL;
2365	#endif
2366	}
2367
2368	HRESULT ExtPackManager::cleanup(void)
2369	{
2370	Assert(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON);
2371
2372	AutoCaller autoCaller(this);
2373	HRESULT hrc = autoCaller.rc();
2374	if (SUCCEEDED(hrc))
2375	{
2376	/*
2377	* Run the set-uid-to-root binary that performs the cleanup.
2378	*
2379	* Take the write lock to prevent conflicts with other calls to this
2380	* VBoxSVC instance.
2381	*/
2382	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
2383	hrc = i_runSetUidToRootHelper(NULL,
2384	"cleanup",
2385	"--base-dir", m->strBaseDir.c_str(),
2386	(const char *)NULL);
2387	}
2388
2389	return hrc;
2390	}
2391
2392	HRESULT ExtPackManager::queryAllPlugInsForFrontend(const com::Utf8Str &aFrontendName, std::vector<com::Utf8Str> &aPlugInModules)
2393	{
2394	NOREF(aFrontendName);
2395	aPlugInModules.resize(0);
2396	return S_OK;
2397	}
2398
2399	HRESULT ExtPackManager::isExtPackUsable(const com::Utf8Str &aName, BOOL *aUsable)
2400	{
2401	*aUsable = i_isExtPackUsable(aName.c_str());
2402	return S_OK;
2403	}
2404
2405	/**
2406	* Finds the success indicator string in the stderr output ofr hte helper app.
2407	*
2408	* @returns Pointer to the indicator.
2409	* @param psz The stderr output string. Can be NULL.
2410	* @param cch The size of the string.
2411	*/
2412	static char findSuccessIndicator(char psz, size_t cch)
2413	{
2414	static const char s_szSuccessInd[] = "rcExit=RTEXITCODE_SUCCESS";
2415	Assert(!cch \|\| strlen(psz) == cch);
2416	if (cch < sizeof(s_szSuccessInd) - 1)
2417	return NULL;
2418	char *pszInd = &psz[cch - sizeof(s_szSuccessInd) + 1];
2419	if (strcmp(s_szSuccessInd, pszInd))
2420	return NULL;
2421	return pszInd;
2422	}
2423
2424	/**
2425	* Runs the helper application that does the privileged operations.
2426	*
2427	* @returns S_OK or a failure status with error information set.
2428	* @param a_pstrDisplayInfo Platform specific display info hacks.
2429	* @param a_pszCommand The command to execute.
2430	* @param ... The argument strings that goes along with the
2431	* command. Maximum is about 16. Terminated by a
2432	* NULL.
2433	*/
2434	HRESULT ExtPackManager::i_runSetUidToRootHelper(Utf8Str const a_pstrDisplayInfo, const char a_pszCommand, ...)
2435	{
2436	/*
2437	* Calculate the path to the helper application.
2438	*/
2439	char szExecName[RTPATH_MAX];
2440	int vrc = RTPathAppPrivateArch(szExecName, sizeof(szExecName));
2441	AssertLogRelRCReturn(vrc, E_UNEXPECTED);
2442
2443	vrc = RTPathAppend(szExecName, sizeof(szExecName), VBOX_EXTPACK_HELPER_NAME);
2444	AssertLogRelRCReturn(vrc, E_UNEXPECTED);
2445
2446	/*
2447	* Convert the variable argument list to a RTProcCreate argument vector.
2448	*/
2449	const char *apszArgs[20];
2450	unsigned cArgs = 0;
2451
2452	LogRel(("ExtPack: Executing '%s'", szExecName));
2453	apszArgs[cArgs++] = &szExecName[0];
2454
2455	if ( a_pstrDisplayInfo
2456	&& a_pstrDisplayInfo->isNotEmpty())
2457	{
2458	LogRel((" '--display-info-hack' '%s'", a_pstrDisplayInfo->c_str()));
2459	apszArgs[cArgs++] = "--display-info-hack";
2460	apszArgs[cArgs++] = a_pstrDisplayInfo->c_str();
2461	}
2462
2463	LogRel((" '%s'", a_pszCommand));
2464	apszArgs[cArgs++] = a_pszCommand;
2465
2466	va_list va;
2467	va_start(va, a_pszCommand);
2468	const char *pszLastArg;
2469	for (;;)
2470	{
2471	AssertReturn(cArgs < RT_ELEMENTS(apszArgs) - 1, E_UNEXPECTED);
2472	pszLastArg = va_arg(va, const char *);
2473	if (!pszLastArg)
2474	break;
2475	LogRel((" '%s'", pszLastArg));
2476	apszArgs[cArgs++] = pszLastArg;
2477	};
2478	va_end(va);
2479
2480	LogRel(("\n"));
2481	apszArgs[cArgs] = NULL;
2482
2483	/*
2484	* Create a PIPE which we attach to stderr so that we can read the error
2485	* message on failure and report it back to the caller.
2486	*/
2487	RTPIPE hPipeR;
2488	RTHANDLE hStdErrPipe;
2489	hStdErrPipe.enmType = RTHANDLETYPE_PIPE;
2490	vrc = RTPipeCreate(&hPipeR, &hStdErrPipe.u.hPipe, RTPIPE_C_INHERIT_WRITE);
2491	AssertLogRelRCReturn(vrc, E_UNEXPECTED);
2492
2493	/*
2494	* Spawn the process.
2495	*/
2496	HRESULT hrc;
2497	RTPROCESS hProcess;
2498	vrc = RTProcCreateEx(szExecName,
2499	apszArgs,
2500	RTENV_DEFAULT,
2501	0 /fFlags/,
2502	NULL /phStdIn/,
2503	NULL /phStdOut/,
2504	&hStdErrPipe,
2505	NULL /pszAsUser/,
2506	NULL /pszPassword/,
2507	&hProcess);
2508	if (RT_SUCCESS(vrc))
2509	{
2510	vrc = RTPipeClose(hStdErrPipe.u.hPipe);
2511	hStdErrPipe.u.hPipe = NIL_RTPIPE;
2512
2513	/*
2514	* Read the pipe output until the process completes.
2515	*/
2516	RTPROCSTATUS ProcStatus = { -42, RTPROCEXITREASON_ABEND };
2517	size_t cbStdErrBuf = 0;
2518	size_t offStdErrBuf = 0;
2519	char *pszStdErrBuf = NULL;
2520	do
2521	{
2522	/*
2523	* Service the pipe. Block waiting for output or the pipe breaking
2524	* when the process terminates.
2525	*/
2526	if (hPipeR != NIL_RTPIPE)
2527	{
2528	char achBuf[1024];
2529	size_t cbRead;
2530	vrc = RTPipeReadBlocking(hPipeR, achBuf, sizeof(achBuf), &cbRead);
2531	if (RT_SUCCESS(vrc))
2532	{
2533	/* grow the buffer? */
2534	size_t cbBufReq = offStdErrBuf + cbRead + 1;
2535	if ( cbBufReq > cbStdErrBuf
2536	&& cbBufReq < _256K)
2537	{
2538	size_t cbNew = RT_ALIGN_Z(cbBufReq, 16); // 1024
2539	void *pvNew = RTMemRealloc(pszStdErrBuf, cbNew);
2540	if (pvNew)
2541	{
2542	pszStdErrBuf = (char *)pvNew;
2543	cbStdErrBuf = cbNew;
2544	}
2545	}
2546
2547	/* append if we've got room. */
2548	if (cbBufReq <= cbStdErrBuf)
2549	{
2550	memcpy(&pszStdErrBuf[offStdErrBuf], achBuf, cbRead);
2551	offStdErrBuf = offStdErrBuf + cbRead;
2552	pszStdErrBuf[offStdErrBuf] = '\0';
2553	}
2554	}
2555	else
2556	{
2557	AssertLogRelMsg(vrc == VERR_BROKEN_PIPE, ("%Rrc\n", vrc));
2558	RTPipeClose(hPipeR);
2559	hPipeR = NIL_RTPIPE;
2560	}
2561	}
2562
2563	/*
2564	* Service the process. Block if we have no pipe.
2565	*/
2566	if (hProcess != NIL_RTPROCESS)
2567	{
2568	vrc = RTProcWait(hProcess,
2569	hPipeR == NIL_RTPIPE ? RTPROCWAIT_FLAGS_BLOCK : RTPROCWAIT_FLAGS_NOBLOCK,
2570	&ProcStatus);
2571	if (RT_SUCCESS(vrc))
2572	hProcess = NIL_RTPROCESS;
2573	else
2574	AssertLogRelMsgStmt(vrc == VERR_PROCESS_RUNNING, ("%Rrc\n", vrc), hProcess = NIL_RTPROCESS);
2575	}
2576	} while ( hPipeR != NIL_RTPIPE
2577	\|\| hProcess != NIL_RTPROCESS);
2578
2579	LogRel(("ExtPack: enmReason=%d iStatus=%d stderr='%s'\n",
2580	ProcStatus.enmReason, ProcStatus.iStatus, offStdErrBuf ? pszStdErrBuf : ""));
2581
2582	/*
2583	* Look for rcExit=RTEXITCODE_SUCCESS at the end of the error output,
2584	* cut it as it is only there to attest the success.
2585	*/
2586	if (offStdErrBuf > 0)
2587	{
2588	RTStrStripR(pszStdErrBuf);
2589	offStdErrBuf = strlen(pszStdErrBuf);
2590	}
2591
2592	char *pszSuccessInd = findSuccessIndicator(pszStdErrBuf, offStdErrBuf);
2593	if (pszSuccessInd)
2594	{
2595	*pszSuccessInd = '\0';
2596	offStdErrBuf = pszSuccessInd - pszStdErrBuf;
2597	}
2598	else if ( ProcStatus.enmReason == RTPROCEXITREASON_NORMAL
2599	&& ProcStatus.iStatus == 0)
2600	ProcStatus.iStatus = offStdErrBuf ? 667 : 666;
2601
2602	/*
2603	* Compose the status code and, on failure, error message.
2604	*/
2605	if ( ProcStatus.enmReason == RTPROCEXITREASON_NORMAL
2606	&& ProcStatus.iStatus == 0)
2607	hrc = S_OK;
2608	else if (ProcStatus.enmReason == RTPROCEXITREASON_NORMAL)
2609	{
2610	AssertMsg(ProcStatus.iStatus != 0, ("%s\n", pszStdErrBuf));
2611	hrc = setError(E_FAIL, tr("The installer failed with exit code %d: %s"),
2612	ProcStatus.iStatus, offStdErrBuf ? pszStdErrBuf : "");
2613	}
2614	else if (ProcStatus.enmReason == RTPROCEXITREASON_SIGNAL)
2615	hrc = setError(E_UNEXPECTED, tr("The installer was killed by signal #d (stderr: %s)"),
2616	ProcStatus.iStatus, offStdErrBuf ? pszStdErrBuf : "");
2617	else if (ProcStatus.enmReason == RTPROCEXITREASON_ABEND)
2618	hrc = setError(E_UNEXPECTED, tr("The installer aborted abnormally (stderr: %s)"),
2619	offStdErrBuf ? pszStdErrBuf : "");
2620	else
2621	hrc = setError(E_UNEXPECTED, tr("internal error: enmReason=%d iStatus=%d stderr='%s'"),
2622	ProcStatus.enmReason, ProcStatus.iStatus, offStdErrBuf ? pszStdErrBuf : "");
2623
2624	RTMemFree(pszStdErrBuf);
2625	}
2626	else
2627	hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("Failed to launch the helper application '%s' (%Rrc)"), szExecName, vrc);
2628
2629	RTPipeClose(hPipeR);
2630	RTPipeClose(hStdErrPipe.u.hPipe);
2631
2632	return hrc;
2633	}
2634
2635	/**
2636	* Finds an installed extension pack.
2637	*
2638	* @returns Pointer to the extension pack if found, NULL if not. (No reference
2639	* counting problem here since the caller must be holding the lock.)
2640	* @param a_pszName The name of the extension pack.
2641	*/
2642	ExtPack ExtPackManager::i_findExtPack(const char a_pszName)
2643	{
2644	size_t cchName = strlen(a_pszName);
2645
2646	for (ExtPackList::iterator it = m->llInstalledExtPacks.begin();
2647	it != m->llInstalledExtPacks.end();
2648	++it)
2649	{
2650	ExtPack::Data pExtPackData = (it)->m;
2651	if ( pExtPackData
2652	&& pExtPackData->Desc.strName.length() == cchName
2653	&& pExtPackData->Desc.strName.equalsIgnoreCase(a_pszName))
2654	return (*it);
2655	}
2656	return NULL;
2657	}
2658
2659	/**
2660	* Removes an installed extension pack from the internal list.
2661	*
2662	* The package is expected to exist!
2663	*
2664	* @param a_pszName The name of the extension pack.
2665	*/
2666	void ExtPackManager::i_removeExtPack(const char *a_pszName)
2667	{
2668	size_t cchName = strlen(a_pszName);
2669
2670	for (ExtPackList::iterator it = m->llInstalledExtPacks.begin();
2671	it != m->llInstalledExtPacks.end();
2672	++it)
2673	{
2674	ExtPack::Data pExtPackData = (it)->m;
2675	if ( pExtPackData
2676	&& pExtPackData->Desc.strName.length() == cchName
2677	&& pExtPackData->Desc.strName.equalsIgnoreCase(a_pszName))
2678	{
2679	m->llInstalledExtPacks.erase(it);
2680	m->cUpdate++;
2681	return;
2682	}
2683	}
2684	AssertMsgFailed(("%s\n", a_pszName));
2685	}
2686
2687	#ifndef VBOX_COM_INPROC
2688
2689	/**
2690	* Refreshes the specified extension pack.
2691	*
2692	* This may remove the extension pack from the list, so any non-smart pointers
2693	* to the extension pack object may become invalid.
2694	*
2695	* @returns S_OK and *a_ppExtPack on success, COM status code and error
2696	* message on failure. Note that *a_ppExtPack can be NULL.
2697	*
2698	* @param a_pszName The extension to update..
2699	* @param a_fUnusableIsError If @c true, report an unusable extension pack
2700	* as an error.
2701	* @param a_ppExtPack Where to store the pointer to the extension
2702	* pack of it is still around after the refresh.
2703	* This is optional.
2704	*
2705	* @remarks Caller holds the extension manager lock.
2706	* @remarks Only called in VBoxSVC.
2707	*/
2708	HRESULT ExtPackManager::i_refreshExtPack(const char a_pszName, bool a_fUnusableIsError, ExtPack *a_ppExtPack)
2709	{
2710	Assert(m->pVirtualBox != NULL); /* Only called from VBoxSVC. */
2711
2712	HRESULT hrc;
2713	ExtPack *pExtPack = i_findExtPack(a_pszName);
2714	if (pExtPack)
2715	{
2716	/*
2717	* Refresh existing object.
2718	*/
2719	bool fCanDelete;
2720	hrc = pExtPack->i_refresh(&fCanDelete);
2721	if (SUCCEEDED(hrc))
2722	{
2723	if (fCanDelete)
2724	{
2725	i_removeExtPack(a_pszName);
2726	pExtPack = NULL;
2727	}
2728	}
2729	}
2730	else
2731	{
2732	/*
2733	* Do this check here, otherwise VBoxExtPackCalcDir() will fail with a strange
2734	* error.
2735	*/
2736	bool fValid = VBoxExtPackIsValidName(a_pszName);
2737	if (!fValid)
2738	return setError(E_FAIL, "Invalid extension pack name specified");
2739
2740	/*
2741	* Does the dir exist? Make some special effort to deal with case
2742	* sensitivie file systems (a_pszName is case insensitive and mangled).
2743	*/
2744	char szDir[RTPATH_MAX];
2745	int vrc = VBoxExtPackCalcDir(szDir, sizeof(szDir), m->strBaseDir.c_str(), a_pszName);
2746	AssertLogRelRCReturn(vrc, E_FAIL);
2747
2748	RTDIRENTRYEX Entry;
2749	RTFSOBJINFO ObjInfo;
2750	vrc = RTPathQueryInfoEx(szDir, &ObjInfo, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK);
2751	bool fExists = RT_SUCCESS(vrc) && RTFS_IS_DIRECTORY(ObjInfo.Attr.fMode);
2752	if (!fExists)
2753	{
2754	RTDIR hDir;
2755	vrc = RTDirOpen(&hDir, m->strBaseDir.c_str());
2756	if (RT_SUCCESS(vrc))
2757	{
2758	const char *pszMangledName = RTPathFilename(szDir);
2759	for (;;)
2760	{
2761	vrc = RTDirReadEx(hDir, &Entry, NULL /pcbDirEntry/, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK);
2762	if (RT_FAILURE(vrc))
2763	{
2764	AssertLogRelMsg(vrc == VERR_NO_MORE_FILES, ("%Rrc\n", vrc));
2765	break;
2766	}
2767	if ( RTFS_IS_DIRECTORY(Entry.Info.Attr.fMode)
2768	&& !RTStrICmp(Entry.szName, pszMangledName))
2769	{
2770	/*
2771	* The installed extension pack has a uses different case.
2772	* Update the name and directory variables.
2773	*/
2774	vrc = RTPathJoin(szDir, sizeof(szDir), m->strBaseDir.c_str(), Entry.szName); /* not really necessary */
2775	AssertLogRelRCReturnStmt(vrc, RTDirClose(hDir), E_UNEXPECTED);
2776	a_pszName = Entry.szName;
2777	fExists = true;
2778	break;
2779	}
2780	}
2781	RTDirClose(hDir);
2782	}
2783	}
2784	if (fExists)
2785	{
2786	/*
2787	* We've got something, create a new extension pack object for it.
2788	*/
2789	ComObjPtr<ExtPack> ptrNewExtPack;
2790	hrc = ptrNewExtPack.createObject();
2791	if (SUCCEEDED(hrc))
2792	hrc = ptrNewExtPack->initWithDir(m->pVirtualBox, m->enmContext, a_pszName, szDir);
2793	if (SUCCEEDED(hrc))
2794	{
2795	m->llInstalledExtPacks.push_back(ptrNewExtPack);
2796	m->cUpdate++;
2797	if (ptrNewExtPack->m->fUsable)
2798	LogRel(("ExtPackManager: Found extension pack '%s'.\n", a_pszName));
2799	else
2800	LogRel(("ExtPackManager: Found bad extension pack '%s': %s\n",
2801	a_pszName, ptrNewExtPack->m->strWhyUnusable.c_str() ));
2802	pExtPack = ptrNewExtPack;
2803	}
2804	}
2805	else
2806	hrc = S_OK;
2807	}
2808
2809	/*
2810	* Report error if not usable, if that is desired.
2811	*/
2812	if ( SUCCEEDED(hrc)
2813	&& pExtPack
2814	&& a_fUnusableIsError
2815	&& !pExtPack->m->fUsable)
2816	hrc = setError(E_FAIL, "%s", pExtPack->m->strWhyUnusable.c_str());
2817
2818	if (a_ppExtPack)
2819	*a_ppExtPack = pExtPack;
2820	return hrc;
2821	}
2822
2823	/**
2824	* Checks if there are any running VMs.
2825	*
2826	* This is called when uninstalling or replacing an extension pack.
2827	*
2828	* @returns true / false
2829	*/
2830	bool ExtPackManager::i_areThereAnyRunningVMs(void) const
2831	{
2832	Assert(m->pVirtualBox != NULL); /* Only called from VBoxSVC. */
2833
2834	/*
2835	* Get list of machines and their states.
2836	*/
2837	com::SafeIfaceArray<IMachine> SaMachines;
2838	HRESULT hrc = m->pVirtualBox->COMGETTER(Machines)(ComSafeArrayAsOutParam(SaMachines));
2839	if (SUCCEEDED(hrc))
2840	{
2841	com::SafeArray<MachineState_T> SaStates;
2842	hrc = m->pVirtualBox->GetMachineStates(ComSafeArrayAsInParam(SaMachines), ComSafeArrayAsOutParam(SaStates));
2843	if (SUCCEEDED(hrc))
2844	{
2845	/*
2846	* Scan the two parallel arrays for machines in the running state.
2847	*/
2848	Assert(SaStates.size() == SaMachines.size());
2849	for (size_t i = 0; i < SaMachines.size(); ++i)
2850	if (SaMachines[i] && Global::IsOnline(SaStates[i]))
2851	return true;
2852	}
2853	}
2854	return false;
2855	}
2856
2857	/**
2858	* Worker for IExtPackFile::Install.
2859	*
2860	* Called on a worker thread via doInstallThreadProc.
2861	*
2862	* @returns COM status code.
2863	* @param a_pExtPackFile The extension pack file, caller checks that
2864	* it's usable.
2865	* @param a_fReplace Whether to replace any existing extpack or just
2866	* fail.
2867	* @param a_pstrDisplayInfo Host specific display information hacks.
2868	* be NULL.
2869	*/
2870	HRESULT ExtPackManager::i_doInstall(ExtPackFile a_pExtPackFile, bool a_fReplace, Utf8Str const a_pstrDisplayInfo)
2871	{
2872	AssertReturn(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON, E_UNEXPECTED);
2873	RTCString const * const pStrName = &a_pExtPackFile->m->Desc.strName;
2874	RTCString const * const pStrTarball = &a_pExtPackFile->m->strExtPackFile;
2875	RTCString const * const pStrTarballDigest = &a_pExtPackFile->m->strDigest;
2876
2877	AutoCaller autoCaller(this);
2878	HRESULT hrc = autoCaller.rc();
2879	if (SUCCEEDED(hrc))
2880	{
2881	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
2882
2883	/*
2884	* Refresh the data we have on the extension pack as it
2885	* may be made stale by direct meddling or some other user.
2886	*/
2887	ExtPack *pExtPack;
2888	hrc = i_refreshExtPack(pStrName->c_str(), false /a_fUnusableIsError/, &pExtPack);
2889	if (SUCCEEDED(hrc))
2890	{
2891	if (pExtPack && a_fReplace)
2892	{
2893	/* We must leave the lock when calling i_areThereAnyRunningVMs,
2894	which means we have to redo the refresh call afterwards. */
2895	autoLock.release();
2896	bool fRunningVMs = i_areThereAnyRunningVMs();
2897	bool fVetoingCP = pExtPack->i_areThereCloudProviderUninstallVetos();
2898	autoLock.acquire();
2899	hrc = i_refreshExtPack(pStrName->c_str(), false /a_fUnusableIsError/, &pExtPack);
2900	if (fRunningVMs)
2901	{
2902	LogRel(("Upgrading extension pack '%s' failed because at least one VM is still running.", pStrName->c_str()));
2903	hrc = setError(E_FAIL, tr("Upgrading extension pack '%s' failed because at least one VM is still running"),
2904	pStrName->c_str());
2905	}
2906	else if (fVetoingCP)
2907	{
2908	LogRel(("Upgrading extension pack '%s' failed because at least one Cloud Provider is still busy.", pStrName->c_str()));
2909	hrc = setError(E_FAIL, tr("Upgrading extension pack '%s' failed because at least one Cloud Provider is still busy"),
2910	pStrName->c_str());
2911	}
2912	else if (SUCCEEDED(hrc) && pExtPack)
2913	hrc = pExtPack->i_callUninstallHookAndClose(m->pVirtualBox, false /a_ForcedRemoval/);
2914	}
2915	else if (pExtPack)
2916	hrc = setError(E_FAIL,
2917	tr("Extension pack '%s' is already installed."
2918	" In case of a reinstallation, please uninstall it first"),
2919	pStrName->c_str());
2920	}
2921	if (SUCCEEDED(hrc))
2922	{
2923	/*
2924	* Run the privileged helper binary that performs the actual
2925	* installation. Then create an object for the packet (we do this
2926	* even on failure, to be on the safe side).
2927	*/
2928	hrc = i_runSetUidToRootHelper(a_pstrDisplayInfo,
2929	"install",
2930	"--base-dir", m->strBaseDir.c_str(),
2931	"--cert-dir", m->strCertificatDirPath.c_str(),
2932	"--name", pStrName->c_str(),
2933	"--tarball", pStrTarball->c_str(),
2934	"--sha-256", pStrTarballDigest->c_str(),
2935	pExtPack ? "--replace" : (const char *)NULL,
2936	(const char *)NULL);
2937	if (SUCCEEDED(hrc))
2938	{
2939	hrc = i_refreshExtPack(pStrName->c_str(), true /a_fUnusableIsError/, &pExtPack);
2940	if (SUCCEEDED(hrc) && pExtPack)
2941	{
2942	RTERRINFOSTATIC ErrInfo;
2943	RTErrInfoInitStatic(&ErrInfo);
2944	pExtPack->i_callInstalledHook(m->pVirtualBox, &autoLock, &ErrInfo.Core);
2945	if (RT_SUCCESS(ErrInfo.Core.rc))
2946	LogRel(("ExtPackManager: Successfully installed extension pack '%s'.\n", pStrName->c_str()));
2947	else
2948	{
2949	LogRel(("ExtPackManager: Installed hook for '%s' failed: %Rrc - %s\n",
2950	pStrName->c_str(), ErrInfo.Core.rc, ErrInfo.Core.pszMsg));
2951
2952	/*
2953	* Uninstall the extpack if the error indicates that.
2954	*/
2955	if (ErrInfo.Core.rc == VERR_EXTPACK_UNSUPPORTED_HOST_UNINSTALL)
2956	i_runSetUidToRootHelper(a_pstrDisplayInfo,
2957	"uninstall",
2958	"--base-dir", m->strBaseDir.c_str(),
2959	"--name", pStrName->c_str(),
2960	"--forced",
2961	(const char *)NULL);
2962	hrc = setErrorBoth(E_FAIL, ErrInfo.Core.rc, tr("The installation hook failed: %Rrc - %s"),
2963	ErrInfo.Core.rc, ErrInfo.Core.pszMsg);
2964	}
2965	}
2966	else if (SUCCEEDED(hrc))
2967	hrc = setError(E_FAIL, tr("Installing extension pack '%s' failed under mysterious circumstances"),
2968	pStrName->c_str());
2969	}
2970	else
2971	{
2972	ErrorInfoKeeper Eik;
2973	i_refreshExtPack(pStrName->c_str(), false /a_fUnusableIsError/, NULL);
2974	}
2975	}
2976
2977	/*
2978	* Do VirtualBoxReady callbacks now for any freshly installed
2979	* extension pack (old ones will not be called).
2980	*/
2981	if (m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON)
2982	{
2983	autoLock.release();
2984	i_callAllVirtualBoxReadyHooks();
2985	}
2986	}
2987
2988	return hrc;
2989	}
2990
2991	/**
2992	* Worker for IExtPackManager::Uninstall.
2993	*
2994	* Called on a worker thread via doUninstallThreadProc.
2995	*
2996	* @returns COM status code.
2997	* @param a_pstrName The name of the extension pack to uninstall.
2998	* @param a_fForcedRemoval Whether to be skip and ignore certain bits of
2999	* the extpack feedback. To deal with misbehaving
3000	* extension pack hooks.
3001	* @param a_pstrDisplayInfo Host specific display information hacks.
3002	*/
3003	HRESULT ExtPackManager::i_doUninstall(Utf8Str const a_pstrName, bool a_fForcedRemoval, Utf8Str const a_pstrDisplayInfo)
3004	{
3005	Assert(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON);
3006
3007	AutoCaller autoCaller(this);
3008	HRESULT hrc = autoCaller.rc();
3009	if (SUCCEEDED(hrc))
3010	{
3011	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3012
3013	/*
3014	* Refresh the data we have on the extension pack as it
3015	* may be made stale by direct meddling or some other user.
3016	*/
3017	ExtPack *pExtPack;
3018	hrc = i_refreshExtPack(a_pstrName->c_str(), false /a_fUnusableIsError/, &pExtPack);
3019	if (SUCCEEDED(hrc) && pExtPack)
3020	{
3021	/* We must leave the lock when calling i_areThereAnyRunningVMs,
3022	which means we have to redo the refresh call afterwards. */
3023	autoLock.release();
3024	bool fRunningVMs = i_areThereAnyRunningVMs();
3025	bool fVetoingCP = pExtPack->i_areThereCloudProviderUninstallVetos();
3026	autoLock.acquire();
3027	if (a_fForcedRemoval \|\| (!fRunningVMs && !fVetoingCP))
3028	{
3029	hrc = i_refreshExtPack(a_pstrName->c_str(), false /a_fUnusableIsError/, &pExtPack);
3030	if (SUCCEEDED(hrc))
3031	{
3032	if (!pExtPack)
3033	{
3034	LogRel(("ExtPackManager: Extension pack '%s' is not installed, so nothing to uninstall.\n", a_pstrName->c_str()));
3035	hrc = S_OK; /* nothing to uninstall */
3036	}
3037	else
3038	{
3039	/*
3040	* Call the uninstall hook and unload the main dll.
3041	*/
3042	hrc = pExtPack->i_callUninstallHookAndClose(m->pVirtualBox, a_fForcedRemoval);
3043	if (SUCCEEDED(hrc))
3044	{
3045	/*
3046	* Run the set-uid-to-root binary that performs the
3047	* uninstallation. Then refresh the object.
3048	*
3049	* This refresh is theorically subject to races, but it's of
3050	* the don't-do-that variety.
3051	*/
3052	const char *pszForcedOpt = a_fForcedRemoval ? "--forced" : NULL;
3053	hrc = i_runSetUidToRootHelper(a_pstrDisplayInfo,
3054	"uninstall",
3055	"--base-dir", m->strBaseDir.c_str(),
3056	"--name", a_pstrName->c_str(),
3057	pszForcedOpt, /* Last as it may be NULL. */
3058	(const char *)NULL);
3059	if (SUCCEEDED(hrc))
3060	{
3061	hrc = i_refreshExtPack(a_pstrName->c_str(), false /a_fUnusableIsError/, &pExtPack);
3062	if (SUCCEEDED(hrc))
3063	{
3064	if (!pExtPack)
3065	LogRel(("ExtPackManager: Successfully uninstalled extension pack '%s'.\n", a_pstrName->c_str()));
3066	else
3067	hrc = setError(E_FAIL,
3068	tr("Uninstall extension pack '%s' failed under mysterious circumstances"),
3069	a_pstrName->c_str());
3070	}
3071	}
3072	else
3073	{
3074	ErrorInfoKeeper Eik;
3075	i_refreshExtPack(a_pstrName->c_str(), false /a_fUnusableIsError/, NULL);
3076	}
3077	}
3078	}
3079	}
3080	}
3081	else
3082	{
3083	if (fRunningVMs)
3084	{
3085	LogRel(("Uninstall extension pack '%s' failed because at least one VM is still running.", a_pstrName->c_str()));
3086	hrc = setError(E_FAIL, tr("Uninstall extension pack '%s' failed because at least one VM is still running"),
3087	a_pstrName->c_str());
3088	}
3089	else if (fVetoingCP)
3090	{
3091	LogRel(("Uninstall extension pack '%s' failed because at least one Cloud Provider is still busy.", a_pstrName->c_str()));
3092	hrc = setError(E_FAIL, tr("Uninstall extension pack '%s' failed because at least one Cloud Provider is still busy"),
3093	a_pstrName->c_str());
3094	}
3095	else
3096	{
3097	LogRel(("Uninstall extension pack '%s' failed for an unknown reason.", a_pstrName->c_str()));
3098	hrc = setError(E_FAIL, tr("Uninstall extension pack '%s' failed for an unknown reason"),
3099	a_pstrName->c_str());
3100
3101	}
3102	}
3103	}
3104
3105	/*
3106	* Do VirtualBoxReady callbacks now for any freshly installed
3107	* extension pack (old ones will not be called).
3108	*/
3109	if (m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON)
3110	{
3111	autoLock.release();
3112	i_callAllVirtualBoxReadyHooks();
3113	}
3114	}
3115
3116	return hrc;
3117	}
3118
3119
3120	/**
3121	* Calls the pfnVirtualBoxReady hook for all working extension packs.
3122	*
3123	* @remarks The caller must not hold any locks.
3124	*/
3125	void ExtPackManager::i_callAllVirtualBoxReadyHooks(void)
3126	{
3127	AutoCaller autoCaller(this);
3128	HRESULT hrc = autoCaller.rc();
3129	if (FAILED(hrc))
3130	return;
3131	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3132	ComPtr<ExtPackManager> ptrSelfRef = this;
3133
3134	for (ExtPackList::iterator it = m->llInstalledExtPacks.begin();
3135	it != m->llInstalledExtPacks.end();
3136	/* advancing below */)
3137	{
3138	if ((*it)->i_callVirtualBoxReadyHook(m->pVirtualBox, &autoLock))
3139	it = m->llInstalledExtPacks.begin();
3140	else
3141	++it;
3142	}
3143	}
3144
3145
3146	/**
3147	* Queries objects of type @a aObjUuid from all the extension packs.
3148	*
3149	* @returns COM status code.
3150	* @param aObjUuid The UUID of the kind of objects we're querying.
3151	* @param aObjects Where to return the objects.
3152	* @param a_pstrExtPackNames Where to return the corresponding extpack names (may be NULL).
3153	*
3154	* @remarks The caller must not hold any locks.
3155	*/
3156	HRESULT ExtPackManager::i_queryObjects(const com::Utf8Str &aObjUuid, std::vector<ComPtr<IUnknown> > &aObjects, std::vector<com::Utf8Str> *a_pstrExtPackNames)
3157	{
3158	aObjects.clear();
3159	if (a_pstrExtPackNames)
3160	a_pstrExtPackNames->clear();
3161
3162	AutoCaller autoCaller(this);
3163	HRESULT hrc = autoCaller.rc();
3164	if (SUCCEEDED(hrc))
3165	{
3166	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3167	ComPtr<ExtPackManager> ptrSelfRef = this;
3168
3169	for (ExtPackList::iterator it = m->llInstalledExtPacks.begin();
3170	it != m->llInstalledExtPacks.end();
3171	++it)
3172	{
3173	ComPtr<IUnknown> ptrIf;
3174	HRESULT hrc2 = (*it)->queryObject(aObjUuid, ptrIf);
3175	if (SUCCEEDED(hrc2))
3176	{
3177	aObjects.push_back(ptrIf);
3178	if (a_pstrExtPackNames)
3179	a_pstrExtPackNames->push_back((*it)->m->Desc.strName);
3180	}
3181	else if (hrc2 != E_NOINTERFACE)
3182	hrc = hrc2;
3183	}
3184
3185	if (aObjects.size() > 0)
3186	hrc = S_OK;
3187	}
3188	return hrc;
3189	}
3190
3191	#endif /* !VBOX_COM_INPROC */
3192
3193	#ifdef VBOX_COM_INPROC
3194	/**
3195	* Calls the pfnConsoleReady hook for all working extension packs.
3196	*
3197	* @param a_pConsole The console interface.
3198	* @remarks The caller must not hold any locks.
3199	*/
3200	void ExtPackManager::i_callAllConsoleReadyHooks(IConsole *a_pConsole)
3201	{
3202	AutoCaller autoCaller(this);
3203	HRESULT hrc = autoCaller.rc();
3204	if (FAILED(hrc))
3205	return;
3206	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3207	ComPtr<ExtPackManager> ptrSelfRef = this;
3208
3209	for (ExtPackList::iterator it = m->llInstalledExtPacks.begin();
3210	it != m->llInstalledExtPacks.end();
3211	/* advancing below */)
3212	{
3213	if ((*it)->i_callConsoleReadyHook(a_pConsole, &autoLock))
3214	it = m->llInstalledExtPacks.begin();
3215	else
3216	++it;
3217	}
3218	}
3219	#endif
3220
3221	#ifndef VBOX_COM_INPROC
3222	/**
3223	* Calls the pfnVMCreated hook for all working extension packs.
3224	*
3225	* @param a_pMachine The machine interface of the new VM.
3226	*/
3227	void ExtPackManager::i_callAllVmCreatedHooks(IMachine *a_pMachine)
3228	{
3229	AutoCaller autoCaller(this);
3230	HRESULT hrc = autoCaller.rc();
3231	if (FAILED(hrc))
3232	return;
3233	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3234	ComPtr<ExtPackManager> ptrSelfRef = this; /* paranoia */
3235	ExtPackList llExtPacks = m->llInstalledExtPacks;
3236
3237	for (ExtPackList::iterator it = llExtPacks.begin(); it != llExtPacks.end(); ++it)
3238	(*it)->i_callVmCreatedHook(m->pVirtualBox, a_pMachine, &autoLock);
3239	}
3240	#endif
3241
3242	#ifdef VBOX_COM_INPROC
3243	/**
3244	* Calls the pfnVMConfigureVMM hook for all working extension packs.
3245	*
3246	* @returns VBox status code. Stops on the first failure, expecting the caller
3247	* to signal this to the caller of the CFGM constructor.
3248	* @param a_pConsole The console interface for the VM.
3249	* @param a_pVM The VM handle.
3250	*/
3251	int ExtPackManager::i_callAllVmConfigureVmmHooks(IConsole *a_pConsole, PVM a_pVM)
3252	{
3253	AutoCaller autoCaller(this);
3254	HRESULT hrc = autoCaller.rc();
3255	if (FAILED(hrc))
3256	return Global::vboxStatusCodeFromCOM(hrc);
3257	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3258	ComPtr<ExtPackManager> ptrSelfRef = this; /* paranoia */
3259	ExtPackList llExtPacks = m->llInstalledExtPacks;
3260
3261	for (ExtPackList::iterator it = llExtPacks.begin(); it != llExtPacks.end(); ++it)
3262	{
3263	int vrc;
3264	(*it)->i_callVmConfigureVmmHook(a_pConsole, a_pVM, &autoLock, &vrc);
3265	if (RT_FAILURE(vrc))
3266	return vrc;
3267	}
3268
3269	return VINF_SUCCESS;
3270	}
3271
3272	/**
3273	* Calls the pfnVMPowerOn hook for all working extension packs.
3274	*
3275	* @returns VBox status code. Stops on the first failure, expecting the caller
3276	* to not power on the VM.
3277	* @param a_pConsole The console interface for the VM.
3278	* @param a_pVM The VM handle.
3279	*/
3280	int ExtPackManager::i_callAllVmPowerOnHooks(IConsole *a_pConsole, PVM a_pVM)
3281	{
3282	AutoCaller autoCaller(this);
3283	HRESULT hrc = autoCaller.rc();
3284	if (FAILED(hrc))
3285	return Global::vboxStatusCodeFromCOM(hrc);
3286	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3287	ComPtr<ExtPackManager> ptrSelfRef = this; /* paranoia */
3288	ExtPackList llExtPacks = m->llInstalledExtPacks;
3289
3290	for (ExtPackList::iterator it = llExtPacks.begin(); it != llExtPacks.end(); ++it)
3291	{
3292	int vrc;
3293	(*it)->i_callVmPowerOnHook(a_pConsole, a_pVM, &autoLock, &vrc);
3294	if (RT_FAILURE(vrc))
3295	return vrc;
3296	}
3297
3298	return VINF_SUCCESS;
3299	}
3300
3301	/**
3302	* Calls the pfnVMPowerOff hook for all working extension packs.
3303	*
3304	* @param a_pConsole The console interface for the VM.
3305	* @param a_pVM The VM handle. Can be NULL.
3306	*/
3307	void ExtPackManager::i_callAllVmPowerOffHooks(IConsole *a_pConsole, PVM a_pVM)
3308	{
3309	AutoCaller autoCaller(this);
3310	HRESULT hrc = autoCaller.rc();
3311	if (FAILED(hrc))
3312	return;
3313	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3314	ComPtr<ExtPackManager> ptrSelfRef = this; /* paranoia */
3315	ExtPackList llExtPacks = m->llInstalledExtPacks;
3316
3317	for (ExtPackList::iterator it = llExtPacks.begin(); it != llExtPacks.end(); ++it)
3318	(*it)->i_callVmPowerOffHook(a_pConsole, a_pVM, &autoLock);
3319	}
3320	#endif
3321
3322
3323	/**
3324	* Checks that the specified extension pack contains a VRDE module and that it
3325	* is shipshape.
3326	*
3327	* @returns S_OK if ok, appropriate failure status code with details.
3328	* @param a_pstrExtPack The name of the extension pack.
3329	*/
3330	HRESULT ExtPackManager::i_checkVrdeExtPack(Utf8Str const *a_pstrExtPack)
3331	{
3332	AutoCaller autoCaller(this);
3333	HRESULT hrc = autoCaller.rc();
3334	if (SUCCEEDED(hrc))
3335	{
3336	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3337
3338	ExtPack *pExtPack = i_findExtPack(a_pstrExtPack->c_str());
3339	if (pExtPack)
3340	hrc = pExtPack->i_checkVrde();
3341	else
3342	hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("No extension pack by the name '%s' was found"), a_pstrExtPack->c_str());
3343	}
3344
3345	return hrc;
3346	}
3347
3348	/**
3349	* Gets the full path to the VRDE library of the specified extension pack.
3350	*
3351	* This will do extacly the same as checkVrdeExtPack and then resolve the
3352	* library path.
3353	*
3354	* @returns S_OK if a path is returned, COM error status and message return if
3355	* not.
3356	* @param a_pstrExtPack The extension pack.
3357	* @param a_pstrVrdeLibrary Where to return the path.
3358	*/
3359	int ExtPackManager::i_getVrdeLibraryPathForExtPack(Utf8Str const a_pstrExtPack, Utf8Str a_pstrVrdeLibrary)
3360	{
3361	AutoCaller autoCaller(this);
3362	HRESULT hrc = autoCaller.rc();
3363	if (SUCCEEDED(hrc))
3364	{
3365	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3366
3367	ExtPack *pExtPack = i_findExtPack(a_pstrExtPack->c_str());
3368	if (pExtPack)
3369	hrc = pExtPack->i_getVrdpLibraryName(a_pstrVrdeLibrary);
3370	else
3371	hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("No extension pack by the name '%s' was found"),
3372	a_pstrExtPack->c_str());
3373	}
3374
3375	return hrc;
3376	}
3377
3378	/**
3379	* Gets the full path to the specified library of the specified extension pack.
3380	*
3381	* @returns S_OK if a path is returned, COM error status and message return if
3382	* not.
3383	* @param a_pszModuleName The library.
3384	* @param a_pszExtPack The extension pack.
3385	* @param a_pstrLibrary Where to return the path.
3386	*/
3387	HRESULT ExtPackManager::i_getLibraryPathForExtPack(const char a_pszModuleName, const char a_pszExtPack, Utf8Str *a_pstrLibrary)
3388	{
3389	AutoCaller autoCaller(this);
3390	HRESULT hrc = autoCaller.rc();
3391	if (SUCCEEDED(hrc))
3392	{
3393	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3394
3395	ExtPack *pExtPack = i_findExtPack(a_pszExtPack);
3396	if (pExtPack)
3397	hrc = pExtPack->i_getLibraryName(a_pszModuleName, a_pstrLibrary);
3398	else
3399	hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("No extension pack by the name '%s' was found"), a_pszExtPack);
3400	}
3401
3402	return hrc;
3403	}
3404
3405	/**
3406	* Gets the name of the default VRDE extension pack.
3407	*
3408	* @returns S_OK or some COM error status on red tape failure.
3409	* @param a_pstrExtPack Where to return the extension pack name. Returns
3410	* empty if no extension pack wishes to be the default
3411	* VRDP provider.
3412	*/
3413	HRESULT ExtPackManager::i_getDefaultVrdeExtPack(Utf8Str *a_pstrExtPack)
3414	{
3415	a_pstrExtPack->setNull();
3416
3417	AutoCaller autoCaller(this);
3418	HRESULT hrc = autoCaller.rc();
3419	if (SUCCEEDED(hrc))
3420	{
3421	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3422
3423	for (ExtPackList::iterator it = m->llInstalledExtPacks.begin();
3424	it != m->llInstalledExtPacks.end();
3425	++it)
3426	{
3427	if ((*it)->i_wantsToBeDefaultVrde())
3428	{
3429	a_pstrExtPack = (it)->m->Desc.strName;
3430	break;
3431	}
3432	}
3433	}
3434	return hrc;
3435	}
3436
3437	/**
3438	* Checks if an extension pack is (present and) usable.
3439	*
3440	* @returns @c true if it is, otherwise @c false.
3441	* @param a_pszExtPack The name of the extension pack.
3442	*/
3443	bool ExtPackManager::i_isExtPackUsable(const char *a_pszExtPack)
3444	{
3445	AutoCaller autoCaller(this);
3446	HRESULT hrc = autoCaller.rc();
3447	if (FAILED(hrc))
3448	return false;
3449	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3450
3451	ExtPack *pExtPack = i_findExtPack(a_pszExtPack);
3452	return pExtPack != NULL
3453	&& pExtPack->m->fUsable;
3454	}
3455
3456	/**
3457	* Dumps all extension packs to the release log.
3458	*/
3459	void ExtPackManager::i_dumpAllToReleaseLog(void)
3460	{
3461	AutoCaller autoCaller(this);
3462	HRESULT hrc = autoCaller.rc();
3463	if (FAILED(hrc))
3464	return;
3465	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3466
3467	LogRel(("Installed Extension Packs:\n"));
3468	for (ExtPackList::iterator it = m->llInstalledExtPacks.begin();
3469	it != m->llInstalledExtPacks.end();
3470	++it)
3471	{
3472	ExtPack::Data pExtPackData = (it)->m;
3473	if (pExtPackData)
3474	{
3475	if (pExtPackData->fUsable)
3476	LogRel((" %s (Version: %s r%u%s%s; VRDE Module: %s)\n",
3477	pExtPackData->Desc.strName.c_str(),
3478	pExtPackData->Desc.strVersion.c_str(),
3479	pExtPackData->Desc.uRevision,
3480	pExtPackData->Desc.strEdition.isEmpty() ? "" : " ",
3481	pExtPackData->Desc.strEdition.c_str(),
3482	pExtPackData->Desc.strVrdeModule.c_str() ));
3483	else
3484	LogRel((" %s (Version: %s r%u%s%s; VRDE Module: %s unusable because of '%s')\n",
3485	pExtPackData->Desc.strName.c_str(),
3486	pExtPackData->Desc.strVersion.c_str(),
3487	pExtPackData->Desc.uRevision,
3488	pExtPackData->Desc.strEdition.isEmpty() ? "" : " ",
3489	pExtPackData->Desc.strEdition.c_str(),
3490	pExtPackData->Desc.strVrdeModule.c_str(),
3491	pExtPackData->strWhyUnusable.c_str() ));
3492	}
3493	else
3494	LogRel((" pExtPackData is NULL\n"));
3495	}
3496
3497	if (!m->llInstalledExtPacks.size())
3498	LogRel((" None installed!\n"));
3499	}
3500
3501	/**
3502	* Gets the update counter (reflecting extpack list updates).
3503	*/
3504	uint64_t ExtPackManager::i_getUpdateCounter(void)
3505	{
3506	AutoCaller autoCaller(this);
3507	HRESULT hrc = autoCaller.rc();
3508	if (FAILED(hrc))
3509	return 0;
3510	AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
3511	return m->cUpdate;
3512	}
3513
3514	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

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

source: vbox/trunk/src/VBox/Main/src-all/ExtPackManagerImpl.cpp@ 75663

Download in other formats: