ApplianceImpl.h@ 72919

最後變更在這個檔案從72919是 72902,由 vboxsync 提交於 7 年前
Appliance::i_URIFromTypeOfVirtualDiskFormat: is unused
屬性 svn:eol-style 設為 `native` 屬性 svn:keywords 設為 `Author Date Id Revision`
檔案大小: 13.0 KB

行
1	/* $Id: ApplianceImpl.h 72902 2018-07-04 19:46:14Z vboxsync $ */
2	/** @file
3	* VirtualBox COM class implementation
4	*/
5
6	/*
7	* Copyright (C) 2006-2017 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.alldomusa.eu.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#ifndef ____H_APPLIANCEIMPL
19	#define ____H_APPLIANCEIMPL
20
21	/* VBox includes */
22	#include "VirtualSystemDescriptionWrap.h"
23	#include "ApplianceWrap.h"
24	#include "MediumFormatImpl.h"
25
26	/* Todo: This file needs massive cleanup. Split IAppliance in a public and
27	* private classes. */
28	#include <iprt/tar.h>
29	#include "ovfreader.h"
30	#include <set>
31
32	/* VBox forward declarations */
33	class Certificate;
34	class Progress;
35	class VirtualSystemDescription;
36	struct VirtualSystemDescriptionEntry;
37	struct LocationInfo;
38	typedef struct VDINTERFACE *PVDINTERFACE;
39	typedef struct VDINTERFACEIO *PVDINTERFACEIO;
40	typedef struct SHASTORAGE *PSHASTORAGE;
41
42	namespace ovf
43	{
44	struct HardDiskController;
45	struct VirtualSystem;
46	class OVFReader;
47	struct DiskImage;
48	struct EnvelopeData;
49	}
50
51	namespace xml
52	{
53	class Document;
54	class ElementNode;
55	}
56
57	namespace settings
58	{
59	class MachineConfigFile;
60	}
61
62	class ATL_NO_VTABLE Appliance :
63	public ApplianceWrap
64	{
65	public:
66
67	DECLARE_EMPTY_CTOR_DTOR(Appliance)
68
69	HRESULT FinalConstruct();
70	void FinalRelease();
71
72
73	HRESULT init(VirtualBox *aVirtualBox);
74	void uninit();
75
76	/* public methods only for internal purposes */
77
78	static HRESULT i_setErrorStatic(HRESULT aResultCode,
79	const Utf8Str &aText)
80	{
81	return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
82	}
83
84	/* private instance data */
85	private:
86	// wrapped IAppliance properties
87	HRESULT getPath(com::Utf8Str &aPath);
88	HRESULT getDisks(std::vector<com::Utf8Str> &aDisks);
89	HRESULT getCertificate(ComPtr<ICertificate> &aCertificateInfo);
90	HRESULT getVirtualSystemDescriptions(std::vector<ComPtr<IVirtualSystemDescription> > &aVirtualSystemDescriptions);
91	HRESULT getMachines(std::vector<com::Utf8Str> &aMachines);
92
93	// wrapped IAppliance methods
94	HRESULT read(const com::Utf8Str &aFile,
95	ComPtr<IProgress> &aProgress);
96	HRESULT interpret();
97	HRESULT importMachines(const std::vector<ImportOptions_T> &aOptions,
98	ComPtr<IProgress> &aProgress);
99	HRESULT createVFSExplorer(const com::Utf8Str &aURI,
100	ComPtr<IVFSExplorer> &aExplorer);
101	HRESULT write(const com::Utf8Str &aFormat,
102	const std::vector<ExportOptions_T> &aOptions,
103	const com::Utf8Str &aPath,
104	ComPtr<IProgress> &aProgress);
105	HRESULT getWarnings(std::vector<com::Utf8Str> &aWarnings);
106	HRESULT getPasswordIds(std::vector<com::Utf8Str> &aIdentifiers);
107	HRESULT getMediumIdsForPasswordId(const com::Utf8Str &aPasswordId, std::vector<com::Guid> &aIdentifiers);
108	HRESULT addPasswords(const std::vector<com::Utf8Str> &aIdentifiers,
109	const std::vector<com::Utf8Str> &aPasswords);
110
111	/** weak VirtualBox parent */
112	VirtualBox* const mVirtualBox;
113
114	struct ImportStack;
115	class TaskOVF;
116	struct Data; // opaque, defined in ApplianceImpl.cpp
117	Data *m;
118
119	enum SetUpProgressMode { ImportFile, ImportS3, WriteFile, WriteS3 };
120
121	/** @name General stuff
122	* @{
123	*/
124	bool i_isApplianceIdle();
125	HRESULT i_searchUniqueVMName(Utf8Str& aName) const;
126	HRESULT i_searchUniqueDiskImageFilePath(const Utf8Str &aMachineFolder, Utf8Str &aName) const;
127	HRESULT i_setUpProgress(ComObjPtr<Progress> &pProgress,
128	const Utf8Str &strDescription,
129	SetUpProgressMode mode);
130	void i_waitForAsyncProgress(ComObjPtr<Progress> &pProgressThis, ComPtr<IProgress> &pProgressAsync);
131	void i_addWarning(const char* aWarning, ...);
132	void i_disksWeight();
133	void i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket);
134
135	static void i_importOrExportThreadTask(TaskOVF *pTask);
136
137	HRESULT i_initBackendNames();
138
139	Utf8Str i_typeOfVirtualDiskFormatFromURI(Utf8Str type) const;
140
141	#if 0 /* unused */
142	std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
143	#endif
144
145	HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
146
147	RTVFSIOSTREAM i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
148	bool fRead = true);
149	/** @} */
150
151	/** @name Read stuff
152	* @{
153	*/
154	void i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
155
156	HRESULT i_readFS(TaskOVF *pTask);
157	HRESULT i_readFSOVF(TaskOVF *pTask);
158	HRESULT i_readFSOVA(TaskOVF *pTask);
159	HRESULT i_readOVFFile(TaskOVF pTask, RTVFSIOSTREAM hIosOvf, const char pszManifestEntry);
160	HRESULT i_readManifestFile(TaskOVF pTask, RTVFSIOSTREAM hIosMf, const char pszSubFileNm);
161	HRESULT i_readSignatureFile(TaskOVF pTask, RTVFSIOSTREAM hIosCert, const char pszSubFileNm);
162	HRESULT i_readTailProcessing(TaskOVF *pTask);
163	/** @} */
164
165	/** @name Import stuff
166	* @}
167	*/
168	HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
169
170	HRESULT i_importFS(TaskOVF *pTask);
171	HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
172	HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
173	HRESULT i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva = NIL_RTVFSFSSTREAM);
174
175	HRESULT i_verifyManifestFile(ImportStack &stack);
176
177	void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
178	uint32_t ulAddressOnParent,
179	Utf8Str &controllerName,
180	int32_t &lControllerPort,
181	int32_t &lDevice);
182
183	void i_importOneDiskImage(const ovf::DiskImage &di,
184	const Utf8Str &strDstPath,
185	ComObjPtr<Medium> &pTargetHD,
186	ImportStack &stack);
187
188	void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
189	ComObjPtr<VirtualSystemDescription> &vsdescThis,
190	ComPtr<IMachine> &pNewMachine,
191	ImportStack &stack);
192	void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
193	ComPtr<IMachine> &pNewMachine,
194	ImportStack &stack);
195	void i_importMachines(ImportStack &stack);
196
197	HRESULT i_preCheckImageAvailability(ImportStack &stack);
198	bool i_importEnsureOvaLookAhead(ImportStack &stack);
199	RTVFSIOSTREAM i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry);
200	HRESULT i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath,
201	RTVFSIOSTREAM hVfsIosSrc, Utf8Str const &rstrSrcLogNm);
202
203	void i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
204	const char *pszManifestEntry);
205	void i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
206	const char *pszManifestEntry);
207	/** @} */
208
209	/** @name Write stuff
210	* @{
211	*/
212	HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
213
214	HRESULT i_writeFS(TaskOVF *pTask);
215	HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
216	HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
217	HRESULT i_writeFSOPC(TaskOVF *pTask, AutoWriteLockBase& writeLock);
218	HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase &writeLock, RTVFSFSSTREAM hVfsFssDst);
219	HRESULT i_writeBufferToFile(RTVFSFSSTREAM hVfsFssDst, const char pszFilename, const void pvContent, size_t cbContent);
220
221	struct XMLStack;
222
223	void i_buildXML(AutoWriteLockBase& writeLock,
224	xml::Document &doc,
225	XMLStack &stack,
226	const Utf8Str &strPath,
227	ovf::OVFVersion_T enFormat);
228	void i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
229	xml::ElementNode &elmToAddVirtualSystemsTo,
230	std::list<xml::ElementNode> pllElementsWithUuidAttributes,
231	ComObjPtr<VirtualSystemDescription> &vsdescThis,
232	ovf::OVFVersion_T enFormat,
233	XMLStack &stack);
234	/** @} */
235
236	friend class Machine;
237	friend class Certificate;
238	};
239
240	void i_parseURI(Utf8Str strUri, LocationInfo &locInfo);
241
242	struct VirtualSystemDescriptionEntry
243	{
244	uint32_t ulIndex; ///< zero-based index of this entry within array
245	VirtualSystemDescriptionType_T type; ///< type of this entry
246	Utf8Str strRef; ///< reference number (hard disk controllers only)
247	Utf8Str strOvf; ///< original OVF value (type-dependent)
248	Utf8Str strVBoxSuggested; ///< configuration value (type-dependent); original value suggested by interpret()
249	Utf8Str strVBoxCurrent; ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
250	Utf8Str strExtraConfigSuggested; ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
251	Utf8Str strExtraConfigCurrent; ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
252
253	uint32_t ulSizeMB; ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
254	bool skipIt; ///< used during export to skip some parts if it's needed
255	};
256
257	class ATL_NO_VTABLE VirtualSystemDescription :
258	public VirtualSystemDescriptionWrap
259	{
260	friend class Appliance;
261
262	public:
263
264	DECLARE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
265
266	HRESULT FinalConstruct();
267	void FinalRelease();
268
269	HRESULT init();
270	void uninit();
271
272	/* public methods only for internal purposes */
273	void i_addEntry(VirtualSystemDescriptionType_T aType,
274	const Utf8Str &strRef,
275	const Utf8Str &aOvfValue,
276	const Utf8Str &aVBoxValue,
277	uint32_t ulSizeMB = 0,
278	const Utf8Str &strExtraConfig = "");
279
280	std::list<VirtualSystemDescriptionEntry*> i_findByType(VirtualSystemDescriptionType_T aType);
281	const VirtualSystemDescriptionEntry* i_findControllerFromID(uint32_t id);
282
283	void i_importVBoxMachineXML(const xml::ElementNode &elmMachine);
284	const settings::MachineConfigFile* i_getMachineConfig() const;
285
286	/* private instance data */
287	private:
288
289	// wrapped IVirtualSystemDescription properties
290	HRESULT getCount(ULONG *aCount);
291
292	// wrapped IVirtualSystemDescription methods
293	HRESULT getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
294	std::vector<com::Utf8Str> &aRefs,
295	std::vector<com::Utf8Str> &aOVFValues,
296	std::vector<com::Utf8Str> &aVBoxValues,
297	std::vector<com::Utf8Str> &aExtraConfigValues);
298	HRESULT getDescriptionByType(VirtualSystemDescriptionType_T aType,
299	std::vector<VirtualSystemDescriptionType_T> &aTypes,
300	std::vector<com::Utf8Str> &aRefs,
301	std::vector<com::Utf8Str> &aOVFValues,
302	std::vector<com::Utf8Str> &aVBoxValues,
303	std::vector<com::Utf8Str> &aExtraConfigValues);
304	HRESULT getValuesByType(VirtualSystemDescriptionType_T aType,
305	VirtualSystemDescriptionValueType_T aWhich,
306	std::vector<com::Utf8Str> &aValues);
307	HRESULT setFinalValues(const std::vector<BOOL> &aEnabled,
308	const std::vector<com::Utf8Str> &aVBoxValues,
309	const std::vector<com::Utf8Str> &aExtraConfigValues);
310	HRESULT addDescription(VirtualSystemDescriptionType_T aType,
311	const com::Utf8Str &aVBoxValue,
312	const com::Utf8Str &aExtraConfigValue);
313	void i_removeByType(VirtualSystemDescriptionType_T aType);
314
315	struct Data;
316	Data *m;
317
318	friend class Machine;
319	};
320
321	#endif // !____H_APPLIANCEIMPL
322	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

source: vbox/trunk/src/VBox/Main/include/ApplianceImpl.h@ 72919

以其他格式下載: