VirtualBox

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

最後變更 在這個檔案從60332是 60332,由 vboxsync 提交於 9 年 前

ApplianceImpl: The what's needed to determine the trusted state of the certificate is already all there, no need of extra variables. Also: Data members shall start with 'm' unless obvious (like with 'm->xxx'). There shall be space after 'if'. A 'bool' shall under no circumstances start with a 'l' prefix.
  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 12.9 KB
行 
1/* $Id: ApplianceImpl.h 60332 2016-04-05 12:32:22Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2013 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 <VBox/settings.h>
23#include "VirtualSystemDescriptionWrap.h"
24#include "ApplianceWrap.h"
25#include "MediumFormatImpl.h"
26
27/* Todo: This file needs massive cleanup. Split IAppliance in a public and
28 * private classes. */
29#include <iprt/tar.h>
30#include "ovfreader.h"
31#include <set>
32
33/* VBox forward declarations */
34class Certificate;
35class Progress;
36class VirtualSystemDescription;
37struct VirtualSystemDescriptionEntry;
38struct LocationInfo;
39typedef struct VDINTERFACE *PVDINTERFACE;
40typedef struct VDINTERFACEIO *PVDINTERFACEIO;
41typedef struct SHASTORAGE *PSHASTORAGE;
42
43typedef enum applianceIOName { applianceIOTar, applianceIOFile, applianceIOSha } APPLIANCEIONAME;
44
45namespace ovf
46{
47 struct HardDiskController;
48 struct VirtualSystem;
49 class OVFReader;
50 struct DiskImage;
51 struct EnvelopeData;
52}
53
54namespace xml
55{
56 class Document;
57 class ElementNode;
58}
59
60namespace settings
61{
62 class MachineConfigFile;
63}
64
65class ATL_NO_VTABLE Appliance :
66 public ApplianceWrap
67{
68public:
69
70 DECLARE_EMPTY_CTOR_DTOR(Appliance)
71
72 HRESULT FinalConstruct();
73 void FinalRelease();
74
75
76 HRESULT init(VirtualBox *aVirtualBox);
77 void uninit();
78
79 /* public methods only for internal purposes */
80
81 static HRESULT i_setErrorStatic(HRESULT aResultCode,
82 const Utf8Str &aText)
83 {
84 return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
85 }
86
87 /* private instance data */
88private:
89 // wrapped IAppliance properties
90 HRESULT getPath(com::Utf8Str &aPath);
91 HRESULT getDisks(std::vector<com::Utf8Str> &aDisks);
92 HRESULT getCertificate(ComPtr<ICertificate> &aCertificateInfo);
93 HRESULT getVirtualSystemDescriptions(std::vector<ComPtr<IVirtualSystemDescription> > &aVirtualSystemDescriptions);
94 HRESULT getMachines(std::vector<com::Utf8Str> &aMachines);
95
96 // wrapped IAppliance methods
97 HRESULT read(const com::Utf8Str &aFile,
98 ComPtr<IProgress> &aProgress);
99 HRESULT interpret();
100 HRESULT importMachines(const std::vector<ImportOptions_T> &aOptions,
101 ComPtr<IProgress> &aProgress);
102 HRESULT createVFSExplorer(const com::Utf8Str &aURI,
103 ComPtr<IVFSExplorer> &aExplorer);
104 HRESULT write(const com::Utf8Str &aFormat,
105 const std::vector<ExportOptions_T> &aOptions,
106 const com::Utf8Str &aPath,
107 ComPtr<IProgress> &aProgress);
108 HRESULT getWarnings(std::vector<com::Utf8Str> &aWarnings);
109 HRESULT getPasswordIds(std::vector<com::Utf8Str> &aIdentifiers);
110 HRESULT getMediumIdsForPasswordId(const com::Utf8Str &aPasswordId, std::vector<com::Guid> &aIdentifiers);
111 HRESULT addPasswords(const std::vector<com::Utf8Str> &aIdentifiers,
112 const std::vector<com::Utf8Str> &aPasswords);
113
114 /** weak VirtualBox parent */
115 VirtualBox* const mVirtualBox;
116
117 ComObjPtr<Certificate> mptrCertificateInfo;
118 struct ImportStack;
119 class TaskOVF;
120 struct Data; // opaque, defined in ApplianceImpl.cpp
121 Data *m;
122
123 enum SetUpProgressMode { ImportFile, ImportS3, WriteFile, WriteS3 };
124
125 /** @name General stuff
126 * @{
127 */
128 bool i_isApplianceIdle();
129 HRESULT i_searchUniqueVMName(Utf8Str& aName) const;
130 HRESULT i_searchUniqueDiskImageFilePath(Utf8Str& aName) const;
131 HRESULT i_setUpProgress(ComObjPtr<Progress> &pProgress,
132 const Bstr &bstrDescription,
133 SetUpProgressMode mode);
134 void i_waitForAsyncProgress(ComObjPtr<Progress> &pProgressThis, ComPtr<IProgress> &pProgressAsync);
135 void i_addWarning(const char* aWarning, ...);
136 void i_disksWeight();
137 void i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket);
138
139 static DECLCALLBACK(int) i_taskThreadImportOrExport(RTTHREAD aThread, void *pvUser);
140
141 HRESULT i_initSetOfSupportedStandardsURI();
142
143 Utf8Str i_typeOfVirtualDiskFormatFromURI(Utf8Str type) const;
144
145 std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
146
147 HRESULT i_initApplianceIONameMap();
148
149 Utf8Str i_applianceIOName(APPLIANCEIONAME type) const;
150
151 HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
152 /** @} */
153
154 /** @name Read stuff
155 * @{
156 */
157 void i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
158
159 HRESULT i_readFS(TaskOVF *pTask);
160 HRESULT i_readFSOVF(TaskOVF *pTask);
161 HRESULT i_readFSOVA(TaskOVF *pTask);
162 HRESULT i_readOVFFile(TaskOVF *pTask, RTVFSIOSTREAM hIosOvf, const char *pszManifestEntry);
163 HRESULT i_readManifestFile(TaskOVF *pTask, RTVFSIOSTREAM hIosMf, const char *pszSubFileNm);
164 HRESULT i_readSignatureFile(TaskOVF *pTask, RTVFSIOSTREAM hIosCert, const char *pszSubFileNm);
165 HRESULT i_readTailProcessing(TaskOVF *pTask);
166 /** @} */
167
168 /** @name Import stuff
169 * @}
170 */
171 HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
172
173 HRESULT i_importFS(TaskOVF *pTask);
174 HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
175 HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
176 HRESULT i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva = NIL_RTVFSFSSTREAM);
177
178 HRESULT i_verifyManifestFile(ImportStack &stack);
179
180 void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
181 uint32_t ulAddressOnParent,
182 Bstr &controllerType,
183 int32_t &lControllerPort,
184 int32_t &lDevice);
185
186 void i_importOneDiskImage(const ovf::DiskImage &di,
187 Utf8Str *strTargetPath,
188 ComObjPtr<Medium> &pTargetHD,
189 ImportStack &stack);
190
191 void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
192 ComObjPtr<VirtualSystemDescription> &vsdescThis,
193 ComPtr<IMachine> &pNewMachine,
194 ImportStack &stack);
195 void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
196 ComPtr<IMachine> &pNewMachine,
197 ImportStack &stack);
198 void i_importMachines(ImportStack &stack);
199
200 HRESULT i_preCheckImageAvailability(ImportStack &stack);
201 bool i_importEnsureOvaLookAhead(ImportStack &stack);
202 RTVFSIOSTREAM i_importSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry);
203 RTVFSIOSTREAM i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry);
204 HRESULT i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath,
205 RTVFSIOSTREAM hVfsIosSrc, Utf8Str const &rstrSrcLogNm);
206
207 void i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
208 const char *pszManifestEntry);
209 void i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
210 const char *pszManifestEntry);
211 /** @} */
212
213 /** @name Write stuff
214 * @{
215 */
216 HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
217
218 HRESULT i_writeFS(TaskOVF *pTask);
219 HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
220 HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
221 HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase& writeLock, PVDINTERFACEIO pCallbacks, PSHASTORAGE pStorage);
222
223 struct XMLStack;
224
225 void i_buildXML(AutoWriteLockBase& writeLock,
226 xml::Document &doc,
227 XMLStack &stack,
228 const Utf8Str &strPath,
229 ovf::OVFVersion_T enFormat);
230 void i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
231 xml::ElementNode &elmToAddVirtualSystemsTo,
232 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes,
233 ComObjPtr<VirtualSystemDescription> &vsdescThis,
234 ovf::OVFVersion_T enFormat,
235 XMLStack &stack);
236 /** @} */
237
238 friend class Machine;
239 friend class Certificate;
240};
241
242void i_parseURI(Utf8Str strUri, LocationInfo &locInfo);
243
244struct VirtualSystemDescriptionEntry
245{
246 uint32_t ulIndex; ///< zero-based index of this entry within array
247 VirtualSystemDescriptionType_T type; ///< type of this entry
248 Utf8Str strRef; ///< reference number (hard disk controllers only)
249 Utf8Str strOvf; ///< original OVF value (type-dependent)
250 Utf8Str strVBoxSuggested; ///< configuration value (type-dependent); original value suggested by interpret()
251 Utf8Str strVBoxCurrent; ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
252 Utf8Str strExtraConfigSuggested; ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
253 Utf8Str strExtraConfigCurrent; ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
254
255 uint32_t ulSizeMB; ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
256 bool skipIt; ///< used during export to skip some parts if it's needed
257};
258
259class ATL_NO_VTABLE VirtualSystemDescription :
260 public VirtualSystemDescriptionWrap
261{
262 friend class Appliance;
263
264public:
265
266 DECLARE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
267
268 HRESULT FinalConstruct();
269 void FinalRelease();
270
271 HRESULT init();
272 void uninit();
273
274 /* public methods only for internal purposes */
275 void i_addEntry(VirtualSystemDescriptionType_T aType,
276 const Utf8Str &strRef,
277 const Utf8Str &aOvfValue,
278 const Utf8Str &aVBoxValue,
279 uint32_t ulSizeMB = 0,
280 const Utf8Str &strExtraConfig = "");
281
282 std::list<VirtualSystemDescriptionEntry*> i_findByType(VirtualSystemDescriptionType_T aType);
283 const VirtualSystemDescriptionEntry* i_findControllerFromID(uint32_t id);
284
285 void i_importVBoxMachineXML(const xml::ElementNode &elmMachine);
286 const settings::MachineConfigFile* i_getMachineConfig() const;
287
288 /* private instance data */
289private:
290
291 // wrapped IVirtualSystemDescription properties
292 HRESULT getCount(ULONG *aCount);
293
294 // wrapped IVirtualSystemDescription methods
295 HRESULT getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
296 std::vector<com::Utf8Str> &aRefs,
297 std::vector<com::Utf8Str> &aOVFValues,
298 std::vector<com::Utf8Str> &aVBoxValues,
299 std::vector<com::Utf8Str> &aExtraConfigValues);
300 HRESULT getDescriptionByType(VirtualSystemDescriptionType_T aType,
301 std::vector<VirtualSystemDescriptionType_T> &aTypes,
302 std::vector<com::Utf8Str> &aRefs,
303 std::vector<com::Utf8Str> &aOVFValues,
304 std::vector<com::Utf8Str> &aVBoxValues,
305 std::vector<com::Utf8Str> &aExtraConfigValues);
306 HRESULT getValuesByType(VirtualSystemDescriptionType_T aType,
307 VirtualSystemDescriptionValueType_T aWhich,
308 std::vector<com::Utf8Str> &aValues);
309 HRESULT setFinalValues(const std::vector<BOOL> &aEnabled,
310 const std::vector<com::Utf8Str> &aVBoxValues,
311 const std::vector<com::Utf8Str> &aExtraConfigValues);
312 HRESULT addDescription(VirtualSystemDescriptionType_T aType,
313 const com::Utf8Str &aVBoxValue,
314 const com::Utf8Str &aExtraConfigValue);
315 void i_removeByType(VirtualSystemDescriptionType_T aType);
316
317 struct Data;
318 Data *m;
319
320 friend class Machine;
321};
322
323#endif // !____H_APPLIANCEIMPL
324/* vi: set tabstop=4 shiftwidth=4 expandtab: */
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette