VirtualBox

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

Last change on this file since 73133 was 73133, checked in by vboxsync, 6 years ago

Main/Appliance: fix header file parameter name inconsistency
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.1 KB
Line 
1/* $Id: ApplianceImpl.h 73133 2018-07-13 18:32: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.virtualbox.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 */
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_searchUniqueImageFilePath(const Utf8Str &aMachineFolder,
127 DeviceType_T aDeviceType,
128 Utf8Str &aName) const;
129 HRESULT i_setUpProgress(ComObjPtr<Progress> &pProgress,
130 const Utf8Str &strDescription,
131 SetUpProgressMode mode);
132 void i_waitForAsyncProgress(ComObjPtr<Progress> &pProgressThis, ComPtr<IProgress> &pProgressAsync);
133 void i_addWarning(const char* aWarning, ...);
134 void i_disksWeight();
135 void i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket);
136
137 static void i_importOrExportThreadTask(TaskOVF *pTask);
138
139 HRESULT i_initBackendNames();
140
141 Utf8Str i_typeOfVirtualDiskFormatFromURI(Utf8Str type) const;
142
143#if 0 /* unused */
144 std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
145#endif
146
147 HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
148
149 RTVFSIOSTREAM i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
150 bool fRead = true);
151 /** @} */
152
153 /** @name Read stuff
154 * @{
155 */
156 void i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
157
158 HRESULT i_readFS(TaskOVF *pTask);
159 HRESULT i_readFSOVF(TaskOVF *pTask);
160 HRESULT i_readFSOVA(TaskOVF *pTask);
161 HRESULT i_readOVFFile(TaskOVF *pTask, RTVFSIOSTREAM hIosOvf, const char *pszManifestEntry);
162 HRESULT i_readManifestFile(TaskOVF *pTask, RTVFSIOSTREAM hIosMf, const char *pszSubFileNm);
163 HRESULT i_readSignatureFile(TaskOVF *pTask, RTVFSIOSTREAM hIosCert, const char *pszSubFileNm);
164 HRESULT i_readTailProcessing(TaskOVF *pTask);
165 /** @} */
166
167 /** @name Import stuff
168 * @}
169 */
170 HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
171
172 HRESULT i_importFS(TaskOVF *pTask);
173 HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
174 HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
175 HRESULT i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva = NIL_RTVFSFSSTREAM);
176
177 HRESULT i_verifyManifestFile(ImportStack &stack);
178
179 void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
180 uint32_t ulAddressOnParent,
181 Utf8Str &controllerName,
182 int32_t &lControllerPort,
183 int32_t &lDevice);
184
185 void i_importOneDiskImage(const ovf::DiskImage &di,
186 const Utf8Str &strDstPath,
187 ComObjPtr<Medium> &pTargetMedium,
188 ImportStack &stack);
189
190 void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
191 ComObjPtr<VirtualSystemDescription> &vsdescThis,
192 ComPtr<IMachine> &pNewMachine,
193 ImportStack &stack);
194 void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
195 ComPtr<IMachine> &pNewMachine,
196 ImportStack &stack);
197 void i_importMachines(ImportStack &stack);
198
199 HRESULT i_preCheckImageAvailability(ImportStack &stack);
200 bool i_importEnsureOvaLookAhead(ImportStack &stack);
201 RTVFSIOSTREAM i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry);
202 HRESULT i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath,
203 RTVFSIOSTREAM hVfsIosSrc, Utf8Str const &rstrSrcLogNm);
204
205 void i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
206 const char *pszManifestEntry);
207 void i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
208 const char *pszManifestEntry);
209 /** @} */
210
211 /** @name Write stuff
212 * @{
213 */
214 HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
215
216 HRESULT i_writeFS(TaskOVF *pTask);
217 HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
218 HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
219 HRESULT i_writeFSOPC(TaskOVF *pTask, AutoWriteLockBase& writeLock);
220 HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase &writeLock, RTVFSFSSTREAM hVfsFssDst);
221 HRESULT i_writeBufferToFile(RTVFSFSSTREAM hVfsFssDst, const char *pszFilename, const void *pvContent, size_t cbContent);
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: */
Note: See TracBrowser for help on using the repository browser.

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