VirtualBox

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

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

Appliance::i_readImpl: Either throw errors or return them, don't do both. duh.
  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 13.0 KB
行 
1/* $Id: ApplianceImpl.h 59586 2016-02-04 17:41:00Z 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 Progress;
35class VirtualSystemDescription;
36struct VirtualSystemDescriptionEntry;
37struct LocationInfo;
38typedef struct VDINTERFACE *PVDINTERFACE;
39typedef struct VDINTERFACEIO *PVDINTERFACEIO;
40typedef struct SHASTORAGE *PSHASTORAGE;
41
42typedef enum applianceIOName { applianceIOTar, applianceIOFile, applianceIOSha } APPLIANCEIONAME;
43
44namespace ovf
45{
46 struct HardDiskController;
47 struct VirtualSystem;
48 class OVFReader;
49 struct DiskImage;
50 struct EnvelopeData;
51}
52
53namespace xml
54{
55 class Document;
56 class ElementNode;
57}
58
59namespace settings
60{
61 class MachineConfigFile;
62}
63
64class ATL_NO_VTABLE Appliance :
65 public ApplianceWrap
66{
67public:
68
69 DECLARE_EMPTY_CTOR_DTOR(Appliance)
70
71 HRESULT FinalConstruct();
72 void FinalRelease();
73
74
75 HRESULT init(VirtualBox *aVirtualBox);
76 void uninit();
77
78 /* public methods only for internal purposes */
79
80 static HRESULT i_setErrorStatic(HRESULT aResultCode,
81 const Utf8Str &aText)
82 {
83 return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
84 }
85
86 /* private instance data */
87private:
88 // wrapped IAppliance properties
89 HRESULT getPath(com::Utf8Str &aPath);
90 HRESULT getDisks(std::vector<com::Utf8Str> &aDisks);
91 HRESULT getVirtualSystemDescriptions(std::vector<ComPtr<IVirtualSystemDescription> > &aVirtualSystemDescriptions);
92 HRESULT getMachines(std::vector<com::Utf8Str> &aMachines);
93
94 // wrapped IAppliance methods
95 HRESULT read(const com::Utf8Str &aFile,
96 ComPtr<IProgress> &aProgress);
97 HRESULT interpret();
98 HRESULT importMachines(const std::vector<ImportOptions_T> &aOptions,
99 ComPtr<IProgress> &aProgress);
100 HRESULT createVFSExplorer(const com::Utf8Str &aURI,
101 ComPtr<IVFSExplorer> &aExplorer);
102 HRESULT write(const com::Utf8Str &aFormat,
103 const std::vector<ExportOptions_T> &aOptions,
104 const com::Utf8Str &aPath,
105 ComPtr<IProgress> &aProgress);
106 HRESULT getWarnings(std::vector<com::Utf8Str> &aWarnings);
107 HRESULT getPasswordIds(std::vector<com::Utf8Str> &aIdentifiers);
108 HRESULT getMediumIdsForPasswordId(const com::Utf8Str &aPasswordId, std::vector<com::Guid> &aIdentifiers);
109 HRESULT addPasswords(const std::vector<com::Utf8Str> &aIdentifiers,
110 const std::vector<com::Utf8Str> &aPasswords);
111
112 /** weak VirtualBox parent */
113 VirtualBox* const mVirtualBox;
114
115 struct ImportStack;
116 class TaskOVF;
117 struct Data; // opaque, defined in ApplianceImpl.cpp
118 Data *m;
119
120 enum SetUpProgressMode { ImportFile, ImportS3, WriteFile, WriteS3 };
121
122 /** @name General stuff
123 * @{
124 */
125 bool i_isApplianceIdle();
126 HRESULT i_searchUniqueVMName(Utf8Str& aName) const;
127 HRESULT i_searchUniqueDiskImageFilePath(Utf8Str& aName) const;
128 HRESULT i_setUpProgress(ComObjPtr<Progress> &pProgress,
129 const Bstr &bstrDescription,
130 SetUpProgressMode mode);
131 void i_waitForAsyncProgress(ComObjPtr<Progress> &pProgressThis, ComPtr<IProgress> &pProgressAsync);
132 void i_addWarning(const char* aWarning, ...);
133 void i_disksWeight();
134 void i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket);
135
136 static DECLCALLBACK(int) i_taskThreadImportOrExport(RTTHREAD aThread, void *pvUser);
137
138 HRESULT i_initSetOfSupportedStandardsURI();
139
140 Utf8Str i_typeOfVirtualDiskFormatFromURI(Utf8Str type) const;
141
142 std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
143
144 HRESULT i_initApplianceIONameMap();
145
146 Utf8Str i_applianceIOName(APPLIANCEIONAME type) const;
147
148 HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
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_readFSImpl(TaskOVF *pTask, const RTCString &strFilename, PVDINTERFACEIO pCallbacks, PSHASTORAGE pStorage);
160 /** @} */
161
162 /** @name Import stuff
163 * @}
164 */
165 HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
166
167 HRESULT i_importFS(TaskOVF *pTask);
168 HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
169 HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
170
171 HRESULT i_readFileToBuf(const Utf8Str &strFile,
172 void **ppvBuf,
173 size_t *pcbSize,
174 bool fCreateDigest,
175 PVDINTERFACEIO pCallbacks,
176 PSHASTORAGE pStorage);
177 HRESULT i_readTarFileToBuf(struct FSSRDONLYINTERFACEIO *pTarIo,
178 const Utf8Str &strFile,
179 void **ppvBuf,
180 size_t *pcbSize,
181 bool fCreateDigest,
182 PVDINTERFACEIO pCallbacks,
183 PSHASTORAGE pStorage);
184 HRESULT i_verifyManifestFile(const Utf8Str &strFile, ImportStack &stack,
185 RTVFSFILE hManifestVfsFile, const char *pszOvfEntry);
186
187 HRESULT i_verifyCertificateFile(void *pvBuf, size_t cbSize, PSHASTORAGE pStorage);
188
189 void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
190 uint32_t ulAddressOnParent,
191 Bstr &controllerType,
192 int32_t &lControllerPort,
193 int32_t &lDevice);
194
195 void i_importOneDiskImage(const ovf::DiskImage &di,
196 Utf8Str *strTargetPath,
197 ComObjPtr<Medium> &pTargetHD,
198 ImportStack &stack,
199 PVDINTERFACEIO pCallbacks,
200 PSHASTORAGE pStorage);
201
202 void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
203 ComObjPtr<VirtualSystemDescription> &vsdescThis,
204 ComPtr<IMachine> &pNewMachine,
205 ImportStack &stack,
206 PVDINTERFACEIO pCallbacks,
207 PSHASTORAGE pStorage);
208 void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
209 ComPtr<IMachine> &pNewMachine,
210 ImportStack &stack,
211 PVDINTERFACEIO pCallbacks,
212 PSHASTORAGE pStorage);
213 void i_importMachines(ImportStack &stack,
214 PVDINTERFACEIO pCallbacks,
215 PSHASTORAGE pStorage);
216
217 HRESULT i_preCheckImageAvailability(PSHASTORAGE pSHAStorage,
218 RTCString &availableImage);
219 /** @} */
220
221 /** @name Write stuff
222 * @{
223 */
224 HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
225
226 HRESULT i_writeFS(TaskOVF *pTask);
227 HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
228 HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
229 HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase& writeLock, PVDINTERFACEIO pCallbacks, PSHASTORAGE pStorage);
230
231 struct XMLStack;
232
233 void i_buildXML(AutoWriteLockBase& writeLock,
234 xml::Document &doc,
235 XMLStack &stack,
236 const Utf8Str &strPath,
237 ovf::OVFVersion_T enFormat);
238 void i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
239 xml::ElementNode &elmToAddVirtualSystemsTo,
240 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes,
241 ComObjPtr<VirtualSystemDescription> &vsdescThis,
242 ovf::OVFVersion_T enFormat,
243 XMLStack &stack);
244 /** @} */
245
246 friend class Machine;
247};
248
249void i_parseURI(Utf8Str strUri, LocationInfo &locInfo);
250
251struct VirtualSystemDescriptionEntry
252{
253 uint32_t ulIndex; ///< zero-based index of this entry within array
254 VirtualSystemDescriptionType_T type; ///< type of this entry
255 Utf8Str strRef; ///< reference number (hard disk controllers only)
256 Utf8Str strOvf; ///< original OVF value (type-dependent)
257 Utf8Str strVBoxSuggested; ///< configuration value (type-dependent); original value suggested by interpret()
258 Utf8Str strVBoxCurrent; ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
259 Utf8Str strExtraConfigSuggested; ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
260 Utf8Str strExtraConfigCurrent; ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
261
262 uint32_t ulSizeMB; ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
263 bool skipIt; ///< used during export to skip some parts if it's needed
264};
265
266class ATL_NO_VTABLE VirtualSystemDescription :
267 public VirtualSystemDescriptionWrap
268{
269 friend class Appliance;
270
271public:
272
273 DECLARE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
274
275 HRESULT FinalConstruct();
276 void FinalRelease();
277
278 HRESULT init();
279 void uninit();
280
281 /* public methods only for internal purposes */
282 void i_addEntry(VirtualSystemDescriptionType_T aType,
283 const Utf8Str &strRef,
284 const Utf8Str &aOvfValue,
285 const Utf8Str &aVBoxValue,
286 uint32_t ulSizeMB = 0,
287 const Utf8Str &strExtraConfig = "");
288
289 std::list<VirtualSystemDescriptionEntry*> i_findByType(VirtualSystemDescriptionType_T aType);
290 const VirtualSystemDescriptionEntry* i_findControllerFromID(uint32_t id);
291
292 void i_importVBoxMachineXML(const xml::ElementNode &elmMachine);
293 const settings::MachineConfigFile* i_getMachineConfig() const;
294
295 /* private instance data */
296private:
297
298 // wrapped IVirtualSystemDescription properties
299 HRESULT getCount(ULONG *aCount);
300
301 // wrapped IVirtualSystemDescription methods
302 HRESULT getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
303 std::vector<com::Utf8Str> &aRefs,
304 std::vector<com::Utf8Str> &aOVFValues,
305 std::vector<com::Utf8Str> &aVBoxValues,
306 std::vector<com::Utf8Str> &aExtraConfigValues);
307 HRESULT getDescriptionByType(VirtualSystemDescriptionType_T aType,
308 std::vector<VirtualSystemDescriptionType_T> &aTypes,
309 std::vector<com::Utf8Str> &aRefs,
310 std::vector<com::Utf8Str> &aOVFValues,
311 std::vector<com::Utf8Str> &aVBoxValues,
312 std::vector<com::Utf8Str> &aExtraConfigValues);
313 HRESULT getValuesByType(VirtualSystemDescriptionType_T aType,
314 VirtualSystemDescriptionValueType_T aWhich,
315 std::vector<com::Utf8Str> &aValues);
316 HRESULT setFinalValues(const std::vector<BOOL> &aEnabled,
317 const std::vector<com::Utf8Str> &aVBoxValues,
318 const std::vector<com::Utf8Str> &aExtraConfigValues);
319 HRESULT addDescription(VirtualSystemDescriptionType_T aType,
320 const com::Utf8Str &aVBoxValue,
321 const com::Utf8Str &aExtraConfigValue);
322 void i_removeByType(VirtualSystemDescriptionType_T aType);
323
324 struct Data;
325 Data *m;
326
327 friend class Machine;
328};
329
330#endif // !____H_APPLIANCEIMPL
331/* 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