VirtualBox

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

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

Main/Appliance::i_readImpl: Fixes for regressions introduced by r130427 (bugref:130427) and cleaning up the code, getting rid of the very silly way of returning status codes by exception. Untested.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.7 KB
Line 
1/* $Id: ApplianceImpl.h 78747 2019-05-25 16:26:09Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2019 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 MAIN_INCLUDED_ApplianceImpl_h
19#define MAIN_INCLUDED_ApplianceImpl_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24/* VBox includes */
25#include "VirtualSystemDescriptionWrap.h"
26#include "ApplianceWrap.h"
27#include "MediumFormatImpl.h"
28
29/* Todo: This file needs massive cleanup. Split IAppliance in a public and
30 * private classes. */
31#include <iprt/tar.h>
32#include "ovfreader.h"
33#include <set>
34
35/* VBox forward declarations */
36class Certificate;
37class Progress;
38class VirtualSystemDescription;
39struct VirtualSystemDescriptionEntry;
40struct LocationInfo;
41typedef struct VDINTERFACE *PVDINTERFACE;
42typedef struct VDINTERFACEIO *PVDINTERFACEIO;
43typedef struct SHASTORAGE *PSHASTORAGE;
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 HRESULT createVirtualSystemDescriptions(ULONG aRequested, ULONG *aCreated);
114 /** weak VirtualBox parent */
115 VirtualBox* const mVirtualBox;
116
117 struct ImportStack;
118 class TaskOVF;
119 class TaskOPC;
120 class TaskCloud;
121
122 struct Data; // opaque, defined in ApplianceImpl.cpp
123 Data *m;
124
125 enum SetUpProgressMode { ImportFile, ImportS3, WriteFile, WriteS3, ExportCloud, ImportCloud };
126
127 /** @name General stuff
128 * @{
129 */
130 bool i_isApplianceIdle();
131 HRESULT i_searchUniqueVMName(Utf8Str& aName) const;
132 HRESULT i_searchUniqueImageFilePath(const Utf8Str &aMachineFolder,
133 DeviceType_T aDeviceType,
134 Utf8Str &aName) const;
135 HRESULT i_setUpProgress(ComObjPtr<Progress> &pProgress,
136 const Utf8Str &strDescription,
137 SetUpProgressMode mode);
138 void i_addWarning(const char* aWarning, ...);
139 void i_disksWeight();
140 void i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket);
141
142 static void i_importOrExportThreadTask(TaskOVF *pTask);
143 static void i_exportOPCThreadTask(TaskOPC *pTask);
144 static void i_importOrExportCloudThreadTask(TaskCloud *pTask);
145
146 HRESULT i_initBackendNames();
147
148 Utf8Str i_typeOfVirtualDiskFormatFromURI(Utf8Str type) const;
149
150#if 0 /* unused */
151 std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
152#endif
153
154 HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
155
156 RTVFSIOSTREAM i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
157 bool fRead = true);
158 /** @} */
159
160 /** @name Read stuff
161 * @{
162 */
163 HRESULT i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
164
165 HRESULT i_readFS(TaskOVF *pTask);
166 HRESULT i_readFSOVF(TaskOVF *pTask);
167 HRESULT i_readFSOVA(TaskOVF *pTask);
168 HRESULT i_readOVFFile(TaskOVF *pTask, RTVFSIOSTREAM hIosOvf, const char *pszManifestEntry);
169 HRESULT i_readManifestFile(TaskOVF *pTask, RTVFSIOSTREAM hIosMf, const char *pszSubFileNm);
170 HRESULT i_readSignatureFile(TaskOVF *pTask, RTVFSIOSTREAM hIosCert, const char *pszSubFileNm);
171 HRESULT i_readTailProcessing(TaskOVF *pTask);
172 HRESULT i_gettingCloudData(TaskCloud *pTask);
173
174 /** @} */
175
176 /** @name Import stuff
177 * @}
178 */
179 HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
180
181 HRESULT i_importFS(TaskOVF *pTask);
182 HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
183 HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
184 HRESULT i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva = NIL_RTVFSFSSTREAM);
185
186 HRESULT i_verifyManifestFile(ImportStack &stack);
187
188 void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
189 uint32_t ulAddressOnParent,
190 Utf8Str &controllerName,
191 int32_t &lControllerPort,
192 int32_t &lDevice);
193
194 void i_importOneDiskImage(const ovf::DiskImage &di,
195 const Utf8Str &strDstPath,
196 ComObjPtr<Medium> &pTargetMedium,
197 ImportStack &stack);
198
199 void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
200 ComObjPtr<VirtualSystemDescription> &vsdescThis,
201 ComPtr<IMachine> &pNewMachine,
202 ImportStack &stack);
203 void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
204 ComPtr<IMachine> &pNewMachine,
205 ImportStack &stack);
206 void i_importMachines(ImportStack &stack);
207
208 HRESULT i_preCheckImageAvailability(ImportStack &stack);
209 bool i_importEnsureOvaLookAhead(ImportStack &stack);
210 RTVFSIOSTREAM i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry);
211 HRESULT i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath,
212 RTVFSIOSTREAM hVfsIosSrc, Utf8Str const &rstrSrcLogNm);
213
214 void i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
215 const char *pszManifestEntry);
216 void i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
217 const char *pszManifestEntry);
218 HRESULT i_importCloudImpl(TaskCloud *pTask);
219 /** @} */
220
221 /** @name Write stuff
222 * @{
223 */
224 HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
225 HRESULT i_writeOPCImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
226 HRESULT i_writeCloudImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
227
228 HRESULT i_writeFS(TaskOVF *pTask);
229 HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
230 HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
231 HRESULT i_writeFSOPC(TaskOPC *pTask);
232 HRESULT i_exportCloudImpl(TaskCloud *pTask);
233 HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase &writeLock, RTVFSFSSTREAM hVfsFssDst);
234 HRESULT i_writeBufferToFile(RTVFSFSSTREAM hVfsFssDst, const char *pszFilename, const void *pvContent, size_t cbContent);
235
236 struct XMLStack;
237
238 void i_buildXML(AutoWriteLockBase& writeLock,
239 xml::Document &doc,
240 XMLStack &stack,
241 const Utf8Str &strPath,
242 ovf::OVFVersion_T enFormat);
243 void i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
244 xml::ElementNode &elmToAddVirtualSystemsTo,
245 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes,
246 ComObjPtr<VirtualSystemDescription> &vsdescThis,
247 ovf::OVFVersion_T enFormat,
248 XMLStack &stack);
249 /** @} */
250
251 friend class Machine;
252 friend class Certificate;
253};
254
255void i_parseURI(Utf8Str strUri, LocationInfo &locInfo);
256
257struct VirtualSystemDescriptionEntry
258{
259 uint32_t ulIndex; ///< zero-based index of this entry within array
260 VirtualSystemDescriptionType_T type; ///< type of this entry
261 Utf8Str strRef; ///< reference number (hard disk controllers only)
262 Utf8Str strOvf; ///< original OVF value (type-dependent)
263 Utf8Str strVBoxSuggested; ///< configuration value (type-dependent); original value suggested by interpret()
264 Utf8Str strVBoxCurrent; ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
265 Utf8Str strExtraConfigSuggested; ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
266 Utf8Str strExtraConfigCurrent; ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
267
268 uint32_t ulSizeMB; ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
269 bool skipIt; ///< used during export to skip some parts if it's needed
270};
271
272class ATL_NO_VTABLE VirtualSystemDescription :
273 public VirtualSystemDescriptionWrap
274{
275 friend class Appliance;
276
277public:
278
279 DECLARE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
280
281 HRESULT FinalConstruct();
282 void FinalRelease();
283
284 HRESULT init();
285 void uninit();
286
287 /* public methods only for internal purposes */
288 void i_addEntry(VirtualSystemDescriptionType_T aType,
289 const Utf8Str &strRef,
290 const Utf8Str &aOvfValue,
291 const Utf8Str &aVBoxValue,
292 uint32_t ulSizeMB = 0,
293 const Utf8Str &strExtraConfig = "");
294
295 std::list<VirtualSystemDescriptionEntry*> i_findByType(VirtualSystemDescriptionType_T aType);
296 const VirtualSystemDescriptionEntry* i_findControllerFromID(uint32_t id);
297
298 void i_importVBoxMachineXML(const xml::ElementNode &elmMachine);
299 const settings::MachineConfigFile* i_getMachineConfig() const;
300
301 /* private instance data */
302private:
303
304 // wrapped IVirtualSystemDescription properties
305 HRESULT getCount(ULONG *aCount);
306
307 // wrapped IVirtualSystemDescription methods
308 HRESULT getDescription(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 getDescriptionByType(VirtualSystemDescriptionType_T aType,
314 std::vector<VirtualSystemDescriptionType_T> &aTypes,
315 std::vector<com::Utf8Str> &aRefs,
316 std::vector<com::Utf8Str> &aOVFValues,
317 std::vector<com::Utf8Str> &aVBoxValues,
318 std::vector<com::Utf8Str> &aExtraConfigValues);
319 HRESULT getValuesByType(VirtualSystemDescriptionType_T aType,
320 VirtualSystemDescriptionValueType_T aWhich,
321 std::vector<com::Utf8Str> &aValues);
322 HRESULT setFinalValues(const std::vector<BOOL> &aEnabled,
323 const std::vector<com::Utf8Str> &aVBoxValues,
324 const std::vector<com::Utf8Str> &aExtraConfigValues);
325 HRESULT addDescription(VirtualSystemDescriptionType_T aType,
326 const com::Utf8Str &aVBoxValue,
327 const com::Utf8Str &aExtraConfigValue);
328 HRESULT removeDescriptionByType(VirtualSystemDescriptionType_T aType);
329 void i_removeByType(VirtualSystemDescriptionType_T aType);
330
331 struct Data;
332 Data *m;
333
334 friend class Machine;
335};
336
337#endif /* !MAIN_INCLUDED_ApplianceImpl_h */
338/* 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