VirtualBox

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

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

bugref:9416. removed unused variable.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 62.7 KB
Line 
1/* $Id: ApplianceImpl.cpp 78256 2019-04-23 07:31:40Z 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.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
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 i=0;
632
633 if (lQuantity < 1)
634 return setError(E_FAIL, tr("The number of VirtualSystemDescription objects must be at least 1 or more."));
635 try
636 {
637 for (; i<lQuantity; ++i)
638 {
639 ComObjPtr<VirtualSystemDescription> opVSD;
640 rc = opVSD.createObject();
641 if (SUCCEEDED(rc))
642 {
643 rc = opVSD->init();
644 if (SUCCEEDED(rc))
645 m->virtualSystemDescriptions.push_back(opVSD);
646 else
647 break;
648 }
649 else
650 break;
651 }
652
653 if (i<lQuantity)
654 LogRel(("Number of created VirtualSystemDescription objects is less than requested"
655 "(Requested %d, Created %d)",lQuantity, i));
656
657 *aCreated = i;
658 }
659 catch (HRESULT aRC)
660 {
661 for (; i>0; --i)
662 {
663 if (!m->virtualSystemDescriptions.empty())
664 m->virtualSystemDescriptions.pop_back();
665 else
666 break;
667 }
668 rc = aRC;
669 }
670
671 return rc;
672}
673
674/**
675 * Public method implementation.
676 */
677HRESULT Appliance::getWarnings(std::vector<com::Utf8Str> &aWarnings)
678{
679 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
680
681 aWarnings.resize(m->llWarnings.size());
682
683 list<Utf8Str>::const_iterator it;
684 size_t i = 0;
685 for (it = m->llWarnings.begin();
686 it != m->llWarnings.end();
687 ++it, ++i)
688 {
689 aWarnings[i] = *it;
690 }
691
692 return S_OK;
693}
694
695HRESULT Appliance::getPasswordIds(std::vector<com::Utf8Str> &aIdentifiers)
696{
697 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
698
699 aIdentifiers = m->m_vecPasswordIdentifiers;
700 return S_OK;
701}
702
703HRESULT Appliance::getMediumIdsForPasswordId(const com::Utf8Str &aPasswordId, std::vector<com::Guid> &aIdentifiers)
704{
705 HRESULT hrc = S_OK;
706 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
707
708 std::map<com::Utf8Str, GUIDVEC>::const_iterator it = m->m_mapPwIdToMediumIds.find(aPasswordId);
709 if (it != m->m_mapPwIdToMediumIds.end())
710 aIdentifiers = it->second;
711 else
712 hrc = setError(E_FAIL, tr("The given password identifier is not associated with any medium"));
713
714 return hrc;
715}
716
717HRESULT Appliance::addPasswords(const std::vector<com::Utf8Str> &aIdentifiers,
718 const std::vector<com::Utf8Str> &aPasswords)
719{
720 HRESULT hrc = S_OK;
721
722 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
723
724 /* Check that the IDs do not exist already before changing anything. */
725 for (unsigned i = 0; i < aIdentifiers.size(); i++)
726 {
727 SecretKey *pKey = NULL;
728 int rc = m->m_pSecretKeyStore->retainSecretKey(aIdentifiers[i], &pKey);
729 if (rc != VERR_NOT_FOUND)
730 {
731 AssertPtr(pKey);
732 if (pKey)
733 pKey->release();
734 return setError(VBOX_E_OBJECT_IN_USE, tr("A password with the given ID already exists"));
735 }
736 }
737
738 for (unsigned i = 0; i < aIdentifiers.size() && SUCCEEDED(hrc); i++)
739 {
740 size_t cbKey = aPasswords[i].length() + 1; /* Include terminator */
741 const uint8_t *pbKey = (const uint8_t *)aPasswords[i].c_str();
742
743 int rc = m->m_pSecretKeyStore->addSecretKey(aIdentifiers[i], pbKey, cbKey);
744 if (RT_SUCCESS(rc))
745 m->m_cPwProvided++;
746 else if (rc == VERR_NO_MEMORY)
747 hrc = setError(E_OUTOFMEMORY, tr("Failed to allocate enough secure memory for the key"));
748 else
749 hrc = setError(E_FAIL, tr("Unknown error happened while adding a password (%Rrc)"), rc);
750 }
751
752 return hrc;
753}
754
755////////////////////////////////////////////////////////////////////////////////
756//
757// Appliance private methods
758//
759////////////////////////////////////////////////////////////////////////////////
760
761HRESULT Appliance::i_initBackendNames()
762{
763 HRESULT hrc = S_OK;
764 if (!g_fInitializedBackendNames)
765 {
766 /*
767 * Use the system properties to translate file extensions into
768 * storage backend names.
769 */
770 static struct
771 {
772 const char *pszExt; /**< extension */
773 char *pszBackendName;
774 size_t cbBackendName;
775 } const s_aFormats[] =
776 {
777 { "iso", g_szIsoBackend, sizeof(g_szIsoBackend) },
778 { "vmdk", g_szVmdkBackend, sizeof(g_szVmdkBackend) },
779 { "vhd", g_szVhdBackend, sizeof(g_szVhdBackend) },
780 };
781 SystemProperties *pSysProps = mVirtualBox->i_getSystemProperties();
782 for (unsigned i = 0; i < RT_ELEMENTS(s_aFormats); i++)
783 {
784 ComObjPtr<MediumFormat> trgFormat = pSysProps->i_mediumFormatFromExtension(s_aFormats[i].pszExt);
785 if (trgFormat.isNotNull())
786 {
787 const char *pszName = trgFormat->i_getName().c_str();
788 int vrc = RTStrCopy(s_aFormats[i].pszBackendName, s_aFormats[i].cbBackendName, pszName);
789 AssertRCStmt(vrc, hrc = setError(E_FAIL, "Unexpected storage backend name copy error %Rrc for %s.", vrc, pszName));
790 }
791 else
792 hrc = setError(E_FAIL, tr("Can't find appropriate medium format for ISO type of a virtual disk."));
793 }
794
795 if (SUCCEEDED(hrc))
796 g_fInitializedBackendNames = true;
797 }
798
799 return hrc;
800}
801
802Utf8Str Appliance::i_typeOfVirtualDiskFormatFromURI(Utf8Str uri) const
803{
804 Assert(g_fInitializedBackendNames);
805
806 unsigned i = RT_ELEMENTS(g_aUriToBackend);
807 while (i-- > 0)
808 if (RTStrICmp(g_aUriToBackend[i].pszUri, uri.c_str()) == 0)
809 return Utf8Str(g_aUriToBackend[i].pszBackend);
810 return Utf8Str();
811}
812
813#if 0 /* unused */
814std::set<Utf8Str> Appliance::i_URIFromTypeOfVirtualDiskFormat(Utf8Str type)
815{
816 Assert(g_fInitializedBackendNames);
817
818 std::set<Utf8Str> UriSet;
819 unsigned i = RT_ELEMENTS(g_aUriToBackend);
820 while (i-- > 0)
821 if (RTStrICmp(g_aUriToBackend[i].pszBackend, type.c_str()) == 0)
822 UriSet.insert(g_aUriToBackend[i].pszUri);
823 return UriSet;
824}
825#endif
826
827/**
828 * Returns a medium format object corresponding to the given
829 * disk image or null if no such format.
830 *
831 * @param di Disk Image
832 * @param mf Medium Format
833 *
834 * @return ComObjPtr<MediumFormat>
835 */
836HRESULT Appliance::i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf)
837{
838 HRESULT rc = S_OK;
839
840 /* Get the system properties. */
841 SystemProperties *pSysProps = mVirtualBox->i_getSystemProperties();
842
843 /* We need a proper source format description */
844 /* Which format to use? */
845 Utf8Str strSrcFormat = i_typeOfVirtualDiskFormatFromURI(di.strFormat);
846
847 /*
848 * fallback, if we can't determine virtual disk format using URI from the attribute ovf:format
849 * in the corresponding section <Disk> in the OVF file.
850 */
851 if (strSrcFormat.isEmpty())
852 {
853 strSrcFormat = di.strHref;
854
855 /* check either file gzipped or not
856 * if "yes" then remove last extension,
857 * i.e. "image.vmdk.gz"->"image.vmdk"
858 */
859 if (di.strCompression == "gzip")
860 {
861 if (RTPathHasSuffix(strSrcFormat.c_str()))
862 {
863 strSrcFormat.stripSuffix();
864 }
865 else
866 {
867 mf.setNull();
868 rc = setError(E_FAIL,
869 tr("Internal inconsistency looking up medium format for the disk image '%s'"),
870 di.strHref.c_str());
871 return rc;
872 }
873 }
874 /* Figure out from extension which format the image of disk has. */
875 if (RTPathHasSuffix(strSrcFormat.c_str()))
876 {
877 const char *pszExt = RTPathSuffix(strSrcFormat.c_str());
878 if (pszExt)
879 pszExt++;
880 mf = pSysProps->i_mediumFormatFromExtension(pszExt);
881 }
882 else
883 mf.setNull();
884 }
885 else
886 mf = pSysProps->i_mediumFormat(strSrcFormat);
887
888 if (mf.isNull())
889 rc = setError(E_FAIL, tr("Internal inconsistency looking up medium format for the disk image '%s'"),
890 di.strHref.c_str());
891
892 return rc;
893}
894
895/**
896 * Setup automatic I/O stream digest calculation, adding it to hOurManifest.
897 *
898 * @returns Passthru I/O stream, of @a hVfsIos if no digest calc needed.
899 * @param hVfsIos The stream to wrap. Always consumed.
900 * @param pszManifestEntry The manifest entry.
901 * @param fRead Set if read stream, clear if write.
902 * @throws Nothing.
903 */
904RTVFSIOSTREAM Appliance::i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
905 bool fRead /*= true */)
906{
907 int vrc;
908 Assert(!RTManifestPtIosIsInstanceOf(hVfsIos));
909
910 if (m->fDigestTypes == 0)
911 return hVfsIos;
912
913 /* Create the manifest if necessary. */
914 if (m->hOurManifest == NIL_RTMANIFEST)
915 {
916 vrc = RTManifestCreate(0 /*fFlags*/, &m->hOurManifest);
917 AssertRCReturnStmt(vrc, RTVfsIoStrmRelease(hVfsIos), NIL_RTVFSIOSTREAM);
918 }
919
920 /* Setup the stream. */
921 RTVFSIOSTREAM hVfsIosPt;
922 vrc = RTManifestEntryAddPassthruIoStream(m->hOurManifest, hVfsIos, pszManifestEntry, m->fDigestTypes, fRead, &hVfsIosPt);
923
924 RTVfsIoStrmRelease(hVfsIos); /* always consumed! */
925 if (RT_SUCCESS(vrc))
926 return hVfsIosPt;
927
928 setErrorVrc(vrc, "RTManifestEntryAddPassthruIoStream failed with rc=%Rrc", vrc);
929 return NIL_RTVFSIOSTREAM;
930}
931
932/**
933 * Returns true if the appliance is in "idle" state. This should always be the
934 * case unless an import or export is currently in progress. Similar to machine
935 * states, this permits the Appliance implementation code to let go of the
936 * Appliance object lock while a time-consuming disk conversion is in progress
937 * without exposing the appliance to conflicting calls.
938 *
939 * This sets an error on "this" (the appliance) and returns false if the appliance
940 * is busy. The caller should then return E_ACCESSDENIED.
941 *
942 * Must be called from under the object lock!
943 */
944bool Appliance::i_isApplianceIdle()
945{
946 if (m->state == Data::ApplianceImporting)
947 setError(VBOX_E_INVALID_OBJECT_STATE, tr("The appliance is busy importing files"));
948 else if (m->state == Data::ApplianceExporting)
949 setError(VBOX_E_INVALID_OBJECT_STATE, tr("The appliance is busy exporting files"));
950 else
951 return true;
952
953 return false;
954}
955
956HRESULT Appliance::i_searchUniqueVMName(Utf8Str& aName) const
957{
958 IMachine *machine = NULL;
959 char *tmpName = RTStrDup(aName.c_str());
960 int i = 1;
961 while (mVirtualBox->FindMachine(Bstr(tmpName).raw(), &machine) != VBOX_E_OBJECT_NOT_FOUND)
962 {
963 RTStrFree(tmpName);
964 RTStrAPrintf(&tmpName, "%s %d", aName.c_str(), i);
965 ++i;
966 }
967 aName = tmpName;
968 RTStrFree(tmpName);
969
970 return S_OK;
971}
972
973HRESULT Appliance::i_searchUniqueImageFilePath(const Utf8Str &aMachineFolder, DeviceType_T aDeviceType, Utf8Str &aName) const
974{
975 /*
976 * Check if the file exists or if a medium with this path is registered already
977 */
978 Utf8Str strAbsName;
979 ssize_t offDashNum = -1;
980 ssize_t cchDashNum = 0;
981 for (unsigned i = 1;; i++)
982 {
983 /* Complete the path (could be relative to machine folder). */
984 int rc = RTPathAbsExCxx(strAbsName, aMachineFolder, aName);
985 AssertRCReturn(rc, Global::vboxStatusCodeToCOM(rc)); /** @todo stupid caller ignores this */
986
987 /* Check that the file does not exist and that there is no media somehow matching the name. */
988 if (!RTPathExists(strAbsName.c_str()))
989 {
990 ComPtr<IMedium> ptrMedium;
991 HRESULT hrc = mVirtualBox->OpenMedium(Bstr(strAbsName).raw(), aDeviceType, AccessMode_ReadWrite,
992 FALSE /* fForceNewUuid */, ptrMedium.asOutParam());
993 if (hrc == VBOX_E_OBJECT_NOT_FOUND)
994 return S_OK;
995 }
996
997 /* Insert '_%i' before the suffix and try again. */
998 if (offDashNum < 0)
999 {
1000 const char *pszSuffix = RTPathSuffix(aName.c_str());
1001 offDashNum = pszSuffix ? pszSuffix - aName.c_str() : aName.length();
1002 }
1003 char szTmp[32];
1004 size_t cchTmp = RTStrPrintf(szTmp, sizeof(szTmp), "_%u", i);
1005 aName.replace(offDashNum, cchDashNum, szTmp, cchTmp);
1006 cchDashNum = cchTmp;
1007 }
1008}
1009
1010/**
1011 * Called from Appliance::importImpl() and Appliance::writeImpl() to set up a
1012 * progress object with the proper weights and maximum progress values.
1013 */
1014HRESULT Appliance::i_setUpProgress(ComObjPtr<Progress> &pProgress,
1015 const Utf8Str &strDescription,
1016 SetUpProgressMode mode)
1017{
1018 HRESULT rc;
1019
1020 /* Create the progress object */
1021 pProgress.createObject();
1022
1023 // compute the disks weight (this sets ulTotalDisksMB and cDisks in the instance data)
1024 i_disksWeight();
1025
1026 m->ulWeightForManifestOperation = 0;
1027
1028 ULONG cOperations;
1029 ULONG ulTotalOperationsWeight;
1030
1031 cOperations = 1 // one for XML setup
1032 + m->cDisks; // plus one per disk
1033 if (m->ulTotalDisksMB)
1034 {
1035 m->ulWeightForXmlOperation = (ULONG)((double)m->ulTotalDisksMB * 1 / 100); // use 1% of the progress for the XML
1036 ulTotalOperationsWeight = m->ulTotalDisksMB + m->ulWeightForXmlOperation;
1037 }
1038 else
1039 {
1040 // no disks to export:
1041 m->ulWeightForXmlOperation = 1;
1042 ulTotalOperationsWeight = 1;
1043 }
1044
1045 switch (mode)
1046 {
1047 case ImportFile:
1048 {
1049 break;
1050 }
1051 case WriteFile:
1052 {
1053 // assume that creating the manifest will take .1% of the time it takes to export the disks
1054 if (m->fManifest)
1055 {
1056 ++cOperations; // another one for creating the manifest
1057
1058 m->ulWeightForManifestOperation = (ULONG)((double)m->ulTotalDisksMB * .1 / 100); // use .5% of the
1059 // progress for the manifest
1060 ulTotalOperationsWeight += m->ulWeightForManifestOperation;
1061 }
1062 break;
1063 }
1064 case ImportS3:
1065 {
1066 cOperations += 1 + 1; // another one for the manifest file & another one for the import
1067 ulTotalOperationsWeight = m->ulTotalDisksMB;
1068 if (!m->ulTotalDisksMB)
1069 // no disks to export:
1070 ulTotalOperationsWeight = 1;
1071
1072 ULONG ulImportWeight = (ULONG)((double)ulTotalOperationsWeight * 50 / 100); // use 50% for import
1073 ulTotalOperationsWeight += ulImportWeight;
1074
1075 m->ulWeightForXmlOperation = ulImportWeight; /* save for using later */
1076
1077 ULONG ulInitWeight = (ULONG)((double)ulTotalOperationsWeight * 0.1 / 100); // use 0.1% for init
1078 ulTotalOperationsWeight += ulInitWeight;
1079 break;
1080 }
1081 case WriteS3:
1082 {
1083 cOperations += 1 + 1; // another one for the mf & another one for temporary creation
1084
1085 if (m->ulTotalDisksMB)
1086 {
1087 m->ulWeightForXmlOperation = (ULONG)((double)m->ulTotalDisksMB * 1 / 100); // use 1% of the progress
1088 // for OVF file upload
1089 // (we didn't know the
1090 // size at this point)
1091 ulTotalOperationsWeight = m->ulTotalDisksMB + m->ulWeightForXmlOperation;
1092 }
1093 else
1094 {
1095 // no disks to export:
1096 ulTotalOperationsWeight = 1;
1097 m->ulWeightForXmlOperation = 1;
1098 }
1099 ULONG ulOVFCreationWeight = (ULONG)((double)ulTotalOperationsWeight * 50.0 / 100.0); /* Use 50% for the
1100 creation of the OVF
1101 & the disks */
1102 ulTotalOperationsWeight += ulOVFCreationWeight;
1103 break;
1104 }
1105 case ExportCloud:
1106 cOperations = 1 + 9;//7
1107 ulTotalOperationsWeight = 100*cOperations;
1108 m->ulWeightForXmlOperation = 100;
1109 break;
1110 }
1111 Log(("Setting up progress object: ulTotalMB = %d, cDisks = %d, => cOperations = %d, ulTotalOperationsWeight = %d, m->ulWeightForXmlOperation = %d\n",
1112 m->ulTotalDisksMB, m->cDisks, cOperations, ulTotalOperationsWeight, m->ulWeightForXmlOperation));
1113
1114 rc = pProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
1115 Bstr(strDescription).raw(),
1116 TRUE /* aCancelable */,
1117 cOperations, // ULONG cOperations,
1118 ulTotalOperationsWeight, // ULONG ulTotalOperationsWeight,
1119 Bstr(strDescription).raw(), // CBSTR bstrFirstOperationDescription,
1120 m->ulWeightForXmlOperation); // ULONG ulFirstOperationWeight,
1121 return rc;
1122}
1123
1124void Appliance::i_addWarning(const char* aWarning, ...)
1125{
1126 try
1127 {
1128 va_list args;
1129 va_start(args, aWarning);
1130 Utf8Str str(aWarning, args);
1131 va_end(args);
1132 m->llWarnings.push_back(str);
1133 }
1134 catch (...)
1135 {
1136 AssertFailed();
1137 }
1138}
1139
1140/**
1141 * Refreshes the cDisks and ulTotalDisksMB members in the instance data.
1142 * Requires that virtual system descriptions are present.
1143 */
1144void Appliance::i_disksWeight()
1145{
1146 m->ulTotalDisksMB = 0;
1147 m->cDisks = 0;
1148 // weigh the disk images according to their sizes
1149 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
1150 for (it = m->virtualSystemDescriptions.begin();
1151 it != m->virtualSystemDescriptions.end();
1152 ++it)
1153 {
1154 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
1155 /* One for every medium of the Virtual System */
1156 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskImage);
1157 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
1158 for (itH = avsdeHDs.begin();
1159 itH != avsdeHDs.end();
1160 ++itH)
1161 {
1162 const VirtualSystemDescriptionEntry *pHD = *itH;
1163 m->ulTotalDisksMB += pHD->ulSizeMB;
1164 ++m->cDisks;
1165 }
1166
1167 avsdeHDs = vsdescThis->i_findByType(VirtualSystemDescriptionType_CDROM);
1168 for (itH = avsdeHDs.begin();
1169 itH != avsdeHDs.end();
1170 ++itH)
1171 {
1172 const VirtualSystemDescriptionEntry *pHD = *itH;
1173 m->ulTotalDisksMB += pHD->ulSizeMB;
1174 ++m->cDisks;
1175 }
1176 }
1177
1178}
1179
1180void Appliance::i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket)
1181{
1182 /* Buckets are S3 specific. So parse the bucket out of the file path */
1183 if (!aPath.startsWith("/"))
1184 throw setError(E_INVALIDARG,
1185 tr("The path '%s' must start with /"), aPath.c_str());
1186 size_t bpos = aPath.find("/", 1);
1187 if (bpos != Utf8Str::npos)
1188 {
1189 aBucket = aPath.substr(1, bpos - 1); /* The bucket without any slashes */
1190 aPath = aPath.substr(bpos); /* The rest of the file path */
1191 }
1192 /* If there is no bucket name provided reject it */
1193 if (aBucket.isEmpty())
1194 throw setError(E_INVALIDARG,
1195 tr("You doesn't provide a bucket name in the URI '%s'"), aPath.c_str());
1196}
1197
1198/**
1199 * Worker for TaskOVF::handler.
1200 *
1201 * The TaskOVF is started in Appliance::readImpl() and Appliance::importImpl()
1202 * and Appliance::writeImpl().
1203 *
1204 * This will in turn call Appliance::readFS() or Appliance::importFS() or
1205 * Appliance::writeFS().
1206 *
1207 * @thread pTask The task.
1208 */
1209/* static */ void Appliance::i_importOrExportThreadTask(TaskOVF *pTask)
1210{
1211 LogFlowFuncEnter();
1212 AssertReturnVoid(pTask);
1213
1214 Appliance *pAppliance = pTask->pAppliance;
1215 LogFlowFunc(("Appliance %p taskType=%d\n", pAppliance, pTask->taskType));
1216
1217 switch (pTask->taskType)
1218 {
1219 case TaskOVF::Read:
1220 pAppliance->m->resetReadData();
1221 if (pTask->locInfo.storageType == VFSType_File)
1222 pTask->rc = pAppliance->i_readFS(pTask);
1223 else
1224 pTask->rc = E_NOTIMPL;
1225 break;
1226
1227 case TaskOVF::Import:
1228 /** @todo allow overriding these? */
1229 if (!pAppliance->m->fSignatureValid && pAppliance->m->pbSignedDigest)
1230 pTask->rc = pAppliance->setError(E_FAIL, tr("The manifest signature for '%s' is not valid"),
1231 pTask->locInfo.strPath.c_str());
1232 else if (!pAppliance->m->fCertificateValid && pAppliance->m->pbSignedDigest)
1233 {
1234 if (pAppliance->m->strCertError.isNotEmpty())
1235 pTask->rc = pAppliance->setError(E_FAIL, tr("The certificate used to signed '%s' is not valid: %s"),
1236 pTask->locInfo.strPath.c_str(), pAppliance->m->strCertError.c_str());
1237 else
1238 pTask->rc = pAppliance->setError(E_FAIL, tr("The certificate used to signed '%s' is not valid"),
1239 pTask->locInfo.strPath.c_str());
1240 }
1241 // fusion does not consider this a show stopper (we've filed a warning during read).
1242 //else if (pAppliance->m->fCertificateMissingPath && pAppliance->m->pbSignedDigest)
1243 // pTask->rc = pAppliance->setError(E_FAIL, tr("The certificate used to signed '%s' is does not have a valid CA path"),
1244 // pTask->locInfo.strPath.c_str());
1245 else
1246 {
1247 if (pTask->locInfo.storageType == VFSType_File)
1248 pTask->rc = pAppliance->i_importFS(pTask);
1249 else
1250 pTask->rc = E_NOTIMPL;
1251 }
1252 break;
1253
1254 case TaskOVF::Write:
1255 if (pTask->locInfo.storageType == VFSType_File)
1256 pTask->rc = pAppliance->i_writeFS(pTask);
1257 else
1258 pTask->rc = E_NOTIMPL;
1259 break;
1260
1261 default:
1262 AssertFailed();
1263 pTask->rc = E_FAIL;
1264 break;
1265 }
1266
1267 if (!pTask->pProgress.isNull())
1268 pTask->pProgress->i_notifyComplete(pTask->rc);
1269
1270 LogFlowFuncLeave();
1271}
1272
1273/* static */ DECLCALLBACK(int) Appliance::TaskOVF::updateProgress(unsigned uPercent, void *pvUser)
1274{
1275 Appliance::TaskOVF* pTask = *(Appliance::TaskOVF**)pvUser;
1276
1277 if ( pTask
1278 && !pTask->pProgress.isNull())
1279 {
1280 BOOL fCanceled;
1281 pTask->pProgress->COMGETTER(Canceled)(&fCanceled);
1282 if (fCanceled)
1283 return -1;
1284 pTask->pProgress->SetCurrentOperationProgress(uPercent);
1285 }
1286 return VINF_SUCCESS;
1287}
1288
1289/**
1290 * Worker for TaskOPC::handler.
1291 * @thread pTask The task.
1292 */
1293/* static */
1294void Appliance::i_exportOPCThreadTask(TaskOPC *pTask)
1295{
1296 LogFlowFuncEnter();
1297 AssertReturnVoid(pTask);
1298
1299 Appliance *pAppliance = pTask->pAppliance;
1300 LogFlowFunc(("Appliance %p taskType=%d\n", pAppliance, pTask->taskType));
1301
1302 switch (pTask->taskType)
1303 {
1304 case TaskOPC::Export:
1305 pTask->rc = pAppliance->i_writeFSOPC(pTask);
1306 break;
1307
1308 default:
1309 AssertFailed();
1310 pTask->rc = E_FAIL;
1311 break;
1312 }
1313
1314 if (!pTask->pProgress.isNull())
1315 pTask->pProgress->i_notifyComplete(pTask->rc);
1316
1317 LogFlowFuncLeave();
1318}
1319
1320/* static */
1321DECLCALLBACK(int) Appliance::TaskOPC::updateProgress(unsigned uPercent, void *pvUser)
1322{
1323 Appliance::TaskOPC* pTask = *(Appliance::TaskOPC**)pvUser;
1324
1325 if ( pTask
1326 && !pTask->pProgress.isNull())
1327 {
1328 BOOL fCanceled;
1329 pTask->pProgress->COMGETTER(Canceled)(&fCanceled);
1330 if (fCanceled)
1331 return -1;
1332 pTask->pProgress->SetCurrentOperationProgress(uPercent);
1333 }
1334 return VINF_SUCCESS;
1335}
1336
1337/**
1338 * Worker for TaskCloud::handler.
1339 * @thread pTask The task.
1340 */
1341/* static */
1342void Appliance::i_exportCloudThreadTask(TaskCloud *pTask)
1343{
1344 LogFlowFuncEnter();
1345 AssertReturnVoid(pTask);
1346
1347 Appliance *pAppliance = pTask->pAppliance;
1348 LogFlowFunc(("Appliance %p taskType=%d\n", pAppliance, pTask->taskType));
1349
1350 switch (pTask->taskType)
1351 {
1352 case TaskCloud::Export:
1353 pTask->rc = pAppliance->i_writeFSCloud(pTask);
1354 break;
1355
1356 default:
1357 AssertFailed();
1358 pTask->rc = E_FAIL;
1359 break;
1360 }
1361
1362 if (!pTask->pProgress.isNull())
1363 pTask->pProgress->i_notifyComplete(pTask->rc);
1364
1365 LogFlowFuncLeave();
1366}
1367
1368/* static */
1369DECLCALLBACK(int) Appliance::TaskCloud::updateProgress(unsigned uPercent, void *pvUser)
1370{
1371 Appliance::TaskCloud* pTask = *(Appliance::TaskCloud**)pvUser;
1372
1373 if ( pTask
1374 && !pTask->pProgress.isNull())
1375 {
1376 BOOL fCanceled;
1377 pTask->pProgress->COMGETTER(Canceled)(&fCanceled);
1378 if (fCanceled)
1379 return -1;
1380 pTask->pProgress->SetCurrentOperationProgress(uPercent);
1381 }
1382 return VINF_SUCCESS;
1383}
1384
1385void i_parseURI(Utf8Str strUri, LocationInfo &locInfo)
1386{
1387 /* Check the URI for the protocol */
1388 if (strUri.startsWith("file://", Utf8Str::CaseInsensitive)) /* File based */
1389 {
1390 locInfo.storageType = VFSType_File;
1391 strUri = strUri.substr(sizeof("file://") - 1);
1392 }
1393 else if (strUri.startsWith("SunCloud://", Utf8Str::CaseInsensitive)) /* Sun Cloud service */
1394 {
1395 locInfo.storageType = VFSType_S3;
1396 strUri = strUri.substr(sizeof("SunCloud://") - 1);
1397 }
1398 else if (strUri.startsWith("S3://", Utf8Str::CaseInsensitive)) /* S3 service */
1399 {
1400 locInfo.storageType = VFSType_S3;
1401 strUri = strUri.substr(sizeof("S3://") - 1);
1402 }
1403 else if (strUri.startsWith("OCI://", Utf8Str::CaseInsensitive)) /* OCI service (storage or compute) */
1404 {
1405 locInfo.storageType = VFSType_Cloud;
1406 locInfo.strProvider = "OCI";
1407 strUri = strUri.substr(sizeof("OCI://") - 1);
1408 }
1409 else if (strUri.startsWith("webdav://", Utf8Str::CaseInsensitive)) /* webdav service */
1410 throw E_NOTIMPL;
1411
1412 /* Not necessary on a file based URI */
1413 if (locInfo.storageType != VFSType_File)
1414 {
1415 size_t uppos = strUri.find("@"); /* username:password combo */
1416 if (uppos != Utf8Str::npos)
1417 {
1418 locInfo.strUsername = strUri.substr(0, uppos);
1419 strUri = strUri.substr(uppos + 1);
1420 size_t upos = locInfo.strUsername.find(":");
1421 if (upos != Utf8Str::npos)
1422 {
1423 locInfo.strPassword = locInfo.strUsername.substr(upos + 1);
1424 locInfo.strUsername = locInfo.strUsername.substr(0, upos);
1425 }
1426 }
1427 size_t hpos = strUri.find("/"); /* hostname part */
1428 if (hpos != Utf8Str::npos)
1429 {
1430 locInfo.strHostname = strUri.substr(0, hpos);
1431 strUri = strUri.substr(hpos);
1432 }
1433 }
1434
1435 locInfo.strPath = strUri;
1436}
1437
1438
1439////////////////////////////////////////////////////////////////////////////////
1440//
1441// IVirtualSystemDescription constructor / destructor
1442//
1443////////////////////////////////////////////////////////////////////////////////
1444
1445/**
1446 * COM initializer.
1447 * @return
1448 */
1449HRESULT VirtualSystemDescription::init()
1450{
1451 /* Enclose the state transition NotReady->InInit->Ready */
1452 AutoInitSpan autoInitSpan(this);
1453 AssertReturn(autoInitSpan.isOk(), E_FAIL);
1454
1455 /* Initialize data */
1456 m = new Data();
1457 m->pConfig = NULL;
1458
1459 /* Confirm a successful initialization */
1460 autoInitSpan.setSucceeded();
1461 return S_OK;
1462}
1463
1464/**
1465* COM uninitializer.
1466*/
1467
1468void VirtualSystemDescription::uninit()
1469{
1470 if (m->pConfig)
1471 delete m->pConfig;
1472 delete m;
1473 m = NULL;
1474}
1475
1476
1477////////////////////////////////////////////////////////////////////////////////
1478//
1479// IVirtualSystemDescription public methods
1480//
1481////////////////////////////////////////////////////////////////////////////////
1482
1483/**
1484 * Public method implementation.
1485 */
1486HRESULT VirtualSystemDescription::getCount(ULONG *aCount)
1487{
1488 if (!aCount)
1489 return E_POINTER;
1490
1491 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1492
1493 *aCount = (ULONG)m->maDescriptions.size();
1494 return S_OK;
1495}
1496
1497/**
1498 * Public method implementation.
1499 */
1500HRESULT VirtualSystemDescription::getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
1501 std::vector<com::Utf8Str> &aRefs,
1502 std::vector<com::Utf8Str> &aOVFValues,
1503 std::vector<com::Utf8Str> &aVBoxValues,
1504 std::vector<com::Utf8Str> &aExtraConfigValues)
1505
1506{
1507 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1508 size_t c = m->maDescriptions.size();
1509 aTypes.resize(c);
1510 aRefs.resize(c);
1511 aOVFValues.resize(c);
1512 aVBoxValues.resize(c);
1513 aExtraConfigValues.resize(c);
1514
1515 for (size_t i = 0; i < c; i++)
1516 {
1517 const VirtualSystemDescriptionEntry &vsde = m->maDescriptions[i];
1518 aTypes[i] = vsde.type;
1519 aRefs[i] = vsde.strRef;
1520 aOVFValues[i] = vsde.strOvf;
1521 aVBoxValues[i] = vsde.strVBoxCurrent;
1522 aExtraConfigValues[i] = vsde.strExtraConfigCurrent;
1523 }
1524 return S_OK;
1525}
1526
1527/**
1528 * Public method implementation.
1529 */
1530HRESULT VirtualSystemDescription::getDescriptionByType(VirtualSystemDescriptionType_T aType,
1531 std::vector<VirtualSystemDescriptionType_T> &aTypes,
1532 std::vector<com::Utf8Str> &aRefs,
1533 std::vector<com::Utf8Str> &aOVFValues,
1534 std::vector<com::Utf8Str> &aVBoxValues,
1535 std::vector<com::Utf8Str> &aExtraConfigValues)
1536{
1537 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1538 std::list<VirtualSystemDescriptionEntry*> vsd = i_findByType(aType);
1539
1540 size_t c = vsd.size();
1541 aTypes.resize(c);
1542 aRefs.resize(c);
1543 aOVFValues.resize(c);
1544 aVBoxValues.resize(c);
1545 aExtraConfigValues.resize(c);
1546
1547 size_t i = 0;
1548 for (list<VirtualSystemDescriptionEntry*>::const_iterator it = vsd.begin(); it != vsd.end(); ++it, ++i)
1549 {
1550 const VirtualSystemDescriptionEntry *vsde = (*it);
1551 aTypes[i] = vsde->type;
1552 aRefs[i] = vsde->strRef;
1553 aOVFValues[i] = vsde->strOvf;
1554 aVBoxValues[i] = vsde->strVBoxCurrent;
1555 aExtraConfigValues[i] = vsde->strExtraConfigCurrent;
1556 }
1557
1558 return S_OK;
1559}
1560
1561/**
1562 * Public method implementation.
1563 */
1564HRESULT VirtualSystemDescription::getValuesByType(VirtualSystemDescriptionType_T aType,
1565 VirtualSystemDescriptionValueType_T aWhich,
1566 std::vector<com::Utf8Str> &aValues)
1567{
1568 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1569
1570 std::list<VirtualSystemDescriptionEntry*> vsd = i_findByType (aType);
1571 aValues.resize((ULONG)vsd.size());
1572
1573 list<VirtualSystemDescriptionEntry*>::const_iterator it;
1574 size_t i = 0;
1575 for (it = vsd.begin();
1576 it != vsd.end();
1577 ++it, ++i)
1578 {
1579 const VirtualSystemDescriptionEntry *vsde = (*it);
1580
1581 Bstr bstr;
1582 switch (aWhich)
1583 {
1584 case VirtualSystemDescriptionValueType_Reference: aValues[i] = vsde->strRef; break;
1585 case VirtualSystemDescriptionValueType_Original: aValues[i] = vsde->strOvf; break;
1586 case VirtualSystemDescriptionValueType_Auto: aValues[i] = vsde->strVBoxCurrent; break;
1587 case VirtualSystemDescriptionValueType_ExtraConfig: aValues[i] = vsde->strExtraConfigCurrent; break;
1588#ifdef VBOX_WITH_XPCOM_CPP_ENUM_HACK
1589 case VirtualSystemDescriptionValueType_32BitHack: AssertFailedBreak(); /* (compiler warnings) */
1590#endif
1591 }
1592 }
1593
1594 return S_OK;
1595}
1596
1597/**
1598 * Public method implementation.
1599 */
1600HRESULT VirtualSystemDescription::setFinalValues(const std::vector<BOOL> &aEnabled,
1601 const std::vector<com::Utf8Str> &aVBoxValues,
1602 const std::vector<com::Utf8Str> &aExtraConfigValues)
1603{
1604#ifndef RT_OS_WINDOWS
1605 // NOREF(aEnabledSize);
1606#endif /* RT_OS_WINDOWS */
1607 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1608
1609 if ( (aEnabled.size() != m->maDescriptions.size())
1610 || (aVBoxValues.size() != m->maDescriptions.size())
1611 || (aExtraConfigValues.size() != m->maDescriptions.size())
1612 )
1613 return E_INVALIDARG;
1614
1615 size_t i = 0;
1616 for (vector<VirtualSystemDescriptionEntry>::iterator it = m->maDescriptions.begin();
1617 it != m->maDescriptions.end();
1618 ++it, ++i)
1619 {
1620 VirtualSystemDescriptionEntry& vsde = *it;
1621
1622 if (aEnabled[i])
1623 {
1624 vsde.strVBoxCurrent = aVBoxValues[i];
1625 vsde.strExtraConfigCurrent = aExtraConfigValues[i];
1626 }
1627 else
1628 vsde.type = VirtualSystemDescriptionType_Ignore;
1629 }
1630
1631 return S_OK;
1632}
1633
1634/**
1635 * Public method implementation.
1636 */
1637HRESULT VirtualSystemDescription::addDescription(VirtualSystemDescriptionType_T aType,
1638 const com::Utf8Str &aVBoxValue,
1639 const com::Utf8Str &aExtraConfigValue)
1640
1641{
1642 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1643 i_addEntry(aType, "", aVBoxValue, aVBoxValue, 0, aExtraConfigValue);
1644 return S_OK;
1645}
1646
1647/**
1648 * Internal method; adds a new description item to the member list.
1649 * @param aType Type of description for the new item.
1650 * @param strRef Reference item; only used with storage controllers.
1651 * @param aOvfValue Corresponding original value from OVF.
1652 * @param aVBoxValue Initial configuration value (can be overridden by caller with setFinalValues).
1653 * @param ulSizeMB Weight for IProgress
1654 * @param strExtraConfig Extra configuration; meaning dependent on type.
1655 */
1656void VirtualSystemDescription::i_addEntry(VirtualSystemDescriptionType_T aType,
1657 const Utf8Str &strRef,
1658 const Utf8Str &aOvfValue,
1659 const Utf8Str &aVBoxValue,
1660 uint32_t ulSizeMB,
1661 const Utf8Str &strExtraConfig /*= ""*/)
1662{
1663 VirtualSystemDescriptionEntry vsde;
1664 vsde.ulIndex = (uint32_t)m->maDescriptions.size(); // each entry gets an index so the client side can reference them
1665 vsde.type = aType;
1666 vsde.strRef = strRef;
1667 vsde.strOvf = aOvfValue;
1668 vsde.strVBoxSuggested /* remember original value */
1669 = vsde.strVBoxCurrent /* and set current value which can be overridden by setFinalValues() */
1670 = aVBoxValue;
1671 vsde.strExtraConfigSuggested
1672 = vsde.strExtraConfigCurrent
1673 = strExtraConfig;
1674 vsde.ulSizeMB = ulSizeMB;
1675
1676 vsde.skipIt = false;
1677
1678 m->maDescriptions.push_back(vsde);
1679}
1680
1681/**
1682 * Private method; returns a list of description items containing all the items from the member
1683 * description items of this virtual system that match the given type.
1684 */
1685std::list<VirtualSystemDescriptionEntry*> VirtualSystemDescription::i_findByType(VirtualSystemDescriptionType_T aType)
1686{
1687 std::list<VirtualSystemDescriptionEntry*> vsd;
1688 for (vector<VirtualSystemDescriptionEntry>::iterator it = m->maDescriptions.begin();
1689 it != m->maDescriptions.end();
1690 ++it)
1691 {
1692 if (it->type == aType)
1693 vsd.push_back(&(*it));
1694 }
1695
1696 return vsd;
1697}
1698
1699HRESULT VirtualSystemDescription::removeDescriptionByType(VirtualSystemDescriptionType_T aType)
1700{
1701 std::vector<VirtualSystemDescriptionEntry>::iterator it = m->maDescriptions.begin();
1702 while (it != m->maDescriptions.end())
1703 {
1704 if (it->type == aType)
1705 it = m->maDescriptions.erase(it);
1706 else
1707 ++it;
1708 }
1709
1710 return S_OK;
1711}
1712
1713/* Private method; delete all records from the list
1714 * m->llDescriptions that match the given type.
1715 */
1716void VirtualSystemDescription::i_removeByType(VirtualSystemDescriptionType_T aType)
1717{
1718 std::vector<VirtualSystemDescriptionEntry>::iterator it = m->maDescriptions.begin();
1719 while (it != m->maDescriptions.end())
1720 {
1721 if (it->type == aType)
1722 it = m->maDescriptions.erase(it);
1723 else
1724 ++it;
1725 }
1726}
1727
1728/**
1729 * Private method; looks thru the member hardware items for the IDE, SATA, or SCSI controller with
1730 * the given reference ID. Useful when needing the controller for a particular
1731 * virtual disk.
1732 */
1733const VirtualSystemDescriptionEntry* VirtualSystemDescription::i_findControllerFromID(uint32_t id)
1734{
1735 Utf8Str strRef = Utf8StrFmt("%RI32", id);
1736 vector<VirtualSystemDescriptionEntry>::const_iterator it;
1737 for (it = m->maDescriptions.begin();
1738 it != m->maDescriptions.end();
1739 ++it)
1740 {
1741 const VirtualSystemDescriptionEntry &d = *it;
1742 switch (d.type)
1743 {
1744 case VirtualSystemDescriptionType_HardDiskControllerIDE:
1745 case VirtualSystemDescriptionType_HardDiskControllerSATA:
1746 case VirtualSystemDescriptionType_HardDiskControllerSCSI:
1747 case VirtualSystemDescriptionType_HardDiskControllerSAS:
1748 if (d.strRef == strRef)
1749 return &d;
1750 break;
1751 default: break; /* Shut up MSC. */
1752 }
1753 }
1754
1755 return NULL;
1756}
1757
1758/**
1759 * Method called from Appliance::Interpret() if the source OVF for a virtual system
1760 * contains a <vbox:Machine> element. This method then attempts to parse that and
1761 * create a MachineConfigFile instance from it which is stored in this instance data
1762 * and can then be used to create a machine.
1763 *
1764 * This must only be called once per instance.
1765 *
1766 * This rethrows all XML and logic errors from MachineConfigFile.
1767 *
1768 * @param elmMachine <vbox:Machine> element with attributes and subelements from some
1769 * DOM tree.
1770 */
1771void VirtualSystemDescription::i_importVBoxMachineXML(const xml::ElementNode &elmMachine)
1772{
1773 settings::MachineConfigFile *pConfig = NULL;
1774
1775 Assert(m->pConfig == NULL);
1776
1777 try
1778 {
1779 pConfig = new settings::MachineConfigFile(NULL);
1780 pConfig->importMachineXML(elmMachine);
1781
1782 m->pConfig = pConfig;
1783 }
1784 catch (...)
1785 {
1786 if (pConfig)
1787 delete pConfig;
1788 throw;
1789 }
1790}
1791
1792/**
1793 * Returns the machine config created by importVBoxMachineXML() or NULL if there's none.
1794 */
1795const settings::MachineConfigFile* VirtualSystemDescription::i_getMachineConfig() const
1796{
1797 return m->pConfig;
1798}
1799
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