1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
|
/* $Id: ApplianceImpl.h $ */
/** @file
* VirtualBox COM class implementation
*/
/*
* Copyright (C) 2006-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef MAIN_INCLUDED_ApplianceImpl_h
#define MAIN_INCLUDED_ApplianceImpl_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/* VBox includes */
#include "VirtualSystemDescriptionWrap.h"
#include "ApplianceWrap.h"
#include "MediumFormatImpl.h"
/** @todo This file needs massive cleanup. Split IAppliance in a public and
* private classes. */
#include <iprt/tar.h>
#include "ovfreader.h"
#include <set>
/* VBox forward declarations */
class Certificate;
class Progress;
class VirtualSystemDescription;
struct VirtualSystemDescriptionEntry;
struct LocationInfo;
typedef struct VDINTERFACE *PVDINTERFACE;
typedef struct VDINTERFACEIO *PVDINTERFACEIO;
typedef struct SHASTORAGE *PSHASTORAGE;
namespace ovf
{
struct HardDiskController;
struct VirtualSystem;
class OVFReader;
struct DiskImage;
struct EnvelopeData;
}
namespace xml
{
class Document;
class ElementNode;
}
namespace settings
{
class MachineConfigFile;
}
class ATL_NO_VTABLE Appliance :
public ApplianceWrap
{
public:
DECLARE_COMMON_CLASS_METHODS(Appliance)
HRESULT FinalConstruct();
void FinalRelease();
HRESULT init(VirtualBox *aVirtualBox);
void uninit();
/* public methods only for internal purposes */
static HRESULT i_setErrorStatic(HRESULT aResultCode, const char *aText, ...)
{
va_list va;
va_start(va, aText);
HRESULT hrc = setErrorInternalV(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, va, false, true);
va_end(va);
return hrc;
}
/* private instance data */
private:
// wrapped IAppliance properties
HRESULT getPath(com::Utf8Str &aPath);
HRESULT getDisks(std::vector<com::Utf8Str> &aDisks);
HRESULT getCertificate(ComPtr<ICertificate> &aCertificateInfo);
HRESULT getVirtualSystemDescriptions(std::vector<ComPtr<IVirtualSystemDescription> > &aVirtualSystemDescriptions);
HRESULT getMachines(std::vector<com::Utf8Str> &aMachines);
// wrapped IAppliance methods
HRESULT read(const com::Utf8Str &aFile,
ComPtr<IProgress> &aProgress);
HRESULT interpret();
HRESULT importMachines(const std::vector<ImportOptions_T> &aOptions,
ComPtr<IProgress> &aProgress);
HRESULT createVFSExplorer(const com::Utf8Str &aURI,
ComPtr<IVFSExplorer> &aExplorer);
HRESULT write(const com::Utf8Str &aFormat,
const std::vector<ExportOptions_T> &aOptions,
const com::Utf8Str &aPath,
ComPtr<IProgress> &aProgress);
HRESULT getWarnings(std::vector<com::Utf8Str> &aWarnings);
HRESULT getPasswordIds(std::vector<com::Utf8Str> &aIdentifiers);
HRESULT getMediumIdsForPasswordId(const com::Utf8Str &aPasswordId, std::vector<com::Guid> &aIdentifiers);
HRESULT addPasswords(const std::vector<com::Utf8Str> &aIdentifiers,
const std::vector<com::Utf8Str> &aPasswords);
HRESULT createVirtualSystemDescriptions(ULONG aRequested, ULONG *aCreated);
/** weak VirtualBox parent */
VirtualBox* const mVirtualBox;
struct ImportStack;
class TaskOVF;
class TaskOPC;
class TaskCloud;
struct Data; // opaque, defined in ApplianceImpl.cpp
Data *m;
enum SetUpProgressMode { ImportFile, ImportS3, WriteFile, WriteS3, ExportCloud, ImportCloud };
enum ApplianceState { ApplianceIdle, ApplianceImporting, ApplianceExporting };
void i_setApplianceState(const ApplianceState &state);
/** @name General stuff
* @{
*/
bool i_isApplianceIdle();
HRESULT i_searchUniqueVMName(Utf8Str &aName) const;
HRESULT i_ensureUniqueImageFilePath(const Utf8Str &aMachineFolder,
DeviceType_T aDeviceType,
Utf8Str &aName) const;
HRESULT i_setUpProgress(ComObjPtr<Progress> &pProgress,
const Utf8Str &strDescription,
SetUpProgressMode mode);
void i_addWarning(const char* aWarning, ...);
void i_disksWeight();
void i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket);
static void i_importOrExportThreadTask(TaskOVF *pTask);
static void i_exportOPCThreadTask(TaskOPC *pTask);
static void i_importOrExportCloudThreadTask(TaskCloud *pTask);
HRESULT i_initBackendNames();
Utf8Str i_typeOfVirtualDiskFormatFromURI(Utf8Str type) const;
#if 0 /* unused */
std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
#endif
HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
RTVFSIOSTREAM i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
bool fRead = true);
/** @} */
/** @name Read stuff
* @{
*/
HRESULT i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
HRESULT i_readFS(TaskOVF *pTask);
HRESULT i_readFSOVF(TaskOVF *pTask);
HRESULT i_readFSOVA(TaskOVF *pTask);
HRESULT i_readOVFFile(TaskOVF *pTask, RTVFSIOSTREAM hIosOvf, const char *pszManifestEntry);
HRESULT i_readManifestFile(TaskOVF *pTask, RTVFSIOSTREAM hIosMf, const char *pszSubFileNm);
HRESULT i_readSignatureFile(TaskOVF *pTask, RTVFSIOSTREAM hIosCert, const char *pszSubFileNm);
HRESULT i_readTailProcessing(TaskOVF *pTask);
HRESULT i_readTailProcessingGetManifestData(void **ppvData, size_t *pcbData);
HRESULT i_readTailProcessingSignedData(PRTERRINFOSTATIC pErrInfo);
HRESULT i_readTailProcessingVerifySelfSignedOvfCert(TaskOVF *pTask, RTCRSTORE hTrustedCerts, PRTERRINFOSTATIC pErrInfo);
HRESULT i_readTailProcessingVerifyIssuedOvfCert(TaskOVF *pTask, RTCRSTORE hTrustedStore, PRTERRINFOSTATIC pErrInfo);
HRESULT i_readTailProcessingVerifyContentInfoCerts(void const *pvData, size_t cbData,
RTCRSTORE hTrustedStore, PRTERRINFOSTATIC pErrInfo);
HRESULT i_readTailProcessingVerifyAnalyzeSignerInfo(void const *pvData, size_t cbData, RTCRSTORE hTrustedStore,
uint32_t iSigner, PRTTIMESPEC pNow, int vrc,
PRTERRINFOSTATIC pErrInfo, PRTCRSTORE phTrustedStore2);
HRESULT i_readTailProcessingVerifyContentInfoFailOne(const char *pszSignature, int vrc, PRTERRINFOSTATIC pErrInfo);
HRESULT i_gettingCloudData(TaskCloud *pTask);
/** @} */
/** @name Import stuff
* @{
*/
HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
HRESULT i_importFS(TaskOVF *pTask);
HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
HRESULT i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva = NIL_RTVFSFSSTREAM);
HRESULT i_verifyManifestFile(ImportStack &stack);
void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
uint32_t ulAddressOnParent,
Utf8Str &controllerName,
int32_t &lControllerPort,
int32_t &lDevice);
void i_importOneDiskImage(const ovf::DiskImage &di,
const Utf8Str &strDstPath,
ComObjPtr<Medium> &pTargetMedium,
ImportStack &stack);
void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
ComObjPtr<VirtualSystemDescription> &vsdescThis,
ComPtr<IMachine> &pNewMachineRet,
ImportStack &stack);
void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
ComPtr<IMachine> &pNewMachine,
ImportStack &stack);
void i_importMachines(ImportStack &stack);
HRESULT i_verifyStorageControllerPortValid(const StorageControllerType_T aStorageControllerType,
const uint32_t aControllerPort,
ULONG *ulMaxPorts);
HRESULT i_preCheckImageAvailability(ImportStack &stack);
bool i_importEnsureOvaLookAhead(ImportStack &stack);
RTVFSIOSTREAM i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry);
HRESULT i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath,
RTVFSIOSTREAM hVfsIosSrc, Utf8Str const &rstrSrcLogNm);
void i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
const char *pszManifestEntry);
void i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
const char *pszManifestEntry);
HRESULT i_importCloudImpl(TaskCloud *pTask);
/** @} */
/** @name Write stuff
* @{
*/
HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
HRESULT i_writeOPCImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
HRESULT i_writeCloudImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
HRESULT i_writeFS(TaskOVF *pTask);
HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
HRESULT i_writeFSOPC(TaskOPC *pTask);
HRESULT i_exportCloudImpl(TaskCloud *pTask);
HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase &writeLock, RTVFSFSSTREAM hVfsFssDst);
HRESULT i_writeBufferToFile(RTVFSFSSTREAM hVfsFssDst, const char *pszFilename, const void *pvContent, size_t cbContent);
struct XMLStack;
void i_buildXML(AutoWriteLockBase& writeLock,
xml::Document &doc,
XMLStack &stack,
const Utf8Str &strPath,
ovf::OVFVersion_T enFormat);
void i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
xml::ElementNode &elmToAddVirtualSystemsTo,
std::list<xml::ElementNode*> *pllElementsWithUuidAttributes,
ComObjPtr<VirtualSystemDescription> &vsdescThis,
ovf::OVFVersion_T enFormat,
XMLStack &stack);
/** @} */
friend class Machine;
friend class Certificate;
};
void i_parseURI(Utf8Str strUri, LocationInfo &locInfo);
struct VirtualSystemDescriptionEntry
{
uint32_t ulIndex; ///< zero-based index of this entry within array
VirtualSystemDescriptionType_T type; ///< type of this entry
Utf8Str strRef; ///< reference number (hard disk controllers only)
Utf8Str strOvf; ///< original OVF value (type-dependent)
Utf8Str strVBoxSuggested; ///< configuration value (type-dependent); original value suggested by interpret()
Utf8Str strVBoxCurrent; ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
Utf8Str strExtraConfigSuggested; ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
Utf8Str strExtraConfigCurrent; ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
uint32_t ulSizeMB; ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
bool skipIt; ///< used during export to skip some parts if it's needed
};
class ATL_NO_VTABLE VirtualSystemDescription :
public VirtualSystemDescriptionWrap
{
friend class Appliance;
public:
DECLARE_COMMON_CLASS_METHODS(VirtualSystemDescription)
HRESULT FinalConstruct();
void FinalRelease();
HRESULT init();
void uninit();
/* public methods only for internal purposes */
void i_addEntry(VirtualSystemDescriptionType_T aType,
const Utf8Str &strRef,
const Utf8Str &aOvfValue,
const Utf8Str &aVBoxValue,
uint32_t ulSizeMB = 0,
const Utf8Str &strExtraConfig = "");
std::list<VirtualSystemDescriptionEntry*> i_findByType(VirtualSystemDescriptionType_T aType);
const VirtualSystemDescriptionEntry* i_findControllerFromID(const Utf8Str &id);
const VirtualSystemDescriptionEntry* i_findByIndex(const uint32_t aIndex);
void i_importVBoxMachineXML(const xml::ElementNode &elmMachine);
const settings::MachineConfigFile* i_getMachineConfig() const;
/* private instance data */
private:
// wrapped IVirtualSystemDescription properties
HRESULT getCount(ULONG *aCount);
// wrapped IVirtualSystemDescription methods
HRESULT getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
std::vector<com::Utf8Str> &aRefs,
std::vector<com::Utf8Str> &aOVFValues,
std::vector<com::Utf8Str> &aVBoxValues,
std::vector<com::Utf8Str> &aExtraConfigValues);
HRESULT getDescriptionByType(VirtualSystemDescriptionType_T aType,
std::vector<VirtualSystemDescriptionType_T> &aTypes,
std::vector<com::Utf8Str> &aRefs,
std::vector<com::Utf8Str> &aOVFValues,
std::vector<com::Utf8Str> &aVBoxValues,
std::vector<com::Utf8Str> &aExtraConfigValues);
HRESULT getValuesByType(VirtualSystemDescriptionType_T aType,
VirtualSystemDescriptionValueType_T aWhich,
std::vector<com::Utf8Str> &aValues);
HRESULT setFinalValues(const std::vector<BOOL> &aEnabled,
const std::vector<com::Utf8Str> &aVBoxValues,
const std::vector<com::Utf8Str> &aExtraConfigValues);
HRESULT addDescription(VirtualSystemDescriptionType_T aType,
const com::Utf8Str &aVBoxValue,
const com::Utf8Str &aExtraConfigValue);
HRESULT removeDescriptionByType(VirtualSystemDescriptionType_T aType);
void i_removeByType(VirtualSystemDescriptionType_T aType);
struct Data;
Data *m;
friend class Machine;
};
#endif /* !MAIN_INCLUDED_ApplianceImpl_h */
/* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
