VirtualBox

source: vbox/trunk/src/VBox/Main/ApplianceImpl.cpp@ 20131

Last change on this file since 20131 was 20081, checked in by vboxsync, 16 years ago

Main: initial code for upload to cloud (second try)
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 206.2 KB
Line 
1/* $Id: ApplianceImpl.cpp 20081 2009-05-27 12:55:11Z vboxsync $ */
2/** @file
3 *
4 * IAppliance and IVirtualSystem COM class implementations.
5 */
6
7/*
8 * Copyright (C) 2008-2009 Sun Microsystems, Inc.
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 *
18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
19 * Clara, CA 95054 USA or visit http://www.sun.com if you need
20 * additional information or have any questions.
21 */
22
23#include <iprt/stream.h>
24#include <iprt/path.h>
25#include <iprt/dir.h>
26#include <iprt/file.h>
27#include <iprt/s3.h>
28
29#include <VBox/param.h>
30#include <VBox/version.h>
31
32#include "ApplianceImpl.h"
33#include "VFSExplorerImpl.h"
34#include "VirtualBoxImpl.h"
35#include "GuestOSTypeImpl.h"
36#include "ProgressImpl.h"
37#include "MachineImpl.h"
38#include "HostNetworkInterfaceImpl.h"
39
40#include "Logging.h"
41
42#include "VBox/xml.h"
43
44using namespace std;
45
46////////////////////////////////////////////////////////////////////////////////
47//
48// hardware definitions
49//
50////////////////////////////////////////////////////////////////////////////////
51
52struct DiskImage
53{
54 Utf8Str strDiskId; // value from DiskSection/Disk/@diskId
55 int64_t iCapacity; // value from DiskSection/Disk/@capacity;
56 // (maximum size for dynamic images, I guess; we always translate this to bytes)
57 int64_t iPopulatedSize; // optional value from DiskSection/Disk/@populatedSize
58 // (actual used size of disk, always in bytes; can be an estimate of used disk
59 // space, but cannot be larger than iCapacity; -1 if not set)
60 Utf8Str strFormat; // value from DiskSection/Disk/@format
61 // typically http://www.vmware.com/specifications/vmdk.html#sparse
62
63 // fields from /References/File; the spec says the file reference from disk can be empty,
64 // so in that case, strFilename will be empty, then a new disk should be created
65 Utf8Str strHref; // value from /References/File/@href (filename); if empty, then the remaining fields are ignored
66 int64_t iSize; // value from /References/File/@size (optional according to spec; then we set -1 here)
67 int64_t iChunkSize; // value from /References/File/@chunkSize (optional, unsupported)
68 Utf8Str strCompression; // value from /References/File/@compression (optional, can be "gzip" according to spec)
69};
70
71struct VirtualHardwareItem
72{
73 Utf8Str strDescription;
74 Utf8Str strCaption;
75 Utf8Str strElementName;
76
77 uint32_t ulInstanceID;
78 uint32_t ulParent;
79
80 OVFResourceType_T resourceType;
81 Utf8Str strOtherResourceType;
82 Utf8Str strResourceSubType;
83
84 Utf8Str strHostResource; // "Abstractly specifies how a device shall connect to a resource on the deployment platform.
85 // Not all devices need a backing." Used with disk items, for which this references a virtual
86 // disk from the Disks section.
87 bool fAutomaticAllocation;
88 bool fAutomaticDeallocation;
89 Utf8Str strConnection; // "All Ethernet adapters that specify the same abstract network connection name within an OVF
90 // package shall be deployed on the same network. The abstract network connection name shall be
91 // listed in the NetworkSection at the outermost envelope level." We ignore this and only set up
92 // a network adapter depending on the network name.
93 Utf8Str strAddress; // "Device-specific. For an Ethernet adapter, this specifies the MAC address."
94 Utf8Str strAddressOnParent; // "For a device, this specifies its location on the controller."
95 Utf8Str strAllocationUnits; // "Specifies the units of allocation used. For example, “byte * 2^20”."
96 uint64_t ullVirtualQuantity; // "Specifies the quantity of resources presented. For example, “256”."
97 uint64_t ullReservation; // "Specifies the minimum quantity of resources guaranteed to be available."
98 uint64_t ullLimit; // "Specifies the maximum quantity of resources that will be granted."
99 uint64_t ullWeight; // "Specifies a relative priority for this allocation in relation to other allocations."
100
101 Utf8Str strConsumerVisibility;
102 Utf8Str strMappingBehavior;
103 Utf8Str strPoolID;
104 uint32_t ulBusNumber; // seen with IDE controllers, but not listed in OVF spec
105
106 uint32_t ulLineNumber; // line number of <Item> element in XML source; cached for error messages
107
108 VirtualHardwareItem()
109 : ulInstanceID(0), fAutomaticAllocation(false), fAutomaticDeallocation(false), ullVirtualQuantity(0), ullReservation(0), ullLimit(0), ullWeight(0), ulBusNumber(0), ulLineNumber(0)
110 {};
111};
112
113typedef map<Utf8Str, DiskImage> DiskImagesMap;
114
115struct VirtualSystem;
116
117typedef map<uint32_t, VirtualHardwareItem> HardwareItemsMap;
118
119struct HardDiskController
120{
121 uint32_t idController; // instance ID (Item/InstanceId); this gets referenced from HardDisk
122 enum ControllerSystemType { IDE, SATA, SCSI };
123 ControllerSystemType system; // one of IDE, SATA, SCSI
124 Utf8Str strControllerType; // controller subtype (Item/ResourceSubType); e.g. "LsiLogic"; can be empty (esp. for IDE)
125 Utf8Str strAddress; // for IDE
126 uint32_t ulBusNumber; // for IDE
127
128 HardDiskController()
129 : idController(0),
130 ulBusNumber(0)
131 {
132 }
133};
134
135typedef map<uint32_t, HardDiskController> ControllersMap;
136
137struct VirtualDisk
138{
139 uint32_t idController; // SCSI (or IDE) controller this disk is connected to;
140 // points into VirtualSystem.mapControllers
141 uint32_t ulAddressOnParent; // parsed strAddressOnParent of hardware item; will be 0 or 1 for IDE
142 // and possibly higher for disks attached to SCSI controllers (untested)
143 Utf8Str strDiskId; // if the hard disk has an ovf:/disk/<id> reference,
144 // this receives the <id> component; points to one of the
145 // references in Appliance::Data.mapDisks
146};
147
148typedef map<Utf8Str, VirtualDisk> VirtualDisksMap;
149
150struct EthernetAdapter
151{
152 Utf8Str strAdapterType; // "PCNet32" or "E1000" or whatever; from <rasd:ResourceSubType>
153 Utf8Str strNetworkName; // from <rasd:Connection>
154};
155
156typedef list<EthernetAdapter> EthernetAdaptersList;
157
158struct VirtualSystem
159{
160 Utf8Str strName; // copy of VirtualSystem/@id
161
162 Utf8Str strDescription; // copy of VirtualSystem/Info content
163
164 CIMOSType_T cimos;
165 Utf8Str strCimosDesc; // readable description of the cimos type in the case of cimos = 0/1/102
166 Utf8Str strVirtualSystemType; // generic hardware description; OVF says this can be something like "vmx-4" or "xen";
167 // VMware Workstation 6.5 is "vmx-07"
168
169 HardwareItemsMap mapHardwareItems; // map of virtual hardware items, sorted by unique instance ID
170
171 uint64_t ullMemorySize; // always in bytes, copied from llHardwareItems; default = 0 (unspecified)
172 uint16_t cCPUs; // no. of CPUs, copied from llHardwareItems; default = 1
173
174 EthernetAdaptersList llEthernetAdapters; // (one for each VirtualSystem/Item[@ResourceType=10]element)
175
176 ControllersMap mapControllers;
177 // list of hard disk controllers
178 // (one for each VirtualSystem/Item[@ResourceType=6] element with accumulated data from children)
179
180 VirtualDisksMap mapVirtualDisks;
181 // (one for each VirtualSystem/Item[@ResourceType=17] element with accumulated data from children)
182
183 bool fHasFloppyDrive; // true if there's a floppy item in mapHardwareItems
184 bool fHasCdromDrive; // true if there's a CD-ROM item in mapHardwareItems; ISO images are not yet supported by OVFtool
185 bool fHasUsbController; // true if there's a USB controller item in mapHardwareItems
186
187 Utf8Str strSoundCardType; // if not empty, then the system wants a soundcard; this then specifies the hardware;
188 // VMware Workstation 6.5 uses "ensoniq1371" for example
189
190 Utf8Str strLicenseText; // license info if any; receives contents of VirtualSystem/EulaSection/License
191
192 Utf8Str strProduct; // product info if any; receives contents of VirtualSystem/ProductSection/Product
193 Utf8Str strVendor; // product info if any; receives contents of VirtualSystem/ProductSection/Vendor
194 Utf8Str strVersion; // product info if any; receives contents of VirtualSystem/ProductSection/Version
195 Utf8Str strProductUrl; // product info if any; receives contents of VirtualSystem/ProductSection/ProductUrl
196 Utf8Str strVendorUrl; // product info if any; receives contents of VirtualSystem/ProductSection/VendorUrl
197
198 VirtualSystem()
199 : ullMemorySize(0), cCPUs(1), fHasFloppyDrive(false), fHasCdromDrive(false), fHasUsbController(false)
200 {
201 }
202};
203
204////////////////////////////////////////////////////////////////////////////////
205//
206// Appliance data definition
207//
208////////////////////////////////////////////////////////////////////////////////
209
210// opaque private instance data of Appliance class
211struct Appliance::Data
212{
213 Utf8Str strPath; // file name last given to either read() or write()
214
215 DiskImagesMap mapDisks; // map of DiskImage structs, sorted by DiskImage.strDiskId
216
217 list<VirtualSystem> llVirtualSystems; // list of virtual systems, created by and valid after read()
218
219 list< ComObjPtr<VirtualSystemDescription> > virtualSystemDescriptions; //
220
221 list<Utf8Str> llWarnings;
222
223 ULONG ulWeightPerOperation; // for progress calculations
224};
225
226struct VirtualSystemDescription::Data
227{
228 list<VirtualSystemDescriptionEntry> llDescriptions;
229};
230
231////////////////////////////////////////////////////////////////////////////////
232//
233// internal helpers
234//
235////////////////////////////////////////////////////////////////////////////////
236
237static Utf8Str stripFilename(const Utf8Str &strFile)
238{
239 Utf8Str str2(strFile);
240 RTPathStripFilename(str2.mutableRaw());
241 return str2;
242}
243
244static const struct
245{
246 CIMOSType_T cim;
247 const char *pcszVbox;
248}
249 g_osTypes[] =
250 {
251 { CIMOSType_CIMOS_Unknown, SchemaDefs_OSTypeId_Other },
252 { CIMOSType_CIMOS_OS2, SchemaDefs_OSTypeId_OS2 },
253 { CIMOSType_CIMOS_MSDOS, SchemaDefs_OSTypeId_DOS },
254 { CIMOSType_CIMOS_WIN3x, SchemaDefs_OSTypeId_Windows31 },
255 { CIMOSType_CIMOS_WIN95, SchemaDefs_OSTypeId_Windows95 },
256 { CIMOSType_CIMOS_WIN98, SchemaDefs_OSTypeId_Windows98 },
257 { CIMOSType_CIMOS_WINNT, SchemaDefs_OSTypeId_WindowsNT4 },
258 { CIMOSType_CIMOS_NetWare, SchemaDefs_OSTypeId_Netware },
259 { CIMOSType_CIMOS_NovellOES, SchemaDefs_OSTypeId_Netware },
260 { CIMOSType_CIMOS_Solaris, SchemaDefs_OSTypeId_OpenSolaris },
261 { CIMOSType_CIMOS_SunOS, SchemaDefs_OSTypeId_OpenSolaris },
262 { CIMOSType_CIMOS_FreeBSD, SchemaDefs_OSTypeId_FreeBSD },
263 { CIMOSType_CIMOS_NetBSD, SchemaDefs_OSTypeId_NetBSD },
264 { CIMOSType_CIMOS_QNX, SchemaDefs_OSTypeId_QNX },
265 { CIMOSType_CIMOS_Windows2000, SchemaDefs_OSTypeId_Windows2000 },
266 { CIMOSType_CIMOS_WindowsMe, SchemaDefs_OSTypeId_WindowsMe },
267 { CIMOSType_CIMOS_OpenBSD, SchemaDefs_OSTypeId_OpenBSD },
268 { CIMOSType_CIMOS_WindowsXP, SchemaDefs_OSTypeId_WindowsXP },
269 { CIMOSType_CIMOS_WindowsXPEmbedded, SchemaDefs_OSTypeId_WindowsXP },
270 { CIMOSType_CIMOS_WindowsEmbeddedforPointofService, SchemaDefs_OSTypeId_WindowsXP },
271 { CIMOSType_CIMOS_MicrosoftWindowsServer2003, SchemaDefs_OSTypeId_Windows2003 },
272 { CIMOSType_CIMOS_MicrosoftWindowsServer2003_64, SchemaDefs_OSTypeId_Windows2003_64 },
273 { CIMOSType_CIMOS_WindowsXP_64, SchemaDefs_OSTypeId_WindowsXP_64 },
274 { CIMOSType_CIMOS_WindowsVista, SchemaDefs_OSTypeId_WindowsVista },
275 { CIMOSType_CIMOS_WindowsVista_64, SchemaDefs_OSTypeId_WindowsVista_64 },
276 { CIMOSType_CIMOS_MicrosoftWindowsServer2008, SchemaDefs_OSTypeId_Windows2008 },
277 { CIMOSType_CIMOS_MicrosoftWindowsServer2008_64, SchemaDefs_OSTypeId_Windows2008_64 },
278 { CIMOSType_CIMOS_FreeBSD_64, SchemaDefs_OSTypeId_FreeBSD_64 },
279 { CIMOSType_CIMOS_RedHatEnterpriseLinux, SchemaDefs_OSTypeId_RedHat },
280 { CIMOSType_CIMOS_RedHatEnterpriseLinux_64, SchemaDefs_OSTypeId_RedHat_64 },
281 { CIMOSType_CIMOS_Solaris_64, SchemaDefs_OSTypeId_OpenSolaris_64 },
282 { CIMOSType_CIMOS_SUSE, SchemaDefs_OSTypeId_OpenSUSE },
283 { CIMOSType_CIMOS_SLES, SchemaDefs_OSTypeId_OpenSUSE },
284 { CIMOSType_CIMOS_NovellLinuxDesktop, SchemaDefs_OSTypeId_OpenSUSE },
285 { CIMOSType_CIMOS_SUSE_64, SchemaDefs_OSTypeId_OpenSUSE_64 },
286 { CIMOSType_CIMOS_SLES_64, SchemaDefs_OSTypeId_OpenSUSE_64 },
287 { CIMOSType_CIMOS_LINUX, SchemaDefs_OSTypeId_Linux },
288 { CIMOSType_CIMOS_SunJavaDesktopSystem, SchemaDefs_OSTypeId_Linux },
289 { CIMOSType_CIMOS_TurboLinux, SchemaDefs_OSTypeId_Linux},
290
291 // { CIMOSType_CIMOS_TurboLinux_64, },
292
293 { CIMOSType_CIMOS_Mandriva, SchemaDefs_OSTypeId_Mandriva },
294 { CIMOSType_CIMOS_Mandriva_64, SchemaDefs_OSTypeId_Mandriva_64 },
295 { CIMOSType_CIMOS_Ubuntu, SchemaDefs_OSTypeId_Ubuntu },
296 { CIMOSType_CIMOS_Ubuntu_64, SchemaDefs_OSTypeId_Ubuntu_64 },
297 { CIMOSType_CIMOS_Debian, SchemaDefs_OSTypeId_Debian },
298 { CIMOSType_CIMOS_Debian_64, SchemaDefs_OSTypeId_Debian_64 },
299 { CIMOSType_CIMOS_Linux_2_4_x, SchemaDefs_OSTypeId_Linux24 },
300 { CIMOSType_CIMOS_Linux_2_4_x_64, SchemaDefs_OSTypeId_Linux24_64 },
301 { CIMOSType_CIMOS_Linux_2_6_x, SchemaDefs_OSTypeId_Linux26 },
302 { CIMOSType_CIMOS_Linux_2_6_x_64, SchemaDefs_OSTypeId_Linux26_64 },
303 { CIMOSType_CIMOS_Linux_64, SchemaDefs_OSTypeId_Linux26_64 }
304};
305
306/* Pattern structure for matching the os type description field */
307struct osTypePattern
308{
309 const char *pcszPattern;
310 const char *pcszVbox;
311};
312
313/* These are the 32-Bit ones. They are sorted by priority. */
314static const osTypePattern g_osTypesPattern[] =
315{
316 {"Windows NT", SchemaDefs_OSTypeId_WindowsNT4},
317 {"Windows XP", SchemaDefs_OSTypeId_WindowsXP},
318 {"Windows 2000", SchemaDefs_OSTypeId_Windows2000},
319 {"Windows 2003", SchemaDefs_OSTypeId_Windows2003},
320 {"Windows Vista", SchemaDefs_OSTypeId_WindowsVista},
321 {"Windows 2008", SchemaDefs_OSTypeId_Windows2008},
322 {"SUSE", SchemaDefs_OSTypeId_OpenSUSE},
323 {"Novell", SchemaDefs_OSTypeId_OpenSUSE},
324 {"Red Hat", SchemaDefs_OSTypeId_RedHat},
325 {"Mandriva", SchemaDefs_OSTypeId_Mandriva},
326 {"Ubuntu", SchemaDefs_OSTypeId_Ubuntu},
327 {"Debian", SchemaDefs_OSTypeId_Debian},
328 {"QNX", SchemaDefs_OSTypeId_QNX},
329 {"Linux 2.4", SchemaDefs_OSTypeId_Linux24},
330 {"Linux 2.6", SchemaDefs_OSTypeId_Linux26},
331 {"Linux", SchemaDefs_OSTypeId_Linux},
332 {"OpenSolaris", SchemaDefs_OSTypeId_OpenSolaris},
333 {"Solaris", SchemaDefs_OSTypeId_OpenSolaris},
334 {"FreeBSD", SchemaDefs_OSTypeId_FreeBSD},
335 {"NetBSD", SchemaDefs_OSTypeId_NetBSD},
336 {"Windows 95", SchemaDefs_OSTypeId_Windows95},
337 {"Windows 98", SchemaDefs_OSTypeId_Windows98},
338 {"Windows Me", SchemaDefs_OSTypeId_WindowsMe},
339 {"Windows 3.", SchemaDefs_OSTypeId_Windows31},
340 {"DOS", SchemaDefs_OSTypeId_DOS},
341 {"OS2", SchemaDefs_OSTypeId_OS2}
342};
343
344/* These are the 64-Bit ones. They are sorted by priority. */
345static const osTypePattern g_osTypesPattern64[] =
346{
347 {"Windows XP", SchemaDefs_OSTypeId_WindowsXP_64},
348 {"Windows 2003", SchemaDefs_OSTypeId_Windows2003_64},
349 {"Windows Vista", SchemaDefs_OSTypeId_WindowsVista_64},
350 {"Windows 2008", SchemaDefs_OSTypeId_Windows2008_64},
351 {"SUSE", SchemaDefs_OSTypeId_OpenSUSE_64},
352 {"Novell", SchemaDefs_OSTypeId_OpenSUSE_64},
353 {"Red Hat", SchemaDefs_OSTypeId_RedHat_64},
354 {"Mandriva", SchemaDefs_OSTypeId_Mandriva_64},
355 {"Ubuntu", SchemaDefs_OSTypeId_Ubuntu_64},
356 {"Debian", SchemaDefs_OSTypeId_Debian_64},
357 {"Linux 2.4", SchemaDefs_OSTypeId_Linux24_64},
358 {"Linux 2.6", SchemaDefs_OSTypeId_Linux26_64},
359 {"Linux", SchemaDefs_OSTypeId_Linux26_64},
360 {"OpenSolaris", SchemaDefs_OSTypeId_OpenSolaris_64},
361 {"Solaris", SchemaDefs_OSTypeId_OpenSolaris_64},
362 {"FreeBSD", SchemaDefs_OSTypeId_FreeBSD_64},
363};
364
365/**
366 * Private helper func that suggests a VirtualBox guest OS type
367 * for the given OVF operating system type.
368 * @param osTypeVBox
369 * @param c
370 * @param cStr
371 */
372static void convertCIMOSType2VBoxOSType(Utf8Str &strType, CIMOSType_T c, const Utf8Str &cStr)
373{
374 /* First check if the type is other/other_64 */
375 if (c == CIMOSType_CIMOS_Other)
376 {
377 for (size_t i=0; i < RT_ELEMENTS(g_osTypesPattern); ++i)
378 if (cStr.contains (g_osTypesPattern[i].pcszPattern, Utf8Str::CaseInsensitive))
379 {
380 strType = g_osTypesPattern[i].pcszVbox;
381 return;
382 }
383 }
384 else if (c == CIMOSType_CIMOS_Other_64)
385 {
386 for (size_t i=0; i < RT_ELEMENTS(g_osTypesPattern64); ++i)
387 if (cStr.contains (g_osTypesPattern64[i].pcszPattern, Utf8Str::CaseInsensitive))
388 {
389 strType = g_osTypesPattern64[i].pcszVbox;
390 return;
391 }
392 }
393
394 for (size_t i = 0; i < RT_ELEMENTS(g_osTypes); ++i)
395 {
396 if (c == g_osTypes[i].cim)
397 {
398 strType = g_osTypes[i].pcszVbox;
399 return;
400 }
401 }
402
403 strType = SchemaDefs_OSTypeId_Other;
404}
405
406/**
407 * Private helper func that suggests a VirtualBox guest OS type
408 * for the given OVF operating system type.
409 * @param osTypeVBox
410 * @param c
411 */
412static CIMOSType_T convertVBoxOSType2CIMOSType(const char *pcszVbox)
413{
414 for (size_t i = 0; i < RT_ELEMENTS(g_osTypes); ++i)
415 {
416 if (!RTStrICmp(pcszVbox, g_osTypes[i].pcszVbox))
417 return g_osTypes[i].cim;
418 }
419
420 return CIMOSType_CIMOS_Other;
421}
422
423////////////////////////////////////////////////////////////////////////////////
424//
425// IVirtualBox public methods
426//
427////////////////////////////////////////////////////////////////////////////////
428
429// This code is here so we won't have to include the appliance headers in the
430// IVirtualBox implementation.
431
432/**
433 * Implementation for IVirtualBox::createAppliance.
434 *
435 * @param anAppliance IAppliance object created if S_OK is returned.
436 * @return S_OK or error.
437 */
438STDMETHODIMP VirtualBox::CreateAppliance(IAppliance** anAppliance)
439{
440 HRESULT rc;
441
442 ComObjPtr<Appliance> appliance;
443 appliance.createObject();
444 rc = appliance->init(this);
445
446 if (SUCCEEDED(rc))
447 appliance.queryInterfaceTo(anAppliance);
448
449 return rc;
450}
451
452////////////////////////////////////////////////////////////////////////////////
453//
454// Appliance constructor / destructor
455//
456////////////////////////////////////////////////////////////////////////////////
457
458DEFINE_EMPTY_CTOR_DTOR(Appliance)
459struct shutup {};
460
461/**
462 * Appliance COM initializer.
463 * @param
464 * @return
465 */
466HRESULT Appliance::init(VirtualBox *aVirtualBox)
467{
468 /* Enclose the state transition NotReady->InInit->Ready */
469 AutoInitSpan autoInitSpan(this);
470 AssertReturn(autoInitSpan.isOk(), E_FAIL);
471
472 /* Weak reference to a VirtualBox object */
473 unconst(mVirtualBox) = aVirtualBox;
474
475 // initialize data
476 m = new Data;
477
478 /* Confirm a successful initialization */
479 autoInitSpan.setSucceeded();
480
481 return S_OK;
482}
483
484/**
485 * Appliance COM uninitializer.
486 * @return
487 */
488void Appliance::uninit()
489{
490 delete m;
491 m = NULL;
492}
493
494////////////////////////////////////////////////////////////////////////////////
495//
496// Appliance private methods
497//
498////////////////////////////////////////////////////////////////////////////////
499
500/**
501 * Private helper method that goes thru the elements of the given "current" element in the OVF XML
502 * and handles the contained child elements (which can be "Section" or "Content" elements).
503 *
504 * @param pcszPath Path spec of the XML file, for error messages.
505 * @param pReferencesElement "References" element from OVF, for looking up file specifications; can be NULL if no such element is present.
506 * @param pCurElem Element whose children are to be analyzed here.
507 * @return
508 */
509HRESULT Appliance::LoopThruSections(const char *pcszPath,
510 const xml::ElementNode *pReferencesElem,
511 const xml::ElementNode *pCurElem)
512{
513 HRESULT rc;
514
515 xml::NodesLoop loopChildren(*pCurElem);
516 const xml::ElementNode *pElem;
517 while ((pElem = loopChildren.forAllNodes()))
518 {
519 const char *pcszElemName = pElem->getName();
520 const char *pcszTypeAttr = "";
521 const xml::AttributeNode *pTypeAttr;
522 if ((pTypeAttr = pElem->findAttribute("type")))
523 pcszTypeAttr = pTypeAttr->getValue();
524
525 if ( (!strcmp(pcszElemName, "DiskSection"))
526 || ( (!strcmp(pcszElemName, "Section"))
527 && (!strcmp(pcszTypeAttr, "ovf:DiskSection_Type"))
528 )
529 )
530 {
531 if (!(SUCCEEDED((rc = HandleDiskSection(pcszPath, pReferencesElem, pElem)))))
532 return rc;
533 }
534 else if ( (!strcmp(pcszElemName, "NetworkSection"))
535 || ( (!strcmp(pcszElemName, "Section"))
536 && (!strcmp(pcszTypeAttr, "ovf:NetworkSection_Type"))
537 )
538 )
539 {
540 if (!(SUCCEEDED((rc = HandleNetworkSection(pcszPath, pElem)))))
541 return rc;
542 }
543 else if ( (!strcmp(pcszElemName, "DeploymentOptionSection")))
544 {
545 // TODO
546 }
547 else if ( (!strcmp(pcszElemName, "Info")))
548 {
549 // child of VirtualSystemCollection -- TODO
550 }
551 else if ( (!strcmp(pcszElemName, "ResourceAllocationSection")))
552 {
553 // child of VirtualSystemCollection -- TODO
554 }
555 else if ( (!strcmp(pcszElemName, "StartupSection")))
556 {
557 // child of VirtualSystemCollection -- TODO
558 }
559 else if ( (!strcmp(pcszElemName, "VirtualSystem"))
560 || ( (!strcmp(pcszElemName, "Content"))
561 && (!strcmp(pcszTypeAttr, "ovf:VirtualSystem_Type"))
562 )
563 )
564 {
565 if (!(SUCCEEDED((rc = HandleVirtualSystemContent(pcszPath, pElem)))))
566 return rc;
567 }
568 else if ( (!strcmp(pcszElemName, "VirtualSystemCollection"))
569 || ( (!strcmp(pcszElemName, "Content"))
570 && (!strcmp(pcszTypeAttr, "ovf:VirtualSystemCollection_Type"))
571 )
572 )
573 {
574 // TODO ResourceAllocationSection
575
576 // recurse for this, since it has VirtualSystem elements as children
577 if (!(SUCCEEDED((rc = LoopThruSections(pcszPath, pReferencesElem, pElem)))))
578 return rc;
579 }
580 }
581
582 return S_OK;
583}
584
585/**
586 * Private helper method that handles disk sections in the OVF XML.
587 * Gets called indirectly from IAppliance::read().
588 *
589 * @param pcszPath Path spec of the XML file, for error messages.
590 * @param pReferencesElement "References" element from OVF, for looking up file specifications; can be NULL if no such element is present.
591 * @param pSectionElem Section element for which this helper is getting called.
592 * @return
593 */
594HRESULT Appliance::HandleDiskSection(const char *pcszPath,
595 const xml::ElementNode *pReferencesElem,
596 const xml::ElementNode *pSectionElem)
597{
598 // contains "Disk" child elements
599 xml::NodesLoop loopDisks(*pSectionElem, "Disk");
600 const xml::ElementNode *pelmDisk;
601 while ((pelmDisk = loopDisks.forAllNodes()))
602 {
603 DiskImage d;
604 const char *pcszBad = NULL;
605 const char *pcszDiskId;
606 const char *pcszFormat;
607 if (!(pelmDisk->getAttributeValue("diskId", pcszDiskId)))
608 pcszBad = "diskId";
609 else if (!(pelmDisk->getAttributeValue("format", pcszFormat)))
610 pcszBad = "format";
611 else if (!(pelmDisk->getAttributeValue("capacity", d.iCapacity)))
612 pcszBad = "capacity";
613 else
614 {
615 d.strDiskId = pcszDiskId;
616 d.strFormat = pcszFormat;
617
618 if (!(pelmDisk->getAttributeValue("populatedSize", d.iPopulatedSize)))
619 // optional
620 d.iPopulatedSize = -1;
621
622 const char *pcszFileRef;
623 if (pelmDisk->getAttributeValue("fileRef", pcszFileRef)) // optional
624 {
625 // look up corresponding /References/File nodes (list built above)
626 const xml::ElementNode *pFileElem;
627 if ( pReferencesElem
628 && ((pFileElem = pReferencesElem->findChildElementFromId(pcszFileRef)))
629 )
630 {
631 // copy remaining values from file node then
632 const char *pcszBadInFile = NULL;
633 const char *pcszHref;
634 if (!(pFileElem->getAttributeValue("href", pcszHref)))
635 pcszBadInFile = "href";
636 else if (!(pFileElem->getAttributeValue("size", d.iSize)))
637 d.iSize = -1; // optional
638
639 d.strHref = pcszHref;
640
641 // if (!(pFileElem->getAttributeValue("size", d.iChunkSize))) TODO
642 d.iChunkSize = -1; // optional
643 const char *pcszCompression;
644 if (pFileElem->getAttributeValue("compression", pcszCompression))
645 d.strCompression = pcszCompression;
646
647 if (pcszBadInFile)
648 return setError(VBOX_E_FILE_ERROR,
649 tr("Error reading \"%s\": missing or invalid attribute '%s' in 'File' element, line %d"),
650 pcszPath,
651 pcszBadInFile,
652 pFileElem->getLineNumber());
653 }
654 else
655 return setError(VBOX_E_FILE_ERROR,
656 tr("Error reading \"%s\": cannot find References/File element for ID '%s' referenced by 'Disk' element, line %d"),
657 pcszPath,
658 pcszFileRef,
659 pelmDisk->getLineNumber());
660 }
661 }
662
663 if (pcszBad)
664 return setError(VBOX_E_FILE_ERROR,
665 tr("Error reading \"%s\": missing or invalid attribute '%s' in 'DiskSection' element, line %d"),
666 pcszPath,
667 pcszBad,
668 pelmDisk->getLineNumber());
669
670 m->mapDisks[d.strDiskId] = d;
671 }
672
673 return S_OK;
674}
675
676/**
677 * Private helper method that handles network sections in the OVF XML.
678 * Gets called indirectly from IAppliance::read().
679 *
680 * @param pcszPath Path spec of the XML file, for error messages.
681 * @param pSectionElem Section element for which this helper is getting called.
682 * @return
683 */
684HRESULT Appliance::HandleNetworkSection(const char * /* pcszPath */,
685 const xml::ElementNode * /* pSectionElem */)
686{
687 // we ignore network sections for now
688
689// xml::NodesLoop loopNetworks(*pSectionElem, "Network");
690// const xml::Node *pelmNetwork;
691// while ((pelmNetwork = loopNetworks.forAllNodes()))
692// {
693// Network n;
694// if (!(pelmNetwork->getAttributeValue("name", n.strNetworkName)))
695// return setError(VBOX_E_FILE_ERROR,
696// tr("Error reading \"%s\": missing 'name' attribute in 'Network', line %d"),
697// pcszPath,
698// pelmNetwork->getLineNumber());
699//
700// m->mapNetworks[n.strNetworkName] = n;
701// }
702
703 return S_OK;
704}
705
706/**
707 * Private helper method that handles a "VirtualSystem" element in the OVF XML.
708 * Gets called indirectly from IAppliance::read().
709 *
710 * @param pcszPath
711 * @param pContentElem
712 * @return
713 */
714HRESULT Appliance::HandleVirtualSystemContent(const char *pcszPath,
715 const xml::ElementNode *pelmVirtualSystem)
716{
717 VirtualSystem vsys;
718
719 const xml::AttributeNode *pIdAttr = pelmVirtualSystem->findAttribute("id");
720 if (pIdAttr)
721 vsys.strName = pIdAttr->getValue();
722
723 xml::NodesLoop loop(*pelmVirtualSystem); // all child elements
724 const xml::ElementNode *pelmThis;
725 while ((pelmThis = loop.forAllNodes()))
726 {
727 const char *pcszElemName = pelmThis->getName();
728 const xml::AttributeNode *pTypeAttr = pelmThis->findAttribute("type");
729 const char *pcszTypeAttr = (pTypeAttr) ? pTypeAttr->getValue() : "";
730
731 if ( (!strcmp(pcszElemName, "EulaSection"))
732 || (!strcmp(pcszTypeAttr, "ovf:EulaSection_Type"))
733 )
734 {
735 /* <EulaSection>
736 <Info ovf:msgid="6">License agreement for the Virtual System.</Info>
737 <License ovf:msgid="1">License terms can go in here.</License>
738 </EulaSection> */
739
740 const xml::ElementNode *pelmLicense;
741 if ((pelmLicense = pelmThis->findChildElement("License")))
742 vsys.strLicenseText = pelmLicense->getValue();
743 }
744 if ( (!strcmp(pcszElemName, "ProductSection"))
745 || (!strcmp(pcszTypeAttr, "ovf:ProductSection_Type"))
746 )
747 {
748 /* <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
749 <Info>Meta-information about the installed software</Info>
750 <Product>VAtest</Product>
751 <Vendor>SUN Microsystems</Vendor>
752 <Version>10.0</Version>
753 <ProductUrl>http://blogs.sun.com/VirtualGuru</ProductUrl>
754 <VendorUrl>http://www.sun.com</VendorUrl>
755 </Section> */
756 const xml::ElementNode *pelmProduct;
757 if ((pelmProduct = pelmThis->findChildElement("Product")))
758 vsys.strProduct = pelmProduct->getValue();
759 const xml::ElementNode *pelmVendor;
760 if ((pelmVendor = pelmThis->findChildElement("Vendor")))
761 vsys.strVendor = pelmVendor->getValue();
762 const xml::ElementNode *pelmVersion;
763 if ((pelmVersion = pelmThis->findChildElement("Version")))
764 vsys.strVersion = pelmVersion->getValue();
765 const xml::ElementNode *pelmProductUrl;
766 if ((pelmProductUrl = pelmThis->findChildElement("ProductUrl")))
767 vsys.strProductUrl = pelmProductUrl->getValue();
768 const xml::ElementNode *pelmVendorUrl;
769 if ((pelmVendorUrl = pelmThis->findChildElement("VendorUrl")))
770 vsys.strVendorUrl = pelmVendorUrl->getValue();
771 }
772 else if ( (!strcmp(pcszElemName, "VirtualHardwareSection"))
773 || (!strcmp(pcszTypeAttr, "ovf:VirtualHardwareSection_Type"))
774 )
775 {
776 const xml::ElementNode *pelmSystem, *pelmVirtualSystemType;
777 if ((pelmSystem = pelmThis->findChildElement("System")))
778 {
779 /* <System>
780 <vssd:Description>Description of the virtual hardware section.</vssd:Description>
781 <vssd:ElementName>vmware</vssd:ElementName>
782 <vssd:InstanceID>1</vssd:InstanceID>
783 <vssd:VirtualSystemIdentifier>MyLampService</vssd:VirtualSystemIdentifier>
784 <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
785 </System>*/
786 if ((pelmVirtualSystemType = pelmSystem->findChildElement("VirtualSystemType")))
787 vsys.strVirtualSystemType = pelmVirtualSystemType->getValue();
788 }
789
790 xml::NodesLoop loopVirtualHardwareItems(*pelmThis, "Item"); // all "Item" child elements
791 const xml::ElementNode *pelmItem;
792 while ((pelmItem = loopVirtualHardwareItems.forAllNodes()))
793 {
794 VirtualHardwareItem i;
795
796 i.ulLineNumber = pelmItem->getLineNumber();
797
798 xml::NodesLoop loopItemChildren(*pelmItem); // all child elements
799 const xml::ElementNode *pelmItemChild;
800 while ((pelmItemChild = loopItemChildren.forAllNodes()))
801 {
802 const char *pcszItemChildName = pelmItemChild->getName();
803 if (!strcmp(pcszItemChildName, "Description"))
804 i.strDescription = pelmItemChild->getValue();
805 else if (!strcmp(pcszItemChildName, "Caption"))
806 i.strCaption = pelmItemChild->getValue();
807 else if (!strcmp(pcszItemChildName, "ElementName"))
808 i.strElementName = pelmItemChild->getValue();
809 else if ( (!strcmp(pcszItemChildName, "InstanceID"))
810 || (!strcmp(pcszItemChildName, "InstanceId"))
811 )
812 pelmItemChild->copyValue(i.ulInstanceID);
813 else if (!strcmp(pcszItemChildName, "HostResource"))
814 i.strHostResource = pelmItemChild->getValue();
815 else if (!strcmp(pcszItemChildName, "ResourceType"))
816 {
817 uint32_t ulType;
818 pelmItemChild->copyValue(ulType);
819 i.resourceType = (OVFResourceType_T)ulType;
820 }
821 else if (!strcmp(pcszItemChildName, "OtherResourceType"))
822 i.strOtherResourceType = pelmItemChild->getValue();
823 else if (!strcmp(pcszItemChildName, "ResourceSubType"))
824 i.strResourceSubType = pelmItemChild->getValue();
825 else if (!strcmp(pcszItemChildName, "AutomaticAllocation"))
826 i.fAutomaticAllocation = (!strcmp(pelmItemChild->getValue(), "true")) ? true : false;
827 else if (!strcmp(pcszItemChildName, "AutomaticDeallocation"))
828 i.fAutomaticDeallocation = (!strcmp(pelmItemChild->getValue(), "true")) ? true : false;
829 else if (!strcmp(pcszItemChildName, "Parent"))
830 pelmItemChild->copyValue(i.ulParent);
831 else if (!strcmp(pcszItemChildName, "Connection"))
832 i.strConnection = pelmItemChild->getValue();
833 else if (!strcmp(pcszItemChildName, "Address"))
834 i.strAddress = pelmItemChild->getValue();
835 else if (!strcmp(pcszItemChildName, "AddressOnParent"))
836 i.strAddressOnParent = pelmItemChild->getValue();
837 else if (!strcmp(pcszItemChildName, "AllocationUnits"))
838 i.strAllocationUnits = pelmItemChild->getValue();
839 else if (!strcmp(pcszItemChildName, "VirtualQuantity"))
840 pelmItemChild->copyValue(i.ullVirtualQuantity);
841 else if (!strcmp(pcszItemChildName, "Reservation"))
842 pelmItemChild->copyValue(i.ullReservation);
843 else if (!strcmp(pcszItemChildName, "Limit"))
844 pelmItemChild->copyValue(i.ullLimit);
845 else if (!strcmp(pcszItemChildName, "Weight"))
846 pelmItemChild->copyValue(i.ullWeight);
847 else if (!strcmp(pcszItemChildName, "ConsumerVisibility"))
848 i.strConsumerVisibility = pelmItemChild->getValue();
849 else if (!strcmp(pcszItemChildName, "MappingBehavior"))
850 i.strMappingBehavior = pelmItemChild->getValue();
851 else if (!strcmp(pcszItemChildName, "PoolID"))
852 i.strPoolID = pelmItemChild->getValue();
853 else if (!strcmp(pcszItemChildName, "BusNumber"))
854 pelmItemChild->copyValue(i.ulBusNumber);
855 else
856 return setError(VBOX_E_FILE_ERROR,
857 tr("Error reading \"%s\": unknown element \"%s\" under Item element, line %d"),
858 pcszPath,
859 pcszItemChildName,
860 i.ulLineNumber);
861 }
862
863 // store!
864 vsys.mapHardwareItems[i.ulInstanceID] = i;
865 }
866
867 // now go thru all hardware items and handle them according to their type;
868 // in this first loop we handle all items _except_ hard disk images,
869 // which we'll handle in a second loop below
870 HardwareItemsMap::const_iterator itH;
871 for (itH = vsys.mapHardwareItems.begin();
872 itH != vsys.mapHardwareItems.end();
873 ++itH)
874 {
875 const VirtualHardwareItem &i = itH->second;
876
877 // do some analysis
878 switch (i.resourceType)
879 {
880 case OVFResourceType_Processor: // 3
881 /* <rasd:Caption>1 virtual CPU</rasd:Caption>
882 <rasd:Description>Number of virtual CPUs</rasd:Description>
883 <rasd:ElementName>virtual CPU</rasd:ElementName>
884 <rasd:InstanceID>1</rasd:InstanceID>
885 <rasd:ResourceType>3</rasd:ResourceType>
886 <rasd:VirtualQuantity>1</rasd:VirtualQuantity>*/
887 if (i.ullVirtualQuantity < UINT16_MAX)
888 vsys.cCPUs = (uint16_t)i.ullVirtualQuantity;
889 else
890 return setError(VBOX_E_FILE_ERROR,
891 tr("Error reading \"%s\": CPU count %RI64 is larger than %d, line %d"),
892 pcszPath,
893 i.ullVirtualQuantity,
894 UINT16_MAX,
895 i.ulLineNumber);
896 break;
897
898 case OVFResourceType_Memory: // 4
899 if ( (i.strAllocationUnits == "MegaBytes") // found in OVF created by OVF toolkit
900 || (i.strAllocationUnits == "MB") // found in MS docs
901 || (i.strAllocationUnits == "byte * 2^20") // suggested by OVF spec DSP0243 page 21
902 )
903 vsys.ullMemorySize = i.ullVirtualQuantity * 1024 * 1024;
904 else
905 return setError(VBOX_E_FILE_ERROR,
906 tr("Error reading \"%s\": Invalid allocation unit \"%s\" specified with memory size item, line %d"),
907 pcszPath,
908 i.strAllocationUnits.c_str(),
909 i.ulLineNumber);
910 break;
911
912 case OVFResourceType_IDEController: // 5
913 {
914 /* <Item>
915 <rasd:Caption>ideController0</rasd:Caption>
916 <rasd:Description>IDE Controller</rasd:Description>
917 <rasd:InstanceId>5</rasd:InstanceId>
918 <rasd:ResourceType>5</rasd:ResourceType>
919 <rasd:Address>0</rasd:Address>
920 <rasd:BusNumber>0</rasd:BusNumber>
921 </Item> */
922 HardDiskController hdc;
923 hdc.system = HardDiskController::IDE;
924 hdc.idController = i.ulInstanceID;
925 hdc.strControllerType = i.strResourceSubType;
926 hdc.strAddress = i.strAddress;
927 hdc.ulBusNumber = i.ulBusNumber;
928
929 vsys.mapControllers[i.ulInstanceID] = hdc;
930 }
931 break;
932
933 case OVFResourceType_ParallelSCSIHBA: // 6 SCSI controller
934 {
935 /* <Item>
936 <rasd:Caption>SCSI Controller 0 - LSI Logic</rasd:Caption>
937 <rasd:Description>SCI Controller</rasd:Description>
938 <rasd:ElementName>SCSI controller</rasd:ElementName>
939 <rasd:InstanceID>4</rasd:InstanceID>
940 <rasd:ResourceSubType>LsiLogic</rasd:ResourceSubType>
941 <rasd:ResourceType>6</rasd:ResourceType>
942 </Item> */
943 HardDiskController hdc;
944 hdc.system = HardDiskController::SCSI;
945 hdc.idController = i.ulInstanceID;
946 hdc.strControllerType = i.strResourceSubType;
947
948 vsys.mapControllers[i.ulInstanceID] = hdc;
949 }
950 break;
951
952 case OVFResourceType_EthernetAdapter: // 10
953 {
954 /* <Item>
955 <rasd:Caption>Ethernet adapter on 'Bridged'</rasd:Caption>
956 <rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
957 <rasd:Connection>Bridged</rasd:Connection>
958 <rasd:InstanceID>6</rasd:InstanceID>
959 <rasd:ResourceType>10</rasd:ResourceType>
960 <rasd:ResourceSubType>E1000</rasd:ResourceSubType>
961 </Item>
962
963 OVF spec DSP 0243 page 21:
964 "For an Ethernet adapter, this specifies the abstract network connection name
965 for the virtual machine. All Ethernet adapters that specify the same abstract
966 network connection name within an OVF package shall be deployed on the same
967 network. The abstract network connection name shall be listed in the NetworkSection
968 at the outermost envelope level." */
969
970 // only store the name
971 EthernetAdapter ea;
972 ea.strAdapterType = i.strResourceSubType;
973 ea.strNetworkName = i.strConnection;
974 vsys.llEthernetAdapters.push_back(ea);
975 }
976 break;
977
978 case OVFResourceType_FloppyDrive: // 14
979 vsys.fHasFloppyDrive = true; // we have no additional information
980 break;
981
982 case OVFResourceType_CDDrive: // 15
983 /* <Item ovf:required="false">
984 <rasd:Caption>cdrom1</rasd:Caption>
985 <rasd:InstanceId>7</rasd:InstanceId>
986 <rasd:ResourceType>15</rasd:ResourceType>
987 <rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
988 <rasd:Parent>5</rasd:Parent>
989 <rasd:AddressOnParent>0</rasd:AddressOnParent>
990 </Item> */
991 // I tried to see what happens if I set an ISO for the CD-ROM in VMware Workstation,
992 // but then the ovftool dies with "Device backing not supported". So I guess if
993 // VMware can't export ISOs, then we don't need to be able to import them right now.
994 vsys.fHasCdromDrive = true; // we have no additional information
995 break;
996
997 case OVFResourceType_HardDisk: // 17
998 // handled separately in second loop below
999 break;
1000
1001 case OVFResourceType_OtherStorageDevice: // 20 SATA controller
1002 {
1003 /* <Item>
1004 <rasd:Description>SATA Controller</rasd:Description>
1005 <rasd:Caption>sataController0</rasd:Caption>
1006 <rasd:InstanceID>4</rasd:InstanceID>
1007 <rasd:ResourceType>20</rasd:ResourceType>
1008 <rasd:ResourceSubType>AHCI</rasd:ResourceSubType>
1009 <rasd:Address>0</rasd:Address>
1010 <rasd:BusNumber>0</rasd:BusNumber>
1011 </Item> */
1012 if (i.strCaption.startsWith ("sataController", Utf8Str::CaseInsensitive) &&
1013 !i.strResourceSubType.compare ("AHCI", Utf8Str::CaseInsensitive))
1014 {
1015 HardDiskController hdc;
1016 hdc.system = HardDiskController::SATA;
1017 hdc.idController = i.ulInstanceID;
1018 hdc.strControllerType = i.strResourceSubType;
1019
1020 vsys.mapControllers[i.ulInstanceID] = hdc;
1021 }
1022 else
1023 return setError(VBOX_E_FILE_ERROR,
1024 tr("Error reading \"%s\": Host resource of type \"Other Storage Device (%d)\" is supported with SATA AHCI controllers only, line %d"),
1025 pcszPath,
1026 OVFResourceType_OtherStorageDevice,
1027 i.ulLineNumber);
1028 }
1029 break;
1030
1031 case OVFResourceType_USBController: // 23
1032 /* <Item ovf:required="false">
1033 <rasd:Caption>usb</rasd:Caption>
1034 <rasd:Description>USB Controller</rasd:Description>
1035 <rasd:InstanceId>3</rasd:InstanceId>
1036 <rasd:ResourceType>23</rasd:ResourceType>
1037 <rasd:Address>0</rasd:Address>
1038 <rasd:BusNumber>0</rasd:BusNumber>
1039 </Item> */
1040 vsys.fHasUsbController = true; // we have no additional information
1041 break;
1042
1043 case OVFResourceType_SoundCard: // 35
1044 /* <Item ovf:required="false">
1045 <rasd:Caption>sound</rasd:Caption>
1046 <rasd:Description>Sound Card</rasd:Description>
1047 <rasd:InstanceId>10</rasd:InstanceId>
1048 <rasd:ResourceType>35</rasd:ResourceType>
1049 <rasd:ResourceSubType>ensoniq1371</rasd:ResourceSubType>
1050 <rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
1051 <rasd:AddressOnParent>3</rasd:AddressOnParent>
1052 </Item> */
1053 vsys.strSoundCardType = i.strResourceSubType;
1054 break;
1055
1056 default:
1057 return setError(VBOX_E_FILE_ERROR,
1058 tr("Error reading \"%s\": Unknown resource type %d in hardware item, line %d"),
1059 pcszPath,
1060 i.resourceType,
1061 i.ulLineNumber);
1062 } // end switch
1063 }
1064
1065 // now run through the items for a second time, but handle only
1066 // hard disk images; otherwise the code would fail if a hard
1067 // disk image appears in the OVF before its hard disk controller
1068 for (itH = vsys.mapHardwareItems.begin();
1069 itH != vsys.mapHardwareItems.end();
1070 ++itH)
1071 {
1072 const VirtualHardwareItem &i = itH->second;
1073
1074 // do some analysis
1075 switch (i.resourceType)
1076 {
1077 case OVFResourceType_HardDisk: // 17
1078 {
1079 /* <Item>
1080 <rasd:Caption>Harddisk 1</rasd:Caption>
1081 <rasd:Description>HD</rasd:Description>
1082 <rasd:ElementName>Hard Disk</rasd:ElementName>
1083 <rasd:HostResource>ovf://disk/lamp</rasd:HostResource>
1084 <rasd:InstanceID>5</rasd:InstanceID>
1085 <rasd:Parent>4</rasd:Parent>
1086 <rasd:ResourceType>17</rasd:ResourceType>
1087 </Item> */
1088
1089 // look up the hard disk controller element whose InstanceID equals our Parent;
1090 // this is how the connection is specified in OVF
1091 ControllersMap::const_iterator it = vsys.mapControllers.find(i.ulParent);
1092 if (it == vsys.mapControllers.end())
1093 return setError(VBOX_E_FILE_ERROR,
1094 tr("Error reading \"%s\": Hard disk item with instance ID %d specifies invalid parent %d, line %d"),
1095 pcszPath,
1096 i.ulInstanceID,
1097 i.ulParent,
1098 i.ulLineNumber);
1099 //const HardDiskController &hdc = it->second;
1100
1101 VirtualDisk vd;
1102 vd.idController = i.ulParent;
1103 i.strAddressOnParent.toInt(vd.ulAddressOnParent);
1104 // ovf://disk/lamp
1105 // 123456789012345
1106 if (i.strHostResource.substr(0, 11) == "ovf://disk/")
1107 vd.strDiskId = i.strHostResource.substr(11);
1108 else if (i.strHostResource.substr(0, 6) == "/disk/")
1109 vd.strDiskId = i.strHostResource.substr(6);
1110
1111 if ( !(vd.strDiskId.length())
1112 || (m->mapDisks.find(vd.strDiskId) == m->mapDisks.end())
1113 )
1114 return setError(VBOX_E_FILE_ERROR,
1115 tr("Error reading \"%s\": Hard disk item with instance ID %d specifies invalid host resource \"%s\", line %d"),
1116 pcszPath,
1117 i.ulInstanceID,
1118 i.strHostResource.c_str(),
1119 i.ulLineNumber);
1120
1121 vsys.mapVirtualDisks[vd.strDiskId] = vd;
1122 }
1123 break;
1124 }
1125 }
1126 }
1127 else if ( (!strcmp(pcszElemName, "OperatingSystemSection"))
1128 || (!strcmp(pcszTypeAttr, "ovf:OperatingSystemSection_Type"))
1129 )
1130 {
1131 uint64_t cimos64;
1132 if (!(pelmThis->getAttributeValue("id", cimos64)))
1133 return setError(VBOX_E_FILE_ERROR,
1134 tr("Error reading \"%s\": missing or invalid 'ovf:id' attribute in operating system section element, line %d"),
1135 pcszPath,
1136 pelmThis->getLineNumber());
1137
1138 vsys.cimos = (CIMOSType_T)cimos64;
1139 const xml::ElementNode *pelmCIMOSDescription;
1140 if ((pelmCIMOSDescription = pelmThis->findChildElement("Description")))
1141 vsys.strCimosDesc = pelmCIMOSDescription->getValue();
1142 }
1143 else if ( (!strcmp(pcszElemName, "AnnotationSection"))
1144 || (!strcmp(pcszTypeAttr, "ovf:AnnotationSection_Type"))
1145 )
1146 {
1147 const xml::ElementNode *pelmAnnotation;
1148 if ((pelmAnnotation = pelmThis->findChildElement("Annotation")))
1149 vsys.strDescription = pelmAnnotation->getValue();
1150 }
1151 }
1152
1153 // now create the virtual system
1154 m->llVirtualSystems.push_back(vsys);
1155
1156 return S_OK;
1157}
1158
1159////////////////////////////////////////////////////////////////////////////////
1160//
1161// IAppliance public methods
1162//
1163////////////////////////////////////////////////////////////////////////////////
1164
1165/**
1166 * Public method implementation.
1167 * @param
1168 * @return
1169 */
1170STDMETHODIMP Appliance::COMGETTER(Path)(BSTR *aPath)
1171{
1172 if (!aPath)
1173 return E_POINTER;
1174
1175 AutoCaller autoCaller(this);
1176 CheckComRCReturnRC(autoCaller.rc());
1177
1178 AutoReadLock alock(this);
1179
1180 Bstr bstrPath(m->strPath);
1181 bstrPath.cloneTo(aPath);
1182
1183 return S_OK;
1184}
1185
1186/**
1187 * Public method implementation.
1188 * @param
1189 * @return
1190 */
1191STDMETHODIMP Appliance::COMGETTER(Disks)(ComSafeArrayOut(BSTR, aDisks))
1192{
1193 CheckComArgOutSafeArrayPointerValid(aDisks);
1194
1195 AutoCaller autoCaller(this);
1196 CheckComRCReturnRC(autoCaller.rc());
1197
1198 AutoReadLock alock(this);
1199
1200 size_t c = m->mapDisks.size();
1201 com::SafeArray<BSTR> sfaDisks(c);
1202
1203 DiskImagesMap::const_iterator it;
1204 size_t i = 0;
1205 for (it = m->mapDisks.begin();
1206 it != m->mapDisks.end();
1207 ++it, ++i)
1208 {
1209 // create a string representing this disk
1210 const DiskImage &d = it->second;
1211 char *psz = NULL;
1212 RTStrAPrintf(&psz,
1213 "%s\t"
1214 "%RI64\t"
1215 "%RI64\t"
1216 "%s\t"
1217 "%s\t"
1218 "%RI64\t"
1219 "%RI64\t"
1220 "%s",
1221 d.strDiskId.c_str(),
1222 d.iCapacity,
1223 d.iPopulatedSize,
1224 d.strFormat.c_str(),
1225 d.strHref.c_str(),
1226 d.iSize,
1227 d.iChunkSize,
1228 d.strCompression.c_str());
1229 Utf8Str utf(psz);
1230 Bstr bstr(utf);
1231 // push to safearray
1232 bstr.cloneTo(&sfaDisks[i]);
1233 RTStrFree(psz);
1234 }
1235
1236 sfaDisks.detachTo(ComSafeArrayOutArg(aDisks));
1237
1238 return S_OK;
1239}
1240
1241/**
1242 * Public method implementation.
1243 * @param
1244 * @return
1245 */
1246STDMETHODIMP Appliance::COMGETTER(VirtualSystemDescriptions)(ComSafeArrayOut(IVirtualSystemDescription*, aVirtualSystemDescriptions))
1247{
1248 CheckComArgOutSafeArrayPointerValid(aVirtualSystemDescriptions);
1249
1250 AutoCaller autoCaller(this);
1251 CheckComRCReturnRC(autoCaller.rc());
1252
1253 AutoReadLock alock(this);
1254
1255 SafeIfaceArray<IVirtualSystemDescription> sfaVSD(m->virtualSystemDescriptions);
1256 sfaVSD.detachTo(ComSafeArrayOutArg(aVirtualSystemDescriptions));
1257
1258 return S_OK;
1259}
1260
1261/**
1262 * Public method implementation.
1263 * @param path
1264 * @return
1265 */
1266STDMETHODIMP Appliance::Read(IN_BSTR path)
1267{
1268 HRESULT rc = S_OK;
1269
1270 if (!path)
1271 return E_POINTER;
1272
1273 AutoCaller autoCaller(this);
1274 CheckComRCReturnRC(autoCaller.rc());
1275
1276 AutoWriteLock alock(this);
1277
1278 // see if we can handle this file; for now we insist it has an ".ovf" extension
1279 m->strPath = path;
1280 if (!m->strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
1281 return setError(VBOX_E_FILE_ERROR,
1282 tr("Appliance file must have .ovf extension"));
1283
1284 try
1285 {
1286 xml::XmlFileParser parser;
1287 xml::Document doc;
1288 parser.read(m->strPath.raw(),
1289 doc);
1290
1291 const xml::ElementNode *pRootElem = doc.getRootElement();
1292 if (strcmp(pRootElem->getName(), "Envelope"))
1293 return setError(VBOX_E_FILE_ERROR,
1294 tr("Root element in OVF file must be \"Envelope\"."));
1295
1296 // OVF has the following rough layout:
1297 /*
1298 -- <References> .... files referenced from other parts of the file, such as VMDK images
1299 -- Metadata, comprised of several section commands
1300 -- virtual machines, either a single <VirtualSystem>, or a <VirtualSystemCollection>
1301 -- optionally <Strings> for localization
1302 */
1303
1304 // get all "File" child elements of "References" section so we can look up files easily;
1305 // first find the "References" sections so we can look up files
1306 xml::ElementNodesList listFileElements; // receives all /Envelope/References/File nodes
1307 const xml::ElementNode *pReferencesElem;
1308 if ((pReferencesElem = pRootElem->findChildElement("References")))
1309 pReferencesElem->getChildElements(listFileElements, "File");
1310
1311 // now go though the sections
1312 if (!(SUCCEEDED(rc = LoopThruSections(m->strPath.raw(), pReferencesElem, pRootElem))))
1313 return rc;
1314 }
1315 catch(xml::Error &x)
1316 {
1317 return setError(VBOX_E_FILE_ERROR,
1318 x.what());
1319 }
1320
1321 return S_OK;
1322}
1323
1324/**
1325 * Public method implementation.
1326 * @return
1327 */
1328STDMETHODIMP Appliance::Interpret()
1329{
1330 // @todo:
1331 // - don't use COM methods but the methods directly (faster, but needs appropriate locking of that objects itself (s. HardDisk))
1332 // - Appropriate handle errors like not supported file formats
1333 AutoCaller autoCaller(this);
1334 CheckComRCReturnRC(autoCaller.rc());
1335
1336 AutoWriteLock(this);
1337
1338 HRESULT rc = S_OK;
1339
1340 /* Clear any previous virtual system descriptions */
1341 m->virtualSystemDescriptions.clear();
1342
1343 /* We need the default path for storing disk images */
1344 ComPtr<ISystemProperties> systemProps;
1345 rc = mVirtualBox->COMGETTER(SystemProperties)(systemProps.asOutParam());
1346 CheckComRCReturnRC(rc);
1347 Bstr bstrDefaultHardDiskLocation;
1348 rc = systemProps->COMGETTER(DefaultHardDiskFolder)(bstrDefaultHardDiskLocation.asOutParam());
1349 CheckComRCReturnRC(rc);
1350
1351 /* Try/catch so we can clean up on error */
1352 try
1353 {
1354 list<VirtualSystem>::const_iterator it;
1355 /* Iterate through all virtual systems */
1356 for (it = m->llVirtualSystems.begin();
1357 it != m->llVirtualSystems.end();
1358 ++it)
1359 {
1360 const VirtualSystem &vsysThis = *it;
1361
1362 ComObjPtr<VirtualSystemDescription> pNewDesc;
1363 rc = pNewDesc.createObject();
1364 CheckComRCThrowRC(rc);
1365 rc = pNewDesc->init();
1366 CheckComRCThrowRC(rc);
1367
1368 /* Guest OS type */
1369 Utf8Str strOsTypeVBox,
1370 strCIMOSType = Utf8StrFmt("%RI32", (uint32_t)vsysThis.cimos);
1371 convertCIMOSType2VBoxOSType(strOsTypeVBox, vsysThis.cimos, vsysThis.strCimosDesc);
1372 pNewDesc->addEntry(VirtualSystemDescriptionType_OS,
1373 "",
1374 strCIMOSType,
1375 strOsTypeVBox);
1376
1377 /* VM name */
1378 /* If the there isn't any name specified create a default one out of
1379 * the OS type */
1380 Utf8Str nameVBox = vsysThis.strName;
1381 if (nameVBox.isEmpty())
1382 nameVBox = strOsTypeVBox;
1383 searchUniqueVMName(nameVBox);
1384 pNewDesc->addEntry(VirtualSystemDescriptionType_Name,
1385 "",
1386 vsysThis.strName,
1387 nameVBox);
1388
1389 /* VM Product */
1390 if (!vsysThis.strProduct.isEmpty())
1391 pNewDesc->addEntry(VirtualSystemDescriptionType_Product,
1392 "",
1393 vsysThis.strProduct,
1394 vsysThis.strProduct);
1395
1396 /* VM Vendor */
1397 if (!vsysThis.strVendor.isEmpty())
1398 pNewDesc->addEntry(VirtualSystemDescriptionType_Vendor,
1399 "",
1400 vsysThis.strVendor,
1401 vsysThis.strVendor);
1402
1403 /* VM Version */
1404 if (!vsysThis.strVersion.isEmpty())
1405 pNewDesc->addEntry(VirtualSystemDescriptionType_Version,
1406 "",
1407 vsysThis.strVersion,
1408 vsysThis.strVersion);
1409
1410 /* VM ProductUrl */
1411 if (!vsysThis.strProductUrl.isEmpty())
1412 pNewDesc->addEntry(VirtualSystemDescriptionType_ProductUrl,
1413 "",
1414 vsysThis.strProductUrl,
1415 vsysThis.strProductUrl);
1416
1417 /* VM VendorUrl */
1418 if (!vsysThis.strVendorUrl.isEmpty())
1419 pNewDesc->addEntry(VirtualSystemDescriptionType_VendorUrl,
1420 "",
1421 vsysThis.strVendorUrl,
1422 vsysThis.strVendorUrl);
1423
1424 /* VM description */
1425 if (!vsysThis.strDescription.isEmpty())
1426 pNewDesc->addEntry(VirtualSystemDescriptionType_Description,
1427 "",
1428 vsysThis.strDescription,
1429 vsysThis.strDescription);
1430
1431 /* VM license */
1432 if (!vsysThis.strLicenseText.isEmpty())
1433 pNewDesc->addEntry(VirtualSystemDescriptionType_License,
1434 "",
1435 vsysThis.strLicenseText,
1436 vsysThis.strLicenseText);
1437
1438 /* Now that we know the OS type, get our internal defaults based on that. */
1439 ComPtr<IGuestOSType> pGuestOSType;
1440 rc = mVirtualBox->GetGuestOSType(Bstr(strOsTypeVBox), pGuestOSType.asOutParam());
1441 CheckComRCThrowRC(rc);
1442
1443 /* CPU count */
1444 ULONG cpuCountVBox = vsysThis.cCPUs;
1445 /* Check for the constrains */
1446 if (cpuCountVBox > 1) //SchemaDefs::MaxCPUCount)
1447 {
1448 addWarning(tr("The virtual system \"%s\" claims support for %u CPU's, but VirtualBox has support for max %u CPU's only."),
1449 vsysThis.strName.c_str(), cpuCountVBox, 1); //SchemaDefs::MaxCPUCount);
1450 cpuCountVBox = 1; //SchemaDefs::MaxCPUCount;
1451 }
1452 if (vsysThis.cCPUs == 0)
1453 cpuCountVBox = 1;
1454 pNewDesc->addEntry(VirtualSystemDescriptionType_CPU,
1455 "",
1456 Utf8StrFmt("%RI32", (uint32_t)vsysThis.cCPUs),
1457 Utf8StrFmt("%RI32", (uint32_t)cpuCountVBox));
1458
1459 /* RAM */
1460 uint64_t ullMemSizeVBox = vsysThis.ullMemorySize / _1M;
1461 /* Check for the constrains */
1462 if (ullMemSizeVBox != 0 &&
1463 (ullMemSizeVBox < MM_RAM_MIN_IN_MB ||
1464 ullMemSizeVBox > MM_RAM_MAX_IN_MB))
1465 {
1466 addWarning(tr("The virtual system \"%s\" claims support for %llu MB RAM size, but VirtualBox has support for min %u & max %u MB RAM size only."),
1467 vsysThis.strName.c_str(), ullMemSizeVBox, MM_RAM_MIN_IN_MB, MM_RAM_MAX_IN_MB);
1468 ullMemSizeVBox = RT_MIN(RT_MAX(ullMemSizeVBox, MM_RAM_MIN_IN_MB), MM_RAM_MAX_IN_MB);
1469 }
1470 if (vsysThis.ullMemorySize == 0)
1471 {
1472 /* If the RAM of the OVF is zero, use our predefined values */
1473 ULONG memSizeVBox2;
1474 rc = pGuestOSType->COMGETTER(RecommendedRAM)(&memSizeVBox2);
1475 CheckComRCThrowRC(rc);
1476 /* VBox stores that in MByte */
1477 ullMemSizeVBox = (uint64_t)memSizeVBox2;
1478 }
1479 pNewDesc->addEntry(VirtualSystemDescriptionType_Memory,
1480 "",
1481 Utf8StrFmt("%RI64", (uint64_t)vsysThis.ullMemorySize),
1482 Utf8StrFmt("%RI64", (uint64_t)ullMemSizeVBox));
1483
1484 /* Audio */
1485 if (!vsysThis.strSoundCardType.isNull())
1486 /* Currently we set the AC97 always.
1487 @todo: figure out the hardware which could be possible */
1488 pNewDesc->addEntry(VirtualSystemDescriptionType_SoundCard,
1489 "",
1490 vsysThis.strSoundCardType,
1491 Utf8StrFmt("%RI32", (uint32_t)AudioControllerType_AC97));
1492
1493#ifdef VBOX_WITH_USB
1494 /* USB Controller */
1495 if (vsysThis.fHasUsbController)
1496 pNewDesc->addEntry(VirtualSystemDescriptionType_USBController, "", "", "");
1497#endif /* VBOX_WITH_USB */
1498
1499 /* Network Controller */
1500 size_t cEthernetAdapters = vsysThis.llEthernetAdapters.size();
1501 if (cEthernetAdapters > 0)
1502 {
1503 /* Check for the constrains */
1504 if (cEthernetAdapters > SchemaDefs::NetworkAdapterCount)
1505 addWarning(tr("The virtual system \"%s\" claims support for %zu network adapters, but VirtualBox has support for max %u network adapter only."),
1506 vsysThis.strName.c_str(), cEthernetAdapters, SchemaDefs::NetworkAdapterCount);
1507
1508 /* Get the default network adapter type for the selected guest OS */
1509 NetworkAdapterType_T defaultAdapterVBox = NetworkAdapterType_Am79C970A;
1510 rc = pGuestOSType->COMGETTER(AdapterType)(&defaultAdapterVBox);
1511 CheckComRCThrowRC(rc);
1512
1513 EthernetAdaptersList::const_iterator itEA;
1514 /* Iterate through all abstract networks. We support 8 network
1515 * adapters at the maximum, so the first 8 will be added only. */
1516 size_t a = 0;
1517 for (itEA = vsysThis.llEthernetAdapters.begin();
1518 itEA != vsysThis.llEthernetAdapters.end() && a < SchemaDefs::NetworkAdapterCount;
1519 ++itEA, ++a)
1520 {
1521 const EthernetAdapter &ea = *itEA; // logical network to connect to
1522 Utf8Str strNetwork = ea.strNetworkName;
1523 // make sure it's one of these two
1524 if ( (strNetwork.compare("Null", Utf8Str::CaseInsensitive))
1525 && (strNetwork.compare("NAT", Utf8Str::CaseInsensitive))
1526 && (strNetwork.compare("Bridged", Utf8Str::CaseInsensitive))
1527 && (strNetwork.compare("Internal", Utf8Str::CaseInsensitive))
1528 && (strNetwork.compare("HostOnly", Utf8Str::CaseInsensitive))
1529 )
1530 strNetwork = "Bridged"; // VMware assumes this is the default apparently
1531
1532 /* Figure out the hardware type */
1533 NetworkAdapterType_T nwAdapterVBox = defaultAdapterVBox;
1534 if (!ea.strAdapterType.compare("PCNet32", Utf8Str::CaseInsensitive))
1535 {
1536 /* If the default adapter is already one of the two
1537 * PCNet adapters use the default one. If not use the
1538 * Am79C970A as fallback. */
1539 if (!(defaultAdapterVBox == NetworkAdapterType_Am79C970A ||
1540 defaultAdapterVBox == NetworkAdapterType_Am79C973))
1541 nwAdapterVBox = NetworkAdapterType_Am79C970A;
1542 }
1543#ifdef VBOX_WITH_E1000
1544 /* VMWare accidentally write this with VirtualCenter 3.5,
1545 so make sure in this case always to use the VMWare one */
1546 else if (!ea.strAdapterType.compare("E10000", Utf8Str::CaseInsensitive))
1547 nwAdapterVBox = NetworkAdapterType_I82545EM;
1548 else if (!ea.strAdapterType.compare("E1000", Utf8Str::CaseInsensitive))
1549 {
1550 /* Check if this OVF was written by VirtualBox */
1551 if (vsysThis.strVirtualSystemType.contains("virtualbox", Utf8Str::CaseInsensitive))
1552 {
1553 /* If the default adapter is already one of the three
1554 * E1000 adapters use the default one. If not use the
1555 * I82545EM as fallback. */
1556 if (!(defaultAdapterVBox == NetworkAdapterType_I82540EM ||
1557 defaultAdapterVBox == NetworkAdapterType_I82543GC ||
1558 defaultAdapterVBox == NetworkAdapterType_I82545EM))
1559 nwAdapterVBox = NetworkAdapterType_I82540EM;
1560 }
1561 else
1562 /* Always use this one since it's what VMware uses */
1563 nwAdapterVBox = NetworkAdapterType_I82545EM;
1564 }
1565#endif /* VBOX_WITH_E1000 */
1566
1567 pNewDesc->addEntry(VirtualSystemDescriptionType_NetworkAdapter,
1568 "", // ref
1569 ea.strNetworkName, // orig
1570 Utf8StrFmt("%RI32", (uint32_t)nwAdapterVBox), // conf
1571 0,
1572 Utf8StrFmt("type=%s", strNetwork.c_str())); // extra conf
1573 }
1574 }
1575
1576 /* Floppy Drive */
1577 if (vsysThis.fHasFloppyDrive)
1578 pNewDesc->addEntry(VirtualSystemDescriptionType_Floppy, "", "", "");
1579
1580 /* CD Drive */
1581 /* @todo: I can't disable the CDROM. So nothing to do for now */
1582 /*
1583 if (vsysThis.fHasCdromDrive)
1584 pNewDesc->addEntry(VirtualSystemDescriptionType_CDROM, "", "", "");*/
1585
1586 /* Hard disk Controller */
1587 uint16_t cIDEused = 0;
1588 uint16_t cSATAused = 0;
1589 uint16_t cSCSIused = 0;
1590 ControllersMap::const_iterator hdcIt;
1591 /* Iterate through all hard disk controllers */
1592 for (hdcIt = vsysThis.mapControllers.begin();
1593 hdcIt != vsysThis.mapControllers.end();
1594 ++hdcIt)
1595 {
1596 const HardDiskController &hdc = hdcIt->second;
1597 Utf8Str strControllerID = Utf8StrFmt("%RI32", (uint32_t)hdc.idController);
1598
1599 switch (hdc.system)
1600 {
1601 case HardDiskController::IDE:
1602 {
1603 /* Check for the constrains */
1604 /* @todo: I'm very confused! Are these bits *one* controller or
1605 is every port/bus declared as an extra controller. */
1606 if (cIDEused < 4)
1607 {
1608 // @todo: figure out the IDE types
1609 /* Use PIIX4 as default */
1610 Utf8Str strType = "PIIX4";
1611 if (!hdc.strControllerType.compare("PIIX3", Utf8Str::CaseInsensitive))
1612 strType = "PIIX3";
1613 else if (!hdc.strControllerType.compare("ICH6", Utf8Str::CaseInsensitive))
1614 strType = "ICH6";
1615 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
1616 strControllerID,
1617 hdc.strControllerType,
1618 strType);
1619 }
1620 else
1621 {
1622 /* Warn only once */
1623 if (cIDEused == 1)
1624 addWarning(tr("The virtual \"%s\" system requests support for more than one IDE controller, but VirtualBox has support for only one."),
1625 vsysThis.strName.c_str());
1626
1627 }
1628 ++cIDEused;
1629 break;
1630 }
1631
1632#ifdef VBOX_WITH_AHCI
1633 case HardDiskController::SATA:
1634 {
1635 /* Check for the constrains */
1636 if (cSATAused < 1)
1637 {
1638 // @todo: figure out the SATA types
1639 /* We only support a plain AHCI controller, so use them always */
1640 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,
1641 strControllerID,
1642 hdc.strControllerType,
1643 "AHCI");
1644 }
1645 else
1646 {
1647 /* Warn only once */
1648 if (cSATAused == 1)
1649 addWarning(tr("The virtual system \"%s\" requests support for more than one SATA controller, but VirtualBox has support for only one"),
1650 vsysThis.strName.c_str());
1651
1652 }
1653 ++cSATAused;
1654 break;
1655 }
1656#endif /* VBOX_WITH_AHCI */
1657
1658 case HardDiskController::SCSI:
1659 {
1660 /* Check for the constrains */
1661 if (cSCSIused < 1)
1662 {
1663 Utf8Str hdcController = "LsiLogic";
1664 if (!hdc.strControllerType.compare("BusLogic", Utf8Str::CaseInsensitive))
1665 hdcController = "BusLogic";
1666 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,
1667 strControllerID,
1668 hdc.strControllerType,
1669 hdcController);
1670 }
1671 else
1672 addWarning(tr("The virtual system \"%s\" requests support for an additional SCSI controller of type \"%s\" with ID %s, but VirtualBox presently supports only one SCSI controller."),
1673 vsysThis.strName.c_str(),
1674 hdc.strControllerType.c_str(),
1675 strControllerID.c_str());
1676 ++cSCSIused;
1677 break;
1678 }
1679 }
1680 }
1681
1682 /* Hard disks */
1683 if (vsysThis.mapVirtualDisks.size() > 0)
1684 {
1685 VirtualDisksMap::const_iterator itVD;
1686 /* Iterate through all hard disks ()*/
1687 for (itVD = vsysThis.mapVirtualDisks.begin();
1688 itVD != vsysThis.mapVirtualDisks.end();
1689 ++itVD)
1690 {
1691 const VirtualDisk &hd = itVD->second;
1692 /* Get the associated disk image */
1693 const DiskImage &di = m->mapDisks[hd.strDiskId];
1694
1695 // @todo:
1696 // - figure out all possible vmdk formats we also support
1697 // - figure out if there is a url specifier for vhd already
1698 // - we need a url specifier for the vdi format
1699 if ( di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#sparse", Utf8Str::CaseInsensitive)
1700 || di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive))
1701 {
1702 /* If the href is empty use the VM name as filename */
1703 Utf8Str strFilename = di.strHref;
1704 if (!strFilename.length())
1705 strFilename = Utf8StrFmt("%s.vmdk", nameVBox.c_str());
1706 /* Construct a unique target path */
1707 Utf8StrFmt strPath("%ls%c%s",
1708 bstrDefaultHardDiskLocation.raw(),
1709 RTPATH_DELIMITER,
1710 strFilename.c_str());
1711 searchUniqueDiskImageFilePath(strPath);
1712
1713 /* find the description for the hard disk controller
1714 * that has the same ID as hd.idController */
1715 const VirtualSystemDescriptionEntry *pController;
1716 if (!(pController = pNewDesc->findControllerFromID(hd.idController)))
1717 throw setError(E_FAIL,
1718 tr("Cannot find hard disk controller with OVF instance ID %RI32 to which disk \"%s\" should be attached"),
1719 hd.idController,
1720 di.strHref.c_str());
1721
1722 /* controller to attach to, and the bus within that controller */
1723 Utf8StrFmt strExtraConfig("controller=%RI16;channel=%RI16",
1724 pController->ulIndex,
1725 hd.ulAddressOnParent);
1726 ULONG ulSize = 0;
1727 if (di.iCapacity != -1)
1728 ulSize = (ULONG)(di.iCapacity / _1M);
1729 else if (di.iPopulatedSize != -1)
1730 ulSize = (ULONG)(di.iPopulatedSize / _1M);
1731 else if (di.iSize != -1)
1732 ulSize = (ULONG)(di.iSize / _1M);
1733 if (ulSize == 0)
1734 ulSize = 10000; // assume 10 GB, this is for the progress bar only anyway
1735 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskImage,
1736 hd.strDiskId,
1737 di.strHref,
1738 strPath,
1739 ulSize,
1740 strExtraConfig);
1741 }
1742 else
1743 throw setError(VBOX_E_FILE_ERROR,
1744 tr("Unsupported format for virtual disk image in OVF: \"%s\"", di.strFormat.c_str()));
1745 }
1746 }
1747
1748 m->virtualSystemDescriptions.push_back(pNewDesc);
1749 }
1750 }
1751 catch (HRESULT aRC)
1752 {
1753 /* On error we clear the list & return */
1754 m->virtualSystemDescriptions.clear();
1755 rc = aRC;
1756 }
1757
1758 return rc;
1759}
1760
1761struct Appliance::TaskImportMachines
1762{
1763 TaskImportMachines(Appliance *aThat, Progress *aProgress)
1764 : pAppliance(aThat)
1765 , progress(aProgress)
1766 , rc(S_OK)
1767 {}
1768 ~TaskImportMachines() {}
1769
1770 HRESULT startThread();
1771
1772 Appliance *pAppliance;
1773 ComObjPtr<Progress> progress;
1774 HRESULT rc;
1775};
1776
1777HRESULT Appliance::TaskImportMachines::startThread()
1778{
1779 int vrc = RTThreadCreate(NULL, Appliance::taskThreadImportMachines, this,
1780 0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
1781 "Appliance::Task");
1782 ComAssertMsgRCRet(vrc,
1783 ("Could not create taskThreadImportMachines (%Rrc)\n", vrc), E_FAIL);
1784
1785 return S_OK;
1786}
1787
1788/**
1789 * Public method implementation.
1790 * @param aProgress
1791 * @return
1792 */
1793STDMETHODIMP Appliance::ImportMachines(IProgress **aProgress)
1794{
1795 CheckComArgOutPointerValid(aProgress);
1796
1797 AutoCaller autoCaller(this);
1798 CheckComRCReturnRC(autoCaller.rc());
1799
1800 AutoReadLock(this);
1801
1802 HRESULT rc = S_OK;
1803
1804 ComObjPtr<Progress> progress;
1805 try
1806 {
1807 Bstr progressDesc = BstrFmt(tr("Import appliance '%s'"),
1808 m->strPath.raw());
1809 rc = setUpProgress(progress, progressDesc);
1810 if (FAILED(rc)) throw rc;
1811
1812 /* Initialize our worker task */
1813 std::auto_ptr<TaskImportMachines> task(new TaskImportMachines(this, progress));
1814 //AssertComRCThrowRC (task->autoCaller.rc());
1815
1816 rc = task->startThread();
1817 if (FAILED(rc)) throw rc;
1818
1819 task.release();
1820 }
1821 catch (HRESULT aRC)
1822 {
1823 rc = aRC;
1824 }
1825
1826 if (SUCCEEDED(rc))
1827 /* Return progress to the caller */
1828 progress.queryInterfaceTo(aProgress);
1829
1830 return rc;
1831}
1832
1833struct MyHardDiskAttachment
1834{
1835 Guid uuid;
1836 ComPtr<IMachine> pMachine;
1837 Bstr controllerType;
1838 int32_t lChannel;
1839 int32_t lDevice;
1840};
1841
1842/**
1843 * Worker thread implementation for ImportMachines().
1844 * @param aThread
1845 * @param pvUser
1846 */
1847/* static */
1848DECLCALLBACK(int) Appliance::taskThreadImportMachines(RTTHREAD /* aThread */, void *pvUser)
1849{
1850 std::auto_ptr<TaskImportMachines> task(static_cast<TaskImportMachines*>(pvUser));
1851 AssertReturn(task.get(), VERR_GENERAL_FAILURE);
1852
1853 Appliance *pAppliance = task->pAppliance;
1854
1855 LogFlowFuncEnter();
1856 LogFlowFunc(("Appliance %p\n", pAppliance));
1857
1858 AutoCaller autoCaller(pAppliance);
1859 CheckComRCReturnRC(autoCaller.rc());
1860
1861 AutoWriteLock appLock(pAppliance);
1862
1863 HRESULT rc = S_OK;
1864
1865 ComPtr<IVirtualBox> pVirtualBox(pAppliance->mVirtualBox);
1866
1867 // rollback for errors:
1868 // a list of images that we created/imported
1869 list<MyHardDiskAttachment> llHardDiskAttachments;
1870 list< ComPtr<IHardDisk> > llHardDisksCreated;
1871 list<Guid> llMachinesRegistered;
1872
1873 ComPtr<ISession> session;
1874 bool fSessionOpen = false;
1875 rc = session.createInprocObject(CLSID_Session);
1876 CheckComRCReturnRC(rc);
1877
1878 list<VirtualSystem>::const_iterator it;
1879 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it1;
1880 /* Iterate through all virtual systems of that appliance */
1881 size_t i = 0;
1882 for (it = pAppliance->m->llVirtualSystems.begin(),
1883 it1 = pAppliance->m->virtualSystemDescriptions.begin();
1884 it != pAppliance->m->llVirtualSystems.end();
1885 ++it, ++it1, ++i)
1886 {
1887 const VirtualSystem &vsysThis = *it;
1888 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it1);
1889
1890 ComPtr<IMachine> pNewMachine;
1891
1892 /* Catch possible errors */
1893 try
1894 {
1895 /* Guest OS type */
1896 std::list<VirtualSystemDescriptionEntry*> vsdeOS;
1897 vsdeOS = vsdescThis->findByType(VirtualSystemDescriptionType_OS);
1898 if (vsdeOS.size() < 1)
1899 throw setError(VBOX_E_FILE_ERROR,
1900 tr("Missing guest OS type"));
1901 const Utf8Str &strOsTypeVBox = vsdeOS.front()->strVbox;
1902
1903 /* Now that we know the base system get our internal defaults based on that. */
1904 ComPtr<IGuestOSType> osType;
1905 rc = pVirtualBox->GetGuestOSType(Bstr(strOsTypeVBox), osType.asOutParam());
1906 if (FAILED(rc)) throw rc;
1907
1908 /* Create the machine */
1909 /* First get the name */
1910 std::list<VirtualSystemDescriptionEntry*> vsdeName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);
1911 if (vsdeName.size() < 1)
1912 throw setError(VBOX_E_FILE_ERROR,
1913 tr("Missing VM name"));
1914 const Utf8Str &strNameVBox = vsdeName.front()->strVbox;
1915 rc = pVirtualBox->CreateMachine(Bstr(strNameVBox), Bstr(strOsTypeVBox),
1916 Bstr(), Bstr(),
1917 pNewMachine.asOutParam());
1918 if (FAILED(rc)) throw rc;
1919
1920 // and the description
1921 std::list<VirtualSystemDescriptionEntry*> vsdeDescription = vsdescThis->findByType(VirtualSystemDescriptionType_Description);
1922 if (vsdeDescription.size())
1923 {
1924 const Utf8Str &strDescription = vsdeDescription.front()->strVbox;
1925 rc = pNewMachine->COMSETTER(Description)(Bstr(strDescription));
1926 if (FAILED(rc)) throw rc;
1927 }
1928
1929 /* CPU count (ignored for now) */
1930 // EntriesList vsdeCPU = vsd->findByType (VirtualSystemDescriptionType_CPU);
1931
1932 /* RAM */
1933 std::list<VirtualSystemDescriptionEntry*> vsdeRAM = vsdescThis->findByType(VirtualSystemDescriptionType_Memory);
1934 ComAssertMsgThrow(vsdeRAM.size() == 1, ("RAM size missing"), E_FAIL);
1935 const Utf8Str &memoryVBox = vsdeRAM.front()->strVbox;
1936 ULONG tt = (ULONG)RTStrToUInt64(memoryVBox.c_str());
1937 rc = pNewMachine->COMSETTER(MemorySize)(tt);
1938 if (FAILED(rc)) throw rc;
1939
1940 /* VRAM */
1941 /* Get the recommended VRAM for this guest OS type */
1942 ULONG vramVBox;
1943 rc = osType->COMGETTER(RecommendedVRAM)(&vramVBox);
1944 if (FAILED(rc)) throw rc;
1945
1946 /* Set the VRAM */
1947 rc = pNewMachine->COMSETTER(VRAMSize)(vramVBox);
1948 if (FAILED(rc)) throw rc;
1949
1950 /* I/O APIC: so far we have no setting for this. Enable it if we
1951 import a Windows VM because if if Windows was installed without IOAPIC,
1952 it will not mind finding an one later on, but if Windows was installed
1953 _with_ an IOAPIC, it will bluescreen if it's not found */
1954 Bstr bstrFamilyId;
1955 rc = osType->COMGETTER(FamilyId)(bstrFamilyId.asOutParam());
1956 if (FAILED(rc)) throw rc;
1957
1958 Utf8Str strFamilyId(bstrFamilyId);
1959 if (strFamilyId == "Windows")
1960 {
1961 ComPtr<IBIOSSettings> pBIOSSettings;
1962 rc = pNewMachine->COMGETTER(BIOSSettings)(pBIOSSettings.asOutParam());
1963 if (FAILED(rc)) throw rc;
1964
1965 rc = pBIOSSettings->COMSETTER(IOAPICEnabled)(TRUE);
1966 if (FAILED(rc)) throw rc;
1967 }
1968
1969 /* Audio Adapter */
1970 std::list<VirtualSystemDescriptionEntry*> vsdeAudioAdapter = vsdescThis->findByType(VirtualSystemDescriptionType_SoundCard);
1971 /* @todo: we support one audio adapter only */
1972 if (vsdeAudioAdapter.size() > 0)
1973 {
1974 const Utf8Str& audioAdapterVBox = vsdeAudioAdapter.front()->strVbox;
1975 if (audioAdapterVBox.compare("null", Utf8Str::CaseInsensitive) != 0)
1976 {
1977 uint32_t audio = RTStrToUInt32(audioAdapterVBox.c_str());
1978 ComPtr<IAudioAdapter> audioAdapter;
1979 rc = pNewMachine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam());
1980 if (FAILED(rc)) throw rc;
1981 rc = audioAdapter->COMSETTER(Enabled)(true);
1982 if (FAILED(rc)) throw rc;
1983 rc = audioAdapter->COMSETTER(AudioController)(static_cast<AudioControllerType_T>(audio));
1984 if (FAILED(rc)) throw rc;
1985 }
1986 }
1987
1988#ifdef VBOX_WITH_USB
1989 /* USB Controller */
1990 std::list<VirtualSystemDescriptionEntry*> vsdeUSBController = vsdescThis->findByType(VirtualSystemDescriptionType_USBController);
1991 // USB support is enabled if there's at least one such entry; to disable USB support,
1992 // the type of the USB item would have been changed to "ignore"
1993 bool fUSBEnabled = vsdeUSBController.size() > 0;
1994
1995 ComPtr<IUSBController> usbController;
1996 rc = pNewMachine->COMGETTER(USBController)(usbController.asOutParam());
1997 if (FAILED(rc)) throw rc;
1998 rc = usbController->COMSETTER(Enabled)(fUSBEnabled);
1999 if (FAILED(rc)) throw rc;
2000#endif /* VBOX_WITH_USB */
2001
2002 /* Change the network adapters */
2003 std::list<VirtualSystemDescriptionEntry*> vsdeNW = vsdescThis->findByType(VirtualSystemDescriptionType_NetworkAdapter);
2004 if (vsdeNW.size() == 0)
2005 {
2006 /* No network adapters, so we have to disable our default one */
2007 ComPtr<INetworkAdapter> nwVBox;
2008 rc = pNewMachine->GetNetworkAdapter(0, nwVBox.asOutParam());
2009 if (FAILED(rc)) throw rc;
2010 rc = nwVBox->COMSETTER(Enabled)(false);
2011 if (FAILED(rc)) throw rc;
2012 }
2013 else
2014 {
2015 list<VirtualSystemDescriptionEntry*>::const_iterator nwIt;
2016 /* Iterate through all network cards. We support 8 network adapters
2017 * at the maximum. (@todo: warn if there are more!) */
2018 size_t a = 0;
2019 for (nwIt = vsdeNW.begin();
2020 (nwIt != vsdeNW.end() && a < SchemaDefs::NetworkAdapterCount);
2021 ++nwIt, ++a)
2022 {
2023 const VirtualSystemDescriptionEntry* pvsys = *nwIt;
2024
2025 const Utf8Str &nwTypeVBox = pvsys->strVbox;
2026 uint32_t tt1 = RTStrToUInt32(nwTypeVBox.c_str());
2027 ComPtr<INetworkAdapter> pNetworkAdapter;
2028 rc = pNewMachine->GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
2029 if (FAILED(rc)) throw rc;
2030 /* Enable the network card & set the adapter type */
2031 rc = pNetworkAdapter->COMSETTER(Enabled)(true);
2032 if (FAILED(rc)) throw rc;
2033 rc = pNetworkAdapter->COMSETTER(AdapterType)(static_cast<NetworkAdapterType_T>(tt1));
2034 if (FAILED(rc)) throw rc;
2035
2036 // default is NAT; change to "bridged" if extra conf says so
2037 if (!pvsys->strExtraConfig.compare("type=Bridged", Utf8Str::CaseInsensitive))
2038 {
2039 /* Attach to the right interface */
2040 rc = pNetworkAdapter->AttachToBridgedInterface();
2041 if (FAILED(rc)) throw rc;
2042 ComPtr<IHost> host;
2043 rc = pVirtualBox->COMGETTER(Host)(host.asOutParam());
2044 if (FAILED(rc)) throw rc;
2045 com::SafeIfaceArray<IHostNetworkInterface> nwInterfaces;
2046 rc = host->COMGETTER(NetworkInterfaces)(ComSafeArrayAsOutParam(nwInterfaces));
2047 if (FAILED(rc)) throw rc;
2048 /* We search for the first host network interface which
2049 * is usable for bridged networking */
2050 for (size_t i=0; i < nwInterfaces.size(); ++i)
2051 {
2052 HostNetworkInterfaceType_T itype;
2053 rc = nwInterfaces[i]->COMGETTER(InterfaceType)(&itype);
2054 if (FAILED(rc)) throw rc;
2055 if (itype == HostNetworkInterfaceType_Bridged)
2056 {
2057 Bstr name;
2058 rc = nwInterfaces[i]->COMGETTER(Name)(name.asOutParam());
2059 if (FAILED(rc)) throw rc;
2060 /* Set the interface name to attach to */
2061 pNetworkAdapter->COMSETTER(HostInterface)(name);
2062 if (FAILED(rc)) throw rc;
2063 break;
2064 }
2065 }
2066 }
2067 /* Next test for host only interfaces */
2068 else if (!pvsys->strExtraConfig.compare("type=HostOnly", Utf8Str::CaseInsensitive))
2069 {
2070 /* Attach to the right interface */
2071 rc = pNetworkAdapter->AttachToHostOnlyInterface();
2072 if (FAILED(rc)) throw rc;
2073 ComPtr<IHost> host;
2074 rc = pVirtualBox->COMGETTER(Host)(host.asOutParam());
2075 if (FAILED(rc)) throw rc;
2076 com::SafeIfaceArray<IHostNetworkInterface> nwInterfaces;
2077 rc = host->COMGETTER(NetworkInterfaces)(ComSafeArrayAsOutParam(nwInterfaces));
2078 if (FAILED(rc)) throw rc;
2079 /* We search for the first host network interface which
2080 * is usable for host only networking */
2081 for (size_t i=0; i < nwInterfaces.size(); ++i)
2082 {
2083 HostNetworkInterfaceType_T itype;
2084 rc = nwInterfaces[i]->COMGETTER(InterfaceType)(&itype);
2085 if (FAILED(rc)) throw rc;
2086 if (itype == HostNetworkInterfaceType_HostOnly)
2087 {
2088 Bstr name;
2089 rc = nwInterfaces[i]->COMGETTER(Name)(name.asOutParam());
2090 if (FAILED(rc)) throw rc;
2091 /* Set the interface name to attach to */
2092 pNetworkAdapter->COMSETTER(HostInterface)(name);
2093 if (FAILED(rc)) throw rc;
2094 break;
2095 }
2096 }
2097 }
2098 }
2099 }
2100
2101 /* Floppy drive */
2102 std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsdescThis->findByType(VirtualSystemDescriptionType_Floppy);
2103 // Floppy support is enabled if there's at least one such entry; to disable floppy support,
2104 // the type of the floppy item would have been changed to "ignore"
2105 bool fFloppyEnabled = vsdeFloppy.size() > 0;
2106 ComPtr<IFloppyDrive> floppyDrive;
2107 rc = pNewMachine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam());
2108 if (FAILED(rc)) throw rc;
2109 rc = floppyDrive->COMSETTER(Enabled)(fFloppyEnabled);
2110 if (FAILED(rc)) throw rc;
2111
2112 /* CDROM drive */
2113 /* @todo: I can't disable the CDROM. So nothing to do for now */
2114 // std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsd->findByType(VirtualSystemDescriptionType_CDROM);
2115
2116 /* Hard disk controller IDE */
2117 std::list<VirtualSystemDescriptionEntry*> vsdeHDCIDE = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerIDE);
2118 if (vsdeHDCIDE.size() > 1)
2119 throw setError(VBOX_E_FILE_ERROR,
2120 tr("Too many IDE controllers in OVF; VirtualBox only supports one"));
2121 if (vsdeHDCIDE.size() == 1)
2122 {
2123 ComPtr<IStorageController> pController;
2124 rc = pNewMachine->GetStorageControllerByName(Bstr("IDE"), pController.asOutParam());
2125 if (FAILED(rc)) throw rc;
2126
2127 const char *pcszIDEType = vsdeHDCIDE.front()->strVbox.c_str();
2128 if (!strcmp(pcszIDEType, "PIIX3"))
2129 rc = pController->COMSETTER(ControllerType)(StorageControllerType_PIIX3);
2130 else if (!strcmp(pcszIDEType, "PIIX4"))
2131 rc = pController->COMSETTER(ControllerType)(StorageControllerType_PIIX4);
2132 else if (!strcmp(pcszIDEType, "ICH6"))
2133 rc = pController->COMSETTER(ControllerType)(StorageControllerType_ICH6);
2134 else
2135 throw setError(VBOX_E_FILE_ERROR,
2136 tr("Invalid IDE controller type \"%s\""),
2137 pcszIDEType);
2138 if (FAILED(rc)) throw rc;
2139 }
2140#ifdef VBOX_WITH_AHCI
2141 /* Hard disk controller SATA */
2142 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSATA = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSATA);
2143 if (vsdeHDCSATA.size() > 1)
2144 throw setError(VBOX_E_FILE_ERROR,
2145 tr("Too many SATA controllers in OVF; VirtualBox only supports one"));
2146 if (vsdeHDCSATA.size() > 0)
2147 {
2148 ComPtr<IStorageController> pController;
2149 const Utf8Str &hdcVBox = vsdeHDCSATA.front()->strVbox;
2150 if (hdcVBox == "AHCI")
2151 {
2152 rc = pNewMachine->AddStorageController(Bstr("SATA"), StorageBus_SATA, pController.asOutParam());
2153 if (FAILED(rc)) throw rc;
2154 }
2155 else
2156 throw setError(VBOX_E_FILE_ERROR,
2157 tr("Invalid SATA controller type \"%s\""),
2158 hdcVBox.c_str());
2159 }
2160#endif /* VBOX_WITH_AHCI */
2161
2162 /* Hard disk controller SCSI */
2163 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSCSI = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSCSI);
2164 if (vsdeHDCSCSI.size() > 1)
2165 throw setError(VBOX_E_FILE_ERROR,
2166 tr("Too many SCSI controllers in OVF; VirtualBox only supports one"));
2167 if (vsdeHDCSCSI.size() > 0)
2168 {
2169 ComPtr<IStorageController> pController;
2170 StorageControllerType_T controllerType;
2171 const Utf8Str &hdcVBox = vsdeHDCSCSI.front()->strVbox;
2172 if (hdcVBox == "LsiLogic")
2173 controllerType = StorageControllerType_LsiLogic;
2174 else if (hdcVBox == "BusLogic")
2175 controllerType = StorageControllerType_BusLogic;
2176 else
2177 throw setError(VBOX_E_FILE_ERROR,
2178 tr("Invalid SCSI controller type \"%s\""),
2179 hdcVBox.c_str());
2180
2181 rc = pNewMachine->AddStorageController(Bstr("SCSI"), StorageBus_SCSI, pController.asOutParam());
2182 if (FAILED(rc)) throw rc;
2183 rc = pController->COMSETTER(ControllerType)(controllerType);
2184 if (FAILED(rc)) throw rc;
2185 }
2186
2187 /* Now its time to register the machine before we add any hard disks */
2188 rc = pVirtualBox->RegisterMachine(pNewMachine);
2189 if (FAILED(rc)) throw rc;
2190
2191 Bstr newMachineId_;
2192 rc = pNewMachine->COMGETTER(Id)(newMachineId_.asOutParam());
2193 if (FAILED(rc)) throw rc;
2194 Guid newMachineId(newMachineId_);
2195
2196 // store new machine for roll-back in case of errors
2197 llMachinesRegistered.push_back(newMachineId);
2198
2199 /* Create the hard disks & connect them to the appropriate controllers. */
2200 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
2201 if (avsdeHDs.size() > 0)
2202 {
2203 /* If in the next block an error occur we have to deregister
2204 the machine, so make an extra try/catch block. */
2205 ComPtr<IHardDisk> srcHdVBox;
2206 bool fSourceHdNeedsClosing = false;
2207
2208 try
2209 {
2210 /* In order to attach hard disks we need to open a session
2211 * for the new machine */
2212 rc = pVirtualBox->OpenSession(session, newMachineId_);
2213 if (FAILED(rc)) throw rc;
2214 fSessionOpen = true;
2215
2216 /* The disk image has to be on the same place as the OVF file. So
2217 * strip the filename out of the full file path. */
2218 Utf8Str strSrcDir = stripFilename(pAppliance->m->strPath);
2219
2220 /* Iterate over all given disk images */
2221 list<VirtualSystemDescriptionEntry*>::const_iterator itHD;
2222 for (itHD = avsdeHDs.begin();
2223 itHD != avsdeHDs.end();
2224 ++itHD)
2225 {
2226 VirtualSystemDescriptionEntry *vsdeHD = *itHD;
2227
2228 const char *pcszDstFilePath = vsdeHD->strVbox.c_str();
2229 /* Check if the destination file exists already or the
2230 * destination path is empty. */
2231 if ( !(*pcszDstFilePath)
2232 || RTPathExists(pcszDstFilePath)
2233 )
2234 /* This isn't allowed */
2235 throw setError(VBOX_E_FILE_ERROR,
2236 tr("Destination file '%s' exists",
2237 pcszDstFilePath));
2238
2239 /* Find the disk from the OVF's disk list */
2240 DiskImagesMap::const_iterator itDiskImage = pAppliance->m->mapDisks.find(vsdeHD->strRef);
2241 /* vsdeHD->strRef contains the disk identifier (e.g. "vmdisk1"), which should exist
2242 in the virtual system's disks map under that ID and also in the global images map. */
2243 VirtualDisksMap::const_iterator itVirtualDisk = vsysThis.mapVirtualDisks.find(vsdeHD->strRef);
2244
2245 if ( itDiskImage == pAppliance->m->mapDisks.end()
2246 || itVirtualDisk == vsysThis.mapVirtualDisks.end()
2247 )
2248 throw setError(E_FAIL,
2249 tr("Internal inconsistency looking up disk images."));
2250
2251 const DiskImage &di = itDiskImage->second;
2252 const VirtualDisk &vd = itVirtualDisk->second;
2253
2254 /* Make sure all target directories exists */
2255 rc = VirtualBox::ensureFilePathExists(pcszDstFilePath);
2256 if (FAILED(rc))
2257 throw rc;
2258
2259 // subprogress object for hard disk
2260 ComPtr<IProgress> pProgress2;
2261
2262 ComPtr<IHardDisk> dstHdVBox;
2263 /* If strHref is empty we have to create a new file */
2264 if (di.strHref.isEmpty())
2265 {
2266 /* Which format to use? */
2267 Bstr srcFormat = L"VDI";
2268 if ( di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#sparse", Utf8Str::CaseInsensitive)
2269 || di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive))
2270 srcFormat = L"VMDK";
2271 /* Create an empty hard disk */
2272 rc = pVirtualBox->CreateHardDisk(srcFormat, Bstr(pcszDstFilePath), dstHdVBox.asOutParam());
2273 if (FAILED(rc)) throw rc;
2274
2275 /* Create a dynamic growing disk image with the given capacity */
2276 rc = dstHdVBox->CreateBaseStorage(di.iCapacity / _1M, HardDiskVariant_Standard, pProgress2.asOutParam());
2277 if (FAILED(rc)) throw rc;
2278
2279 /* Advance to the next operation */
2280 if (!task->progress.isNull())
2281 task->progress->setNextOperation(BstrFmt(tr("Creating virtual disk image '%s'"), pcszDstFilePath),
2282 vsdeHD->ulSizeMB); // operation's weight, as set up with the IProgress originally
2283 }
2284 else
2285 {
2286 /* Construct the source file path */
2287 Utf8StrFmt strSrcFilePath("%s%c%s", strSrcDir.c_str(), RTPATH_DELIMITER, di.strHref.c_str());
2288 /* Check if the source file exists */
2289 if (!RTPathExists(strSrcFilePath.c_str()))
2290 /* This isn't allowed */
2291 throw setError(VBOX_E_FILE_ERROR,
2292 tr("Source virtual disk image file '%s' doesn't exist"),
2293 strSrcFilePath.c_str());
2294
2295 /* Clone the disk image (this is necessary cause the id has
2296 * to be recreated for the case the same hard disk is
2297 * attached already from a previous import) */
2298
2299 /* First open the existing disk image */
2300 rc = pVirtualBox->OpenHardDisk(Bstr(strSrcFilePath),
2301 AccessMode_ReadOnly,
2302 srcHdVBox.asOutParam());
2303 if (FAILED(rc)) throw rc;
2304 fSourceHdNeedsClosing = true;
2305
2306 /* We need the format description of the source disk image */
2307 Bstr srcFormat;
2308 rc = srcHdVBox->COMGETTER(Format)(srcFormat.asOutParam());
2309 if (FAILED(rc)) throw rc;
2310 /* Create a new hard disk interface for the destination disk image */
2311 rc = pVirtualBox->CreateHardDisk(srcFormat, Bstr(pcszDstFilePath), dstHdVBox.asOutParam());
2312 if (FAILED(rc)) throw rc;
2313 /* Clone the source disk image */
2314 rc = srcHdVBox->CloneTo(dstHdVBox, HardDiskVariant_Standard, NULL, pProgress2.asOutParam());
2315 if (FAILED(rc)) throw rc;
2316
2317 /* Advance to the next operation */
2318 if (!task->progress.isNull())
2319 task->progress->setNextOperation(BstrFmt(tr("Importing virtual disk image '%s'"), strSrcFilePath.c_str()),
2320 vsdeHD->ulSizeMB); // operation's weight, as set up with the IProgress originally);
2321 }
2322
2323 // now wait for the background disk operation to complete; this throws HRESULTs on error
2324 pAppliance->waitForAsyncProgress(task->progress, pProgress2);
2325
2326 if (fSourceHdNeedsClosing)
2327 {
2328 rc = srcHdVBox->Close();
2329 if (FAILED(rc)) throw rc;
2330 fSourceHdNeedsClosing = false;
2331 }
2332
2333 llHardDisksCreated.push_back(dstHdVBox);
2334 /* Now use the new uuid to attach the disk image to our new machine */
2335 ComPtr<IMachine> sMachine;
2336 rc = session->COMGETTER(Machine)(sMachine.asOutParam());
2337 if (FAILED(rc)) throw rc;
2338 Bstr hdId;
2339 rc = dstHdVBox->COMGETTER(Id)(hdId.asOutParam());
2340 if (FAILED(rc)) throw rc;
2341
2342 /* For now we assume we have one controller of every type only */
2343 HardDiskController hdc = (*vsysThis.mapControllers.find(vd.idController)).second;
2344
2345 // this is for rollback later
2346 MyHardDiskAttachment mhda;
2347 mhda.uuid = newMachineId;
2348 mhda.pMachine = pNewMachine;
2349
2350 switch (hdc.system)
2351 {
2352 case HardDiskController::IDE:
2353 // For the IDE bus, the channel parameter can be either 0 or 1, to specify the primary
2354 // or secondary IDE controller, respectively. For the primary controller of the IDE bus,
2355 // the device number can be either 0 or 1, to specify the master or the slave device,
2356 // respectively. For the secondary IDE controller, the device number is always 1 because
2357 // the master device is reserved for the CD-ROM drive.
2358 mhda.controllerType = Bstr("IDE");
2359 switch (vd.ulAddressOnParent)
2360 {
2361 case 0: // interpret this as primary master
2362 mhda.lChannel = (long)0;
2363 mhda.lDevice = (long)0;
2364 break;
2365
2366 case 1: // interpret this as primary slave
2367 mhda.lChannel = (long)0;
2368 mhda.lDevice = (long)1;
2369 break;
2370
2371 case 2: // interpret this as secondary slave
2372 mhda.lChannel = (long)1;
2373 mhda.lDevice = (long)1;
2374 break;
2375
2376 default:
2377 throw setError(VBOX_E_NOT_SUPPORTED,
2378 tr("Invalid channel %RI16 specified; IDE controllers support only 0, 1 or 2"), vd.ulAddressOnParent);
2379 break;
2380 }
2381 break;
2382
2383 case HardDiskController::SATA:
2384 mhda.controllerType = Bstr("SATA");
2385 mhda.lChannel = (long)vd.ulAddressOnParent;
2386 mhda.lDevice = (long)0;
2387 break;
2388
2389 case HardDiskController::SCSI:
2390 mhda.controllerType = Bstr("SCSI");
2391 mhda.lChannel = (long)vd.ulAddressOnParent;
2392 mhda.lDevice = (long)0;
2393 break;
2394
2395 default: break;
2396 }
2397
2398 Log(("Attaching disk %s to channel %d on device %d\n", pcszDstFilePath, mhda.lChannel, mhda.lDevice));
2399
2400 rc = sMachine->AttachHardDisk(hdId,
2401 mhda.controllerType,
2402 mhda.lChannel,
2403 mhda.lDevice);
2404 if (FAILED(rc)) throw rc;
2405
2406 llHardDiskAttachments.push_back(mhda);
2407
2408 rc = sMachine->SaveSettings();
2409 if (FAILED(rc)) throw rc;
2410 } // end for (itHD = avsdeHDs.begin();
2411
2412 // only now that we're done with all disks, close the session
2413 rc = session->Close();
2414 if (FAILED(rc)) throw rc;
2415 fSessionOpen = false;
2416 }
2417 catch(HRESULT /* aRC */)
2418 {
2419 if (fSourceHdNeedsClosing)
2420 srcHdVBox->Close();
2421
2422 if (fSessionOpen)
2423 session->Close();
2424
2425 throw;
2426 }
2427 }
2428 }
2429 catch(HRESULT aRC)
2430 {
2431 rc = aRC;
2432 }
2433
2434 if (FAILED(rc))
2435 break;
2436
2437 } // for (it = pAppliance->m->llVirtualSystems.begin(),
2438
2439 if (FAILED(rc))
2440 {
2441 // with _whatever_ error we've had, do a complete roll-back of
2442 // machines and disks we've created; unfortunately this is
2443 // not so trivially done...
2444
2445 HRESULT rc2;
2446 // detach all hard disks from all machines we created
2447 list<MyHardDiskAttachment>::iterator itM;
2448 for (itM = llHardDiskAttachments.begin();
2449 itM != llHardDiskAttachments.end();
2450 ++itM)
2451 {
2452 const MyHardDiskAttachment &mhda = *itM;
2453 rc2 = pVirtualBox->OpenSession(session, Bstr(mhda.uuid));
2454 if (SUCCEEDED(rc2))
2455 {
2456 ComPtr<IMachine> sMachine;
2457 rc2 = session->COMGETTER(Machine)(sMachine.asOutParam());
2458 if (SUCCEEDED(rc2))
2459 {
2460 rc2 = sMachine->DetachHardDisk(Bstr(mhda.controllerType), mhda.lChannel, mhda.lDevice);
2461 rc2 = sMachine->SaveSettings();
2462 }
2463 session->Close();
2464 }
2465 }
2466
2467 // now clean up all hard disks we created
2468 list< ComPtr<IHardDisk> >::iterator itHD;
2469 for (itHD = llHardDisksCreated.begin();
2470 itHD != llHardDisksCreated.end();
2471 ++itHD)
2472 {
2473 ComPtr<IHardDisk> pDisk = *itHD;
2474 ComPtr<IProgress> pProgress;
2475 rc2 = pDisk->DeleteStorage(pProgress.asOutParam());
2476 rc2 = pProgress->WaitForCompletion(-1);
2477 }
2478
2479 // finally, deregister and remove all machines
2480 list<Guid>::iterator itID;
2481 for (itID = llMachinesRegistered.begin();
2482 itID != llMachinesRegistered.end();
2483 ++itID)
2484 {
2485 const Guid &guid = *itID;
2486 ComPtr<IMachine> failedMachine;
2487 rc2 = pVirtualBox->UnregisterMachine(guid.toUtf16(), failedMachine.asOutParam());
2488 if (SUCCEEDED(rc2))
2489 rc2 = failedMachine->DeleteSettings();
2490 }
2491 }
2492
2493 task->rc = rc;
2494
2495 if (!task->progress.isNull())
2496 task->progress->notifyComplete(rc);
2497
2498 LogFlowFunc(("rc=%Rhrc\n", rc));
2499 LogFlowFuncLeave();
2500
2501 return VINF_SUCCESS;
2502}
2503
2504struct Appliance::TaskWriteOVF
2505{
2506 enum OVFFormat
2507 {
2508 unspecified,
2509 OVF_0_9,
2510 OVF_1_0
2511 };
2512 enum TaskType
2513 {
2514 Write
2515 };
2516
2517 TaskWriteOVF(OVFFormat aFormat, Appliance *aThat)
2518 : taskType(Write),
2519 storageType(VFSType_File),
2520 enFormat(aFormat),
2521 pAppliance(aThat),
2522 rc(S_OK)
2523 {}
2524 ~TaskWriteOVF() {}
2525
2526 int startThread();
2527 static int uploadProgress(unsigned uPercent, void *pvUser);
2528
2529 TaskType taskType;
2530 VFSType_T storageType;
2531 Utf8Str filepath;
2532 Utf8Str hostname;
2533 Utf8Str username;
2534 Utf8Str password;
2535 OVFFormat enFormat;
2536 Appliance *pAppliance;
2537 ComObjPtr<Progress> progress;
2538 HRESULT rc;
2539};
2540
2541int Appliance::TaskWriteOVF::startThread()
2542{
2543 int vrc = RTThreadCreate(NULL, Appliance::taskThreadWriteOVF, this,
2544 0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
2545 "Appliance::Task");
2546
2547 ComAssertMsgRCRet(vrc,
2548 ("Could not create taskThreadWriteOVF (%Rrc)\n", vrc), E_FAIL);
2549
2550 return S_OK;
2551}
2552
2553/* static */
2554int Appliance::TaskWriteOVF::uploadProgress(unsigned uPercent, void *pvUser)
2555{
2556 Appliance::TaskWriteOVF* pTask = *(Appliance::TaskWriteOVF**)pvUser;
2557
2558 if (pTask &&
2559 !pTask->progress.isNull())
2560 {
2561 BOOL fCanceled;
2562 pTask->progress->COMGETTER(Canceled)(&fCanceled);
2563 if (fCanceled)
2564 return -1;
2565 pTask->progress->setCurrentOperationProgress(uPercent);
2566 }
2567 return VINF_SUCCESS;
2568}
2569
2570STDMETHODIMP Appliance::CreateVFSExplorer(IN_BSTR aURI, IVFSExplorer **aExplorer)
2571{
2572 HRESULT rc = S_OK;
2573
2574 CheckComArgOutPointerValid(aExplorer);
2575
2576 AutoCaller autoCaller(this);
2577 CheckComRCReturnRC(autoCaller.rc());
2578
2579 AutoReadLock(this);
2580
2581 Utf8Str uri(aURI);
2582 /* Check which kind of export the user has requested */
2583 VFSType_T type = VFSType_File;
2584 Utf8Str strProtocol = "";
2585 /* Check the URI for the target format */
2586 if (uri.startsWith("SunCloud://", Utf8Str::CaseInsensitive)) /* Sun Cloud service */
2587 {
2588 type = VFSType_S3;
2589 strProtocol = "SunCloud://";
2590 }
2591 else if (uri.startsWith("S3://", Utf8Str::CaseInsensitive)) /* S3 service */
2592 {
2593 type = VFSType_S3;
2594 strProtocol = "S3://";
2595 }
2596 else if (uri.startsWith("webdav://", Utf8Str::CaseInsensitive)) /* webdav service */
2597 throw E_NOTIMPL;
2598
2599 Utf8Str strFilepath;
2600 Utf8Str strHostname;
2601 Utf8Str strUsername;
2602 Utf8Str strPassword;
2603 parseURI(uri, strProtocol, strFilepath, strHostname, strUsername, strPassword);
2604
2605 ComObjPtr<VFSExplorer> explorer;
2606 explorer.createObject();
2607
2608 rc = explorer->init(type, strFilepath, strHostname, strUsername, strPassword, mVirtualBox);
2609
2610 if (SUCCEEDED(rc))
2611 /* Return explorer to the caller */
2612 explorer.queryInterfaceTo(aExplorer);
2613
2614 return rc;
2615}
2616
2617STDMETHODIMP Appliance::Write(IN_BSTR format, IN_BSTR path, IProgress **aProgress)
2618{
2619 HRESULT rc = S_OK;
2620
2621 CheckComArgOutPointerValid(aProgress);
2622
2623 AutoCaller autoCaller(this);
2624 CheckComRCReturnRC(autoCaller.rc());
2625
2626 AutoWriteLock(this);
2627
2628 // see if we can handle this file; for now we insist it has an ".ovf" extension
2629 Utf8Str strPath = path;
2630 if (!strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
2631 return setError(VBOX_E_FILE_ERROR,
2632 tr("Appliance file must have .ovf extension"));
2633
2634 ComObjPtr<Progress> progress;
2635 Utf8Str strFormat(format);
2636 TaskWriteOVF::OVFFormat ovfF;
2637 if (strFormat == "ovf-0.9")
2638 ovfF = TaskWriteOVF::OVF_0_9;
2639 else if (strFormat == "ovf-1.0")
2640 ovfF = TaskWriteOVF::OVF_1_0;
2641 else
2642 return setError(VBOX_E_FILE_ERROR,
2643 tr("Invalid format \"%s\" specified"), strFormat.c_str());
2644
2645 rc = writeImpl(ovfF, strPath, progress);
2646
2647 if (SUCCEEDED(rc))
2648 /* Return progress to the caller */
2649 progress.queryInterfaceTo(aProgress);
2650
2651 return rc;
2652}
2653
2654void Appliance::parseURI(Utf8Str strUri, const Utf8Str &strProtocol, Utf8Str &strFilepath, Utf8Str &strHostname, Utf8Str &strUsername, Utf8Str &strPassword)
2655{
2656 /* Remove the protocol */
2657 if (strUri.startsWith(strProtocol, Utf8Str::CaseInsensitive))
2658 strUri = strUri.substr(strProtocol.length());
2659 size_t uppos = strUri.find("@");
2660 if (uppos != Utf8Str::npos)
2661 {
2662 strUsername = strUri.substr(0, uppos);
2663 strUri = strUri.substr(uppos + 1);
2664 size_t upos = strUsername.find(":");
2665 if (upos != Utf8Str::npos)
2666 {
2667 strPassword = strUsername.substr(upos + 1);
2668 strUsername = strUsername.substr(0, upos);
2669 }
2670 }
2671 size_t hpos = strUri.find("/");
2672 if (hpos != Utf8Str::npos)
2673 {
2674 strHostname = strUri.substr(0, hpos);
2675 strUri = strUri.substr(hpos);
2676 }
2677 strFilepath = strUri;
2678}
2679
2680HRESULT Appliance::writeImpl(int aFormat, Utf8Str aPath, ComObjPtr<Progress> &aProgress)
2681{
2682 HRESULT rc = S_OK;
2683 try
2684 {
2685 m->strPath = aPath;
2686
2687 /* Initialize our worker task */
2688 std::auto_ptr<TaskWriteOVF> task(new TaskWriteOVF((TaskWriteOVF::OVFFormat)aFormat, this));
2689
2690 /* Check which kind of export the user has requested */
2691 Utf8Str strProtocol = "";
2692 /* Check the URI for the target format */
2693 if (m->strPath.startsWith("SunCloud://", Utf8Str::CaseInsensitive)) /* Sun Cloud service */
2694 {
2695 task->storageType = VFSType_S3;
2696 strProtocol = "SunCloud://";
2697 }
2698 else if (m->strPath.startsWith("S3://", Utf8Str::CaseInsensitive)) /* S3 service */
2699 {
2700 task->storageType = VFSType_S3;
2701 strProtocol = "S3://";
2702 }
2703 else if (m->strPath.startsWith("webdav://", Utf8Str::CaseInsensitive)) /* webdav service */
2704 throw E_NOTIMPL;
2705
2706 parseURI(m->strPath, strProtocol, task->filepath, task->hostname, task->username, task->password);
2707 Bstr progressDesc = BstrFmt(tr("Export appliance '%s'"),
2708 task->filepath.c_str());
2709
2710 /* todo: This progress init stuff should be done a little bit more generic */
2711 if (task->storageType == VFSType_S3)
2712 rc = setUpProgressUpload(aProgress, progressDesc);
2713 else
2714 rc = setUpProgress(aProgress, progressDesc);
2715 if (FAILED(rc)) throw rc;
2716
2717 task->progress = aProgress;
2718
2719 rc = task->startThread();
2720 CheckComRCThrowRC(rc);
2721
2722 /* Don't destruct on success */
2723 task.release();
2724 }
2725 catch (HRESULT aRC)
2726 {
2727 rc = aRC;
2728 }
2729
2730 return rc;
2731}
2732
2733DECLCALLBACK(int) Appliance::taskThreadWriteOVF(RTTHREAD /* aThread */, void *pvUser)
2734{
2735 std::auto_ptr<TaskWriteOVF> task(static_cast<TaskWriteOVF*>(pvUser));
2736 AssertReturn(task.get(), VERR_GENERAL_FAILURE);
2737
2738 Appliance *pAppliance = task->pAppliance;
2739
2740 LogFlowFuncEnter();
2741 LogFlowFunc(("Appliance %p\n", pAppliance));
2742
2743 HRESULT rc = S_OK;
2744
2745 switch(task->taskType)
2746 {
2747 case TaskWriteOVF::Write:
2748 {
2749 if (task->storageType == VFSType_File)
2750 rc = pAppliance->writeFS(task.get());
2751 else if (task->storageType == VFSType_S3)
2752 rc = pAppliance->writeS3(task.get());
2753 break;
2754 }
2755 }
2756
2757 LogFlowFunc(("rc=%Rhrc\n", rc));
2758 LogFlowFuncLeave();
2759
2760 return VINF_SUCCESS;
2761}
2762
2763/**
2764 * Worker thread implementation for Write() (ovf writer).
2765 * @param aThread
2766 * @param pvUser
2767 */
2768/* static */
2769int Appliance::writeFS(TaskWriteOVF *pTask)
2770{
2771 LogFlowFuncEnter();
2772 LogFlowFunc(("Appliance %p\n", this));
2773
2774 AutoCaller autoCaller(this);
2775 CheckComRCReturnRC(autoCaller.rc());
2776
2777 AutoWriteLock appLock(this);
2778
2779 HRESULT rc = S_OK;
2780
2781 try
2782 {
2783 xml::Document doc;
2784 xml::ElementNode *pelmRoot = doc.createRootElement("Envelope");
2785
2786 pelmRoot->setAttribute("ovf:version", (pTask->enFormat == TaskWriteOVF::OVF_1_0) ? "1.0" : "0.9");
2787 pelmRoot->setAttribute("xml:lang", "en-US");
2788
2789 Utf8Str strNamespace = (TaskWriteOVF::OVF_0_9)
2790 ? "http://www.vmware.com/schema/ovf/1/envelope" // 0.9
2791 : "http://schemas.dmtf.org/ovf/envelope/1"; // 1.0
2792 pelmRoot->setAttribute("xmlns", strNamespace);
2793 pelmRoot->setAttribute("xmlns:ovf", strNamespace);
2794
2795// pelmRoot->setAttribute("xmlns:ovfstr", "http://schema.dmtf.org/ovf/strings/1");
2796 pelmRoot->setAttribute("xmlns:rasd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData");
2797 pelmRoot->setAttribute("xmlns:vssd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData");
2798 pelmRoot->setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
2799// pelmRoot->setAttribute("xsi:schemaLocation", "http://schemas.dmtf.org/ovf/envelope/1 ../ovf-envelope.xsd");
2800
2801 // <Envelope>/<References>
2802 xml::ElementNode *pelmReferences = pelmRoot->createChild("References"); // 0.9 and 1.0
2803
2804 /* <Envelope>/<DiskSection>:
2805 <DiskSection>
2806 <Info>List of the virtual disks used in the package</Info>
2807 <Disk ovf:capacity="4294967296" ovf:diskId="lamp" ovf:format="http://www.vmware.com/specifications/vmdk.html#compressed" ovf:populatedSize="1924967692"/>
2808 </DiskSection> */
2809 xml::ElementNode *pelmDiskSection;
2810 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2811 {
2812 // <Section xsi:type="ovf:DiskSection_Type">
2813 pelmDiskSection = pelmRoot->createChild("Section");
2814 pelmDiskSection->setAttribute("xsi:type", "ovf:DiskSection_Type");
2815 }
2816 else
2817 pelmDiskSection = pelmRoot->createChild("DiskSection");
2818
2819 xml::ElementNode *pelmDiskSectionInfo = pelmDiskSection->createChild("Info");
2820 pelmDiskSectionInfo->addContent("List of the virtual disks used in the package");
2821 // for now, set up a map so we have a list of unique disk names (to make
2822 // sure the same disk name is only added once)
2823 map<Utf8Str, const VirtualSystemDescriptionEntry*> mapDisks;
2824
2825 /* <Envelope>/<NetworkSection>:
2826 <NetworkSection>
2827 <Info>Logical networks used in the package</Info>
2828 <Network ovf:name="VM Network">
2829 <Description>The network that the LAMP Service will be available on</Description>
2830 </Network>
2831 </NetworkSection> */
2832 xml::ElementNode *pelmNetworkSection;
2833 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2834 {
2835 // <Section xsi:type="ovf:NetworkSection_Type">
2836 pelmNetworkSection = pelmRoot->createChild("Section");
2837 pelmNetworkSection->setAttribute("xsi:type", "ovf:NetworkSection_Type");
2838 }
2839 else
2840 pelmNetworkSection = pelmRoot->createChild("NetworkSection");
2841
2842 xml::ElementNode *pelmNetworkSectionInfo = pelmNetworkSection->createChild("Info");
2843 pelmNetworkSectionInfo->addContent("Logical networks used in the package");
2844 // for now, set up a map so we have a list of unique network names (to make
2845 // sure the same network name is only added once)
2846 map<Utf8Str, bool> mapNetworks;
2847 // we fill this later below when we iterate over the networks
2848
2849 // and here come the virtual systems:
2850
2851 // write a collection if we have more than one virtual system _and_ we're
2852 // writing OVF 1.0; otherwise fail since ovftool can't import more than
2853 // one machine, it seems
2854 xml::ElementNode *pelmToAddVirtualSystemsTo;
2855 if (m->virtualSystemDescriptions.size() > 1)
2856 {
2857 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2858 throw setError(VBOX_E_FILE_ERROR,
2859 tr("Cannot export more than one virtual system with OVF 0.9, use OVF 1.0"));
2860
2861 pelmToAddVirtualSystemsTo = pelmRoot->createChild("VirtualSystemCollection");
2862 /* xml::AttributeNode *pattrVirtualSystemCollectionId = */ pelmToAddVirtualSystemsTo->setAttribute("ovf:name", "ExportedVirtualBoxMachines"); // whatever
2863 }
2864 else
2865 pelmToAddVirtualSystemsTo = pelmRoot; // add virtual system directly under root element
2866
2867 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
2868 /* Iterate through all virtual systems of that appliance */
2869 for (it = m->virtualSystemDescriptions.begin();
2870 it != m->virtualSystemDescriptions.end();
2871 ++it)
2872 {
2873 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
2874
2875 xml::ElementNode *pelmVirtualSystem;
2876 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2877 {
2878 // <Section xsi:type="ovf:NetworkSection_Type">
2879 pelmVirtualSystem = pelmToAddVirtualSystemsTo->createChild("Content");
2880 pelmVirtualSystem->setAttribute("xsi:type", "ovf:VirtualSystem_Type");
2881 }
2882 else
2883 pelmVirtualSystem = pelmToAddVirtualSystemsTo->createChild("VirtualSystem");
2884
2885 /*xml::ElementNode *pelmVirtualSystemInfo =*/ pelmVirtualSystem->createChild("Info")->addContent("A virtual machine");
2886
2887 std::list<VirtualSystemDescriptionEntry*> llName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);
2888 if (llName.size() != 1)
2889 throw setError(VBOX_E_NOT_SUPPORTED,
2890 tr("Missing VM name"));
2891 Utf8Str &strVMName = llName.front()->strVbox;
2892 pelmVirtualSystem->setAttribute("ovf:id", strVMName);
2893
2894 // product info
2895 std::list<VirtualSystemDescriptionEntry*> llProduct = vsdescThis->findByType(VirtualSystemDescriptionType_Product);
2896 std::list<VirtualSystemDescriptionEntry*> llProductUrl = vsdescThis->findByType(VirtualSystemDescriptionType_ProductUrl);
2897 std::list<VirtualSystemDescriptionEntry*> llVendor = vsdescThis->findByType(VirtualSystemDescriptionType_Vendor);
2898 std::list<VirtualSystemDescriptionEntry*> llVendorUrl = vsdescThis->findByType(VirtualSystemDescriptionType_VendorUrl);
2899 std::list<VirtualSystemDescriptionEntry*> llVersion = vsdescThis->findByType(VirtualSystemDescriptionType_Version);
2900 bool fProduct = llProduct.size() && !llProduct.front()->strVbox.isEmpty();
2901 bool fProductUrl = llProductUrl.size() && !llProductUrl.front()->strVbox.isEmpty();
2902 bool fVendor = llVendor.size() && !llVendor.front()->strVbox.isEmpty();
2903 bool fVendorUrl = llVendorUrl.size() && !llVendorUrl.front()->strVbox.isEmpty();
2904 bool fVersion = llVersion.size() && !llVersion.front()->strVbox.isEmpty();
2905 if (fProduct ||
2906 fProductUrl ||
2907 fVersion ||
2908 fVendorUrl ||
2909 fVersion)
2910 {
2911 /* <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
2912 <Info>Meta-information about the installed software</Info>
2913 <Product>VAtest</Product>
2914 <Vendor>SUN Microsystems</Vendor>
2915 <Version>10.0</Version>
2916 <ProductUrl>http://blogs.sun.com/VirtualGuru</ProductUrl>
2917 <VendorUrl>http://www.sun.com</VendorUrl>
2918 </Section> */
2919 xml::ElementNode *pelmAnnotationSection;
2920 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2921 {
2922 // <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
2923 pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
2924 pelmAnnotationSection->setAttribute("xsi:type", "ovf:ProductSection_Type");
2925 }
2926 else
2927 pelmAnnotationSection = pelmVirtualSystem->createChild("ProductSection");
2928
2929 pelmAnnotationSection->createChild("Info")->addContent("Meta-information about the installed software");
2930 if (fProduct)
2931 pelmAnnotationSection->createChild("Product")->addContent(llProduct.front()->strVbox);
2932 if (fVendor)
2933 pelmAnnotationSection->createChild("Vendor")->addContent(llVendor.front()->strVbox);
2934 if (fVersion)
2935 pelmAnnotationSection->createChild("Version")->addContent(llVersion.front()->strVbox);
2936 if (fProductUrl)
2937 pelmAnnotationSection->createChild("ProductUrl")->addContent(llProductUrl.front()->strVbox);
2938 if (fVendorUrl)
2939 pelmAnnotationSection->createChild("VendorUrl")->addContent(llVendorUrl.front()->strVbox);
2940 }
2941
2942 // description
2943 std::list<VirtualSystemDescriptionEntry*> llDescription = vsdescThis->findByType(VirtualSystemDescriptionType_Description);
2944 if (llDescription.size() &&
2945 !llDescription.front()->strVbox.isEmpty())
2946 {
2947 /* <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
2948 <Info>A human-readable annotation</Info>
2949 <Annotation>Plan 9</Annotation>
2950 </Section> */
2951 xml::ElementNode *pelmAnnotationSection;
2952 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2953 {
2954 // <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
2955 pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
2956 pelmAnnotationSection->setAttribute("xsi:type", "ovf:AnnotationSection_Type");
2957 }
2958 else
2959 pelmAnnotationSection = pelmVirtualSystem->createChild("AnnotationSection");
2960
2961 pelmAnnotationSection->createChild("Info")->addContent("A human-readable annotation");
2962 pelmAnnotationSection->createChild("Annotation")->addContent(llDescription.front()->strVbox);
2963 }
2964
2965 // license
2966 std::list<VirtualSystemDescriptionEntry*> llLicense = vsdescThis->findByType(VirtualSystemDescriptionType_License);
2967 if (llLicense.size() &&
2968 !llLicense.front()->strVbox.isEmpty())
2969 {
2970 /* <EulaSection>
2971 <Info ovf:msgid="6">License agreement for the Virtual System.</Info>
2972 <License ovf:msgid="1">License terms can go in here.</License>
2973 </EulaSection> */
2974 xml::ElementNode *pelmEulaSection;
2975 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2976 {
2977 pelmEulaSection = pelmVirtualSystem->createChild("Section");
2978 pelmEulaSection->setAttribute("xsi:type", "ovf:EulaSection_Type");
2979 }
2980 else
2981 pelmEulaSection = pelmVirtualSystem->createChild("EulaSection");
2982
2983 pelmEulaSection->createChild("Info")->addContent("License agreement for the virtual system");
2984 pelmEulaSection->createChild("License")->addContent(llLicense.front()->strVbox);
2985 }
2986
2987 // operating system
2988 std::list<VirtualSystemDescriptionEntry*> llOS = vsdescThis->findByType(VirtualSystemDescriptionType_OS);
2989 if (llOS.size() != 1)
2990 throw setError(VBOX_E_NOT_SUPPORTED,
2991 tr("Missing OS type"));
2992 /* <OperatingSystemSection ovf:id="82">
2993 <Info>Guest Operating System</Info>
2994 <Description>Linux 2.6.x</Description>
2995 </OperatingSystemSection> */
2996 xml::ElementNode *pelmOperatingSystemSection;
2997 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2998 {
2999 pelmOperatingSystemSection = pelmVirtualSystem->createChild("Section");
3000 pelmOperatingSystemSection->setAttribute("xsi:type", "ovf:OperatingSystemSection_Type");
3001 }
3002 else
3003 pelmOperatingSystemSection = pelmVirtualSystem->createChild("OperatingSystemSection");
3004
3005 pelmOperatingSystemSection->setAttribute("ovf:id", llOS.front()->strOvf);
3006 pelmOperatingSystemSection->createChild("Info")->addContent("The kind of installed guest operating system");
3007 Utf8Str strOSDesc;
3008 convertCIMOSType2VBoxOSType(strOSDesc, (CIMOSType_T)llOS.front()->strOvf.toInt32(), "");
3009 pelmOperatingSystemSection->createChild("Description")->addContent(strOSDesc);
3010
3011 // <VirtualHardwareSection ovf:id="hw1" ovf:transport="iso">
3012 xml::ElementNode *pelmVirtualHardwareSection;
3013 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3014 {
3015 // <Section xsi:type="ovf:VirtualHardwareSection_Type">
3016 pelmVirtualHardwareSection = pelmVirtualSystem->createChild("Section");
3017 pelmVirtualHardwareSection->setAttribute("xsi:type", "ovf:VirtualHardwareSection_Type");
3018 }
3019 else
3020 pelmVirtualHardwareSection = pelmVirtualSystem->createChild("VirtualHardwareSection");
3021
3022 pelmVirtualHardwareSection->createChild("Info")->addContent("Virtual hardware requirements for a virtual machine");
3023
3024 /* <System>
3025 <vssd:Description>Description of the virtual hardware section.</vssd:Description>
3026 <vssd:ElementName>vmware</vssd:ElementName>
3027 <vssd:InstanceID>1</vssd:InstanceID>
3028 <vssd:VirtualSystemIdentifier>MyLampService</vssd:VirtualSystemIdentifier>
3029 <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
3030 </System> */
3031 xml::ElementNode *pelmSystem = pelmVirtualHardwareSection->createChild("System");
3032
3033 // <vssd:InstanceId>0</vssd:InstanceId>
3034 pelmSystem->createChild("vssd:InstanceId")->addContent("0");
3035 // <vssd:VirtualSystemIdentifier>VAtest</vssd:VirtualSystemIdentifier>
3036 pelmSystem->createChild("vssd:VirtualSystemIdentifier")->addContent(strVMName);
3037 // <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
3038 const char *pcszHardware = "virtualbox-2.2";
3039 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3040 // pretend to be vmware compatible then
3041 pcszHardware = "vmx-6";
3042 pelmSystem->createChild("vssd:VirtualSystemType")->addContent(pcszHardware);
3043
3044 // loop thru all description entries twice; once to write out all
3045 // devices _except_ disk images, and a second time to assign the
3046 // disk images; this is because disk images need to reference
3047 // IDE controllers, and we can't know their instance IDs without
3048 // assigning them first
3049
3050 uint32_t idIDEController = 0;
3051 int32_t lIDEControllerIndex = 0;
3052 uint32_t idSATAController = 0;
3053 int32_t lSATAControllerIndex = 0;
3054 uint32_t idSCSIController = 0;
3055 int32_t lSCSIControllerIndex = 0;
3056
3057 uint32_t ulInstanceID = 1;
3058 uint32_t cDisks = 0;
3059
3060 for (size_t uLoop = 1;
3061 uLoop <= 2;
3062 ++uLoop)
3063 {
3064 int32_t lIndexThis = 0;
3065 list<VirtualSystemDescriptionEntry>::const_iterator itD;
3066 for (itD = vsdescThis->m->llDescriptions.begin();
3067 itD != vsdescThis->m->llDescriptions.end();
3068 ++itD, ++lIndexThis)
3069 {
3070 const VirtualSystemDescriptionEntry &desc = *itD;
3071
3072 OVFResourceType_T type = (OVFResourceType_T)0; // if this becomes != 0 then we do stuff
3073 Utf8Str strResourceSubType;
3074
3075 Utf8Str strDescription; // results in <rasd:Description>...</rasd:Description> block
3076 Utf8Str strCaption; // results in <rasd:Caption>...</rasd:Caption> block
3077
3078 uint32_t ulParent = 0;
3079
3080 int32_t lVirtualQuantity = -1;
3081 Utf8Str strAllocationUnits;
3082
3083 int32_t lAddress = -1;
3084 int32_t lBusNumber = -1;
3085 int32_t lAddressOnParent = -1;
3086
3087 int32_t lAutomaticAllocation = -1; // 0 means "false", 1 means "true"
3088 Utf8Str strConnection; // results in <rasd:Connection>...</rasd:Connection> block
3089 Utf8Str strHostResource;
3090
3091 uint64_t uTemp;
3092
3093 switch (desc.type)
3094 {
3095 case VirtualSystemDescriptionType_CPU:
3096 /* <Item>
3097 <rasd:Caption>1 virtual CPU</rasd:Caption>
3098 <rasd:Description>Number of virtual CPUs</rasd:Description>
3099 <rasd:ElementName>virtual CPU</rasd:ElementName>
3100 <rasd:InstanceID>1</rasd:InstanceID>
3101 <rasd:ResourceType>3</rasd:ResourceType>
3102 <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
3103 </Item> */
3104 if (uLoop == 1)
3105 {
3106 strDescription = "Number of virtual CPUs";
3107 type = OVFResourceType_Processor; // 3
3108 lVirtualQuantity = 1;
3109 }
3110 break;
3111
3112 case VirtualSystemDescriptionType_Memory:
3113 /* <Item>
3114 <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
3115 <rasd:Caption>256 MB of memory</rasd:Caption>
3116 <rasd:Description>Memory Size</rasd:Description>
3117 <rasd:ElementName>Memory</rasd:ElementName>
3118 <rasd:InstanceID>2</rasd:InstanceID>
3119 <rasd:ResourceType>4</rasd:ResourceType>
3120 <rasd:VirtualQuantity>256</rasd:VirtualQuantity>
3121 </Item> */
3122 if (uLoop == 1)
3123 {
3124 strDescription = "Memory Size";
3125 type = OVFResourceType_Memory; // 4
3126 desc.strVbox.toInt(uTemp);
3127 lVirtualQuantity = (int32_t)(uTemp / _1M);
3128 strAllocationUnits = "MegaBytes";
3129 strCaption = Utf8StrFmt("%d MB of memory", lVirtualQuantity); // without this ovftool won't eat the item
3130 }
3131 break;
3132
3133 case VirtualSystemDescriptionType_HardDiskControllerIDE:
3134 /* <Item>
3135 <rasd:Caption>ideController1</rasd:Caption>
3136 <rasd:Description>IDE Controller</rasd:Description>
3137 <rasd:InstanceId>5</rasd:InstanceId>
3138 <rasd:ResourceType>5</rasd:ResourceType>
3139 <rasd:Address>1</rasd:Address>
3140 <rasd:BusNumber>1</rasd:BusNumber>
3141 </Item> */
3142 if (uLoop == 1)
3143 {
3144 strDescription = "IDE Controller";
3145 type = OVFResourceType_IDEController; // 5
3146 strResourceSubType = desc.strVbox;
3147 // it seems that OVFTool always writes these two, and since we can only
3148 // have one IDE controller, we'll use this as well
3149 lAddress = 1;
3150 lBusNumber = 1;
3151
3152 // remember this ID
3153 idIDEController = ulInstanceID;
3154 lIDEControllerIndex = lIndexThis;
3155 }
3156 break;
3157
3158 case VirtualSystemDescriptionType_HardDiskControllerSATA:
3159 /* <Item>
3160 <rasd:Caption>sataController0</rasd:Caption>
3161 <rasd:Description>SATA Controller</rasd:Description>
3162 <rasd:InstanceId>4</rasd:InstanceId>
3163 <rasd:ResourceType>20</rasd:ResourceType>
3164 <rasd:ResourceSubType>ahci</rasd:ResourceSubType>
3165 <rasd:Address>0</rasd:Address>
3166 <rasd:BusNumber>0</rasd:BusNumber>
3167 </Item>
3168 */
3169 if (uLoop == 1)
3170 {
3171 strDescription = "SATA Controller";
3172 strCaption = "sataController0";
3173 type = OVFResourceType_OtherStorageDevice; // 20
3174 // it seems that OVFTool always writes these two, and since we can only
3175 // have one SATA controller, we'll use this as well
3176 lAddress = 0;
3177 lBusNumber = 0;
3178
3179 if ( desc.strVbox.isEmpty() // AHCI is the default in VirtualBox
3180 || (!desc.strVbox.compare("ahci", Utf8Str::CaseInsensitive))
3181 )
3182 strResourceSubType = "AHCI";
3183 else
3184 throw setError(VBOX_E_NOT_SUPPORTED,
3185 tr("Invalid config string \"%s\" in SATA controller"), desc.strVbox.c_str());
3186
3187 // remember this ID
3188 idSATAController = ulInstanceID;
3189 lSATAControllerIndex = lIndexThis;
3190 }
3191 break;
3192
3193 case VirtualSystemDescriptionType_HardDiskControllerSCSI:
3194 /* <Item>
3195 <rasd:Caption>scsiController0</rasd:Caption>
3196 <rasd:Description>SCSI Controller</rasd:Description>
3197 <rasd:InstanceId>4</rasd:InstanceId>
3198 <rasd:ResourceType>6</rasd:ResourceType>
3199 <rasd:ResourceSubType>buslogic</rasd:ResourceSubType>
3200 <rasd:Address>0</rasd:Address>
3201 <rasd:BusNumber>0</rasd:BusNumber>
3202 </Item>
3203 */
3204 if (uLoop == 1)
3205 {
3206 strDescription = "SCSI Controller";
3207 strCaption = "scsiController0";
3208 type = OVFResourceType_ParallelSCSIHBA; // 6
3209 // it seems that OVFTool always writes these two, and since we can only
3210 // have one SATA controller, we'll use this as well
3211 lAddress = 0;
3212 lBusNumber = 0;
3213
3214 if ( desc.strVbox.isEmpty() // LsiLogic is the default in VirtualBox
3215 || (!desc.strVbox.compare("lsilogic", Utf8Str::CaseInsensitive))
3216 )
3217 strResourceSubType = "lsilogic";
3218 else if (!desc.strVbox.compare("buslogic", Utf8Str::CaseInsensitive))
3219 strResourceSubType = "buslogic";
3220 else
3221 throw setError(VBOX_E_NOT_SUPPORTED,
3222 tr("Invalid config string \"%s\" in SCSI controller"), desc.strVbox.c_str());
3223
3224 // remember this ID
3225 idSCSIController = ulInstanceID;
3226 lSCSIControllerIndex = lIndexThis;
3227 }
3228 break;
3229
3230 case VirtualSystemDescriptionType_HardDiskImage:
3231 /* <Item>
3232 <rasd:Caption>disk1</rasd:Caption>
3233 <rasd:InstanceId>8</rasd:InstanceId>
3234 <rasd:ResourceType>17</rasd:ResourceType>
3235 <rasd:HostResource>/disk/vmdisk1</rasd:HostResource>
3236 <rasd:Parent>4</rasd:Parent>
3237 <rasd:AddressOnParent>0</rasd:AddressOnParent>
3238 </Item> */
3239 if (uLoop == 2)
3240 {
3241 Utf8Str strDiskID = Utf8StrFmt("vmdisk%RI32", ++cDisks);
3242
3243 strDescription = "Disk Image";
3244 strCaption = Utf8StrFmt("disk%RI32", cDisks); // this is not used for anything else
3245 type = OVFResourceType_HardDisk; // 17
3246
3247 // the following references the "<Disks>" XML block
3248 strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());
3249
3250 // controller=<index>;channel=<c>
3251 size_t pos1 = desc.strExtraConfig.find("controller=");
3252 size_t pos2 = desc.strExtraConfig.find("channel=");
3253 if (pos1 != Utf8Str::npos)
3254 {
3255 int32_t lControllerIndex = -1;
3256 RTStrToInt32Ex(desc.strExtraConfig.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
3257 if (lControllerIndex == lIDEControllerIndex)
3258 ulParent = idIDEController;
3259 else if (lControllerIndex == lSCSIControllerIndex)
3260 ulParent = idSCSIController;
3261 else if (lControllerIndex == lSATAControllerIndex)
3262 ulParent = idSATAController;
3263 }
3264 if (pos2 != Utf8Str::npos)
3265 RTStrToInt32Ex(desc.strExtraConfig.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
3266
3267 if ( !ulParent
3268 || lAddressOnParent == -1
3269 )
3270 throw setError(VBOX_E_NOT_SUPPORTED,
3271 tr("Missing or bad extra config string in hard disk image: \"%s\""), desc.strExtraConfig.c_str());
3272
3273 mapDisks[strDiskID] = &desc;
3274 }
3275 break;
3276
3277 case VirtualSystemDescriptionType_Floppy:
3278 if (uLoop == 1)
3279 {
3280 strDescription = "Floppy Drive";
3281 strCaption = "floppy0"; // this is what OVFTool writes
3282 type = OVFResourceType_FloppyDrive; // 14
3283 lAutomaticAllocation = 0;
3284 lAddressOnParent = 0; // this is what OVFTool writes
3285 }
3286 break;
3287
3288 case VirtualSystemDescriptionType_CDROM:
3289 if (uLoop == 2)
3290 {
3291 // we can't have a CD without an IDE controller
3292 if (!idIDEController)
3293 throw setError(VBOX_E_NOT_SUPPORTED,
3294 tr("Can't have CD-ROM without IDE controller"));
3295
3296 strDescription = "CD-ROM Drive";
3297 strCaption = "cdrom1"; // this is what OVFTool writes
3298 type = OVFResourceType_CDDrive; // 15
3299 lAutomaticAllocation = 1;
3300 ulParent = idIDEController;
3301 lAddressOnParent = 0; // this is what OVFTool writes
3302 }
3303 break;
3304
3305 case VirtualSystemDescriptionType_NetworkAdapter:
3306 /* <Item>
3307 <rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
3308 <rasd:Caption>Ethernet adapter on 'VM Network'</rasd:Caption>
3309 <rasd:Connection>VM Network</rasd:Connection>
3310 <rasd:ElementName>VM network</rasd:ElementName>
3311 <rasd:InstanceID>3</rasd:InstanceID>
3312 <rasd:ResourceType>10</rasd:ResourceType>
3313 </Item> */
3314 if (uLoop == 1)
3315 {
3316 lAutomaticAllocation = 1;
3317 strCaption = Utf8StrFmt("Ethernet adapter on '%s'", desc.strOvf.c_str());
3318 type = OVFResourceType_EthernetAdapter; // 10
3319 /* Set the hardware type to something useful.
3320 * To be compatible with vmware & others we set
3321 * PCNet32 for our PCNet types & E1000 for the
3322 * E1000 cards. */
3323 switch (desc.strVbox.toInt32())
3324 {
3325 case NetworkAdapterType_Am79C970A:
3326 case NetworkAdapterType_Am79C973: strResourceSubType = "PCNet32"; break;
3327#ifdef VBOX_WITH_E1000
3328 case NetworkAdapterType_I82540EM:
3329 case NetworkAdapterType_I82545EM:
3330 case NetworkAdapterType_I82543GC: strResourceSubType = "E1000"; break;
3331#endif /* VBOX_WITH_E1000 */
3332 }
3333 strConnection = desc.strOvf;
3334
3335 mapNetworks[desc.strOvf] = true;
3336 }
3337 break;
3338
3339 case VirtualSystemDescriptionType_USBController:
3340 /* <Item ovf:required="false">
3341 <rasd:Caption>usb</rasd:Caption>
3342 <rasd:Description>USB Controller</rasd:Description>
3343 <rasd:InstanceId>3</rasd:InstanceId>
3344 <rasd:ResourceType>23</rasd:ResourceType>
3345 <rasd:Address>0</rasd:Address>
3346 <rasd:BusNumber>0</rasd:BusNumber>
3347 </Item> */
3348 if (uLoop == 1)
3349 {
3350 strDescription = "USB Controller";
3351 strCaption = "usb";
3352 type = OVFResourceType_USBController; // 23
3353 lAddress = 0; // this is what OVFTool writes
3354 lBusNumber = 0; // this is what OVFTool writes
3355 }
3356 break;
3357
3358 case VirtualSystemDescriptionType_SoundCard:
3359 /* <Item ovf:required="false">
3360 <rasd:Caption>sound</rasd:Caption>
3361 <rasd:Description>Sound Card</rasd:Description>
3362 <rasd:InstanceId>10</rasd:InstanceId>
3363 <rasd:ResourceType>35</rasd:ResourceType>
3364 <rasd:ResourceSubType>ensoniq1371</rasd:ResourceSubType>
3365 <rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
3366 <rasd:AddressOnParent>3</rasd:AddressOnParent>
3367 </Item> */
3368 if (uLoop == 1)
3369 {
3370 strDescription = "Sound Card";
3371 strCaption = "sound";
3372 type = OVFResourceType_SoundCard; // 35
3373 strResourceSubType = desc.strOvf; // e.g. ensoniq1371
3374 lAutomaticAllocation = 0;
3375 lAddressOnParent = 3; // what gives? this is what OVFTool writes
3376 }
3377 break;
3378 }
3379
3380 if (type)
3381 {
3382 xml::ElementNode *pItem;
3383
3384 pItem = pelmVirtualHardwareSection->createChild("Item");
3385
3386 // NOTE: do not change the order of these items without good reason! While we don't care
3387 // about ordering, VMware's ovftool does and fails if the items are not written in
3388 // exactly this order, as stupid as it seems.
3389
3390 if (!strCaption.isEmpty())
3391 pItem->createChild("rasd:Caption")->addContent(strCaption);
3392 if (!strDescription.isEmpty())
3393 pItem->createChild("rasd:Description")->addContent(strDescription);
3394
3395 // <rasd:InstanceID>1</rasd:InstanceID>
3396 xml::ElementNode *pelmInstanceID;
3397 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3398 pelmInstanceID = pItem->createChild("rasd:InstanceId");
3399 else
3400 pelmInstanceID = pItem->createChild("rasd:InstanceID"); // capitalization changed...
3401 pelmInstanceID->addContent(Utf8StrFmt("%d", ulInstanceID++));
3402
3403 // <rasd:ResourceType>3</rasd:ResourceType>
3404 pItem->createChild("rasd:ResourceType")->addContent(Utf8StrFmt("%d", type));
3405 if (!strResourceSubType.isEmpty())
3406 pItem->createChild("rasd:ResourceSubType")->addContent(strResourceSubType);
3407
3408 if (!strHostResource.isEmpty())
3409 pItem->createChild("rasd:HostResource")->addContent(strHostResource);
3410
3411 if (!strAllocationUnits.isEmpty())
3412 pItem->createChild("rasd:AllocationUnits")->addContent(strAllocationUnits);
3413
3414 // <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
3415 if (lVirtualQuantity != -1)
3416 pItem->createChild("rasd:VirtualQuantity")->addContent(Utf8StrFmt("%d", lVirtualQuantity));
3417
3418 if (lAutomaticAllocation != -1)
3419 pItem->createChild("rasd:AutomaticAllocation")->addContent( (lAutomaticAllocation) ? "true" : "false" );
3420
3421 if (!strConnection.isEmpty())
3422 pItem->createChild("rasd:Connection")->addContent(strConnection);
3423
3424 if (lAddress != -1)
3425 pItem->createChild("rasd:Address")->addContent(Utf8StrFmt("%d", lAddress));
3426
3427 if (lBusNumber != -1)
3428 pItem->createChild("rasd:BusNumber")->addContent(Utf8StrFmt("%d", lBusNumber));
3429
3430 if (ulParent)
3431 pItem->createChild("rasd:Parent")->addContent(Utf8StrFmt("%d", ulParent));
3432 if (lAddressOnParent != -1)
3433 pItem->createChild("rasd:AddressOnParent")->addContent(Utf8StrFmt("%d", lAddressOnParent));
3434 }
3435 }
3436 } // for (size_t uLoop = 0; ...
3437 }
3438
3439 // finally, fill in the network section we set up empty above according
3440 // to the networks we found with the hardware items
3441 map<Utf8Str, bool>::const_iterator itN;
3442 for (itN = mapNetworks.begin();
3443 itN != mapNetworks.end();
3444 ++itN)
3445 {
3446 const Utf8Str &strNetwork = itN->first;
3447 xml::ElementNode *pelmNetwork = pelmNetworkSection->createChild("Network");
3448 pelmNetwork->setAttribute("ovf:name", strNetwork.c_str());
3449 pelmNetwork->createChild("Description")->addContent("Logical network used by this appliance.");
3450 }
3451
3452 map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;
3453 uint32_t ulFile = 1;
3454 for (itS = mapDisks.begin();
3455 itS != mapDisks.end();
3456 ++itS)
3457 {
3458 const Utf8Str &strDiskID = itS->first;
3459 const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;
3460
3461 // source path: where the VBox image is
3462 const Utf8Str &strSrcFilePath = pDiskEntry->strVbox;
3463 Bstr bstrSrcFilePath(strSrcFilePath);
3464 if (!RTPathExists(strSrcFilePath.c_str()))
3465 /* This isn't allowed */
3466 throw setError(VBOX_E_FILE_ERROR,
3467 tr("Source virtual disk image file '%s' doesn't exist"),
3468 strSrcFilePath.c_str());
3469
3470 // output filename
3471 const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
3472 // target path needs to be composed from where the output OVF is
3473 Utf8Str strTargetFilePath = stripFilename(m->strPath);
3474 strTargetFilePath.append("/");
3475 strTargetFilePath.append(strTargetFileNameOnly);
3476
3477 // clone the disk:
3478 ComPtr<IHardDisk> pSourceDisk;
3479 ComPtr<IHardDisk> pTargetDisk;
3480 ComPtr<IProgress> pProgress2;
3481
3482 Log(("Finding source disk \"%ls\"\n", bstrSrcFilePath.raw()));
3483 rc = mVirtualBox->FindHardDisk(bstrSrcFilePath, pSourceDisk.asOutParam());
3484 if (FAILED(rc)) throw rc;
3485
3486 /* We are always exporting to vmdfk stream optimized for now */
3487 Bstr bstrSrcFormat = L"VMDK";
3488
3489 // create a new hard disk interface for the destination disk image
3490 Log(("Creating target disk \"%s\"\n", strTargetFilePath.raw()));
3491 rc = mVirtualBox->CreateHardDisk(bstrSrcFormat, Bstr(strTargetFilePath), pTargetDisk.asOutParam());
3492 if (FAILED(rc)) throw rc;
3493
3494 // the target disk is now registered and needs to be removed again,
3495 // both after successful cloning or if anything goes bad!
3496 try
3497 {
3498 // create a flat copy of the source disk image
3499 rc = pSourceDisk->CloneTo(pTargetDisk, HardDiskVariant_VmdkStreamOptimized, NULL, pProgress2.asOutParam());
3500 if (FAILED(rc)) throw rc;
3501
3502 // advance to the next operation
3503 if (!pTask->progress.isNull())
3504 pTask->progress->setNextOperation(BstrFmt(tr("Exporting virtual disk image '%s'"), strSrcFilePath.c_str()),
3505 pDiskEntry->ulSizeMB); // operation's weight, as set up with the IProgress originally);
3506
3507 // now wait for the background disk operation to complete; this throws HRESULTs on error
3508 waitForAsyncProgress(pTask->progress, pProgress2);
3509 }
3510 catch (HRESULT rc3)
3511 {
3512 // upon error after registering, close the disk or
3513 // it'll stick in the registry forever
3514 pTargetDisk->Close();
3515 throw;
3516 }
3517
3518 // we need the following for the XML
3519 uint64_t cbFile = 0; // actual file size
3520 rc = pTargetDisk->COMGETTER(Size)(&cbFile);
3521 if (FAILED(rc)) throw rc;
3522
3523 ULONG64 cbCapacity = 0; // size reported to guest
3524 rc = pTargetDisk->COMGETTER(LogicalSize)(&cbCapacity);
3525 if (FAILED(rc)) throw rc;
3526 // capacity is reported in megabytes, so...
3527 cbCapacity *= _1M;
3528
3529 // upon success, close the disk as well
3530 rc = pTargetDisk->Close();
3531 if (FAILED(rc)) throw rc;
3532
3533 // now handle the XML for the disk:
3534 Utf8StrFmt strFileRef("file%RI32", ulFile++);
3535 // <File ovf:href="WindowsXpProfessional-disk1.vmdk" ovf:id="file1" ovf:size="1710381056"/>
3536 xml::ElementNode *pelmFile = pelmReferences->createChild("File");
3537 pelmFile->setAttribute("ovf:href", strTargetFileNameOnly);
3538 pelmFile->setAttribute("ovf:id", strFileRef);
3539 pelmFile->setAttribute("ovf:size", Utf8StrFmt("%RI64", cbFile).c_str());
3540
3541 // add disk to XML Disks section
3542 // <Disk ovf:capacity="8589934592" ovf:diskId="vmdisk1" ovf:fileRef="file1" ovf:format="http://www.vmware.com/specifications/vmdk.html#sparse"/>
3543 xml::ElementNode *pelmDisk = pelmDiskSection->createChild("Disk");
3544 pelmDisk->setAttribute("ovf:capacity", Utf8StrFmt("%RI64", cbCapacity).c_str());
3545 pelmDisk->setAttribute("ovf:diskId", strDiskID);
3546 pelmDisk->setAttribute("ovf:fileRef", strFileRef);
3547 pelmDisk->setAttribute("ovf:format", "http://www.vmware.com/specifications/vmdk.html#sparse"); // must be sparse or ovftool chokes
3548 }
3549
3550 // now go write the XML
3551 xml::XmlFileWriter writer(doc);
3552 writer.write(m->strPath.c_str());
3553 }
3554 catch(xml::Error &x)
3555 {
3556 rc = setError(VBOX_E_FILE_ERROR,
3557 x.what());
3558 }
3559 catch(HRESULT aRC)
3560 {
3561 rc = aRC;
3562 }
3563
3564 pTask->rc = rc;
3565
3566 if (!pTask->progress.isNull())
3567 pTask->progress->notifyComplete(rc);
3568
3569 LogFlowFunc(("rc=%Rhrc\n", rc));
3570 LogFlowFuncLeave();
3571
3572 return VINF_SUCCESS;
3573}
3574
3575/**
3576 * Worker thread implementation for Upload() (ovf uploader).
3577 * @param aThread
3578 * @param pvUser
3579 */
3580/* static */
3581int Appliance::writeS3(TaskWriteOVF *pTask)
3582{
3583 LogFlowFuncEnter();
3584 LogFlowFunc(("Appliance %p\n", this));
3585
3586 AutoCaller autoCaller(this);
3587 CheckComRCReturnRC(autoCaller.rc());
3588
3589 HRESULT rc = S_OK;
3590
3591 AutoWriteLock appLock(this);
3592
3593 /* Buckets are S3 specific. So parse the bucket out of the file path */
3594 Utf8Str tmpPath = pTask->filepath;
3595 if (!tmpPath.startsWith("/"))
3596 return setError(E_INVALIDARG,
3597 tr("The path '%s' must start with /"), tmpPath.c_str());
3598 Utf8Str bucket;
3599 size_t bpos = tmpPath.find("/", 1);
3600 if (bpos != Utf8Str::npos)
3601 {
3602 bucket = tmpPath.substr(1, bpos - 1); /* The bucket without any slashes */
3603 tmpPath = tmpPath.substr(bpos); /* The rest of the file path */
3604 }
3605 /* If there is no bucket name provided reject the upload */
3606 if (bucket.isEmpty())
3607 return setError(E_INVALIDARG,
3608 tr("You doesn't provide a bucket name in the URI"), tmpPath.c_str());
3609
3610 int vrc = VINF_SUCCESS;
3611 RTS3 hS3 = NULL;
3612 char szOSTmpDir[RTPATH_MAX];
3613 RTPathTemp(szOSTmpDir, sizeof(szOSTmpDir));
3614 /* The template for the temporary directory created below */
3615 char *pszTmpDir;
3616 RTStrAPrintf(&pszTmpDir, "%s"RTPATH_SLASH_STR"vbox-ovf-XXXXXX", szOSTmpDir);
3617 list< pair<Utf8Str, ULONG> > filesList;
3618
3619 // todo:
3620 // - getting the tmp directory (especially on win)
3621 // - usable error codes
3622 // - seems snapshot filenames are problematic {uuid}.vdi
3623 try
3624 {
3625 /* We need a temporary directory which we can put the OVF file & all
3626 * disk images in */
3627 vrc = RTDirCreateTemp(pszTmpDir);
3628 if (RT_FAILURE(rc))
3629 throw setError(VBOX_E_FILE_ERROR,
3630 tr("Cannot create temporary directory '%s'"), pszTmpDir);
3631
3632 /* The temporary name of the target OVF file */
3633 Utf8StrFmt strTmpOvf("%s/%s", pszTmpDir, RTPathFilename(tmpPath));
3634
3635 /* Prepare the temporary writing of the OVF */
3636 ComObjPtr<Progress> progress;
3637 rc = writeImpl(pTask->enFormat, strTmpOvf.c_str(), progress);
3638 if (FAILED(rc)) throw rc;
3639
3640 /* Unlock the appliance for the writing thread */
3641 appLock.unlock();
3642 /* Wait until the writing is done, but report the progress back to the
3643 caller */
3644 ComPtr<IProgress> progressInt(progress);
3645 waitForAsyncProgress(pTask->progress, progressInt); /* Any errors will be thrown */
3646
3647 /* Again lock the appliance for the next steps */
3648 appLock.lock();
3649
3650 vrc = RTPathExists(strTmpOvf.c_str()); /* Paranoid check */
3651 if(RT_FAILURE(vrc))
3652 throw setError(VBOX_E_FILE_ERROR,
3653 tr("Cannot find source file '%s'"), strTmpOvf.c_str());
3654 /* Add the OVF file */
3655 filesList.push_back(pair<Utf8Str, ULONG>(strTmpOvf, m->ulWeightPerOperation)); /* Use 1% of the total for the OVF file upload */
3656
3657 /* Now add every disks of every virtual system */
3658 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
3659 for (it = m->virtualSystemDescriptions.begin();
3660 it != m->virtualSystemDescriptions.end();
3661 ++it)
3662 {
3663 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
3664 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
3665 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
3666 for (itH = avsdeHDs.begin();
3667 itH != avsdeHDs.end();
3668 ++itH)
3669 {
3670 const Utf8Str &strTargetFileNameOnly = (*itH)->strOvf;
3671 /* Target path needs to be composed from where the output OVF is */
3672 Utf8Str strTargetFilePath = stripFilename(m->strPath);
3673 strTargetFilePath.append("/");
3674 strTargetFilePath.append(strTargetFileNameOnly);
3675 vrc = RTPathExists(strTargetFilePath.c_str()); /* Paranoid check */
3676 if(RT_FAILURE(vrc))
3677 throw setError(VBOX_E_FILE_ERROR,
3678 tr("Cannot find source file '%s'"), strTargetFilePath.c_str());
3679 filesList.push_back(pair<Utf8Str, ULONG>(strTargetFilePath, (*itH)->ulSizeMB));
3680 }
3681 }
3682 /* Next we have to upload the OVF & all disk images */
3683 vrc = RTS3Create(&hS3, pTask->username.c_str(), pTask->password.c_str(), pTask->hostname.c_str(), "virtualbox-agent/"VBOX_VERSION_STRING);
3684 if(RT_FAILURE(vrc))
3685 throw setError(VBOX_E_IPRT_ERROR,
3686 tr("Cannot create S3 service handler"));
3687 RTS3SetProgressCallback(hS3, pTask->uploadProgress, &pTask);
3688
3689 /* Upload all files */
3690 for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
3691 {
3692 const pair<Utf8Str, ULONG> &s = (*it1);
3693 char *pszFilename = RTPathFilename(s.first.c_str());
3694 /* Advance to the next operation */
3695 if (!pTask->progress.isNull())
3696 pTask->progress->setNextOperation(BstrFmt(tr("Uploading file '%s'"), pszFilename), s.second);
3697 vrc = RTS3PutKey(hS3, bucket.c_str(), pszFilename, s.first.c_str());
3698 if (RT_FAILURE(vrc))
3699 {
3700 if(vrc == VERR_S3_CANCELED)
3701 break;
3702 else if(vrc == VERR_S3_ACCESS_DENIED)
3703 throw setError(E_ACCESSDENIED,
3704 tr("Cannot upload file '%s' to S3 storage server (Access denied)"), pszFilename);
3705 else if(vrc == VERR_S3_NOT_FOUND)
3706 throw setError(VBOX_E_FILE_ERROR,
3707 tr("Cannot upload file '%s' to S3 storage server (File not found)"), pszFilename);
3708 else
3709 throw setError(VBOX_E_IPRT_ERROR,
3710 tr("Cannot upload file '%s' to S3 storage server (%Rrc)"), pszFilename, vrc);
3711 }
3712 }
3713
3714 }
3715 catch(HRESULT aRC)
3716 {
3717 rc = aRC;
3718 }
3719 /* Cleanup */
3720 if (hS3)
3721 RTS3Destroy(hS3);
3722 /* Delete all files which where temporary created */
3723 for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
3724 {
3725 const pair<Utf8Str, ULONG> &s = (*it1);
3726 vrc = RTFileDelete(s.first.c_str());
3727 if(RT_FAILURE(vrc))
3728 rc = setError(VBOX_E_FILE_ERROR,
3729 tr("Cannot delete file '%s' (%Rrc)"), s.first.c_str(), vrc);
3730 }
3731 /* Delete the temporary directory */
3732 if (RTPathExists(pszTmpDir))
3733 {
3734 vrc = RTDirRemove(pszTmpDir);
3735 if(RT_FAILURE(vrc))
3736 rc = setError(VBOX_E_FILE_ERROR,
3737 tr("Cannot delete temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);
3738 }
3739 if (pszTmpDir)
3740 RTStrFree(pszTmpDir);
3741
3742 pTask->rc = rc;
3743
3744 if (!pTask->progress.isNull())
3745 pTask->progress->notifyComplete(rc);
3746
3747 LogFlowFunc(("rc=%Rhrc\n", rc));
3748 LogFlowFuncLeave();
3749
3750 return VINF_SUCCESS;
3751}
3752
3753/**
3754* Public method implementation.
3755 * @return
3756 */
3757STDMETHODIMP Appliance::GetWarnings(ComSafeArrayOut(BSTR, aWarnings))
3758{
3759 if (ComSafeArrayOutIsNull(aWarnings))
3760 return E_POINTER;
3761
3762 AutoCaller autoCaller(this);
3763 CheckComRCReturnRC(autoCaller.rc());
3764
3765 AutoReadLock alock(this);
3766
3767 com::SafeArray<BSTR> sfaWarnings(m->llWarnings.size());
3768
3769 list<Utf8Str>::const_iterator it;
3770 size_t i = 0;
3771 for (it = m->llWarnings.begin();
3772 it != m->llWarnings.end();
3773 ++it, ++i)
3774 {
3775 Bstr bstr = *it;
3776 bstr.cloneTo(&sfaWarnings[i]);
3777 }
3778
3779 sfaWarnings.detachTo(ComSafeArrayOutArg(aWarnings));
3780
3781 return S_OK;
3782}
3783
3784HRESULT Appliance::searchUniqueVMName(Utf8Str& aName) const
3785{
3786 IMachine *machine = NULL;
3787 char *tmpName = RTStrDup(aName.c_str());
3788 int i = 1;
3789 /* @todo: Maybe too cost-intensive; try to find a lighter way */
3790 while (mVirtualBox->FindMachine(Bstr(tmpName), &machine) != VBOX_E_OBJECT_NOT_FOUND)
3791 {
3792 RTStrFree(tmpName);
3793 RTStrAPrintf(&tmpName, "%s_%d", aName.c_str(), i);
3794 ++i;
3795 }
3796 aName = tmpName;
3797 RTStrFree(tmpName);
3798
3799 return S_OK;
3800}
3801
3802HRESULT Appliance::searchUniqueDiskImageFilePath(Utf8Str& aName) const
3803{
3804 IHardDisk *harddisk = NULL;
3805 char *tmpName = RTStrDup(aName.c_str());
3806 int i = 1;
3807 /* Check if the file exists or if a file with this path is registered
3808 * already */
3809 /* @todo: Maybe too cost-intensive; try to find a lighter way */
3810 while (RTPathExists(tmpName) ||
3811 mVirtualBox->FindHardDisk(Bstr(tmpName), &harddisk) != VBOX_E_OBJECT_NOT_FOUND)
3812 {
3813 RTStrFree(tmpName);
3814 char *tmpDir = RTStrDup(aName.c_str());
3815 RTPathStripFilename(tmpDir);;
3816 char *tmpFile = RTStrDup(RTPathFilename(aName.c_str()));
3817 RTPathStripExt(tmpFile);
3818 const char *tmpExt = RTPathExt(aName.c_str());
3819 RTStrAPrintf(&tmpName, "%s%c%s_%d%s", tmpDir, RTPATH_DELIMITER, tmpFile, i, tmpExt);
3820 RTStrFree(tmpFile);
3821 RTStrFree(tmpDir);
3822 ++i;
3823 }
3824 aName = tmpName;
3825 RTStrFree(tmpName);
3826
3827 return S_OK;
3828}
3829
3830/**
3831 * Sets up the given progress object so that it represents disk images accurately
3832 * during importMachines() and write().
3833 * @param pProgress
3834 * @param bstrDescription
3835 * @return
3836 */
3837HRESULT Appliance::setUpProgress(ComObjPtr<Progress> &pProgress, const Bstr &bstrDescription)
3838{
3839 HRESULT rc;
3840
3841 /* Create the progress object */
3842 pProgress.createObject();
3843
3844 // weigh the disk images according to their sizes
3845 uint32_t ulTotalMB = 0;
3846 uint32_t cDisks = 0;
3847 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
3848 for (it = m->virtualSystemDescriptions.begin();
3849 it != m->virtualSystemDescriptions.end();
3850 ++it)
3851 {
3852 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
3853 /* One for every hard disk of the Virtual System */
3854 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
3855 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
3856 for (itH = avsdeHDs.begin();
3857 itH != avsdeHDs.end();
3858 ++itH)
3859 {
3860 const VirtualSystemDescriptionEntry *pHD = *itH;
3861 ulTotalMB += pHD->ulSizeMB;
3862 ++cDisks;
3863 }
3864 }
3865
3866 ULONG cOperations = 1 + cDisks; // one op per disk plus 1 for the XML
3867
3868 ULONG ulTotalOperationsWeight;
3869 if (ulTotalMB)
3870 {
3871 m->ulWeightPerOperation = (ULONG)((double)ulTotalMB * 1 / 100); // use 1% of the progress for the XML
3872 ulTotalOperationsWeight = ulTotalMB + m->ulWeightPerOperation;
3873 }
3874 else
3875 {
3876 // no disks to export:
3877 ulTotalOperationsWeight = 1;
3878 m->ulWeightPerOperation = 1;
3879 }
3880
3881 Log(("Setting up progress object: ulTotalMB = %d, cDisks = %d, => cOperations = %d, ulTotalOperationsWeight = %d, m->ulWeightPerOperation = %d\n",
3882 ulTotalMB, cDisks, cOperations, ulTotalOperationsWeight, m->ulWeightPerOperation));
3883
3884 rc = pProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
3885 bstrDescription,
3886 TRUE /* aCancelable */,
3887 cOperations, // ULONG cOperations,
3888 ulTotalOperationsWeight, // ULONG ulTotalOperationsWeight,
3889 bstrDescription, // CBSTR bstrFirstOperationDescription,
3890 m->ulWeightPerOperation); // ULONG ulFirstOperationWeight,
3891 return rc;
3892}
3893
3894HRESULT Appliance::setUpProgressUpload(ComObjPtr<Progress> &pProgress, const Bstr &bstrDescription)
3895{
3896 HRESULT rc;
3897
3898 /* Create the progress object */
3899 pProgress.createObject();
3900
3901 // weigh the disk images according to their sizes
3902 uint32_t ulTotalMB = 0;
3903 uint32_t cDisks = 0;
3904 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
3905 for (it = m->virtualSystemDescriptions.begin();
3906 it != m->virtualSystemDescriptions.end();
3907 ++it)
3908 {
3909 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
3910 /* One for every hard disk of the Virtual System */
3911 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
3912 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
3913 for (itH = avsdeHDs.begin();
3914 itH != avsdeHDs.end();
3915 ++itH)
3916 {
3917 const VirtualSystemDescriptionEntry *pHD = *itH;
3918 ulTotalMB += pHD->ulSizeMB;
3919 ++cDisks;
3920 }
3921 }
3922
3923 ULONG cOperations = 1 + 1 + cDisks; // one op per disk plus 1 for the OVF & 1 plus to the temporary creation */
3924
3925 ULONG ulTotalOperationsWeight;
3926 if (ulTotalMB)
3927 {
3928 m->ulWeightPerOperation = (ULONG)((double)ulTotalMB * 1 / 100); // use 1% of the progress for OVF file upload (we didn't know the size at this point)
3929 ulTotalOperationsWeight = ulTotalMB + m->ulWeightPerOperation;
3930 }
3931 else
3932 {
3933 // no disks to export:
3934 ulTotalOperationsWeight = 1;
3935 m->ulWeightPerOperation = 1;
3936 }
3937 ULONG ulOVFCreationWeight = ((double)ulTotalOperationsWeight * 50.0 / 100.0); /* Use 50% for the creation of the OVF & the disks */
3938 ulTotalOperationsWeight += ulOVFCreationWeight;
3939
3940 Log(("Setting up progress object: ulTotalMB = %d, cDisks = %d, => cOperations = %d, ulTotalOperationsWeight = %d, m->ulWeightPerOperation = %d\n",
3941 ulTotalMB, cDisks, cOperations, ulTotalOperationsWeight, m->ulWeightPerOperation));
3942
3943 rc = pProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
3944 bstrDescription,
3945 TRUE /* aCancelable */,
3946 cOperations, // ULONG cOperations,
3947 ulTotalOperationsWeight, // ULONG ulTotalOperationsWeight,
3948 bstrDescription, // CBSTR bstrFirstOperationDescription,
3949 ulOVFCreationWeight); // ULONG ulFirstOperationWeight,
3950 return rc;
3951}
3952
3953/**
3954 * Called from the import and export background threads to synchronize the second
3955 * background disk thread's progress object with the current progress object so
3956 * that the user interface sees progress correctly and that cancel signals are
3957 * passed on to the second thread.
3958 * @param pProgressThis Progress object of the current thread.
3959 * @param pProgressAsync Progress object of asynchronous task running in background.
3960 */
3961void Appliance::waitForAsyncProgress(ComObjPtr<Progress> &pProgressThis,
3962 ComPtr<IProgress> &pProgressAsync)
3963{
3964 HRESULT rc;
3965
3966 // now loop until the asynchronous operation completes and then report its result
3967 BOOL fCompleted;
3968 BOOL fCanceled;
3969 ULONG currentPercent;
3970 while (SUCCEEDED(pProgressAsync->COMGETTER(Completed(&fCompleted))))
3971 {
3972 rc = pProgressThis->COMGETTER(Canceled)(&fCanceled);
3973 if (FAILED(rc)) throw rc;
3974 if (fCanceled)
3975 {
3976 pProgressAsync->Cancel();
3977 break;
3978 }
3979
3980 rc = pProgressAsync->COMGETTER(Percent(&currentPercent));
3981 if (FAILED(rc)) throw rc;
3982 if (!pProgressThis.isNull())
3983 pProgressThis->setCurrentOperationProgress(currentPercent);
3984 if (fCompleted)
3985 break;
3986
3987 /* Make sure the loop is not too tight */
3988 rc = pProgressAsync->WaitForCompletion(100);
3989 if (FAILED(rc)) throw rc;
3990 }
3991 // report result of asynchronous operation
3992 LONG iRc;
3993 rc = pProgressAsync->COMGETTER(ResultCode)(&iRc);
3994 if (FAILED(rc)) throw rc;
3995
3996
3997 // if the thread of the progress object has an error, then
3998 // retrieve the error info from there, or it'll be lost
3999 if (FAILED(iRc))
4000 {
4001 ProgressErrorInfo info(pProgressAsync);
4002 Utf8Str str(info.getText());
4003 const char *pcsz = str.c_str();
4004 HRESULT rc2 = setError(iRc, pcsz);
4005 throw rc2;
4006 }
4007}
4008
4009void Appliance::addWarning(const char* aWarning, ...)
4010{
4011 va_list args;
4012 va_start(args, aWarning);
4013 Utf8StrFmtVA str(aWarning, args);
4014 va_end(args);
4015 m->llWarnings.push_back(str);
4016}
4017
4018////////////////////////////////////////////////////////////////////////////////
4019//
4020// IVirtualSystemDescription constructor / destructor
4021//
4022////////////////////////////////////////////////////////////////////////////////
4023
4024DEFINE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
4025struct shutup3 {};
4026
4027/**
4028 * COM initializer.
4029 * @return
4030 */
4031HRESULT VirtualSystemDescription::init()
4032{
4033 /* Enclose the state transition NotReady->InInit->Ready */
4034 AutoInitSpan autoInitSpan(this);
4035 AssertReturn(autoInitSpan.isOk(), E_FAIL);
4036
4037 /* Initialize data */
4038 m = new Data();
4039
4040 /* Confirm a successful initialization */
4041 autoInitSpan.setSucceeded();
4042 return S_OK;
4043}
4044
4045/**
4046* COM uninitializer.
4047*/
4048
4049void VirtualSystemDescription::uninit()
4050{
4051 delete m;
4052 m = NULL;
4053}
4054
4055////////////////////////////////////////////////////////////////////////////////
4056//
4057// IVirtualSystemDescription public methods
4058//
4059////////////////////////////////////////////////////////////////////////////////
4060
4061/**
4062 * Public method implementation.
4063 * @param
4064 * @return
4065 */
4066STDMETHODIMP VirtualSystemDescription::COMGETTER(Count)(ULONG *aCount)
4067{
4068 if (!aCount)
4069 return E_POINTER;
4070
4071 AutoCaller autoCaller(this);
4072 CheckComRCReturnRC(autoCaller.rc());
4073
4074 AutoReadLock alock(this);
4075
4076 *aCount = (ULONG)m->llDescriptions.size();
4077
4078 return S_OK;
4079}
4080
4081/**
4082 * Public method implementation.
4083 * @return
4084 */
4085STDMETHODIMP VirtualSystemDescription::GetDescription(ComSafeArrayOut(VirtualSystemDescriptionType_T, aTypes),
4086 ComSafeArrayOut(BSTR, aRefs),
4087 ComSafeArrayOut(BSTR, aOrigValues),
4088 ComSafeArrayOut(BSTR, aVboxValues),
4089 ComSafeArrayOut(BSTR, aExtraConfigValues))
4090{
4091 if (ComSafeArrayOutIsNull(aTypes) ||
4092 ComSafeArrayOutIsNull(aRefs) ||
4093 ComSafeArrayOutIsNull(aOrigValues) ||
4094 ComSafeArrayOutIsNull(aVboxValues) ||
4095 ComSafeArrayOutIsNull(aExtraConfigValues))
4096 return E_POINTER;
4097
4098 AutoCaller autoCaller(this);
4099 CheckComRCReturnRC(autoCaller.rc());
4100
4101 AutoReadLock alock(this);
4102
4103 ULONG c = (ULONG)m->llDescriptions.size();
4104 com::SafeArray<VirtualSystemDescriptionType_T> sfaTypes(c);
4105 com::SafeArray<BSTR> sfaRefs(c);
4106 com::SafeArray<BSTR> sfaOrigValues(c);
4107 com::SafeArray<BSTR> sfaVboxValues(c);
4108 com::SafeArray<BSTR> sfaExtraConfigValues(c);
4109
4110 list<VirtualSystemDescriptionEntry>::const_iterator it;
4111 size_t i = 0;
4112 for (it = m->llDescriptions.begin();
4113 it != m->llDescriptions.end();
4114 ++it, ++i)
4115 {
4116 const VirtualSystemDescriptionEntry &vsde = (*it);
4117
4118 sfaTypes[i] = vsde.type;
4119
4120 Bstr bstr = vsde.strRef;
4121 bstr.cloneTo(&sfaRefs[i]);
4122
4123 bstr = vsde.strOvf;
4124 bstr.cloneTo(&sfaOrigValues[i]);
4125
4126 bstr = vsde.strVbox;
4127 bstr.cloneTo(&sfaVboxValues[i]);
4128
4129 bstr = vsde.strExtraConfig;
4130 bstr.cloneTo(&sfaExtraConfigValues[i]);
4131 }
4132
4133 sfaTypes.detachTo(ComSafeArrayOutArg(aTypes));
4134 sfaRefs.detachTo(ComSafeArrayOutArg(aRefs));
4135 sfaOrigValues.detachTo(ComSafeArrayOutArg(aOrigValues));
4136 sfaVboxValues.detachTo(ComSafeArrayOutArg(aVboxValues));
4137 sfaExtraConfigValues.detachTo(ComSafeArrayOutArg(aExtraConfigValues));
4138
4139 return S_OK;
4140}
4141
4142/**
4143 * Public method implementation.
4144 * @return
4145 */
4146STDMETHODIMP VirtualSystemDescription::GetDescriptionByType(VirtualSystemDescriptionType_T aType,
4147 ComSafeArrayOut(VirtualSystemDescriptionType_T, aTypes),
4148 ComSafeArrayOut(BSTR, aRefs),
4149 ComSafeArrayOut(BSTR, aOrigValues),
4150 ComSafeArrayOut(BSTR, aVboxValues),
4151 ComSafeArrayOut(BSTR, aExtraConfigValues))
4152{
4153 if (ComSafeArrayOutIsNull(aTypes) ||
4154 ComSafeArrayOutIsNull(aRefs) ||
4155 ComSafeArrayOutIsNull(aOrigValues) ||
4156 ComSafeArrayOutIsNull(aVboxValues) ||
4157 ComSafeArrayOutIsNull(aExtraConfigValues))
4158 return E_POINTER;
4159
4160 AutoCaller autoCaller(this);
4161 CheckComRCReturnRC(autoCaller.rc());
4162
4163 AutoReadLock alock(this);
4164
4165 std::list<VirtualSystemDescriptionEntry*> vsd = findByType (aType);
4166 ULONG c = (ULONG)vsd.size();
4167 com::SafeArray<VirtualSystemDescriptionType_T> sfaTypes(c);
4168 com::SafeArray<BSTR> sfaRefs(c);
4169 com::SafeArray<BSTR> sfaOrigValues(c);
4170 com::SafeArray<BSTR> sfaVboxValues(c);
4171 com::SafeArray<BSTR> sfaExtraConfigValues(c);
4172
4173 list<VirtualSystemDescriptionEntry*>::const_iterator it;
4174 size_t i = 0;
4175 for (it = vsd.begin();
4176 it != vsd.end();
4177 ++it, ++i)
4178 {
4179 const VirtualSystemDescriptionEntry *vsde = (*it);
4180
4181 sfaTypes[i] = vsde->type;
4182
4183 Bstr bstr = vsde->strRef;
4184 bstr.cloneTo(&sfaRefs[i]);
4185
4186 bstr = vsde->strOvf;
4187 bstr.cloneTo(&sfaOrigValues[i]);
4188
4189 bstr = vsde->strVbox;
4190 bstr.cloneTo(&sfaVboxValues[i]);
4191
4192 bstr = vsde->strExtraConfig;
4193 bstr.cloneTo(&sfaExtraConfigValues[i]);
4194 }
4195
4196 sfaTypes.detachTo(ComSafeArrayOutArg(aTypes));
4197 sfaRefs.detachTo(ComSafeArrayOutArg(aRefs));
4198 sfaOrigValues.detachTo(ComSafeArrayOutArg(aOrigValues));
4199 sfaVboxValues.detachTo(ComSafeArrayOutArg(aVboxValues));
4200 sfaExtraConfigValues.detachTo(ComSafeArrayOutArg(aExtraConfigValues));
4201
4202 return S_OK;
4203}
4204
4205/**
4206 * Public method implementation.
4207 * @return
4208 */
4209STDMETHODIMP VirtualSystemDescription::GetValuesByType(VirtualSystemDescriptionType_T aType,
4210 VirtualSystemDescriptionValueType_T aWhich,
4211 ComSafeArrayOut(BSTR, aValues))
4212{
4213 if (ComSafeArrayOutIsNull(aValues))
4214 return E_POINTER;
4215
4216 AutoCaller autoCaller(this);
4217 CheckComRCReturnRC(autoCaller.rc());
4218
4219 AutoReadLock alock(this);
4220
4221 std::list<VirtualSystemDescriptionEntry*> vsd = findByType (aType);
4222 com::SafeArray<BSTR> sfaValues((ULONG)vsd.size());
4223
4224 list<VirtualSystemDescriptionEntry*>::const_iterator it;
4225 size_t i = 0;
4226 for (it = vsd.begin();
4227 it != vsd.end();
4228 ++it, ++i)
4229 {
4230 const VirtualSystemDescriptionEntry *vsde = (*it);
4231
4232 Bstr bstr;
4233 switch (aWhich)
4234 {
4235 case VirtualSystemDescriptionValueType_Reference: bstr = vsde->strRef; break;
4236 case VirtualSystemDescriptionValueType_Original: bstr = vsde->strOvf; break;
4237 case VirtualSystemDescriptionValueType_Auto: bstr = vsde->strVbox; break;
4238 case VirtualSystemDescriptionValueType_ExtraConfig: bstr = vsde->strExtraConfig; break;
4239 }
4240
4241 bstr.cloneTo(&sfaValues[i]);
4242 }
4243
4244 sfaValues.detachTo(ComSafeArrayOutArg(aValues));
4245
4246 return S_OK;
4247}
4248
4249/**
4250 * Public method implementation.
4251 * @return
4252 */
4253STDMETHODIMP VirtualSystemDescription::SetFinalValues(ComSafeArrayIn(BOOL, aEnabled),
4254 ComSafeArrayIn(IN_BSTR, argVboxValues),
4255 ComSafeArrayIn(IN_BSTR, argExtraConfigValues))
4256{
4257#ifndef RT_OS_WINDOWS
4258 NOREF(aEnabledSize);
4259#endif /* RT_OS_WINDOWS */
4260
4261 CheckComArgSafeArrayNotNull(aEnabled);
4262 CheckComArgSafeArrayNotNull(argVboxValues);
4263 CheckComArgSafeArrayNotNull(argExtraConfigValues);
4264
4265 AutoCaller autoCaller(this);
4266 CheckComRCReturnRC(autoCaller.rc());
4267
4268 AutoWriteLock alock(this);
4269
4270 com::SafeArray<BOOL> sfaEnabled(ComSafeArrayInArg(aEnabled));
4271 com::SafeArray<IN_BSTR> sfaVboxValues(ComSafeArrayInArg(argVboxValues));
4272 com::SafeArray<IN_BSTR> sfaExtraConfigValues(ComSafeArrayInArg(argExtraConfigValues));
4273
4274 if ( (sfaEnabled.size() != m->llDescriptions.size())
4275 || (sfaVboxValues.size() != m->llDescriptions.size())
4276 || (sfaExtraConfigValues.size() != m->llDescriptions.size())
4277 )
4278 return E_INVALIDARG;
4279
4280 list<VirtualSystemDescriptionEntry>::iterator it;
4281 size_t i = 0;
4282 for (it = m->llDescriptions.begin();
4283 it != m->llDescriptions.end();
4284 ++it, ++i)
4285 {
4286 VirtualSystemDescriptionEntry& vsde = *it;
4287
4288 if (sfaEnabled[i])
4289 {
4290 vsde.strVbox = sfaVboxValues[i];
4291 vsde.strExtraConfig = sfaExtraConfigValues[i];
4292 }
4293 else
4294 vsde.type = VirtualSystemDescriptionType_Ignore;
4295 }
4296
4297 return S_OK;
4298}
4299
4300/**
4301 * Public method implementation.
4302 * @return
4303 */
4304STDMETHODIMP VirtualSystemDescription::AddDescription(VirtualSystemDescriptionType_T aType,
4305 IN_BSTR aVboxValue,
4306 IN_BSTR aExtraConfigValue)
4307{
4308 CheckComArgNotNull(aVboxValue);
4309 CheckComArgNotNull(aExtraConfigValue);
4310
4311 AutoCaller autoCaller(this);
4312 CheckComRCReturnRC(autoCaller.rc());
4313
4314 AutoWriteLock alock(this);
4315
4316 addEntry(aType, "", aVboxValue, aVboxValue, 0, aExtraConfigValue);
4317
4318 return S_OK;
4319}
4320
4321/**
4322 * Internal method; adds a new description item to the member list.
4323 * @param aType Type of description for the new item.
4324 * @param strRef Reference item; only used with hard disk controllers.
4325 * @param aOrigValue Corresponding original value from OVF.
4326 * @param aAutoValue Initial configuration value (can be overridden by caller with setFinalValues).
4327 * @param strExtraConfig Extra configuration; meaning dependent on type.
4328 */
4329void VirtualSystemDescription::addEntry(VirtualSystemDescriptionType_T aType,
4330 const Utf8Str &strRef,
4331 const Utf8Str &aOrigValue,
4332 const Utf8Str &aAutoValue,
4333 uint32_t ulSizeMB,
4334 const Utf8Str &strExtraConfig /*= ""*/)
4335{
4336 VirtualSystemDescriptionEntry vsde;
4337 vsde.ulIndex = (uint32_t)m->llDescriptions.size(); // each entry gets an index so the client side can reference them
4338 vsde.type = aType;
4339 vsde.strRef = strRef;
4340 vsde.strOvf = aOrigValue;
4341 vsde.strVbox = aAutoValue;
4342 vsde.strExtraConfig = strExtraConfig;
4343 vsde.ulSizeMB = ulSizeMB;
4344
4345 m->llDescriptions.push_back(vsde);
4346}
4347
4348/**
4349 * Private method; returns a list of description items containing all the items from the member
4350 * description items of this virtual system that match the given type.
4351 * @param aType
4352 * @return
4353 */
4354std::list<VirtualSystemDescriptionEntry*> VirtualSystemDescription::findByType(VirtualSystemDescriptionType_T aType)
4355{
4356 std::list<VirtualSystemDescriptionEntry*> vsd;
4357
4358 list<VirtualSystemDescriptionEntry>::iterator it;
4359 for (it = m->llDescriptions.begin();
4360 it != m->llDescriptions.end();
4361 ++it)
4362 {
4363 if (it->type == aType)
4364 vsd.push_back(&(*it));
4365 }
4366
4367 return vsd;
4368}
4369
4370/**
4371 * Private method; looks thru the member hardware items for the IDE, SATA, or SCSI controller with
4372 * the given reference ID. Useful when needing the controller for a particular
4373 * virtual disk.
4374 * @param id
4375 * @return
4376 */
4377const VirtualSystemDescriptionEntry* VirtualSystemDescription::findControllerFromID(uint32_t id)
4378{
4379 Utf8Str strRef = Utf8StrFmt("%RI32", id);
4380 list<VirtualSystemDescriptionEntry>::const_iterator it;
4381 for (it = m->llDescriptions.begin();
4382 it != m->llDescriptions.end();
4383 ++it)
4384 {
4385 const VirtualSystemDescriptionEntry &d = *it;
4386 switch (d.type)
4387 {
4388 case VirtualSystemDescriptionType_HardDiskControllerIDE:
4389 case VirtualSystemDescriptionType_HardDiskControllerSATA:
4390 case VirtualSystemDescriptionType_HardDiskControllerSCSI:
4391 if (d.strRef == strRef)
4392 return &d;
4393 break;
4394 }
4395 }
4396
4397 return NULL;
4398}
4399
4400////////////////////////////////////////////////////////////////////////////////
4401//
4402// IMachine public methods
4403//
4404////////////////////////////////////////////////////////////////////////////////
4405
4406// This code is here so we won't have to include the appliance headers in the
4407// IMachine implementation, and we also need to access private appliance data.
4408
4409/**
4410* Public method implementation.
4411* @param appliance
4412* @return
4413*/
4414
4415STDMETHODIMP Machine::Export(IAppliance *aAppliance, IVirtualSystemDescription **aDescription)
4416{
4417 HRESULT rc = S_OK;
4418
4419 if (!aAppliance)
4420 return E_POINTER;
4421
4422 AutoCaller autoCaller(this);
4423 CheckComRCReturnRC(autoCaller.rc());
4424
4425 AutoReadLock alock(this);
4426
4427 ComObjPtr<VirtualSystemDescription> pNewDesc;
4428
4429 try
4430 {
4431 Bstr bstrName;
4432 Bstr bstrDescription;
4433 Bstr bstrGuestOSType;
4434 uint32_t cCPUs;
4435 uint32_t ulMemSizeMB;
4436 BOOL fDVDEnabled;
4437 BOOL fFloppyEnabled;
4438 BOOL fUSBEnabled;
4439 BOOL fAudioEnabled;
4440 AudioControllerType_T audioController;
4441
4442 ComPtr<IUSBController> pUsbController;
4443 ComPtr<IAudioAdapter> pAudioAdapter;
4444
4445 // get name
4446 bstrName = mUserData->mName;
4447 // get description
4448 bstrDescription = mUserData->mDescription;
4449 // get guest OS
4450 bstrGuestOSType = mUserData->mOSTypeId;
4451 // CPU count
4452 cCPUs = mHWData->mCPUCount;
4453 // memory size in MB
4454 ulMemSizeMB = mHWData->mMemorySize;
4455 // VRAM size?
4456 // BIOS settings?
4457 // 3D acceleration enabled?
4458 // hardware virtualization enabled?
4459 // nested paging enabled?
4460 // HWVirtExVPIDEnabled?
4461 // PAEEnabled?
4462 // snapshotFolder?
4463 // VRDPServer?
4464
4465 // floppy
4466 rc = mFloppyDrive->COMGETTER(Enabled)(&fFloppyEnabled);
4467 if (FAILED(rc)) throw rc;
4468
4469 // CD-ROM ?!?
4470 // ComPtr<IDVDDrive> pDVDDrive;
4471 fDVDEnabled = 1;
4472
4473 // this is more tricky so use the COM method
4474 rc = COMGETTER(USBController)(pUsbController.asOutParam());
4475 if (FAILED(rc)) throw rc;
4476 rc = pUsbController->COMGETTER(Enabled)(&fUSBEnabled);
4477
4478 pAudioAdapter = mAudioAdapter;
4479 rc = pAudioAdapter->COMGETTER(Enabled)(&fAudioEnabled);
4480 if (FAILED(rc)) throw rc;
4481 rc = pAudioAdapter->COMGETTER(AudioController)(&audioController);
4482 if (FAILED(rc)) throw rc;
4483
4484 // create a new virtual system
4485 rc = pNewDesc.createObject();
4486 CheckComRCThrowRC(rc);
4487 rc = pNewDesc->init();
4488 CheckComRCThrowRC(rc);
4489
4490 /* Guest OS type */
4491 Utf8Str strOsTypeVBox(bstrGuestOSType);
4492 CIMOSType_T cim = convertVBoxOSType2CIMOSType(strOsTypeVBox.c_str());
4493 pNewDesc->addEntry(VirtualSystemDescriptionType_OS,
4494 "",
4495 Utf8StrFmt("%RI32", cim),
4496 strOsTypeVBox);
4497
4498 /* VM name */
4499 Utf8Str strVMName(bstrName);
4500 pNewDesc->addEntry(VirtualSystemDescriptionType_Name,
4501 "",
4502 strVMName,
4503 strVMName);
4504
4505 // description
4506 Utf8Str strDescription(bstrDescription);
4507 pNewDesc->addEntry(VirtualSystemDescriptionType_Description,
4508 "",
4509 strDescription,
4510 strDescription);
4511
4512 /* CPU count*/
4513 Utf8Str strCpuCount = Utf8StrFmt("%RI32", cCPUs);
4514 pNewDesc->addEntry(VirtualSystemDescriptionType_CPU,
4515 "",
4516 strCpuCount,
4517 strCpuCount);
4518
4519 /* Memory */
4520 Utf8Str strMemory = Utf8StrFmt("%RI32", (uint64_t)ulMemSizeMB * _1M);
4521 pNewDesc->addEntry(VirtualSystemDescriptionType_Memory,
4522 "",
4523 strMemory,
4524 strMemory);
4525
4526 int32_t lIDEControllerIndex = 0;
4527 int32_t lSATAControllerIndex = 0;
4528 int32_t lSCSIControllerIndex = 0;
4529
4530// <const name="HardDiskControllerIDE" value="6" />
4531 ComPtr<IStorageController> pController;
4532 rc = GetStorageControllerByName(Bstr("IDE"), pController.asOutParam());
4533 if (FAILED(rc)) throw rc;
4534 Utf8Str strVbox;
4535 StorageControllerType_T ctlr;
4536 rc = pController->COMGETTER(ControllerType)(&ctlr);
4537 if (FAILED(rc)) throw rc;
4538 switch(ctlr)
4539 {
4540 case StorageControllerType_PIIX3: strVbox = "PIIX3"; break;
4541 case StorageControllerType_PIIX4: strVbox = "PIIX4"; break;
4542 case StorageControllerType_ICH6: strVbox = "ICH6"; break;
4543 }
4544
4545 if (strVbox.length())
4546 {
4547 lIDEControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
4548 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
4549 Utf8StrFmt("%d", lIDEControllerIndex),
4550 strVbox,
4551 strVbox);
4552 }
4553
4554#ifdef VBOX_WITH_AHCI
4555// <const name="HardDiskControllerSATA" value="7" />
4556 rc = GetStorageControllerByName(Bstr("SATA"), pController.asOutParam());
4557 if (SUCCEEDED(rc))
4558 {
4559 strVbox = "AHCI";
4560 lSATAControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
4561 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,
4562 Utf8StrFmt("%d", lSATAControllerIndex),
4563 strVbox,
4564 strVbox);
4565 }
4566#endif // VBOX_WITH_AHCI
4567
4568// <const name="HardDiskControllerSCSI" value="8" />
4569 rc = GetStorageControllerByName(Bstr("SCSI"), pController.asOutParam());
4570 if (SUCCEEDED(rc))
4571 {
4572 rc = pController->COMGETTER(ControllerType)(&ctlr);
4573 if (SUCCEEDED(rc))
4574 {
4575 strVbox = "LsiLogic"; // the default in VBox
4576 switch(ctlr)
4577 {
4578 case StorageControllerType_LsiLogic: strVbox = "LsiLogic"; break;
4579 case StorageControllerType_BusLogic: strVbox = "BusLogic"; break;
4580 }
4581 lSCSIControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
4582 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,
4583 Utf8StrFmt("%d", lSCSIControllerIndex),
4584 strVbox,
4585 strVbox);
4586 }
4587 else
4588 throw rc;
4589 }
4590
4591// <const name="HardDiskImage" value="9" />
4592 HDData::AttachmentList::iterator itA;
4593 for (itA = mHDData->mAttachments.begin();
4594 itA != mHDData->mAttachments.end();
4595 ++itA)
4596 {
4597 ComObjPtr<HardDiskAttachment> pHDA = *itA;
4598
4599 // the attachment's data
4600 ComPtr<IHardDisk> pHardDisk;
4601 ComPtr<IStorageController> ctl;
4602 Bstr controllerName;
4603
4604 rc = pHDA->COMGETTER(Controller)(controllerName.asOutParam());
4605 if (FAILED(rc)) throw rc;
4606
4607 rc = GetStorageControllerByName(controllerName, ctl.asOutParam());
4608 if (FAILED(rc)) throw rc;
4609
4610 StorageBus_T storageBus;
4611 LONG lChannel;
4612 LONG lDevice;
4613
4614 rc = ctl->COMGETTER(Bus)(&storageBus);
4615 if (FAILED(rc)) throw rc;
4616
4617 rc = pHDA->COMGETTER(HardDisk)(pHardDisk.asOutParam());
4618 if (FAILED(rc)) throw rc;
4619
4620 rc = pHDA->COMGETTER(Port)(&lChannel);
4621 if (FAILED(rc)) throw rc;
4622
4623 rc = pHDA->COMGETTER(Device)(&lDevice);
4624 if (FAILED(rc)) throw rc;
4625
4626 Bstr bstrLocation;
4627 rc = pHardDisk->COMGETTER(Location)(bstrLocation.asOutParam());
4628 if (FAILED(rc)) throw rc;
4629 Bstr bstrName;
4630 rc = pHardDisk->COMGETTER(Name)(bstrName.asOutParam());
4631 if (FAILED(rc)) throw rc;
4632
4633 // force reading state, or else size will be returned as 0
4634 MediaState_T ms;
4635 rc = pHardDisk->COMGETTER(State)(&ms);
4636 if (FAILED(rc)) throw rc;
4637
4638 ULONG64 ullSize;
4639 rc = pHardDisk->COMGETTER(Size)(&ullSize);
4640 if (FAILED(rc)) throw rc;
4641
4642 // and how this translates to the virtual system
4643 int32_t lControllerVsys = 0;
4644 LONG lChannelVsys;
4645
4646 switch (storageBus)
4647 {
4648 case StorageBus_IDE:
4649 // this is the exact reverse to what we're doing in Appliance::taskThreadImportMachines,
4650 // and it must be updated when that is changed!
4651
4652 if (lChannel == 0 && lDevice == 0) // primary master
4653 lChannelVsys = 0;
4654 else if (lChannel == 0 && lDevice == 1) // primary slave
4655 lChannelVsys = 1;
4656 else if (lChannel == 1 && lDevice == 1) // secondary slave; secondary master is always CDROM
4657 lChannelVsys = 2;
4658 else
4659 throw setError(VBOX_E_NOT_SUPPORTED,
4660 tr("Cannot handle hard disk attachment: channel is %d, device is %d"), lChannel, lDevice);
4661
4662 lControllerVsys = lIDEControllerIndex;
4663 break;
4664
4665 case StorageBus_SATA:
4666 lChannelVsys = lChannel; // should be between 0 and 29
4667 lControllerVsys = lSATAControllerIndex;
4668 break;
4669
4670 case StorageBus_SCSI:
4671 lChannelVsys = lChannel; // should be between 0 and 15
4672 lControllerVsys = lSCSIControllerIndex;
4673 break;
4674
4675 default:
4676 throw setError(VBOX_E_NOT_SUPPORTED,
4677 tr("Cannot handle hard disk attachment: storageBus is %d, channel is %d, device is %d"), storageBus, lChannel, lDevice);
4678 break;
4679 }
4680
4681 Utf8Str strTargetVmdkName(bstrName);
4682 RTPathStripExt(strTargetVmdkName.mutableRaw());
4683 strTargetVmdkName.append(".vmdk");
4684
4685 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskImage,
4686 strTargetVmdkName, // disk ID: let's use the name
4687 strTargetVmdkName, // OVF value:
4688 Utf8Str(bstrLocation), // vbox value: media path
4689 (uint32_t)(ullSize / _1M),
4690 Utf8StrFmt("controller=%RI32;channel=%RI32", lControllerVsys, lChannelVsys));
4691 }
4692
4693 /* Floppy Drive */
4694 if (fFloppyEnabled)
4695 pNewDesc->addEntry(VirtualSystemDescriptionType_Floppy, "", "", "");
4696
4697 /* CD Drive */
4698 if (fDVDEnabled)
4699 pNewDesc->addEntry(VirtualSystemDescriptionType_CDROM, "", "", "");
4700
4701// <const name="NetworkAdapter" />
4702 size_t a;
4703 for (a = 0;
4704 a < SchemaDefs::NetworkAdapterCount;
4705 ++a)
4706 {
4707 ComPtr<INetworkAdapter> pNetworkAdapter;
4708 BOOL fEnabled;
4709 NetworkAdapterType_T adapterType;
4710 NetworkAttachmentType_T attachmentType;
4711
4712 rc = GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
4713 if (FAILED(rc)) throw rc;
4714 /* Enable the network card & set the adapter type */
4715 rc = pNetworkAdapter->COMGETTER(Enabled)(&fEnabled);
4716 if (FAILED(rc)) throw rc;
4717
4718 if (fEnabled)
4719 {
4720 Utf8Str strAttachmentType;
4721
4722 rc = pNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
4723 if (FAILED(rc)) throw rc;
4724
4725 rc = pNetworkAdapter->COMGETTER(AttachmentType)(&attachmentType);
4726 if (FAILED(rc)) throw rc;
4727
4728 switch (attachmentType)
4729 {
4730 case NetworkAttachmentType_Null:
4731 strAttachmentType = "Null";
4732 break;
4733
4734 case NetworkAttachmentType_NAT:
4735 strAttachmentType = "NAT";
4736 break;
4737
4738 case NetworkAttachmentType_Bridged:
4739 strAttachmentType = "Bridged";
4740 break;
4741
4742 case NetworkAttachmentType_Internal:
4743 strAttachmentType = "Internal";
4744 break;
4745
4746 case NetworkAttachmentType_HostOnly:
4747 strAttachmentType = "HostOnly";
4748 break;
4749 }
4750
4751 pNewDesc->addEntry(VirtualSystemDescriptionType_NetworkAdapter,
4752 "", // ref
4753 strAttachmentType, // orig
4754 Utf8StrFmt("%RI32", (uint32_t)adapterType), // conf
4755 Utf8StrFmt("type=%s", strAttachmentType.c_str())); // extra conf
4756 }
4757 }
4758
4759// <const name="USBController" />
4760#ifdef VBOX_WITH_USB
4761 if (fUSBEnabled)
4762 pNewDesc->addEntry(VirtualSystemDescriptionType_USBController, "", "", "");
4763#endif /* VBOX_WITH_USB */
4764
4765// <const name="SoundCard" />
4766 if (fAudioEnabled)
4767 {
4768 pNewDesc->addEntry(VirtualSystemDescriptionType_SoundCard,
4769 "",
4770 "ensoniq1371", // this is what OVFTool writes and VMware supports
4771 Utf8StrFmt("%RI32", audioController));
4772 }
4773
4774 // finally, add the virtual system to the appliance
4775 Appliance *pAppliance = static_cast<Appliance*>(aAppliance);
4776 AutoCaller autoCaller1(pAppliance);
4777 CheckComRCReturnRC(autoCaller1.rc());
4778
4779 /* We return the new description to the caller */
4780 ComPtr<IVirtualSystemDescription> copy(pNewDesc);
4781 copy.queryInterfaceTo(aDescription);
4782
4783 AutoWriteLock alock(pAppliance);
4784
4785 pAppliance->m->virtualSystemDescriptions.push_back(pNewDesc);
4786 }
4787 catch(HRESULT arc)
4788 {
4789 rc = arc;
4790 }
4791
4792 return rc;
4793}
4794
4795/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette