VirtualBox

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

Last change on this file since 86648 was 86648, checked in by vboxsync, 4 years ago

bugref:9781. Added the placeholder @@VBOX_COND_GUEST_VERSION[>(required version)]@@. Updated the templates. Removed the obsolete function getGuestOSConditional().
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 15.0 KB
Line 
1/* $Id: ApplianceImpl.h 86648 2020-10-20 13:59:45Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2020 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 enum ApplianceState { ApplianceIdle, ApplianceImporting, ApplianceExporting };
128 void i_setApplianceState(const ApplianceState &state);
129 /** @name General stuff
130 * @{
131 */
132 bool i_isApplianceIdle();
133 HRESULT i_searchUniqueVMName(Utf8Str &aName) const;
134 HRESULT i_ensureUniqueImageFilePath(const Utf8Str &aMachineFolder,
135 DeviceType_T aDeviceType,
136 Utf8Str &aName) const;
137 HRESULT i_setUpProgress(ComObjPtr<Progress> &pProgress,
138 const Utf8Str &strDescription,
139 SetUpProgressMode mode);
140 void i_addWarning(const char* aWarning, ...);
141 void i_disksWeight();
142 void i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket);
143
144 static void i_importOrExportThreadTask(TaskOVF *pTask);
145 static void i_exportOPCThreadTask(TaskOPC *pTask);
146 static void i_importOrExportCloudThreadTask(TaskCloud *pTask);
147
148 HRESULT i_findFirstBootableImage(ComPtr<IMedium>& bootMedium, const ComPtr<IMachine> &pMachine);
149
150 HRESULT i_initBackendNames();
151
152 Utf8Str i_typeOfVirtualDiskFormatFromURI(Utf8Str type) const;
153
154#if 0 /* unused */
155 std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
156#endif
157
158 HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
159
160 RTVFSIOSTREAM i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
161 bool fRead = true);
162 /** @} */
163
164 /** @name Read stuff
165 * @{
166 */
167 HRESULT i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
168
169 HRESULT i_readFS(TaskOVF *pTask);
170 HRESULT i_readFSOVF(TaskOVF *pTask);
171 HRESULT i_readFSOVA(TaskOVF *pTask);
172 HRESULT i_readOVFFile(TaskOVF *pTask, RTVFSIOSTREAM hIosOvf, const char *pszManifestEntry);
173 HRESULT i_readManifestFile(TaskOVF *pTask, RTVFSIOSTREAM hIosMf, const char *pszSubFileNm);
174 HRESULT i_readSignatureFile(TaskOVF *pTask, RTVFSIOSTREAM hIosCert, const char *pszSubFileNm);
175 HRESULT i_readTailProcessing(TaskOVF *pTask);
176 HRESULT i_readTailProcessingGetManifestData(void **ppvData, size_t *pcbData);
177 HRESULT i_readTailProcessingSignedData(PRTERRINFOSTATIC pErrInfo);
178 HRESULT i_readTailProcessingVerifySelfSignedOvfCert(TaskOVF *pTask, RTCRSTORE hTrustedCerts, PRTERRINFOSTATIC pErrInfo);
179 HRESULT i_readTailProcessingVerifyIssuedOvfCert(TaskOVF *pTask, RTCRSTORE hTrustedStore, PRTERRINFOSTATIC pErrInfo);
180 HRESULT i_readTailProcessingVerifyContentInfoCerts(void const *pvData, size_t cbData,
181 RTCRSTORE hTrustedStore, PRTERRINFOSTATIC pErrInfo);
182 HRESULT i_readTailProcessingVerifyAnalyzeSignerInfo(void const *pvData, size_t cbData, RTCRSTORE hTrustedStore,
183 uint32_t iSigner, PRTTIMESPEC pNow, int vrc,
184 PRTERRINFOSTATIC pErrInfo, PRTCRSTORE phTrustedStore2);
185 HRESULT i_readTailProcessingVerifyContentInfoFailOne(const char *pszSignature, int vrc, PRTERRINFOSTATIC pErrInfo);
186
187 HRESULT i_gettingCloudData(TaskCloud *pTask);
188 /** @} */
189
190 /** @name Import stuff
191 * @{
192 */
193 HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
194
195 HRESULT i_importFS(TaskOVF *pTask);
196 HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
197 HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
198 HRESULT i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva = NIL_RTVFSFSSTREAM);
199
200 HRESULT i_verifyManifestFile(ImportStack &stack);
201
202 void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
203 uint32_t ulAddressOnParent,
204 Utf8Str &controllerName,
205 int32_t &lControllerPort,
206 int32_t &lDevice);
207
208 void i_importOneDiskImage(const ovf::DiskImage &di,
209 const Utf8Str &strDstPath,
210 ComObjPtr<Medium> &pTargetMedium,
211 ImportStack &stack);
212
213 void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
214 ComObjPtr<VirtualSystemDescription> &vsdescThis,
215 ComPtr<IMachine> &pNewMachineRet,
216 ImportStack &stack);
217 void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
218 ComPtr<IMachine> &pNewMachine,
219 ImportStack &stack);
220 void i_importMachines(ImportStack &stack);
221
222 HRESULT i_preCheckImageAvailability(ImportStack &stack);
223 bool i_importEnsureOvaLookAhead(ImportStack &stack);
224 RTVFSIOSTREAM i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry);
225 HRESULT i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath,
226 RTVFSIOSTREAM hVfsIosSrc, Utf8Str const &rstrSrcLogNm);
227
228 void i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
229 const char *pszManifestEntry);
230 void i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
231 const char *pszManifestEntry);
232 HRESULT i_importCloudImpl(TaskCloud *pTask);
233 /** @} */
234
235 /** @name Write stuff
236 * @{
237 */
238 HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
239 HRESULT i_writeOPCImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
240 HRESULT i_writeCloudImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
241
242 HRESULT i_writeFS(TaskOVF *pTask);
243 HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
244 HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
245 HRESULT i_writeFSOPC(TaskOPC *pTask);
246 HRESULT i_exportCloudImpl(TaskCloud *pTask);
247 HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase &writeLock, RTVFSFSSTREAM hVfsFssDst);
248 HRESULT i_writeBufferToFile(RTVFSFSSTREAM hVfsFssDst, const char *pszFilename, const void *pvContent, size_t cbContent);
249
250 struct XMLStack;
251
252 void i_buildXML(AutoWriteLockBase& writeLock,
253 xml::Document &doc,
254 XMLStack &stack,
255 const Utf8Str &strPath,
256 ovf::OVFVersion_T enFormat);
257 void i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
258 xml::ElementNode &elmToAddVirtualSystemsTo,
259 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes,
260 ComObjPtr<VirtualSystemDescription> &vsdescThis,
261 ovf::OVFVersion_T enFormat,
262 XMLStack &stack);
263 /** @} */
264
265 friend class Machine;
266 friend class Certificate;
267};
268
269void i_parseURI(Utf8Str strUri, LocationInfo &locInfo);
270
271struct VirtualSystemDescriptionEntry
272{
273 uint32_t ulIndex; ///< zero-based index of this entry within array
274 VirtualSystemDescriptionType_T type; ///< type of this entry
275 Utf8Str strRef; ///< reference number (hard disk controllers only)
276 Utf8Str strOvf; ///< original OVF value (type-dependent)
277 Utf8Str strVBoxSuggested; ///< configuration value (type-dependent); original value suggested by interpret()
278 Utf8Str strVBoxCurrent; ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
279 Utf8Str strExtraConfigSuggested; ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
280 Utf8Str strExtraConfigCurrent; ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
281
282 uint32_t ulSizeMB; ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
283 bool skipIt; ///< used during export to skip some parts if it's needed
284};
285
286class ATL_NO_VTABLE VirtualSystemDescription :
287 public VirtualSystemDescriptionWrap
288{
289 friend class Appliance;
290
291public:
292
293 DECLARE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
294
295 HRESULT FinalConstruct();
296 void FinalRelease();
297
298 HRESULT init();
299 void uninit();
300
301 /* public methods only for internal purposes */
302 void i_addEntry(VirtualSystemDescriptionType_T aType,
303 const Utf8Str &strRef,
304 const Utf8Str &aOvfValue,
305 const Utf8Str &aVBoxValue,
306 uint32_t ulSizeMB = 0,
307 const Utf8Str &strExtraConfig = "");
308
309 std::list<VirtualSystemDescriptionEntry*> i_findByType(VirtualSystemDescriptionType_T aType);
310 const VirtualSystemDescriptionEntry* i_findControllerFromID(uint32_t id);
311
312 void i_importVBoxMachineXML(const xml::ElementNode &elmMachine);
313 const settings::MachineConfigFile* i_getMachineConfig() const;
314
315 /* private instance data */
316private:
317
318 // wrapped IVirtualSystemDescription properties
319 HRESULT getCount(ULONG *aCount);
320
321 // wrapped IVirtualSystemDescription methods
322 HRESULT getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
323 std::vector<com::Utf8Str> &aRefs,
324 std::vector<com::Utf8Str> &aOVFValues,
325 std::vector<com::Utf8Str> &aVBoxValues,
326 std::vector<com::Utf8Str> &aExtraConfigValues);
327 HRESULT getDescriptionByType(VirtualSystemDescriptionType_T aType,
328 std::vector<VirtualSystemDescriptionType_T> &aTypes,
329 std::vector<com::Utf8Str> &aRefs,
330 std::vector<com::Utf8Str> &aOVFValues,
331 std::vector<com::Utf8Str> &aVBoxValues,
332 std::vector<com::Utf8Str> &aExtraConfigValues);
333 HRESULT getValuesByType(VirtualSystemDescriptionType_T aType,
334 VirtualSystemDescriptionValueType_T aWhich,
335 std::vector<com::Utf8Str> &aValues);
336 HRESULT setFinalValues(const std::vector<BOOL> &aEnabled,
337 const std::vector<com::Utf8Str> &aVBoxValues,
338 const std::vector<com::Utf8Str> &aExtraConfigValues);
339 HRESULT addDescription(VirtualSystemDescriptionType_T aType,
340 const com::Utf8Str &aVBoxValue,
341 const com::Utf8Str &aExtraConfigValue);
342 HRESULT removeDescriptionByType(VirtualSystemDescriptionType_T aType);
343 void i_removeByType(VirtualSystemDescriptionType_T aType);
344
345 struct Data;
346 Data *m;
347
348 friend class Machine;
349};
350
351#endif /* !MAIN_INCLUDED_ApplianceImpl_h */
352/* 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