VirtualBox

source: vbox/trunk/src/VBox/Main/src-server/ApplianceImpl.cpp@ 78255

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

bugref:9416. Added new API function \'IAppliance::createVirtualSystemDescriptions\'
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 62.8 KB
Line 
1/* $Id: ApplianceImpl.cpp 78255 2019-04-23 07:27:17Z vboxsync $ */
2/** @file
3 * IAppliance and IVirtualSystem COM class implementations.
4 */
5
6/*
7 * Copyright (C) 2008-2019 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
19/*********************************************************************************************************************************
20* Header Files *
21*********************************************************************************************************************************/
22#define LOG_GROUP LOG_GROUP_MAIN_APPLIANCE
23#include <iprt/path.h>
24#include <iprt/cpp/path.h>
25#include <iprt/cpp/utils.h>
26#include <VBox/com/array.h>
27#include <map>
28
29#include "ApplianceImpl.h"
30#include "VFSExplorerImpl.h"
31#include "VirtualBoxImpl.h"
32#include "GuestOSTypeImpl.h"
33#include "Global.h"
34#include "ProgressImpl.h"
35#include "MachineImpl.h"
36#include "SystemPropertiesImpl.h"
37#include "AutoCaller.h"
38#include "LoggingNew.h"
39#include "CertificateImpl.h"
40
41#include "ApplianceImplPrivate.h"
42
43using namespace std;
44
45
46/*********************************************************************************************************************************
47* Global Variables *
48*********************************************************************************************************************************/
49static const char * const g_pszISOURI = "http://www.ecma-international.org/publications/standards/Ecma-119.htm";
50static const char * const g_pszVMDKStreamURI = "http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized";
51static const char * const g_pszVMDKSparseURI = "http://www.vmware.com/specifications/vmdk.html#sparse";
52static const char * const g_pszVMDKCompressedURI = "http://www.vmware.com/specifications/vmdk.html#compressed";
53static const char * const g_pszVMDKCompressedURI2 = "http://www.vmware.com/interfaces/specifications/vmdk.html#compressed";
54static const char * const g_pszrVHDURI = "http://go.microsoft.com/fwlink/?LinkId=137171";
55static char g_szIsoBackend[128];
56static char g_szVmdkBackend[128];
57static char g_szVhdBackend[128];
58/** Set after the g_szXxxxBackend variables has been initialized. */
59static bool volatile g_fInitializedBackendNames = false;
60
61static struct
62{
63 const char *pszUri, *pszBackend;
64} const g_aUriToBackend[] =
65{
66 { g_pszISOURI, g_szIsoBackend },
67 { g_pszVMDKStreamURI, g_szVmdkBackend },
68 { g_pszVMDKSparseURI, g_szVmdkBackend },
69 { g_pszVMDKCompressedURI, g_szVmdkBackend },
70 { g_pszVMDKCompressedURI2, g_szVmdkBackend },
71 { g_pszrVHDURI, g_szVhdBackend },
72};
73
74static std::map<Utf8Str, Utf8Str> supportedStandardsURI;
75
76static struct
77{
78 ovf::CIMOSType_T cim;
79 VBOXOSTYPE osType;
80} const g_aOsTypes[] =
81{
82 { ovf::CIMOSType_CIMOS_Unknown, VBOXOSTYPE_Unknown },
83 { ovf::CIMOSType_CIMOS_OS2, VBOXOSTYPE_OS2 },
84 { ovf::CIMOSType_CIMOS_OS2, VBOXOSTYPE_OS2Warp3 },
85 { ovf::CIMOSType_CIMOS_OS2, VBOXOSTYPE_OS2Warp4 },
86 { ovf::CIMOSType_CIMOS_OS2, VBOXOSTYPE_OS2Warp45 },
87 { ovf::CIMOSType_CIMOS_MSDOS, VBOXOSTYPE_DOS },
88 { ovf::CIMOSType_CIMOS_WIN3x, VBOXOSTYPE_Win31 },
89 { ovf::CIMOSType_CIMOS_WIN95, VBOXOSTYPE_Win95 },
90 { ovf::CIMOSType_CIMOS_WIN98, VBOXOSTYPE_Win98 },
91 { ovf::CIMOSType_CIMOS_WINNT, VBOXOSTYPE_WinNT },
92 { ovf::CIMOSType_CIMOS_WINNT, VBOXOSTYPE_WinNT4 },
93 { ovf::CIMOSType_CIMOS_WINNT, VBOXOSTYPE_WinNT3x },
94 { ovf::CIMOSType_CIMOS_NetWare, VBOXOSTYPE_Netware },
95 { ovf::CIMOSType_CIMOS_NovellOES, VBOXOSTYPE_Netware },
96 { ovf::CIMOSType_CIMOS_Solaris, VBOXOSTYPE_Solaris },
97 { ovf::CIMOSType_CIMOS_SunOS, VBOXOSTYPE_Solaris },
98 { ovf::CIMOSType_CIMOS_FreeBSD, VBOXOSTYPE_FreeBSD },
99 { ovf::CIMOSType_CIMOS_NetBSD, VBOXOSTYPE_NetBSD },
100 { ovf::CIMOSType_CIMOS_QNX, VBOXOSTYPE_QNX },
101 { ovf::CIMOSType_CIMOS_Windows2000, VBOXOSTYPE_Win2k },
102 { ovf::CIMOSType_CIMOS_WindowsMe, VBOXOSTYPE_WinMe },
103 { ovf::CIMOSType_CIMOS_OpenBSD, VBOXOSTYPE_OpenBSD },
104 { ovf::CIMOSType_CIMOS_WindowsXP, VBOXOSTYPE_WinXP },
105 { ovf::CIMOSType_CIMOS_WindowsXPEmbedded, VBOXOSTYPE_WinXP },
106 { ovf::CIMOSType_CIMOS_WindowsEmbeddedforPointofService, VBOXOSTYPE_WinXP },
107 { ovf::CIMOSType_CIMOS_MicrosoftWindowsServer2003, VBOXOSTYPE_Win2k3 },
108 { ovf::CIMOSType_CIMOS_MicrosoftWindowsServer2003_64, VBOXOSTYPE_Win2k3_x64 },
109 { ovf::CIMOSType_CIMOS_WindowsXP_64, VBOXOSTYPE_WinXP_x64 },
110 { ovf::CIMOSType_CIMOS_WindowsVista, VBOXOSTYPE_WinVista },
111 { ovf::CIMOSType_CIMOS_WindowsVista_64, VBOXOSTYPE_WinVista_x64 },
112 { ovf::CIMOSType_CIMOS_MicrosoftWindowsServer2008, VBOXOSTYPE_Win2k8 },
113 { ovf::CIMOSType_CIMOS_MicrosoftWindowsServer2008_64, VBOXOSTYPE_Win2k8_x64 },
114 { ovf::CIMOSType_CIMOS_FreeBSD_64, VBOXOSTYPE_FreeBSD_x64 },
115 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS },
116 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS_x64 }, // there is no CIM 64-bit type for this
117 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS106 },
118 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS106_x64 },
119 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS107_x64 },
120 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS108_x64 },
121 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS109_x64 },
122 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS1010_x64 },
123 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS1011_x64 },
124 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS1012_x64 },
125 { ovf::CIMOSType_CIMOS_MACOS, VBOXOSTYPE_MacOS1013_x64 },
126
127 // Linuxes
128 { ovf::CIMOSType_CIMOS_RedHatEnterpriseLinux, VBOXOSTYPE_RedHat },
129 { ovf::CIMOSType_CIMOS_RedHatEnterpriseLinux_64, VBOXOSTYPE_RedHat_x64 },
130 { ovf::CIMOSType_CIMOS_Solaris_64, VBOXOSTYPE_Solaris_x64 },
131 { ovf::CIMOSType_CIMOS_SUSE, VBOXOSTYPE_OpenSUSE },
132 { ovf::CIMOSType_CIMOS_SLES, VBOXOSTYPE_OpenSUSE },
133 { ovf::CIMOSType_CIMOS_NovellLinuxDesktop, VBOXOSTYPE_OpenSUSE },
134 { ovf::CIMOSType_CIMOS_SUSE_64, VBOXOSTYPE_OpenSUSE_x64 },
135 { ovf::CIMOSType_CIMOS_SLES_64, VBOXOSTYPE_OpenSUSE_x64 },
136 { ovf::CIMOSType_CIMOS_LINUX, VBOXOSTYPE_Linux },
137 { ovf::CIMOSType_CIMOS_LINUX, VBOXOSTYPE_Linux22 },
138 { ovf::CIMOSType_CIMOS_SunJavaDesktopSystem, VBOXOSTYPE_Linux },
139 { ovf::CIMOSType_CIMOS_TurboLinux, VBOXOSTYPE_Turbolinux },
140 { ovf::CIMOSType_CIMOS_TurboLinux_64, VBOXOSTYPE_Turbolinux_x64 },
141 { ovf::CIMOSType_CIMOS_Mandriva, VBOXOSTYPE_Mandriva },
142 { ovf::CIMOSType_CIMOS_Mandriva_64, VBOXOSTYPE_Mandriva_x64 },
143 { ovf::CIMOSType_CIMOS_Ubuntu, VBOXOSTYPE_Ubuntu },
144 { ovf::CIMOSType_CIMOS_Ubuntu_64, VBOXOSTYPE_Ubuntu_x64 },
145 { ovf::CIMOSType_CIMOS_Debian, VBOXOSTYPE_Debian },
146 { ovf::CIMOSType_CIMOS_Debian_64, VBOXOSTYPE_Debian_x64 },
147 { ovf::CIMOSType_CIMOS_Linux_2_4_x, VBOXOSTYPE_Linux24 },
148 { ovf::CIMOSType_CIMOS_Linux_2_4_x_64, VBOXOSTYPE_Linux24_x64 },
149 { ovf::CIMOSType_CIMOS_Linux_2_6_x, VBOXOSTYPE_Linux26 },
150 { ovf::CIMOSType_CIMOS_Linux_2_6_x_64, VBOXOSTYPE_Linux26_x64 },
151 { ovf::CIMOSType_CIMOS_Linux_64, VBOXOSTYPE_Linux26_x64 },
152
153 // types that we have support for but CIM doesn't
154 { ovf::CIMOSType_CIMOS_Linux_2_6_x, VBOXOSTYPE_ArchLinux },
155 { ovf::CIMOSType_CIMOS_Linux_2_6_x_64, VBOXOSTYPE_ArchLinux_x64 },
156 { ovf::CIMOSType_CIMOS_Linux_2_6_x, VBOXOSTYPE_FedoraCore },
157 { ovf::CIMOSType_CIMOS_Linux_2_6_x_64, VBOXOSTYPE_FedoraCore_x64 },
158 { ovf::CIMOSType_CIMOS_Linux_2_6_x, VBOXOSTYPE_Gentoo },
159 { ovf::CIMOSType_CIMOS_Linux_2_6_x_64, VBOXOSTYPE_Gentoo_x64 },
160 { ovf::CIMOSType_CIMOS_Linux_2_6_x, VBOXOSTYPE_Xandros },
161 { ovf::CIMOSType_CIMOS_Linux_2_6_x_64, VBOXOSTYPE_Xandros_x64 },
162 { ovf::CIMOSType_CIMOS_Solaris, VBOXOSTYPE_OpenSolaris },
163 { ovf::CIMOSType_CIMOS_Solaris_64, VBOXOSTYPE_OpenSolaris_x64 },
164
165 // types added with CIM 2.25.0 follow:
166 { ovf::CIMOSType_CIMOS_WindowsServer2008R2, VBOXOSTYPE_Win2k8 }, // duplicate, see above
167// { ovf::CIMOSType_CIMOS_VMwareESXi = 104, // we can't run ESX in a VM
168 { ovf::CIMOSType_CIMOS_Windows7, VBOXOSTYPE_Win7 },
169 { ovf::CIMOSType_CIMOS_Windows7, VBOXOSTYPE_Win7_x64 }, // there is no
170 // CIM 64-bit type for this
171 { ovf::CIMOSType_CIMOS_CentOS, VBOXOSTYPE_RedHat },
172 { ovf::CIMOSType_CIMOS_CentOS_64, VBOXOSTYPE_RedHat_x64 },
173 { ovf::CIMOSType_CIMOS_OracleEnterpriseLinux, VBOXOSTYPE_Oracle },
174 { ovf::CIMOSType_CIMOS_OracleEnterpriseLinux_64, VBOXOSTYPE_Oracle_x64 },
175 { ovf::CIMOSType_CIMOS_eComStation, VBOXOSTYPE_ECS }
176
177 // there are no CIM types for these, so these turn to "other" on export:
178 // VBOXOSTYPE_OpenBSD
179 // VBOXOSTYPE_OpenBSD_x64
180 // VBOXOSTYPE_NetBSD
181 // VBOXOSTYPE_NetBSD_x64
182
183};
184
185/* Pattern structure for matching the OS type description field */
186struct osTypePattern
187{
188 const char *pcszPattern;
189 VBOXOSTYPE osType;
190};
191
192/* These are the 32-Bit ones. They are sorted by priority. */
193static const osTypePattern g_aOsTypesPattern[] =
194{
195 {"Windows NT", VBOXOSTYPE_WinNT4},
196 {"Windows XP", VBOXOSTYPE_WinXP},
197 {"Windows 2000", VBOXOSTYPE_Win2k},
198 {"Windows 2003", VBOXOSTYPE_Win2k3},
199 {"Windows Vista", VBOXOSTYPE_WinVista},
200 {"Windows 2008", VBOXOSTYPE_Win2k8},
201 {"SUSE", VBOXOSTYPE_OpenSUSE},
202 {"Novell", VBOXOSTYPE_OpenSUSE},
203 {"Red Hat", VBOXOSTYPE_RedHat},
204 {"Mandriva", VBOXOSTYPE_Mandriva},
205 {"Ubuntu", VBOXOSTYPE_Ubuntu},
206 {"Debian", VBOXOSTYPE_Debian},
207 {"QNX", VBOXOSTYPE_QNX},
208 {"Linux 2.4", VBOXOSTYPE_Linux24},
209 {"Linux 2.6", VBOXOSTYPE_Linux26},
210 {"Linux", VBOXOSTYPE_Linux},
211 {"OpenSolaris", VBOXOSTYPE_OpenSolaris},
212 {"Solaris", VBOXOSTYPE_OpenSolaris},
213 {"FreeBSD", VBOXOSTYPE_FreeBSD},
214 {"NetBSD", VBOXOSTYPE_NetBSD},
215 {"Windows 95", VBOXOSTYPE_Win95},
216 {"Windows 98", VBOXOSTYPE_Win98},
217 {"Windows Me", VBOXOSTYPE_WinMe},
218 {"Windows 3.", VBOXOSTYPE_Win31},
219 {"DOS", VBOXOSTYPE_DOS},
220 {"OS2", VBOXOSTYPE_OS2}
221};
222
223/* These are the 64-Bit ones. They are sorted by priority. */
224static const osTypePattern g_aOsTypesPattern64[] =
225{
226 {"Windows XP", VBOXOSTYPE_WinXP_x64},
227 {"Windows 2003", VBOXOSTYPE_Win2k3_x64},
228 {"Windows Vista", VBOXOSTYPE_WinVista_x64},
229 {"Windows 2008", VBOXOSTYPE_Win2k8_x64},
230 {"SUSE", VBOXOSTYPE_OpenSUSE_x64},
231 {"Novell", VBOXOSTYPE_OpenSUSE_x64},
232 {"Red Hat", VBOXOSTYPE_RedHat_x64},
233 {"Mandriva", VBOXOSTYPE_Mandriva_x64},
234 {"Ubuntu", VBOXOSTYPE_Ubuntu_x64},
235 {"Debian", VBOXOSTYPE_Debian_x64},
236 {"Linux 2.4", VBOXOSTYPE_Linux24_x64},
237 {"Linux 2.6", VBOXOSTYPE_Linux26_x64},
238 {"Linux", VBOXOSTYPE_Linux26_x64},
239 {"OpenSolaris", VBOXOSTYPE_OpenSolaris_x64},
240 {"Solaris", VBOXOSTYPE_OpenSolaris_x64},
241 {"FreeBSD", VBOXOSTYPE_FreeBSD_x64},
242};
243
244/**
245 * Private helper func that suggests a VirtualBox guest OS type
246 * for the given OVF operating system type.
247 */
248void convertCIMOSType2VBoxOSType(Utf8Str &strType, ovf::CIMOSType_T c, const Utf8Str &cStr)
249{
250 /* First check if the type is other/other_64 */
251 if (c == ovf::CIMOSType_CIMOS_Other)
252 {
253 for (size_t i = 0; i < RT_ELEMENTS(g_aOsTypesPattern); ++i)
254 if (cStr.contains(g_aOsTypesPattern[i].pcszPattern, Utf8Str::CaseInsensitive))
255 {
256 strType = Global::OSTypeId(g_aOsTypesPattern[i].osType);
257 return;
258 }
259 }
260 else if (c == ovf::CIMOSType_CIMOS_Other_64)
261 {
262 for (size_t i = 0; i < RT_ELEMENTS(g_aOsTypesPattern64); ++i)
263 if (cStr.contains(g_aOsTypesPattern64[i].pcszPattern, Utf8Str::CaseInsensitive))
264 {
265 strType = Global::OSTypeId(g_aOsTypesPattern64[i].osType);
266 return;
267 }
268 }
269
270 for (size_t i = 0; i < RT_ELEMENTS(g_aOsTypes); ++i)
271 {
272 if (c == g_aOsTypes[i].cim)
273 {
274 strType = Global::OSTypeId(g_aOsTypes[i].osType);
275 return;
276 }
277 }
278
279 if (c == ovf::CIMOSType_CIMOS_Other_64)
280 strType = Global::OSTypeId(VBOXOSTYPE_Unknown_x64);
281 else
282 strType = Global::OSTypeId(VBOXOSTYPE_Unknown);
283}
284
285/**
286 * Private helper func that suggests a VirtualBox guest OS type
287 * for the given OVF operating system type.
288 * @returns CIM OS type.
289 * @param pcszVBox Our guest OS type identifier string.
290 * @param fLongMode Whether long mode is enabled and a 64-bit CIM type is
291 * preferred even if the VBox guest type isn't 64-bit.
292 */
293ovf::CIMOSType_T convertVBoxOSType2CIMOSType(const char *pcszVBox, BOOL fLongMode)
294{
295 for (size_t i = 0; i < RT_ELEMENTS(g_aOsTypes); ++i)
296 {
297 if (!RTStrICmp(pcszVBox, Global::OSTypeId(g_aOsTypes[i].osType)))
298 {
299 if (fLongMode && !(g_aOsTypes[i].osType & VBOXOSTYPE_x64))
300 {
301 VBOXOSTYPE enmDesiredOsType = (VBOXOSTYPE)((int)g_aOsTypes[i].osType | (int)VBOXOSTYPE_x64);
302 size_t j = i;
303 while (++j < RT_ELEMENTS(g_aOsTypes))
304 if (g_aOsTypes[j].osType == enmDesiredOsType)
305 return g_aOsTypes[j].cim;
306 j = i;
307 while (--j > 0)
308 if (g_aOsTypes[j].osType == enmDesiredOsType)
309 return g_aOsTypes[j].cim;
310 /* Not all OSes have 64-bit versions, so just return the 32-bit variant. */
311 }
312 return g_aOsTypes[i].cim;
313 }
314 }
315
316 return fLongMode ? ovf::CIMOSType_CIMOS_Other_64 : ovf::CIMOSType_CIMOS_Other;
317}
318
319Utf8Str convertNetworkAttachmentTypeToString(NetworkAttachmentType_T type)
320{
321 Utf8Str strType;
322 switch (type)
323 {
324 case NetworkAttachmentType_NAT: strType = "NAT"; break;
325 case NetworkAttachmentType_Bridged: strType = "Bridged"; break;
326 case NetworkAttachmentType_Internal: strType = "Internal"; break;
327 case NetworkAttachmentType_HostOnly: strType = "HostOnly"; break;
328 case NetworkAttachmentType_Generic: strType = "Generic"; break;
329 case NetworkAttachmentType_NATNetwork: strType = "NATNetwork"; break;
330 case NetworkAttachmentType_Null: strType = "Null"; break;
331#ifdef VBOX_WITH_XPCOM_CPP_ENUM_HACK
332 case NetworkAttachmentType_32BitHack: AssertFailedBreak(); /* (compiler warnings) */
333#endif
334 }
335 return strType;
336}
337
338
339////////////////////////////////////////////////////////////////////////////////
340//
341// Appliance constructor / destructor
342//
343// ////////////////////////////////////////////////////////////////////////////////
344
345DEFINE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
346
347HRESULT VirtualSystemDescription::FinalConstruct()
348{
349 return BaseFinalConstruct();
350}
351
352void VirtualSystemDescription::FinalRelease()
353{
354 uninit();
355
356 BaseFinalRelease();
357}
358
359Appliance::Appliance()
360 : mVirtualBox(NULL)
361{
362}
363
364Appliance::~Appliance()
365{
366}
367
368
369HRESULT Appliance::FinalConstruct()
370{
371 return BaseFinalConstruct();
372}
373
374void Appliance::FinalRelease()
375{
376 uninit();
377
378 BaseFinalRelease();
379}
380
381
382////////////////////////////////////////////////////////////////////////////////
383//
384// Internal helpers
385//
386////////////////////////////////////////////////////////////////////////////////
387
388
389////////////////////////////////////////////////////////////////////////////////
390//
391// IVirtualBox public methods
392//
393////////////////////////////////////////////////////////////////////////////////
394
395// This code is here so we won't have to include the appliance headers in the
396// IVirtualBox implementation.
397
398/**
399 * Implementation for IVirtualBox::createAppliance.
400 *
401 * @param aAppliance IAppliance object created if S_OK is returned.
402 * @return S_OK or error.
403 */
404HRESULT VirtualBox::createAppliance(ComPtr<IAppliance> &aAppliance)
405{
406 ComObjPtr<Appliance> appliance;
407 HRESULT hrc = appliance.createObject();
408 if (SUCCEEDED(hrc))
409 {
410 hrc = appliance->init(this);
411 if (SUCCEEDED(hrc))
412 hrc = appliance.queryInterfaceTo(aAppliance.asOutParam());
413 }
414 return hrc;
415}
416
417/**
418 * Appliance COM initializer.
419 * @param aVirtualBox The VirtualBox object.
420 */
421HRESULT Appliance::init(VirtualBox *aVirtualBox)
422{
423 HRESULT rc = S_OK;
424 /* Enclose the state transition NotReady->InInit->Ready */
425 AutoInitSpan autoInitSpan(this);
426 AssertReturn(autoInitSpan.isOk(), E_FAIL);
427
428 /* Weak reference to a VirtualBox object */
429 unconst(mVirtualBox) = aVirtualBox;
430
431 // initialize data
432 m = new Data;
433 m->m_pSecretKeyStore = new SecretKeyStore(false /* fRequireNonPageable*/);
434 AssertReturn(m->m_pSecretKeyStore, E_FAIL);
435
436 rc = i_initBackendNames();
437
438 /* Confirm a successful initialization */
439 autoInitSpan.setSucceeded();
440
441 return rc;
442}
443
444/**
445 * Appliance COM uninitializer.
446 */
447void Appliance::uninit()
448{
449 /* Enclose the state transition Ready->InUninit->NotReady */
450 AutoUninitSpan autoUninitSpan(this);
451 if (autoUninitSpan.uninitDone())
452 return;
453
454 if (m->m_pSecretKeyStore)
455 delete m->m_pSecretKeyStore;
456
457 delete m;
458 m = NULL;
459}
460
461////////////////////////////////////////////////////////////////////////////////
462//
463// IAppliance public methods
464//
465////////////////////////////////////////////////////////////////////////////////
466
467/**
468 * Public method implementation.
469 */
470HRESULT Appliance::getPath(com::Utf8Str &aPath)
471{
472 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
473
474 if (!i_isApplianceIdle())
475 return E_ACCESSDENIED;
476
477 aPath = m->locInfo.strPath;
478
479 return S_OK;
480}
481
482/**
483 * Public method implementation.
484 */
485HRESULT Appliance::getDisks(std::vector<com::Utf8Str> &aDisks)
486{
487 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
488
489 aDisks.resize(0);
490 if (!i_isApplianceIdle())
491 return E_ACCESSDENIED;
492
493 if (m->pReader) // OVFReader instantiated?
494 {
495 aDisks.resize(m->pReader->m_mapDisks.size());
496
497 ovf::DiskImagesMap::const_iterator it;
498 size_t i = 0;
499 for (it = m->pReader->m_mapDisks.begin();
500 it != m->pReader->m_mapDisks.end();
501 ++it, ++i)
502 {
503 // create a string representing this disk
504 const ovf::DiskImage &d = it->second;
505 char *psz = NULL;
506 RTStrAPrintf(&psz,
507 "%s\t"
508 "%RI64\t"
509 "%RI64\t"
510 "%s\t"
511 "%s\t"
512 "%RI64\t"
513 "%RI64\t"
514 "%s",
515 d.strDiskId.c_str(),
516 d.iCapacity,
517 d.iPopulatedSize,
518 d.strFormat.c_str(),
519 d.strHref.c_str(),
520 d.iSize,
521 d.iChunkSize,
522 d.strCompression.c_str());
523 Utf8Str utf(psz);
524 aDisks[i] = utf;
525 RTStrFree(psz);
526 }
527 }
528
529 return S_OK;
530}
531
532/**
533 * Public method implementation.
534 */
535HRESULT Appliance::getCertificate(ComPtr<ICertificate> &aCertificateInfo)
536{
537 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
538
539 if (!i_isApplianceIdle())
540 return E_ACCESSDENIED;
541
542 /* Can be NULL at this point, queryInterfaceto handles that. */
543 m->ptrCertificateInfo.queryInterfaceTo(aCertificateInfo.asOutParam());
544 return S_OK;
545}
546
547/**
548 * Public method implementation.
549 */
550HRESULT Appliance::getVirtualSystemDescriptions(std::vector<ComPtr<IVirtualSystemDescription> > &aVirtualSystemDescriptions)
551{
552 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
553
554 if (!i_isApplianceIdle())
555 return E_ACCESSDENIED;
556
557 aVirtualSystemDescriptions.resize(m->virtualSystemDescriptions.size());
558 std::list< ComObjPtr<VirtualSystemDescription> > vsds(m->virtualSystemDescriptions);
559 size_t i = 0;
560 for (std::list< ComObjPtr<VirtualSystemDescription> >::iterator it = vsds.begin(); it != vsds.end(); ++it, ++i)
561 {
562 (*it).queryInterfaceTo(aVirtualSystemDescriptions[i].asOutParam());
563 }
564 return S_OK;
565}
566
567/**
568 * Public method implementation.
569 */
570HRESULT Appliance::getMachines(std::vector<com::Utf8Str> &aMachines)
571{
572 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
573
574 if (!i_isApplianceIdle())
575 return E_ACCESSDENIED;
576
577 aMachines.resize(m->llGuidsMachinesCreated.size());
578 size_t i = 0;
579 for (std::list<Guid>::const_iterator it = m->llGuidsMachinesCreated.begin();
580 it != m->llGuidsMachinesCreated.end();
581 ++it, ++i)
582 {
583 const Guid &uuid = *it;
584 aMachines[i] = uuid.toUtf16();
585 }
586 return S_OK;
587}
588
589HRESULT Appliance::createVFSExplorer(const com::Utf8Str &aURI, ComPtr<IVFSExplorer> &aExplorer)
590{
591 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
592
593 ComObjPtr<VFSExplorer> explorer;
594 HRESULT rc = S_OK;
595 try
596 {
597 Utf8Str uri(aURI);
598 /* Check which kind of export the user has requested */
599 LocationInfo li;
600 i_parseURI(aURI, li);
601 /* Create the explorer object */
602 explorer.createObject();
603 rc = explorer->init(li.storageType, li.strPath, li.strHostname, li.strUsername, li.strPassword, mVirtualBox);
604 }
605 catch (HRESULT aRC)
606 {
607 rc = aRC;
608 }
609
610 if (SUCCEEDED(rc))
611 /* Return explorer to the caller */
612 explorer.queryInterfaceTo(aExplorer.asOutParam());
613
614 return rc;
615}
616
617
618/**
619 * Public method implementation.
620 * Add the "aRequested" numbers of new empty objects of VSD into the list
621 * "virtualSystemDescriptions".
622 * The parameter "aCreated" keeps the actual number of the added objects.
623 * In case of exception all added objects are removed from the list.
624 */
625HRESULT Appliance::createVirtualSystemDescriptions(ULONG aRequested, ULONG *aCreated)
626{
627 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
628
629 HRESULT rc = S_OK;
630 uint32_t lQuantity = aRequested;
631 uint32_t oldSize = m->virtualSystemDescriptions.size();
632 uint32_t i=0;
633
634 if (lQuantity < 1)
635 return setError(E_FAIL, tr("The number of VirtualSystemDescription objects must be at least 1 or more."));
636 try
637 {
638 for (; i<lQuantity; ++i)
639 {
640 ComObjPtr<VirtualSystemDescription> opVSD;
641 rc = opVSD.createObject();
642 if (SUCCEEDED(rc))
643 {
644 rc = opVSD->init();
645 if (SUCCEEDED(rc))
646 m->virtualSystemDescriptions.push_back(opVSD);
647 else
648 break;
649 }
650 else
651 break;
652 }
653
654 if (i<lQuantity)
655 LogRel(("Number of created VirtualSystemDescription objects is less than requested"
656 "(Requested %d, Created %d)",lQuantity, i));
657
658 *aCreated = i;
659 }
660 catch (HRESULT aRC)
661 {
662 for (; i>0; --i)
663 {
664 if (!m->virtualSystemDescriptions.empty())
665 m->virtualSystemDescriptions.pop_back();
666 else
667 break;
668 }
669 rc = aRC;
670 }
671
672 return rc;
673}
674
675/**
676 * Public method implementation.
677 */
678HRESULT Appliance::getWarnings(std::vector<com::Utf8Str> &aWarnings)
679{
680 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
681
682 aWarnings.resize(m->llWarnings.size());
683
684 list<Utf8Str>::const_iterator it;
685 size_t i = 0;
686 for (it = m->llWarnings.begin();
687 it != m->llWarnings.end();
688 ++it, ++i)
689 {
690 aWarnings[i] = *it;
691 }
692
693 return S_OK;
694}
695
696HRESULT Appliance::getPasswordIds(std::vector<com::Utf8Str> &aIdentifiers)
697{
698 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
699
700 aIdentifiers = m->m_vecPasswordIdentifiers;
701 return S_OK;
702}
703
704HRESULT Appliance::getMediumIdsForPasswordId(const com::Utf8Str &aPasswordId, std::vector<com::Guid> &aIdentifiers)
705{
706 HRESULT hrc = S_OK;
707 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
708
709 std::map<com::Utf8Str, GUIDVEC>::const_iterator it = m->m_mapPwIdToMediumIds.find(aPasswordId);
710 if (it != m->m_mapPwIdToMediumIds.end())
711 aIdentifiers = it->second;
712 else
713 hrc = setError(E_FAIL, tr("The given password identifier is not associated with any medium"));
714
715 return hrc;
716}
717
718HRESULT Appliance::addPasswords(const std::vector<com::Utf8Str> &aIdentifiers,
719 const std::vector<com::Utf8Str> &aPasswords)
720{
721 HRESULT hrc = S_OK;
722
723 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
724
725 /* Check that the IDs do not exist already before changing anything. */
726 for (unsigned i = 0; i < aIdentifiers.size(); i++)
727 {
728 SecretKey *pKey = NULL;
729 int rc = m->m_pSecretKeyStore->retainSecretKey(aIdentifiers[i], &pKey);
730 if (rc != VERR_NOT_FOUND)
731 {
732 AssertPtr(pKey);
733 if (pKey)
734 pKey->release();
735 return setError(VBOX_E_OBJECT_IN_USE, tr("A password with the given ID already exists"));
736 }
737 }
738
739 for (unsigned i = 0; i < aIdentifiers.size() && SUCCEEDED(hrc); i++)
740 {
741 size_t cbKey = aPasswords[i].length() + 1; /* Include terminator */
742 const uint8_t *pbKey = (const uint8_t *)aPasswords[i].c_str();
743
744 int rc = m->m_pSecretKeyStore->addSecretKey(aIdentifiers[i], pbKey, cbKey);
745 if (RT_SUCCESS(rc))
746 m->m_cPwProvided++;
747 else if (rc == VERR_NO_MEMORY)
748 hrc = setError(E_OUTOFMEMORY, tr("Failed to allocate enough secure memory for the key"));
749 else
750 hrc = setError(E_FAIL, tr("Unknown error happened while adding a password (%Rrc)"), rc);
751 }
752
753 return hrc;
754}
755
756////////////////////////////////////////////////////////////////////////////////
757//
758// Appliance private methods
759//
760////////////////////////////////////////////////////////////////////////////////
761
762HRESULT Appliance::i_initBackendNames()
763{
764 HRESULT hrc = S_OK;
765 if (!g_fInitializedBackendNames)
766 {
767 /*
768 * Use the system properties to translate file extensions into
769 * storage backend names.
770 */
771 static struct
772 {
773 const char *pszExt; /**< extension */
774 char *pszBackendName;
775 size_t cbBackendName;
776 } const s_aFormats[] =
777 {
778 { "iso", g_szIsoBackend, sizeof(g_szIsoBackend) },
779 { "vmdk", g_szVmdkBackend, sizeof(g_szVmdkBackend) },
780 { "vhd", g_szVhdBackend, sizeof(g_szVhdBackend) },
781 };
782 SystemProperties *pSysProps = mVirtualBox->i_getSystemProperties();
783 for (unsigned i = 0; i < RT_ELEMENTS(s_aFormats); i++)
784 {
785 ComObjPtr<MediumFormat> trgFormat = pSysProps->i_mediumFormatFromExtension(s_aFormats[i].pszExt);
786 if (trgFormat.isNotNull())
787 {
788 const char *pszName = trgFormat->i_getName().c_str();
789 int vrc = RTStrCopy(s_aFormats[i].pszBackendName, s_aFormats[i].cbBackendName, pszName);
790 AssertRCStmt(vrc, hrc = setError(E_FAIL, "Unexpected storage backend name copy error %Rrc for %s.", vrc, pszName));
791 }
792 else
793 hrc = setError(E_FAIL, tr("Can't find appropriate medium format for ISO type of a virtual disk."));
794 }
795
796 if (SUCCEEDED(hrc))
797 g_fInitializedBackendNames = true;
798 }
799
800 return hrc;
801}
802
803Utf8Str Appliance::i_typeOfVirtualDiskFormatFromURI(Utf8Str uri) const
804{
805 Assert(g_fInitializedBackendNames);
806
807 unsigned i = RT_ELEMENTS(g_aUriToBackend);
808 while (i-- > 0)
809 if (RTStrICmp(g_aUriToBackend[i].pszUri, uri.c_str()) == 0)
810 return Utf8Str(g_aUriToBackend[i].pszBackend);
811 return Utf8Str();
812}
813
814#if 0 /* unused */
815std::set<Utf8Str> Appliance::i_URIFromTypeOfVirtualDiskFormat(Utf8Str type)
816{
817 Assert(g_fInitializedBackendNames);
818
819 std::set<Utf8Str> UriSet;
820 unsigned i = RT_ELEMENTS(g_aUriToBackend);
821 while (i-- > 0)
822 if (RTStrICmp(g_aUriToBackend[i].pszBackend, type.c_str()) == 0)
823 UriSet.insert(g_aUriToBackend[i].pszUri);
824 return UriSet;
825}
826#endif
827
828/**
829 * Returns a medium format object corresponding to the given
830 * disk image or null if no such format.
831 *
832 * @param di Disk Image
833 * @param mf Medium Format
834 *
835 * @return ComObjPtr<MediumFormat>
836 */
837HRESULT Appliance::i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf)
838{
839 HRESULT rc = S_OK;
840
841 /* Get the system properties. */
842 SystemProperties *pSysProps = mVirtualBox->i_getSystemProperties();
843
844 /* We need a proper source format description */
845 /* Which format to use? */
846 Utf8Str strSrcFormat = i_typeOfVirtualDiskFormatFromURI(di.strFormat);
847
848 /*
849 * fallback, if we can't determine virtual disk format using URI from the attribute ovf:format
850 * in the corresponding section <Disk> in the OVF file.
851 */
852 if (strSrcFormat.isEmpty())
853 {
854 strSrcFormat = di.strHref;
855
856 /* check either file gzipped or not
857 * if "yes" then remove last extension,
858 * i.e. "image.vmdk.gz"->"image.vmdk"
859 */
860 if (di.strCompression == "gzip")
861 {
862 if (RTPathHasSuffix(strSrcFormat.c_str()))
863 {
864 strSrcFormat.stripSuffix();
865 }
866 else
867 {
868 mf.setNull();
869 rc = setError(E_FAIL,
870 tr("Internal inconsistency looking up medium format for the disk image '%s'"),
871 di.strHref.c_str());
872 return rc;
873 }
874 }
875 /* Figure out from extension which format the image of disk has. */
876 if (RTPathHasSuffix(strSrcFormat.c_str()))
877 {
878 const char *pszExt = RTPathSuffix(strSrcFormat.c_str());
879 if (pszExt)
880 pszExt++;
881 mf = pSysProps->i_mediumFormatFromExtension(pszExt);
882 }
883 else
884 mf.setNull();
885 }
886 else
887 mf = pSysProps->i_mediumFormat(strSrcFormat);
888
889 if (mf.isNull())
890 rc = setError(E_FAIL, tr("Internal inconsistency looking up medium format for the disk image '%s'"),
891 di.strHref.c_str());
892
893 return rc;
894}
895
896/**
897 * Setup automatic I/O stream digest calculation, adding it to hOurManifest.
898 *
899 * @returns Passthru I/O stream, of @a hVfsIos if no digest calc needed.
900 * @param hVfsIos The stream to wrap. Always consumed.
901 * @param pszManifestEntry The manifest entry.
902 * @param fRead Set if read stream, clear if write.
903 * @throws Nothing.
904 */
905RTVFSIOSTREAM Appliance::i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
906 bool fRead /*= true */)
907{
908 int vrc;
909 Assert(!RTManifestPtIosIsInstanceOf(hVfsIos));
910
911 if (m->fDigestTypes == 0)
912 return hVfsIos;
913
914 /* Create the manifest if necessary. */
915 if (m->hOurManifest == NIL_RTMANIFEST)
916 {
917 vrc = RTManifestCreate(0 /*fFlags*/, &m->hOurManifest);
918 AssertRCReturnStmt(vrc, RTVfsIoStrmRelease(hVfsIos), NIL_RTVFSIOSTREAM);
919 }
920
921 /* Setup the stream. */
922 RTVFSIOSTREAM hVfsIosPt;
923 vrc = RTManifestEntryAddPassthruIoStream(m->hOurManifest, hVfsIos, pszManifestEntry, m->fDigestTypes, fRead, &hVfsIosPt);
924
925 RTVfsIoStrmRelease(hVfsIos); /* always consumed! */
926 if (RT_SUCCESS(vrc))
927 return hVfsIosPt;
928
929 setErrorVrc(vrc, "RTManifestEntryAddPassthruIoStream failed with rc=%Rrc", vrc);
930 return NIL_RTVFSIOSTREAM;
931}
932
933/**
934 * Returns true if the appliance is in "idle" state. This should always be the
935 * case unless an import or export is currently in progress. Similar to machine
936 * states, this permits the Appliance implementation code to let go of the
937 * Appliance object lock while a time-consuming disk conversion is in progress
938 * without exposing the appliance to conflicting calls.
939 *
940 * This sets an error on "this" (the appliance) and returns false if the appliance
941 * is busy. The caller should then return E_ACCESSDENIED.
942 *
943 * Must be called from under the object lock!
944 */
945bool Appliance::i_isApplianceIdle()
946{
947 if (m->state == Data::ApplianceImporting)
948 setError(VBOX_E_INVALID_OBJECT_STATE, tr("The appliance is busy importing files"));
949 else if (m->state == Data::ApplianceExporting)
950 setError(VBOX_E_INVALID_OBJECT_STATE, tr("The appliance is busy exporting files"));
951 else
952 return true;
953
954 return false;
955}
956
957HRESULT Appliance::i_searchUniqueVMName(Utf8Str& aName) const
958{
959 IMachine *machine = NULL;
960 char *tmpName = RTStrDup(aName.c_str());
961 int i = 1;
962 while (mVirtualBox->FindMachine(Bstr(tmpName).raw(), &machine) != VBOX_E_OBJECT_NOT_FOUND)
963 {
964 RTStrFree(tmpName);
965 RTStrAPrintf(&tmpName, "%s %d", aName.c_str(), i);
966 ++i;
967 }
968 aName = tmpName;
969 RTStrFree(tmpName);
970
971 return S_OK;
972}
973
974HRESULT Appliance::i_searchUniqueImageFilePath(const Utf8Str &aMachineFolder, DeviceType_T aDeviceType, Utf8Str &aName) const
975{
976 /*
977 * Check if the file exists or if a medium with this path is registered already
978 */
979 Utf8Str strAbsName;
980 ssize_t offDashNum = -1;
981 ssize_t cchDashNum = 0;
982 for (unsigned i = 1;; i++)
983 {
984 /* Complete the path (could be relative to machine folder). */
985 int rc = RTPathAbsExCxx(strAbsName, aMachineFolder, aName);
986 AssertRCReturn(rc, Global::vboxStatusCodeToCOM(rc)); /** @todo stupid caller ignores this */
987
988 /* Check that the file does not exist and that there is no media somehow matching the name. */
989 if (!RTPathExists(strAbsName.c_str()))
990 {
991 ComPtr<IMedium> ptrMedium;
992 HRESULT hrc = mVirtualBox->OpenMedium(Bstr(strAbsName).raw(), aDeviceType, AccessMode_ReadWrite,
993 FALSE /* fForceNewUuid */, ptrMedium.asOutParam());
994 if (hrc == VBOX_E_OBJECT_NOT_FOUND)
995 return S_OK;
996 }
997
998 /* Insert '_%i' before the suffix and try again. */
999 if (offDashNum < 0)
1000 {
1001 const char *pszSuffix = RTPathSuffix(aName.c_str());
1002 offDashNum = pszSuffix ? pszSuffix - aName.c_str() : aName.length();
1003 }
1004 char szTmp[32];
1005 size_t cchTmp = RTStrPrintf(szTmp, sizeof(szTmp), "_%u", i);
1006 aName.replace(offDashNum, cchDashNum, szTmp, cchTmp);
1007 cchDashNum = cchTmp;
1008 }
1009}
1010
1011/**
1012 * Called from Appliance::importImpl() and Appliance::writeImpl() to set up a
1013 * progress object with the proper weights and maximum progress values.
1014 */
1015HRESULT Appliance::i_setUpProgress(ComObjPtr<Progress> &pProgress,
1016 const Utf8Str &strDescription,
1017 SetUpProgressMode mode)
1018{
1019 HRESULT rc;
1020
1021 /* Create the progress object */
1022 pProgress.createObject();
1023
1024 // compute the disks weight (this sets ulTotalDisksMB and cDisks in the instance data)
1025 i_disksWeight();
1026
1027 m->ulWeightForManifestOperation = 0;
1028
1029 ULONG cOperations;
1030 ULONG ulTotalOperationsWeight;
1031
1032 cOperations = 1 // one for XML setup
1033 + m->cDisks; // plus one per disk
1034 if (m->ulTotalDisksMB)
1035 {
1036 m->ulWeightForXmlOperation = (ULONG)((double)m->ulTotalDisksMB * 1 / 100); // use 1% of the progress for the XML
1037 ulTotalOperationsWeight = m->ulTotalDisksMB + m->ulWeightForXmlOperation;
1038 }
1039 else
1040 {
1041 // no disks to export:
1042 m->ulWeightForXmlOperation = 1;
1043 ulTotalOperationsWeight = 1;
1044 }
1045
1046 switch (mode)
1047 {
1048 case ImportFile:
1049 {
1050 break;
1051 }
1052 case WriteFile:
1053 {
1054 // assume that creating the manifest will take .1% of the time it takes to export the disks
1055 if (m->fManifest)
1056 {
1057 ++cOperations; // another one for creating the manifest
1058
1059 m->ulWeightForManifestOperation = (ULONG)((double)m->ulTotalDisksMB * .1 / 100); // use .5% of the
1060 // progress for the manifest
1061 ulTotalOperationsWeight += m->ulWeightForManifestOperation;
1062 }
1063 break;
1064 }
1065 case ImportS3:
1066 {
1067 cOperations += 1 + 1; // another one for the manifest file & another one for the import
1068 ulTotalOperationsWeight = m->ulTotalDisksMB;
1069 if (!m->ulTotalDisksMB)
1070 // no disks to export:
1071 ulTotalOperationsWeight = 1;
1072
1073 ULONG ulImportWeight = (ULONG)((double)ulTotalOperationsWeight * 50 / 100); // use 50% for import
1074 ulTotalOperationsWeight += ulImportWeight;
1075
1076 m->ulWeightForXmlOperation = ulImportWeight; /* save for using later */
1077
1078 ULONG ulInitWeight = (ULONG)((double)ulTotalOperationsWeight * 0.1 / 100); // use 0.1% for init
1079 ulTotalOperationsWeight += ulInitWeight;
1080 break;
1081 }
1082 case WriteS3:
1083 {
1084 cOperations += 1 + 1; // another one for the mf & another one for temporary creation
1085
1086 if (m->ulTotalDisksMB)
1087 {
1088 m->ulWeightForXmlOperation = (ULONG)((double)m->ulTotalDisksMB * 1 / 100); // use 1% of the progress
1089 // for OVF file upload
1090 // (we didn't know the
1091 // size at this point)
1092 ulTotalOperationsWeight = m->ulTotalDisksMB + m->ulWeightForXmlOperation;
1093 }
1094 else
1095 {
1096 // no disks to export:
1097 ulTotalOperationsWeight = 1;
1098 m->ulWeightForXmlOperation = 1;
1099 }
1100 ULONG ulOVFCreationWeight = (ULONG)((double)ulTotalOperationsWeight * 50.0 / 100.0); /* Use 50% for the
1101 creation of the OVF
1102 & the disks */
1103 ulTotalOperationsWeight += ulOVFCreationWeight;
1104 break;
1105 }
1106 case ExportCloud:
1107 cOperations = 1 + 9;//7
1108 ulTotalOperationsWeight = 100*cOperations;
1109 m->ulWeightForXmlOperation = 100;
1110 break;
1111 }
1112 Log(("Setting up progress object: ulTotalMB = %d, cDisks = %d, => cOperations = %d, ulTotalOperationsWeight = %d, m->ulWeightForXmlOperation = %d\n",
1113 m->ulTotalDisksMB, m->cDisks, cOperations, ulTotalOperationsWeight, m->ulWeightForXmlOperation));
1114
1115 rc = pProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
1116 Bstr(strDescription).raw(),
1117 TRUE /* aCancelable */,
1118 cOperations, // ULONG cOperations,
1119 ulTotalOperationsWeight, // ULONG ulTotalOperationsWeight,
1120 Bstr(strDescription).raw(), // CBSTR bstrFirstOperationDescription,
1121 m->ulWeightForXmlOperation); // ULONG ulFirstOperationWeight,
1122 return rc;
1123}
1124
1125void Appliance::i_addWarning(const char* aWarning, ...)
1126{
1127 try
1128 {
1129 va_list args;
1130 va_start(args, aWarning);
1131 Utf8Str str(aWarning, args);
1132 va_end(args);
1133 m->llWarnings.push_back(str);
1134 }
1135 catch (...)
1136 {
1137 AssertFailed();
1138 }
1139}
1140
1141/**
1142 * Refreshes the cDisks and ulTotalDisksMB members in the instance data.
1143 * Requires that virtual system descriptions are present.
1144 */
1145void Appliance::i_disksWeight()
1146{
1147 m->ulTotalDisksMB = 0;
1148 m->cDisks = 0;
1149 // weigh the disk images according to their sizes
1150 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
1151 for (it = m->virtualSystemDescriptions.begin();
1152 it != m->virtualSystemDescriptions.end();
1153 ++it)
1154 {
1155 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
1156 /* One for every medium of the Virtual System */
1157 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskImage);
1158 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
1159 for (itH = avsdeHDs.begin();
1160 itH != avsdeHDs.end();
1161 ++itH)
1162 {
1163 const VirtualSystemDescriptionEntry *pHD = *itH;
1164 m->ulTotalDisksMB += pHD->ulSizeMB;
1165 ++m->cDisks;
1166 }
1167
1168 avsdeHDs = vsdescThis->i_findByType(VirtualSystemDescriptionType_CDROM);
1169 for (itH = avsdeHDs.begin();
1170 itH != avsdeHDs.end();
1171 ++itH)
1172 {
1173 const VirtualSystemDescriptionEntry *pHD = *itH;
1174 m->ulTotalDisksMB += pHD->ulSizeMB;
1175 ++m->cDisks;
1176 }
1177 }
1178
1179}
1180
1181void Appliance::i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket)
1182{
1183 /* Buckets are S3 specific. So parse the bucket out of the file path */
1184 if (!aPath.startsWith("/"))
1185 throw setError(E_INVALIDARG,
1186 tr("The path '%s' must start with /"), aPath.c_str());
1187 size_t bpos = aPath.find("/", 1);
1188 if (bpos != Utf8Str::npos)
1189 {
1190 aBucket = aPath.substr(1, bpos - 1); /* The bucket without any slashes */
1191 aPath = aPath.substr(bpos); /* The rest of the file path */
1192 }
1193 /* If there is no bucket name provided reject it */
1194 if (aBucket.isEmpty())
1195 throw setError(E_INVALIDARG,
1196 tr("You doesn't provide a bucket name in the URI '%s'"), aPath.c_str());
1197}
1198
1199/**
1200 * Worker for TaskOVF::handler.
1201 *
1202 * The TaskOVF is started in Appliance::readImpl() and Appliance::importImpl()
1203 * and Appliance::writeImpl().
1204 *
1205 * This will in turn call Appliance::readFS() or Appliance::importFS() or
1206 * Appliance::writeFS().
1207 *
1208 * @thread pTask The task.
1209 */
1210/* static */ void Appliance::i_importOrExportThreadTask(TaskOVF *pTask)
1211{
1212 LogFlowFuncEnter();
1213 AssertReturnVoid(pTask);
1214
1215 Appliance *pAppliance = pTask->pAppliance;
1216 LogFlowFunc(("Appliance %p taskType=%d\n", pAppliance, pTask->taskType));
1217
1218 switch (pTask->taskType)
1219 {
1220 case TaskOVF::Read:
1221 pAppliance->m->resetReadData();
1222 if (pTask->locInfo.storageType == VFSType_File)
1223 pTask->rc = pAppliance->i_readFS(pTask);
1224 else
1225 pTask->rc = E_NOTIMPL;
1226 break;
1227
1228 case TaskOVF::Import:
1229 /** @todo allow overriding these? */
1230 if (!pAppliance->m->fSignatureValid && pAppliance->m->pbSignedDigest)
1231 pTask->rc = pAppliance->setError(E_FAIL, tr("The manifest signature for '%s' is not valid"),
1232 pTask->locInfo.strPath.c_str());
1233 else if (!pAppliance->m->fCertificateValid && pAppliance->m->pbSignedDigest)
1234 {
1235 if (pAppliance->m->strCertError.isNotEmpty())
1236 pTask->rc = pAppliance->setError(E_FAIL, tr("The certificate used to signed '%s' is not valid: %s"),
1237 pTask->locInfo.strPath.c_str(), pAppliance->m->strCertError.c_str());
1238 else
1239 pTask->rc = pAppliance->setError(E_FAIL, tr("The certificate used to signed '%s' is not valid"),
1240 pTask->locInfo.strPath.c_str());
1241 }
1242 // fusion does not consider this a show stopper (we've filed a warning during read).
1243 //else if (pAppliance->m->fCertificateMissingPath && pAppliance->m->pbSignedDigest)
1244 // pTask->rc = pAppliance->setError(E_FAIL, tr("The certificate used to signed '%s' is does not have a valid CA path"),
1245 // pTask->locInfo.strPath.c_str());
1246 else
1247 {
1248 if (pTask->locInfo.storageType == VFSType_File)
1249 pTask->rc = pAppliance->i_importFS(pTask);
1250 else
1251 pTask->rc = E_NOTIMPL;
1252 }
1253 break;
1254
1255 case TaskOVF::Write:
1256 if (pTask->locInfo.storageType == VFSType_File)
1257 pTask->rc = pAppliance->i_writeFS(pTask);
1258 else
1259 pTask->rc = E_NOTIMPL;
1260 break;
1261
1262 default:
1263 AssertFailed();
1264 pTask->rc = E_FAIL;
1265 break;
1266 }
1267
1268 if (!pTask->pProgress.isNull())
1269 pTask->pProgress->i_notifyComplete(pTask->rc);
1270
1271 LogFlowFuncLeave();
1272}
1273
1274/* static */ DECLCALLBACK(int) Appliance::TaskOVF::updateProgress(unsigned uPercent, void *pvUser)
1275{
1276 Appliance::TaskOVF* pTask = *(Appliance::TaskOVF**)pvUser;
1277
1278 if ( pTask
1279 && !pTask->pProgress.isNull())
1280 {
1281 BOOL fCanceled;
1282 pTask->pProgress->COMGETTER(Canceled)(&fCanceled);
1283 if (fCanceled)
1284 return -1;
1285 pTask->pProgress->SetCurrentOperationProgress(uPercent);
1286 }
1287 return VINF_SUCCESS;
1288}
1289
1290/**
1291 * Worker for TaskOPC::handler.
1292 * @thread pTask The task.
1293 */
1294/* static */
1295void Appliance::i_exportOPCThreadTask(TaskOPC *pTask)
1296{
1297 LogFlowFuncEnter();
1298 AssertReturnVoid(pTask);
1299
1300 Appliance *pAppliance = pTask->pAppliance;
1301 LogFlowFunc(("Appliance %p taskType=%d\n", pAppliance, pTask->taskType));
1302
1303 switch (pTask->taskType)
1304 {
1305 case TaskOPC::Export:
1306 pTask->rc = pAppliance->i_writeFSOPC(pTask);
1307 break;
1308
1309 default:
1310 AssertFailed();
1311 pTask->rc = E_FAIL;
1312 break;
1313 }
1314
1315 if (!pTask->pProgress.isNull())
1316 pTask->pProgress->i_notifyComplete(pTask->rc);
1317
1318 LogFlowFuncLeave();
1319}
1320
1321/* static */
1322DECLCALLBACK(int) Appliance::TaskOPC::updateProgress(unsigned uPercent, void *pvUser)
1323{
1324 Appliance::TaskOPC* pTask = *(Appliance::TaskOPC**)pvUser;
1325
1326 if ( pTask
1327 && !pTask->pProgress.isNull())
1328 {
1329 BOOL fCanceled;
1330 pTask->pProgress->COMGETTER(Canceled)(&fCanceled);
1331 if (fCanceled)
1332 return -1;
1333 pTask->pProgress->SetCurrentOperationProgress(uPercent);
1334 }
1335 return VINF_SUCCESS;
1336}
1337
1338/**
1339 * Worker for TaskCloud::handler.
1340 * @thread pTask The task.
1341 */
1342/* static */
1343void Appliance::i_exportCloudThreadTask(TaskCloud *pTask)
1344{
1345 LogFlowFuncEnter();
1346 AssertReturnVoid(pTask);
1347
1348 Appliance *pAppliance = pTask->pAppliance;
1349 LogFlowFunc(("Appliance %p taskType=%d\n", pAppliance, pTask->taskType));
1350
1351 switch (pTask->taskType)
1352 {
1353 case TaskCloud::Export:
1354 pTask->rc = pAppliance->i_writeFSCloud(pTask);
1355 break;
1356
1357 default:
1358 AssertFailed();
1359 pTask->rc = E_FAIL;
1360 break;
1361 }
1362
1363 if (!pTask->pProgress.isNull())
1364 pTask->pProgress->i_notifyComplete(pTask->rc);
1365
1366 LogFlowFuncLeave();
1367}
1368
1369/* static */
1370DECLCALLBACK(int) Appliance::TaskCloud::updateProgress(unsigned uPercent, void *pvUser)
1371{
1372 Appliance::TaskCloud* pTask = *(Appliance::TaskCloud**)pvUser;
1373
1374 if ( pTask
1375 && !pTask->pProgress.isNull())
1376 {
1377 BOOL fCanceled;
1378 pTask->pProgress->COMGETTER(Canceled)(&fCanceled);
1379 if (fCanceled)
1380 return -1;
1381 pTask->pProgress->SetCurrentOperationProgress(uPercent);
1382 }
1383 return VINF_SUCCESS;
1384}
1385
1386void i_parseURI(Utf8Str strUri, LocationInfo &locInfo)
1387{
1388 /* Check the URI for the protocol */
1389 if (strUri.startsWith("file://", Utf8Str::CaseInsensitive)) /* File based */
1390 {
1391 locInfo.storageType = VFSType_File;
1392 strUri = strUri.substr(sizeof("file://") - 1);
1393 }
1394 else if (strUri.startsWith("SunCloud://", Utf8Str::CaseInsensitive)) /* Sun Cloud service */
1395 {
1396 locInfo.storageType = VFSType_S3;
1397 strUri = strUri.substr(sizeof("SunCloud://") - 1);
1398 }
1399 else if (strUri.startsWith("S3://", Utf8Str::CaseInsensitive)) /* S3 service */
1400 {
1401 locInfo.storageType = VFSType_S3;
1402 strUri = strUri.substr(sizeof("S3://") - 1);
1403 }
1404 else if (strUri.startsWith("OCI://", Utf8Str::CaseInsensitive)) /* OCI service (storage or compute) */
1405 {
1406 locInfo.storageType = VFSType_Cloud;
1407 locInfo.strProvider = "OCI";
1408 strUri = strUri.substr(sizeof("OCI://") - 1);
1409 }
1410 else if (strUri.startsWith("webdav://", Utf8Str::CaseInsensitive)) /* webdav service */
1411 throw E_NOTIMPL;
1412
1413 /* Not necessary on a file based URI */
1414 if (locInfo.storageType != VFSType_File)
1415 {
1416 size_t uppos = strUri.find("@"); /* username:password combo */
1417 if (uppos != Utf8Str::npos)
1418 {
1419 locInfo.strUsername = strUri.substr(0, uppos);
1420 strUri = strUri.substr(uppos + 1);
1421 size_t upos = locInfo.strUsername.find(":");
1422 if (upos != Utf8Str::npos)
1423 {
1424 locInfo.strPassword = locInfo.strUsername.substr(upos + 1);
1425 locInfo.strUsername = locInfo.strUsername.substr(0, upos);
1426 }
1427 }
1428 size_t hpos = strUri.find("/"); /* hostname part */
1429 if (hpos != Utf8Str::npos)
1430 {
1431 locInfo.strHostname = strUri.substr(0, hpos);
1432 strUri = strUri.substr(hpos);
1433 }
1434 }
1435
1436 locInfo.strPath = strUri;
1437}
1438
1439
1440////////////////////////////////////////////////////////////////////////////////
1441//
1442// IVirtualSystemDescription constructor / destructor
1443//
1444////////////////////////////////////////////////////////////////////////////////
1445
1446/**
1447 * COM initializer.
1448 * @return
1449 */
1450HRESULT VirtualSystemDescription::init()
1451{
1452 /* Enclose the state transition NotReady->InInit->Ready */
1453 AutoInitSpan autoInitSpan(this);
1454 AssertReturn(autoInitSpan.isOk(), E_FAIL);
1455
1456 /* Initialize data */
1457 m = new Data();
1458 m->pConfig = NULL;
1459
1460 /* Confirm a successful initialization */
1461 autoInitSpan.setSucceeded();
1462 return S_OK;
1463}
1464
1465/**
1466* COM uninitializer.
1467*/
1468
1469void VirtualSystemDescription::uninit()
1470{
1471 if (m->pConfig)
1472 delete m->pConfig;
1473 delete m;
1474 m = NULL;
1475}
1476
1477
1478////////////////////////////////////////////////////////////////////////////////
1479//
1480// IVirtualSystemDescription public methods
1481//
1482////////////////////////////////////////////////////////////////////////////////
1483
1484/**
1485 * Public method implementation.
1486 */
1487HRESULT VirtualSystemDescription::getCount(ULONG *aCount)
1488{
1489 if (!aCount)
1490 return E_POINTER;
1491
1492 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1493
1494 *aCount = (ULONG)m->maDescriptions.size();
1495 return S_OK;
1496}
1497
1498/**
1499 * Public method implementation.
1500 */
1501HRESULT VirtualSystemDescription::getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
1502 std::vector<com::Utf8Str> &aRefs,
1503 std::vector<com::Utf8Str> &aOVFValues,
1504 std::vector<com::Utf8Str> &aVBoxValues,
1505 std::vector<com::Utf8Str> &aExtraConfigValues)
1506
1507{
1508 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1509 size_t c = m->maDescriptions.size();
1510 aTypes.resize(c);
1511 aRefs.resize(c);
1512 aOVFValues.resize(c);
1513 aVBoxValues.resize(c);
1514 aExtraConfigValues.resize(c);
1515
1516 for (size_t i = 0; i < c; i++)
1517 {
1518 const VirtualSystemDescriptionEntry &vsde = m->maDescriptions[i];
1519 aTypes[i] = vsde.type;
1520 aRefs[i] = vsde.strRef;
1521 aOVFValues[i] = vsde.strOvf;
1522 aVBoxValues[i] = vsde.strVBoxCurrent;
1523 aExtraConfigValues[i] = vsde.strExtraConfigCurrent;
1524 }
1525 return S_OK;
1526}
1527
1528/**
1529 * Public method implementation.
1530 */
1531HRESULT VirtualSystemDescription::getDescriptionByType(VirtualSystemDescriptionType_T aType,
1532 std::vector<VirtualSystemDescriptionType_T> &aTypes,
1533 std::vector<com::Utf8Str> &aRefs,
1534 std::vector<com::Utf8Str> &aOVFValues,
1535 std::vector<com::Utf8Str> &aVBoxValues,
1536 std::vector<com::Utf8Str> &aExtraConfigValues)
1537{
1538 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1539 std::list<VirtualSystemDescriptionEntry*> vsd = i_findByType(aType);
1540
1541 size_t c = vsd.size();
1542 aTypes.resize(c);
1543 aRefs.resize(c);
1544 aOVFValues.resize(c);
1545 aVBoxValues.resize(c);
1546 aExtraConfigValues.resize(c);
1547
1548 size_t i = 0;
1549 for (list<VirtualSystemDescriptionEntry*>::const_iterator it = vsd.begin(); it != vsd.end(); ++it, ++i)
1550 {
1551 const VirtualSystemDescriptionEntry *vsde = (*it);
1552 aTypes[i] = vsde->type;
1553 aRefs[i] = vsde->strRef;
1554 aOVFValues[i] = vsde->strOvf;
1555 aVBoxValues[i] = vsde->strVBoxCurrent;
1556 aExtraConfigValues[i] = vsde->strExtraConfigCurrent;
1557 }
1558
1559 return S_OK;
1560}
1561
1562/**
1563 * Public method implementation.
1564 */
1565HRESULT VirtualSystemDescription::getValuesByType(VirtualSystemDescriptionType_T aType,
1566 VirtualSystemDescriptionValueType_T aWhich,
1567 std::vector<com::Utf8Str> &aValues)
1568{
1569 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1570
1571 std::list<VirtualSystemDescriptionEntry*> vsd = i_findByType (aType);
1572 aValues.resize((ULONG)vsd.size());
1573
1574 list<VirtualSystemDescriptionEntry*>::const_iterator it;
1575 size_t i = 0;
1576 for (it = vsd.begin();
1577 it != vsd.end();
1578 ++it, ++i)
1579 {
1580 const VirtualSystemDescriptionEntry *vsde = (*it);
1581
1582 Bstr bstr;
1583 switch (aWhich)
1584 {
1585 case VirtualSystemDescriptionValueType_Reference: aValues[i] = vsde->strRef; break;
1586 case VirtualSystemDescriptionValueType_Original: aValues[i] = vsde->strOvf; break;
1587 case VirtualSystemDescriptionValueType_Auto: aValues[i] = vsde->strVBoxCurrent; break;
1588 case VirtualSystemDescriptionValueType_ExtraConfig: aValues[i] = vsde->strExtraConfigCurrent; break;
1589#ifdef VBOX_WITH_XPCOM_CPP_ENUM_HACK
1590 case VirtualSystemDescriptionValueType_32BitHack: AssertFailedBreak(); /* (compiler warnings) */
1591#endif
1592 }
1593 }
1594
1595 return S_OK;
1596}
1597
1598/**
1599 * Public method implementation.
1600 */
1601HRESULT VirtualSystemDescription::setFinalValues(const std::vector<BOOL> &aEnabled,
1602 const std::vector<com::Utf8Str> &aVBoxValues,
1603 const std::vector<com::Utf8Str> &aExtraConfigValues)
1604{
1605#ifndef RT_OS_WINDOWS
1606 // NOREF(aEnabledSize);
1607#endif /* RT_OS_WINDOWS */
1608 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1609
1610 if ( (aEnabled.size() != m->maDescriptions.size())
1611 || (aVBoxValues.size() != m->maDescriptions.size())
1612 || (aExtraConfigValues.size() != m->maDescriptions.size())
1613 )
1614 return E_INVALIDARG;
1615
1616 size_t i = 0;
1617 for (vector<VirtualSystemDescriptionEntry>::iterator it = m->maDescriptions.begin();
1618 it != m->maDescriptions.end();
1619 ++it, ++i)
1620 {
1621 VirtualSystemDescriptionEntry& vsde = *it;
1622
1623 if (aEnabled[i])
1624 {
1625 vsde.strVBoxCurrent = aVBoxValues[i];
1626 vsde.strExtraConfigCurrent = aExtraConfigValues[i];
1627 }
1628 else
1629 vsde.type = VirtualSystemDescriptionType_Ignore;
1630 }
1631
1632 return S_OK;
1633}
1634
1635/**
1636 * Public method implementation.
1637 */
1638HRESULT VirtualSystemDescription::addDescription(VirtualSystemDescriptionType_T aType,
1639 const com::Utf8Str &aVBoxValue,
1640 const com::Utf8Str &aExtraConfigValue)
1641
1642{
1643 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1644 i_addEntry(aType, "", aVBoxValue, aVBoxValue, 0, aExtraConfigValue);
1645 return S_OK;
1646}
1647
1648/**
1649 * Internal method; adds a new description item to the member list.
1650 * @param aType Type of description for the new item.
1651 * @param strRef Reference item; only used with storage controllers.
1652 * @param aOvfValue Corresponding original value from OVF.
1653 * @param aVBoxValue Initial configuration value (can be overridden by caller with setFinalValues).
1654 * @param ulSizeMB Weight for IProgress
1655 * @param strExtraConfig Extra configuration; meaning dependent on type.
1656 */
1657void VirtualSystemDescription::i_addEntry(VirtualSystemDescriptionType_T aType,
1658 const Utf8Str &strRef,
1659 const Utf8Str &aOvfValue,
1660 const Utf8Str &aVBoxValue,
1661 uint32_t ulSizeMB,
1662 const Utf8Str &strExtraConfig /*= ""*/)
1663{
1664 VirtualSystemDescriptionEntry vsde;
1665 vsde.ulIndex = (uint32_t)m->maDescriptions.size(); // each entry gets an index so the client side can reference them
1666 vsde.type = aType;
1667 vsde.strRef = strRef;
1668 vsde.strOvf = aOvfValue;
1669 vsde.strVBoxSuggested /* remember original value */
1670 = vsde.strVBoxCurrent /* and set current value which can be overridden by setFinalValues() */
1671 = aVBoxValue;
1672 vsde.strExtraConfigSuggested
1673 = vsde.strExtraConfigCurrent
1674 = strExtraConfig;
1675 vsde.ulSizeMB = ulSizeMB;
1676
1677 vsde.skipIt = false;
1678
1679 m->maDescriptions.push_back(vsde);
1680}
1681
1682/**
1683 * Private method; returns a list of description items containing all the items from the member
1684 * description items of this virtual system that match the given type.
1685 */
1686std::list<VirtualSystemDescriptionEntry*> VirtualSystemDescription::i_findByType(VirtualSystemDescriptionType_T aType)
1687{
1688 std::list<VirtualSystemDescriptionEntry*> vsd;
1689 for (vector<VirtualSystemDescriptionEntry>::iterator it = m->maDescriptions.begin();
1690 it != m->maDescriptions.end();
1691 ++it)
1692 {
1693 if (it->type == aType)
1694 vsd.push_back(&(*it));
1695 }
1696
1697 return vsd;
1698}
1699
1700HRESULT VirtualSystemDescription::removeDescriptionByType(VirtualSystemDescriptionType_T aType)
1701{
1702 std::vector<VirtualSystemDescriptionEntry>::iterator it = m->maDescriptions.begin();
1703 while (it != m->maDescriptions.end())
1704 {
1705 if (it->type == aType)
1706 it = m->maDescriptions.erase(it);
1707 else
1708 ++it;
1709 }
1710
1711 return S_OK;
1712}
1713
1714/* Private method; delete all records from the list
1715 * m->llDescriptions that match the given type.
1716 */
1717void VirtualSystemDescription::i_removeByType(VirtualSystemDescriptionType_T aType)
1718{
1719 std::vector<VirtualSystemDescriptionEntry>::iterator it = m->maDescriptions.begin();
1720 while (it != m->maDescriptions.end())
1721 {
1722 if (it->type == aType)
1723 it = m->maDescriptions.erase(it);
1724 else
1725 ++it;
1726 }
1727}
1728
1729/**
1730 * Private method; looks thru the member hardware items for the IDE, SATA, or SCSI controller with
1731 * the given reference ID. Useful when needing the controller for a particular
1732 * virtual disk.
1733 */
1734const VirtualSystemDescriptionEntry* VirtualSystemDescription::i_findControllerFromID(uint32_t id)
1735{
1736 Utf8Str strRef = Utf8StrFmt("%RI32", id);
1737 vector<VirtualSystemDescriptionEntry>::const_iterator it;
1738 for (it = m->maDescriptions.begin();
1739 it != m->maDescriptions.end();
1740 ++it)
1741 {
1742 const VirtualSystemDescriptionEntry &d = *it;
1743 switch (d.type)
1744 {
1745 case VirtualSystemDescriptionType_HardDiskControllerIDE:
1746 case VirtualSystemDescriptionType_HardDiskControllerSATA:
1747 case VirtualSystemDescriptionType_HardDiskControllerSCSI:
1748 case VirtualSystemDescriptionType_HardDiskControllerSAS:
1749 if (d.strRef == strRef)
1750 return &d;
1751 break;
1752 default: break; /* Shut up MSC. */
1753 }
1754 }
1755
1756 return NULL;
1757}
1758
1759/**
1760 * Method called from Appliance::Interpret() if the source OVF for a virtual system
1761 * contains a <vbox:Machine> element. This method then attempts to parse that and
1762 * create a MachineConfigFile instance from it which is stored in this instance data
1763 * and can then be used to create a machine.
1764 *
1765 * This must only be called once per instance.
1766 *
1767 * This rethrows all XML and logic errors from MachineConfigFile.
1768 *
1769 * @param elmMachine <vbox:Machine> element with attributes and subelements from some
1770 * DOM tree.
1771 */
1772void VirtualSystemDescription::i_importVBoxMachineXML(const xml::ElementNode &elmMachine)
1773{
1774 settings::MachineConfigFile *pConfig = NULL;
1775
1776 Assert(m->pConfig == NULL);
1777
1778 try
1779 {
1780 pConfig = new settings::MachineConfigFile(NULL);
1781 pConfig->importMachineXML(elmMachine);
1782
1783 m->pConfig = pConfig;
1784 }
1785 catch (...)
1786 {
1787 if (pConfig)
1788 delete pConfig;
1789 throw;
1790 }
1791}
1792
1793/**
1794 * Returns the machine config created by importVBoxMachineXML() or NULL if there's none.
1795 */
1796const settings::MachineConfigFile* VirtualSystemDescription::i_getMachineConfig() const
1797{
1798 return m->pConfig;
1799}
1800
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