VirtualBox

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

Last change on this file since 72900 was 72900, checked in by vboxsync, 7 years ago

ApplianceImpl.cpp: Replaced the supportedStandardsURI std::map by a more C-ish construct that doesn't leak memory nor introduces any race conditions during initialization and works correctly after an init failure.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.9 KB
Line 
1/* $Id: ApplianceImpl.h 72900 2018-07-04 19:42:18Z 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.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#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 */
33class Certificate;
34class Progress;
35class VirtualSystemDescription;
36struct VirtualSystemDescriptionEntry;
37struct LocationInfo;
38typedef struct VDINTERFACE *PVDINTERFACE;
39typedef struct VDINTERFACEIO *PVDINTERFACEIO;
40typedef struct SHASTORAGE *PSHASTORAGE;
41
42namespace ovf
43{
44 struct HardDiskController;
45 struct VirtualSystem;
46 class OVFReader;
47 struct DiskImage;
48 struct EnvelopeData;
49}
50
51namespace xml
52{
53 class Document;
54 class ElementNode;
55}
56
57namespace settings
58{
59 class MachineConfigFile;
60}
61
62class ATL_NO_VTABLE Appliance :
63 public ApplianceWrap
64{
65public:
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 */
85private:
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 std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
142
143 HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
144
145 RTVFSIOSTREAM i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
146 bool fRead = true);
147 /** @} */
148
149 /** @name Read stuff
150 * @{
151 */
152 void i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
153
154 HRESULT i_readFS(TaskOVF *pTask);
155 HRESULT i_readFSOVF(TaskOVF *pTask);
156 HRESULT i_readFSOVA(TaskOVF *pTask);
157 HRESULT i_readOVFFile(TaskOVF *pTask, RTVFSIOSTREAM hIosOvf, const char *pszManifestEntry);
158 HRESULT i_readManifestFile(TaskOVF *pTask, RTVFSIOSTREAM hIosMf, const char *pszSubFileNm);
159 HRESULT i_readSignatureFile(TaskOVF *pTask, RTVFSIOSTREAM hIosCert, const char *pszSubFileNm);
160 HRESULT i_readTailProcessing(TaskOVF *pTask);
161 /** @} */
162
163 /** @name Import stuff
164 * @}
165 */
166 HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
167
168 HRESULT i_importFS(TaskOVF *pTask);
169 HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
170 HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
171 HRESULT i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva = NIL_RTVFSFSSTREAM);
172
173 HRESULT i_verifyManifestFile(ImportStack &stack);
174
175 void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
176 uint32_t ulAddressOnParent,
177 Utf8Str &controllerName,
178 int32_t &lControllerPort,
179 int32_t &lDevice);
180
181 void i_importOneDiskImage(const ovf::DiskImage &di,
182 const Utf8Str &strDstPath,
183 ComObjPtr<Medium> &pTargetHD,
184 ImportStack &stack);
185
186 void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
187 ComObjPtr<VirtualSystemDescription> &vsdescThis,
188 ComPtr<IMachine> &pNewMachine,
189 ImportStack &stack);
190 void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
191 ComPtr<IMachine> &pNewMachine,
192 ImportStack &stack);
193 void i_importMachines(ImportStack &stack);
194
195 HRESULT i_preCheckImageAvailability(ImportStack &stack);
196 bool i_importEnsureOvaLookAhead(ImportStack &stack);
197 RTVFSIOSTREAM i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry);
198 HRESULT i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath,
199 RTVFSIOSTREAM hVfsIosSrc, Utf8Str const &rstrSrcLogNm);
200
201 void i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
202 const char *pszManifestEntry);
203 void i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
204 const char *pszManifestEntry);
205 /** @} */
206
207 /** @name Write stuff
208 * @{
209 */
210 HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
211
212 HRESULT i_writeFS(TaskOVF *pTask);
213 HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
214 HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
215 HRESULT i_writeFSOPC(TaskOVF *pTask, AutoWriteLockBase& writeLock);
216 HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase &writeLock, RTVFSFSSTREAM hVfsFssDst);
217 HRESULT i_writeBufferToFile(RTVFSFSSTREAM hVfsFssDst, const char *pszFilename, const void *pvContent, size_t cbContent);
218
219 struct XMLStack;
220
221 void i_buildXML(AutoWriteLockBase& writeLock,
222 xml::Document &doc,
223 XMLStack &stack,
224 const Utf8Str &strPath,
225 ovf::OVFVersion_T enFormat);
226 void i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
227 xml::ElementNode &elmToAddVirtualSystemsTo,
228 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes,
229 ComObjPtr<VirtualSystemDescription> &vsdescThis,
230 ovf::OVFVersion_T enFormat,
231 XMLStack &stack);
232 /** @} */
233
234 friend class Machine;
235 friend class Certificate;
236};
237
238void i_parseURI(Utf8Str strUri, LocationInfo &locInfo);
239
240struct VirtualSystemDescriptionEntry
241{
242 uint32_t ulIndex; ///< zero-based index of this entry within array
243 VirtualSystemDescriptionType_T type; ///< type of this entry
244 Utf8Str strRef; ///< reference number (hard disk controllers only)
245 Utf8Str strOvf; ///< original OVF value (type-dependent)
246 Utf8Str strVBoxSuggested; ///< configuration value (type-dependent); original value suggested by interpret()
247 Utf8Str strVBoxCurrent; ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
248 Utf8Str strExtraConfigSuggested; ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
249 Utf8Str strExtraConfigCurrent; ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
250
251 uint32_t ulSizeMB; ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
252 bool skipIt; ///< used during export to skip some parts if it's needed
253};
254
255class ATL_NO_VTABLE VirtualSystemDescription :
256 public VirtualSystemDescriptionWrap
257{
258 friend class Appliance;
259
260public:
261
262 DECLARE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
263
264 HRESULT FinalConstruct();
265 void FinalRelease();
266
267 HRESULT init();
268 void uninit();
269
270 /* public methods only for internal purposes */
271 void i_addEntry(VirtualSystemDescriptionType_T aType,
272 const Utf8Str &strRef,
273 const Utf8Str &aOvfValue,
274 const Utf8Str &aVBoxValue,
275 uint32_t ulSizeMB = 0,
276 const Utf8Str &strExtraConfig = "");
277
278 std::list<VirtualSystemDescriptionEntry*> i_findByType(VirtualSystemDescriptionType_T aType);
279 const VirtualSystemDescriptionEntry* i_findControllerFromID(uint32_t id);
280
281 void i_importVBoxMachineXML(const xml::ElementNode &elmMachine);
282 const settings::MachineConfigFile* i_getMachineConfig() const;
283
284 /* private instance data */
285private:
286
287 // wrapped IVirtualSystemDescription properties
288 HRESULT getCount(ULONG *aCount);
289
290 // wrapped IVirtualSystemDescription methods
291 HRESULT getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
292 std::vector<com::Utf8Str> &aRefs,
293 std::vector<com::Utf8Str> &aOVFValues,
294 std::vector<com::Utf8Str> &aVBoxValues,
295 std::vector<com::Utf8Str> &aExtraConfigValues);
296 HRESULT getDescriptionByType(VirtualSystemDescriptionType_T aType,
297 std::vector<VirtualSystemDescriptionType_T> &aTypes,
298 std::vector<com::Utf8Str> &aRefs,
299 std::vector<com::Utf8Str> &aOVFValues,
300 std::vector<com::Utf8Str> &aVBoxValues,
301 std::vector<com::Utf8Str> &aExtraConfigValues);
302 HRESULT getValuesByType(VirtualSystemDescriptionType_T aType,
303 VirtualSystemDescriptionValueType_T aWhich,
304 std::vector<com::Utf8Str> &aValues);
305 HRESULT setFinalValues(const std::vector<BOOL> &aEnabled,
306 const std::vector<com::Utf8Str> &aVBoxValues,
307 const std::vector<com::Utf8Str> &aExtraConfigValues);
308 HRESULT addDescription(VirtualSystemDescriptionType_T aType,
309 const com::Utf8Str &aVBoxValue,
310 const com::Utf8Str &aExtraConfigValue);
311 void i_removeByType(VirtualSystemDescriptionType_T aType);
312
313 struct Data;
314 Data *m;
315
316 friend class Machine;
317};
318
319#endif // !____H_APPLIANCEIMPL
320/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

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