VirtualBox

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

Last change on this file since 20842 was 20842, checked in by vboxsync, 15 years ago

API and Frontends: change IVirtualBox::openHardDisk to allow modifying the image UUID and parent UUID on open
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 209.1 KB
Line 
1/* $Id: ApplianceImpl.cpp 20842 2009-06-23 14:48:10Z 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 > 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, SchemaDefs::MaxCPUCount);
1450 cpuCountVBox = 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; NOREF(cSATAused);
1589 uint16_t cSCSIused = 0; NOREF(cSCSIused);
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 case HardDiskController::SATA:
1633 {
1634#ifdef VBOX_WITH_AHCI
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#else /* !VBOX_WITH_AHCI */
1656 addWarning(tr("The virtual system \"%s\" requests at least one SATA controller but this version of VirtualBox does not provide a SATA controller emulation"),
1657 vsysThis.strName.c_str());
1658#endif /* !VBOX_WITH_AHCI */
1659 }
1660
1661 case HardDiskController::SCSI:
1662 {
1663#ifdef VBOX_WITH_LSILOGIC
1664 /* Check for the constrains */
1665 if (cSCSIused < 1)
1666 {
1667 Utf8Str hdcController = "LsiLogic";
1668 if (!hdc.strControllerType.compare("BusLogic", Utf8Str::CaseInsensitive))
1669 hdcController = "BusLogic";
1670 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,
1671 strControllerID,
1672 hdc.strControllerType,
1673 hdcController);
1674 }
1675 else
1676 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."),
1677 vsysThis.strName.c_str(),
1678 hdc.strControllerType.c_str(),
1679 strControllerID.c_str());
1680 ++cSCSIused;
1681 break;
1682#else /* !VBOX_WITH_LSILOGIC */
1683 addWarning(tr("The virtual system \"%s\" requests at least one SATA controller but this version of VirtualBox does not provide a SCSI controller emulation"),
1684 vsysThis.strName.c_str());
1685#endif /* !VBOX_WITH_LSILOGIC */
1686 }
1687 }
1688 }
1689
1690 /* Hard disks */
1691 if (vsysThis.mapVirtualDisks.size() > 0)
1692 {
1693 VirtualDisksMap::const_iterator itVD;
1694 /* Iterate through all hard disks ()*/
1695 for (itVD = vsysThis.mapVirtualDisks.begin();
1696 itVD != vsysThis.mapVirtualDisks.end();
1697 ++itVD)
1698 {
1699 const VirtualDisk &hd = itVD->second;
1700 /* Get the associated disk image */
1701 const DiskImage &di = m->mapDisks[hd.strDiskId];
1702
1703 // @todo:
1704 // - figure out all possible vmdk formats we also support
1705 // - figure out if there is a url specifier for vhd already
1706 // - we need a url specifier for the vdi format
1707 if ( di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#sparse", Utf8Str::CaseInsensitive)
1708 || di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive))
1709 {
1710 /* If the href is empty use the VM name as filename */
1711 Utf8Str strFilename = di.strHref;
1712 if (!strFilename.length())
1713 strFilename = Utf8StrFmt("%s.vmdk", nameVBox.c_str());
1714 /* Construct a unique target path */
1715 Utf8StrFmt strPath("%ls%c%s",
1716 bstrDefaultHardDiskLocation.raw(),
1717 RTPATH_DELIMITER,
1718 strFilename.c_str());
1719 searchUniqueDiskImageFilePath(strPath);
1720
1721 /* find the description for the hard disk controller
1722 * that has the same ID as hd.idController */
1723 const VirtualSystemDescriptionEntry *pController;
1724 if (!(pController = pNewDesc->findControllerFromID(hd.idController)))
1725 throw setError(E_FAIL,
1726 tr("Cannot find hard disk controller with OVF instance ID %RI32 to which disk \"%s\" should be attached"),
1727 hd.idController,
1728 di.strHref.c_str());
1729
1730 /* controller to attach to, and the bus within that controller */
1731 Utf8StrFmt strExtraConfig("controller=%RI16;channel=%RI16",
1732 pController->ulIndex,
1733 hd.ulAddressOnParent);
1734 ULONG ulSize = 0;
1735 if (di.iCapacity != -1)
1736 ulSize = (ULONG)(di.iCapacity / _1M);
1737 else if (di.iPopulatedSize != -1)
1738 ulSize = (ULONG)(di.iPopulatedSize / _1M);
1739 else if (di.iSize != -1)
1740 ulSize = (ULONG)(di.iSize / _1M);
1741 if (ulSize == 0)
1742 ulSize = 10000; // assume 10 GB, this is for the progress bar only anyway
1743 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskImage,
1744 hd.strDiskId,
1745 di.strHref,
1746 strPath,
1747 ulSize,
1748 strExtraConfig);
1749 }
1750 else
1751 throw setError(VBOX_E_FILE_ERROR,
1752 tr("Unsupported format for virtual disk image in OVF: \"%s\"", di.strFormat.c_str()));
1753 }
1754 }
1755
1756 m->virtualSystemDescriptions.push_back(pNewDesc);
1757 }
1758 }
1759 catch (HRESULT aRC)
1760 {
1761 /* On error we clear the list & return */
1762 m->virtualSystemDescriptions.clear();
1763 rc = aRC;
1764 }
1765
1766 return rc;
1767}
1768
1769struct Appliance::TaskImportMachines
1770{
1771 TaskImportMachines(Appliance *aThat, Progress *aProgress)
1772 : pAppliance(aThat)
1773 , progress(aProgress)
1774 , rc(S_OK)
1775 {}
1776 ~TaskImportMachines() {}
1777
1778 HRESULT startThread();
1779
1780 Appliance *pAppliance;
1781 ComObjPtr<Progress> progress;
1782 HRESULT rc;
1783};
1784
1785HRESULT Appliance::TaskImportMachines::startThread()
1786{
1787 int vrc = RTThreadCreate(NULL, Appliance::taskThreadImportMachines, this,
1788 0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
1789 "Appliance::Task");
1790 ComAssertMsgRCRet(vrc,
1791 ("Could not create taskThreadImportMachines (%Rrc)\n", vrc), E_FAIL);
1792
1793 return S_OK;
1794}
1795
1796/**
1797 * Public method implementation.
1798 * @param aProgress
1799 * @return
1800 */
1801STDMETHODIMP Appliance::ImportMachines(IProgress **aProgress)
1802{
1803 CheckComArgOutPointerValid(aProgress);
1804
1805 AutoCaller autoCaller(this);
1806 CheckComRCReturnRC(autoCaller.rc());
1807
1808 AutoReadLock(this);
1809
1810 HRESULT rc = S_OK;
1811
1812 ComObjPtr<Progress> progress;
1813 try
1814 {
1815 Bstr progressDesc = BstrFmt(tr("Import appliance '%s'"),
1816 m->strPath.raw());
1817 rc = setUpProgress(progress, progressDesc);
1818 if (FAILED(rc)) throw rc;
1819
1820 /* Initialize our worker task */
1821 std::auto_ptr<TaskImportMachines> task(new TaskImportMachines(this, progress));
1822 //AssertComRCThrowRC (task->autoCaller.rc());
1823
1824 rc = task->startThread();
1825 if (FAILED(rc)) throw rc;
1826
1827 task.release();
1828 }
1829 catch (HRESULT aRC)
1830 {
1831 rc = aRC;
1832 }
1833
1834 if (SUCCEEDED(rc))
1835 /* Return progress to the caller */
1836 progress.queryInterfaceTo(aProgress);
1837
1838 return rc;
1839}
1840
1841struct MyHardDiskAttachment
1842{
1843 Guid uuid;
1844 ComPtr<IMachine> pMachine;
1845 Bstr controllerType;
1846 int32_t lChannel;
1847 int32_t lDevice;
1848};
1849
1850/**
1851 * Worker thread implementation for ImportMachines().
1852 * @param aThread
1853 * @param pvUser
1854 */
1855/* static */
1856DECLCALLBACK(int) Appliance::taskThreadImportMachines(RTTHREAD /* aThread */, void *pvUser)
1857{
1858 std::auto_ptr<TaskImportMachines> task(static_cast<TaskImportMachines*>(pvUser));
1859 AssertReturn(task.get(), VERR_GENERAL_FAILURE);
1860
1861 Appliance *pAppliance = task->pAppliance;
1862
1863 LogFlowFuncEnter();
1864 LogFlowFunc(("Appliance %p\n", pAppliance));
1865
1866 AutoCaller autoCaller(pAppliance);
1867 CheckComRCReturnRC(autoCaller.rc());
1868
1869 AutoWriteLock appLock(pAppliance);
1870
1871 HRESULT rc = S_OK;
1872
1873 ComPtr<IVirtualBox> pVirtualBox(pAppliance->mVirtualBox);
1874
1875 // rollback for errors:
1876 // a list of images that we created/imported
1877 list<MyHardDiskAttachment> llHardDiskAttachments;
1878 list< ComPtr<IHardDisk> > llHardDisksCreated;
1879 list<Guid> llMachinesRegistered;
1880
1881 ComPtr<ISession> session;
1882 bool fSessionOpen = false;
1883 rc = session.createInprocObject(CLSID_Session);
1884 CheckComRCReturnRC(rc);
1885
1886 list<VirtualSystem>::const_iterator it;
1887 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it1;
1888 /* Iterate through all virtual systems of that appliance */
1889 size_t i = 0;
1890 for (it = pAppliance->m->llVirtualSystems.begin(),
1891 it1 = pAppliance->m->virtualSystemDescriptions.begin();
1892 it != pAppliance->m->llVirtualSystems.end();
1893 ++it, ++it1, ++i)
1894 {
1895 const VirtualSystem &vsysThis = *it;
1896 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it1);
1897
1898 ComPtr<IMachine> pNewMachine;
1899
1900 /* Catch possible errors */
1901 try
1902 {
1903 /* Guest OS type */
1904 std::list<VirtualSystemDescriptionEntry*> vsdeOS;
1905 vsdeOS = vsdescThis->findByType(VirtualSystemDescriptionType_OS);
1906 if (vsdeOS.size() < 1)
1907 throw setError(VBOX_E_FILE_ERROR,
1908 tr("Missing guest OS type"));
1909 const Utf8Str &strOsTypeVBox = vsdeOS.front()->strVbox;
1910
1911 /* Now that we know the base system get our internal defaults based on that. */
1912 ComPtr<IGuestOSType> osType;
1913 rc = pVirtualBox->GetGuestOSType(Bstr(strOsTypeVBox), osType.asOutParam());
1914 if (FAILED(rc)) throw rc;
1915
1916 /* Create the machine */
1917 /* First get the name */
1918 std::list<VirtualSystemDescriptionEntry*> vsdeName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);
1919 if (vsdeName.size() < 1)
1920 throw setError(VBOX_E_FILE_ERROR,
1921 tr("Missing VM name"));
1922 const Utf8Str &strNameVBox = vsdeName.front()->strVbox;
1923 rc = pVirtualBox->CreateMachine(Bstr(strNameVBox), Bstr(strOsTypeVBox),
1924 Bstr(), Bstr(),
1925 pNewMachine.asOutParam());
1926 if (FAILED(rc)) throw rc;
1927
1928 // and the description
1929 std::list<VirtualSystemDescriptionEntry*> vsdeDescription = vsdescThis->findByType(VirtualSystemDescriptionType_Description);
1930 if (vsdeDescription.size())
1931 {
1932 const Utf8Str &strDescription = vsdeDescription.front()->strVbox;
1933 rc = pNewMachine->COMSETTER(Description)(Bstr(strDescription));
1934 if (FAILED(rc)) throw rc;
1935 }
1936
1937 /* CPU count */
1938 std::list<VirtualSystemDescriptionEntry*> vsdeCPU = vsdescThis->findByType (VirtualSystemDescriptionType_CPU);
1939 ComAssertMsgThrow(vsdeCPU.size() == 1, ("CPU count missing"), E_FAIL);
1940 const Utf8Str &cpuVBox = vsdeCPU.front()->strVbox;
1941 ULONG tmpCount = (ULONG)RTStrToUInt64(cpuVBox.c_str());
1942 rc = pNewMachine->COMSETTER(CPUCount)(tmpCount);
1943 if (FAILED(rc)) throw rc;
1944 bool fEnableIOApic = false;
1945 /* We need HWVirt & IO-APIC if more than one CPU is requested */
1946 if (tmpCount > 1)
1947 {
1948 rc = pNewMachine->COMSETTER(HWVirtExEnabled)(TSBool_True);
1949 if (FAILED(rc)) throw rc;
1950
1951 fEnableIOApic = true;
1952 }
1953
1954 /* RAM */
1955 std::list<VirtualSystemDescriptionEntry*> vsdeRAM = vsdescThis->findByType(VirtualSystemDescriptionType_Memory);
1956 ComAssertMsgThrow(vsdeRAM.size() == 1, ("RAM size missing"), E_FAIL);
1957 const Utf8Str &memoryVBox = vsdeRAM.front()->strVbox;
1958 ULONG tt = (ULONG)RTStrToUInt64(memoryVBox.c_str());
1959 rc = pNewMachine->COMSETTER(MemorySize)(tt);
1960 if (FAILED(rc)) throw rc;
1961
1962 /* VRAM */
1963 /* Get the recommended VRAM for this guest OS type */
1964 ULONG vramVBox;
1965 rc = osType->COMGETTER(RecommendedVRAM)(&vramVBox);
1966 if (FAILED(rc)) throw rc;
1967
1968 /* Set the VRAM */
1969 rc = pNewMachine->COMSETTER(VRAMSize)(vramVBox);
1970 if (FAILED(rc)) throw rc;
1971
1972 /* I/O APIC: so far we have no setting for this. Enable it if we
1973 import a Windows VM because if if Windows was installed without IOAPIC,
1974 it will not mind finding an one later on, but if Windows was installed
1975 _with_ an IOAPIC, it will bluescreen if it's not found */
1976 Bstr bstrFamilyId;
1977 rc = osType->COMGETTER(FamilyId)(bstrFamilyId.asOutParam());
1978 if (FAILED(rc)) throw rc;
1979
1980 Utf8Str strFamilyId(bstrFamilyId);
1981 if (strFamilyId == "Windows")
1982 fEnableIOApic = true;
1983
1984 /* If IP-APIC should be enabled could be have different reasons.
1985 See CPU count & the Win test above. Here we enable it if it was
1986 previously requested. */
1987 if (fEnableIOApic)
1988 {
1989 ComPtr<IBIOSSettings> pBIOSSettings;
1990 rc = pNewMachine->COMGETTER(BIOSSettings)(pBIOSSettings.asOutParam());
1991 if (FAILED(rc)) throw rc;
1992
1993 rc = pBIOSSettings->COMSETTER(IOAPICEnabled)(TRUE);
1994 if (FAILED(rc)) throw rc;
1995 }
1996
1997 /* Audio Adapter */
1998 std::list<VirtualSystemDescriptionEntry*> vsdeAudioAdapter = vsdescThis->findByType(VirtualSystemDescriptionType_SoundCard);
1999 /* @todo: we support one audio adapter only */
2000 if (vsdeAudioAdapter.size() > 0)
2001 {
2002 const Utf8Str& audioAdapterVBox = vsdeAudioAdapter.front()->strVbox;
2003 if (audioAdapterVBox.compare("null", Utf8Str::CaseInsensitive) != 0)
2004 {
2005 uint32_t audio = RTStrToUInt32(audioAdapterVBox.c_str());
2006 ComPtr<IAudioAdapter> audioAdapter;
2007 rc = pNewMachine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam());
2008 if (FAILED(rc)) throw rc;
2009 rc = audioAdapter->COMSETTER(Enabled)(true);
2010 if (FAILED(rc)) throw rc;
2011 rc = audioAdapter->COMSETTER(AudioController)(static_cast<AudioControllerType_T>(audio));
2012 if (FAILED(rc)) throw rc;
2013 }
2014 }
2015
2016#ifdef VBOX_WITH_USB
2017 /* USB Controller */
2018 std::list<VirtualSystemDescriptionEntry*> vsdeUSBController = vsdescThis->findByType(VirtualSystemDescriptionType_USBController);
2019 // USB support is enabled if there's at least one such entry; to disable USB support,
2020 // the type of the USB item would have been changed to "ignore"
2021 bool fUSBEnabled = vsdeUSBController.size() > 0;
2022
2023 ComPtr<IUSBController> usbController;
2024 rc = pNewMachine->COMGETTER(USBController)(usbController.asOutParam());
2025 if (FAILED(rc)) throw rc;
2026 rc = usbController->COMSETTER(Enabled)(fUSBEnabled);
2027 if (FAILED(rc)) throw rc;
2028#endif /* VBOX_WITH_USB */
2029
2030 /* Change the network adapters */
2031 std::list<VirtualSystemDescriptionEntry*> vsdeNW = vsdescThis->findByType(VirtualSystemDescriptionType_NetworkAdapter);
2032 if (vsdeNW.size() == 0)
2033 {
2034 /* No network adapters, so we have to disable our default one */
2035 ComPtr<INetworkAdapter> nwVBox;
2036 rc = pNewMachine->GetNetworkAdapter(0, nwVBox.asOutParam());
2037 if (FAILED(rc)) throw rc;
2038 rc = nwVBox->COMSETTER(Enabled)(false);
2039 if (FAILED(rc)) throw rc;
2040 }
2041 else
2042 {
2043 list<VirtualSystemDescriptionEntry*>::const_iterator nwIt;
2044 /* Iterate through all network cards. We support 8 network adapters
2045 * at the maximum. (@todo: warn if there are more!) */
2046 size_t a = 0;
2047 for (nwIt = vsdeNW.begin();
2048 (nwIt != vsdeNW.end() && a < SchemaDefs::NetworkAdapterCount);
2049 ++nwIt, ++a)
2050 {
2051 const VirtualSystemDescriptionEntry* pvsys = *nwIt;
2052
2053 const Utf8Str &nwTypeVBox = pvsys->strVbox;
2054 uint32_t tt1 = RTStrToUInt32(nwTypeVBox.c_str());
2055 ComPtr<INetworkAdapter> pNetworkAdapter;
2056 rc = pNewMachine->GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
2057 if (FAILED(rc)) throw rc;
2058 /* Enable the network card & set the adapter type */
2059 rc = pNetworkAdapter->COMSETTER(Enabled)(true);
2060 if (FAILED(rc)) throw rc;
2061 rc = pNetworkAdapter->COMSETTER(AdapterType)(static_cast<NetworkAdapterType_T>(tt1));
2062 if (FAILED(rc)) throw rc;
2063
2064 // default is NAT; change to "bridged" if extra conf says so
2065 if (!pvsys->strExtraConfig.compare("type=Bridged", Utf8Str::CaseInsensitive))
2066 {
2067 /* Attach to the right interface */
2068 rc = pNetworkAdapter->AttachToBridgedInterface();
2069 if (FAILED(rc)) throw rc;
2070 ComPtr<IHost> host;
2071 rc = pVirtualBox->COMGETTER(Host)(host.asOutParam());
2072 if (FAILED(rc)) throw rc;
2073 com::SafeIfaceArray<IHostNetworkInterface> nwInterfaces;
2074 rc = host->COMGETTER(NetworkInterfaces)(ComSafeArrayAsOutParam(nwInterfaces));
2075 if (FAILED(rc)) throw rc;
2076 /* We search for the first host network interface which
2077 * is usable for bridged networking */
2078 for (size_t i=0; i < nwInterfaces.size(); ++i)
2079 {
2080 HostNetworkInterfaceType_T itype;
2081 rc = nwInterfaces[i]->COMGETTER(InterfaceType)(&itype);
2082 if (FAILED(rc)) throw rc;
2083 if (itype == HostNetworkInterfaceType_Bridged)
2084 {
2085 Bstr name;
2086 rc = nwInterfaces[i]->COMGETTER(Name)(name.asOutParam());
2087 if (FAILED(rc)) throw rc;
2088 /* Set the interface name to attach to */
2089 pNetworkAdapter->COMSETTER(HostInterface)(name);
2090 if (FAILED(rc)) throw rc;
2091 break;
2092 }
2093 }
2094 }
2095 /* Next test for host only interfaces */
2096 else if (!pvsys->strExtraConfig.compare("type=HostOnly", Utf8Str::CaseInsensitive))
2097 {
2098 /* Attach to the right interface */
2099 rc = pNetworkAdapter->AttachToHostOnlyInterface();
2100 if (FAILED(rc)) throw rc;
2101 ComPtr<IHost> host;
2102 rc = pVirtualBox->COMGETTER(Host)(host.asOutParam());
2103 if (FAILED(rc)) throw rc;
2104 com::SafeIfaceArray<IHostNetworkInterface> nwInterfaces;
2105 rc = host->COMGETTER(NetworkInterfaces)(ComSafeArrayAsOutParam(nwInterfaces));
2106 if (FAILED(rc)) throw rc;
2107 /* We search for the first host network interface which
2108 * is usable for host only networking */
2109 for (size_t i=0; i < nwInterfaces.size(); ++i)
2110 {
2111 HostNetworkInterfaceType_T itype;
2112 rc = nwInterfaces[i]->COMGETTER(InterfaceType)(&itype);
2113 if (FAILED(rc)) throw rc;
2114 if (itype == HostNetworkInterfaceType_HostOnly)
2115 {
2116 Bstr name;
2117 rc = nwInterfaces[i]->COMGETTER(Name)(name.asOutParam());
2118 if (FAILED(rc)) throw rc;
2119 /* Set the interface name to attach to */
2120 pNetworkAdapter->COMSETTER(HostInterface)(name);
2121 if (FAILED(rc)) throw rc;
2122 break;
2123 }
2124 }
2125 }
2126 }
2127 }
2128
2129 /* Floppy drive */
2130 std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsdescThis->findByType(VirtualSystemDescriptionType_Floppy);
2131 // Floppy support is enabled if there's at least one such entry; to disable floppy support,
2132 // the type of the floppy item would have been changed to "ignore"
2133 bool fFloppyEnabled = vsdeFloppy.size() > 0;
2134 ComPtr<IFloppyDrive> floppyDrive;
2135 rc = pNewMachine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam());
2136 if (FAILED(rc)) throw rc;
2137 rc = floppyDrive->COMSETTER(Enabled)(fFloppyEnabled);
2138 if (FAILED(rc)) throw rc;
2139
2140 /* CDROM drive */
2141 /* @todo: I can't disable the CDROM. So nothing to do for now */
2142 // std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsd->findByType(VirtualSystemDescriptionType_CDROM);
2143
2144 /* Hard disk controller IDE */
2145 std::list<VirtualSystemDescriptionEntry*> vsdeHDCIDE = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerIDE);
2146 if (vsdeHDCIDE.size() > 1)
2147 throw setError(VBOX_E_FILE_ERROR,
2148 tr("Too many IDE controllers in OVF; VirtualBox only supports one"));
2149 if (vsdeHDCIDE.size() == 1)
2150 {
2151 ComPtr<IStorageController> pController;
2152 rc = pNewMachine->GetStorageControllerByName(Bstr("IDE"), pController.asOutParam());
2153 if (FAILED(rc)) throw rc;
2154
2155 const char *pcszIDEType = vsdeHDCIDE.front()->strVbox.c_str();
2156 if (!strcmp(pcszIDEType, "PIIX3"))
2157 rc = pController->COMSETTER(ControllerType)(StorageControllerType_PIIX3);
2158 else if (!strcmp(pcszIDEType, "PIIX4"))
2159 rc = pController->COMSETTER(ControllerType)(StorageControllerType_PIIX4);
2160 else if (!strcmp(pcszIDEType, "ICH6"))
2161 rc = pController->COMSETTER(ControllerType)(StorageControllerType_ICH6);
2162 else
2163 throw setError(VBOX_E_FILE_ERROR,
2164 tr("Invalid IDE controller type \"%s\""),
2165 pcszIDEType);
2166 if (FAILED(rc)) throw rc;
2167 }
2168#ifdef VBOX_WITH_AHCI
2169 /* Hard disk controller SATA */
2170 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSATA = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSATA);
2171 if (vsdeHDCSATA.size() > 1)
2172 throw setError(VBOX_E_FILE_ERROR,
2173 tr("Too many SATA controllers in OVF; VirtualBox only supports one"));
2174 if (vsdeHDCSATA.size() > 0)
2175 {
2176 ComPtr<IStorageController> pController;
2177 const Utf8Str &hdcVBox = vsdeHDCSATA.front()->strVbox;
2178 if (hdcVBox == "AHCI")
2179 {
2180 rc = pNewMachine->AddStorageController(Bstr("SATA"), StorageBus_SATA, pController.asOutParam());
2181 if (FAILED(rc)) throw rc;
2182 }
2183 else
2184 throw setError(VBOX_E_FILE_ERROR,
2185 tr("Invalid SATA controller type \"%s\""),
2186 hdcVBox.c_str());
2187 }
2188#endif /* VBOX_WITH_AHCI */
2189
2190#ifdef VBOX_WITH_LSILOGIC
2191 /* Hard disk controller SCSI */
2192 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSCSI = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSCSI);
2193 if (vsdeHDCSCSI.size() > 1)
2194 throw setError(VBOX_E_FILE_ERROR,
2195 tr("Too many SCSI controllers in OVF; VirtualBox only supports one"));
2196 if (vsdeHDCSCSI.size() > 0)
2197 {
2198 ComPtr<IStorageController> pController;
2199 StorageControllerType_T controllerType;
2200 const Utf8Str &hdcVBox = vsdeHDCSCSI.front()->strVbox;
2201 if (hdcVBox == "LsiLogic")
2202 controllerType = StorageControllerType_LsiLogic;
2203 else if (hdcVBox == "BusLogic")
2204 controllerType = StorageControllerType_BusLogic;
2205 else
2206 throw setError(VBOX_E_FILE_ERROR,
2207 tr("Invalid SCSI controller type \"%s\""),
2208 hdcVBox.c_str());
2209
2210 rc = pNewMachine->AddStorageController(Bstr("SCSI"), StorageBus_SCSI, pController.asOutParam());
2211 if (FAILED(rc)) throw rc;
2212 rc = pController->COMSETTER(ControllerType)(controllerType);
2213 if (FAILED(rc)) throw rc;
2214 }
2215#endif /* VBOX_WITH_LSILOGIC */
2216
2217 /* Now its time to register the machine before we add any hard disks */
2218 rc = pVirtualBox->RegisterMachine(pNewMachine);
2219 if (FAILED(rc)) throw rc;
2220
2221 Bstr newMachineId_;
2222 rc = pNewMachine->COMGETTER(Id)(newMachineId_.asOutParam());
2223 if (FAILED(rc)) throw rc;
2224 Guid newMachineId(newMachineId_);
2225
2226 // store new machine for roll-back in case of errors
2227 llMachinesRegistered.push_back(newMachineId);
2228
2229 /* Create the hard disks & connect them to the appropriate controllers. */
2230 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
2231 if (avsdeHDs.size() > 0)
2232 {
2233 /* If in the next block an error occur we have to deregister
2234 the machine, so make an extra try/catch block. */
2235 ComPtr<IHardDisk> srcHdVBox;
2236 bool fSourceHdNeedsClosing = false;
2237
2238 try
2239 {
2240 /* In order to attach hard disks we need to open a session
2241 * for the new machine */
2242 rc = pVirtualBox->OpenSession(session, newMachineId_);
2243 if (FAILED(rc)) throw rc;
2244 fSessionOpen = true;
2245
2246 /* The disk image has to be on the same place as the OVF file. So
2247 * strip the filename out of the full file path. */
2248 Utf8Str strSrcDir = stripFilename(pAppliance->m->strPath);
2249
2250 /* Iterate over all given disk images */
2251 list<VirtualSystemDescriptionEntry*>::const_iterator itHD;
2252 for (itHD = avsdeHDs.begin();
2253 itHD != avsdeHDs.end();
2254 ++itHD)
2255 {
2256 VirtualSystemDescriptionEntry *vsdeHD = *itHD;
2257
2258 const char *pcszDstFilePath = vsdeHD->strVbox.c_str();
2259 /* Check if the destination file exists already or the
2260 * destination path is empty. */
2261 if ( !(*pcszDstFilePath)
2262 || RTPathExists(pcszDstFilePath)
2263 )
2264 /* This isn't allowed */
2265 throw setError(VBOX_E_FILE_ERROR,
2266 tr("Destination file '%s' exists",
2267 pcszDstFilePath));
2268
2269 /* Find the disk from the OVF's disk list */
2270 DiskImagesMap::const_iterator itDiskImage = pAppliance->m->mapDisks.find(vsdeHD->strRef);
2271 /* vsdeHD->strRef contains the disk identifier (e.g. "vmdisk1"), which should exist
2272 in the virtual system's disks map under that ID and also in the global images map. */
2273 VirtualDisksMap::const_iterator itVirtualDisk = vsysThis.mapVirtualDisks.find(vsdeHD->strRef);
2274
2275 if ( itDiskImage == pAppliance->m->mapDisks.end()
2276 || itVirtualDisk == vsysThis.mapVirtualDisks.end()
2277 )
2278 throw setError(E_FAIL,
2279 tr("Internal inconsistency looking up disk images."));
2280
2281 const DiskImage &di = itDiskImage->second;
2282 const VirtualDisk &vd = itVirtualDisk->second;
2283
2284 /* Make sure all target directories exists */
2285 rc = VirtualBox::ensureFilePathExists(pcszDstFilePath);
2286 if (FAILED(rc))
2287 throw rc;
2288
2289 // subprogress object for hard disk
2290 ComPtr<IProgress> pProgress2;
2291
2292 ComPtr<IHardDisk> dstHdVBox;
2293 /* If strHref is empty we have to create a new file */
2294 if (di.strHref.isEmpty())
2295 {
2296 /* Which format to use? */
2297 Bstr srcFormat = L"VDI";
2298 if ( di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#sparse", Utf8Str::CaseInsensitive)
2299 || di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive))
2300 srcFormat = L"VMDK";
2301 /* Create an empty hard disk */
2302 rc = pVirtualBox->CreateHardDisk(srcFormat, Bstr(pcszDstFilePath), dstHdVBox.asOutParam());
2303 if (FAILED(rc)) throw rc;
2304
2305 /* Create a dynamic growing disk image with the given capacity */
2306 rc = dstHdVBox->CreateBaseStorage(di.iCapacity / _1M, HardDiskVariant_Standard, pProgress2.asOutParam());
2307 if (FAILED(rc)) throw rc;
2308
2309 /* Advance to the next operation */
2310 if (!task->progress.isNull())
2311 task->progress->setNextOperation(BstrFmt(tr("Creating virtual disk image '%s'"), pcszDstFilePath),
2312 vsdeHD->ulSizeMB); // operation's weight, as set up with the IProgress originally
2313 }
2314 else
2315 {
2316 /* Construct the source file path */
2317 Utf8StrFmt strSrcFilePath("%s%c%s", strSrcDir.c_str(), RTPATH_DELIMITER, di.strHref.c_str());
2318 /* Check if the source file exists */
2319 if (!RTPathExists(strSrcFilePath.c_str()))
2320 /* This isn't allowed */
2321 throw setError(VBOX_E_FILE_ERROR,
2322 tr("Source virtual disk image file '%s' doesn't exist"),
2323 strSrcFilePath.c_str());
2324
2325 /* Clone the disk image (this is necessary cause the id has
2326 * to be recreated for the case the same hard disk is
2327 * attached already from a previous import) */
2328
2329 /* First open the existing disk image */
2330 rc = pVirtualBox->OpenHardDisk(Bstr(strSrcFilePath),
2331 AccessMode_ReadOnly,
2332 false, Bstr(""), false, Bstr(""),
2333 srcHdVBox.asOutParam());
2334 if (FAILED(rc)) throw rc;
2335 fSourceHdNeedsClosing = true;
2336
2337 /* We need the format description of the source disk image */
2338 Bstr srcFormat;
2339 rc = srcHdVBox->COMGETTER(Format)(srcFormat.asOutParam());
2340 if (FAILED(rc)) throw rc;
2341 /* Create a new hard disk interface for the destination disk image */
2342 rc = pVirtualBox->CreateHardDisk(srcFormat, Bstr(pcszDstFilePath), dstHdVBox.asOutParam());
2343 if (FAILED(rc)) throw rc;
2344 /* Clone the source disk image */
2345 rc = srcHdVBox->CloneTo(dstHdVBox, HardDiskVariant_Standard, NULL, pProgress2.asOutParam());
2346 if (FAILED(rc)) throw rc;
2347
2348 /* Advance to the next operation */
2349 if (!task->progress.isNull())
2350 task->progress->setNextOperation(BstrFmt(tr("Importing virtual disk image '%s'"), strSrcFilePath.c_str()),
2351 vsdeHD->ulSizeMB); // operation's weight, as set up with the IProgress originally);
2352 }
2353
2354 // now wait for the background disk operation to complete; this throws HRESULTs on error
2355 pAppliance->waitForAsyncProgress(task->progress, pProgress2);
2356
2357 if (fSourceHdNeedsClosing)
2358 {
2359 rc = srcHdVBox->Close();
2360 if (FAILED(rc)) throw rc;
2361 fSourceHdNeedsClosing = false;
2362 }
2363
2364 llHardDisksCreated.push_back(dstHdVBox);
2365 /* Now use the new uuid to attach the disk image to our new machine */
2366 ComPtr<IMachine> sMachine;
2367 rc = session->COMGETTER(Machine)(sMachine.asOutParam());
2368 if (FAILED(rc)) throw rc;
2369 Bstr hdId;
2370 rc = dstHdVBox->COMGETTER(Id)(hdId.asOutParam());
2371 if (FAILED(rc)) throw rc;
2372
2373 /* For now we assume we have one controller of every type only */
2374 HardDiskController hdc = (*vsysThis.mapControllers.find(vd.idController)).second;
2375
2376 // this is for rollback later
2377 MyHardDiskAttachment mhda;
2378 mhda.uuid = newMachineId;
2379 mhda.pMachine = pNewMachine;
2380
2381 switch (hdc.system)
2382 {
2383 case HardDiskController::IDE:
2384 // For the IDE bus, the channel parameter can be either 0 or 1, to specify the primary
2385 // or secondary IDE controller, respectively. For the primary controller of the IDE bus,
2386 // the device number can be either 0 or 1, to specify the master or the slave device,
2387 // respectively. For the secondary IDE controller, the device number is always 1 because
2388 // the master device is reserved for the CD-ROM drive.
2389 mhda.controllerType = Bstr("IDE");
2390 switch (vd.ulAddressOnParent)
2391 {
2392 case 0: // interpret this as primary master
2393 mhda.lChannel = (long)0;
2394 mhda.lDevice = (long)0;
2395 break;
2396
2397 case 1: // interpret this as primary slave
2398 mhda.lChannel = (long)0;
2399 mhda.lDevice = (long)1;
2400 break;
2401
2402 case 2: // interpret this as secondary slave
2403 mhda.lChannel = (long)1;
2404 mhda.lDevice = (long)1;
2405 break;
2406
2407 default:
2408 throw setError(VBOX_E_NOT_SUPPORTED,
2409 tr("Invalid channel %RI16 specified; IDE controllers support only 0, 1 or 2"), vd.ulAddressOnParent);
2410 break;
2411 }
2412 break;
2413
2414 case HardDiskController::SATA:
2415 mhda.controllerType = Bstr("SATA");
2416 mhda.lChannel = (long)vd.ulAddressOnParent;
2417 mhda.lDevice = (long)0;
2418 break;
2419
2420 case HardDiskController::SCSI:
2421 mhda.controllerType = Bstr("SCSI");
2422 mhda.lChannel = (long)vd.ulAddressOnParent;
2423 mhda.lDevice = (long)0;
2424 break;
2425
2426 default: break;
2427 }
2428
2429 Log(("Attaching disk %s to channel %d on device %d\n", pcszDstFilePath, mhda.lChannel, mhda.lDevice));
2430
2431 rc = sMachine->AttachHardDisk(hdId,
2432 mhda.controllerType,
2433 mhda.lChannel,
2434 mhda.lDevice);
2435 if (FAILED(rc)) throw rc;
2436
2437 llHardDiskAttachments.push_back(mhda);
2438
2439 rc = sMachine->SaveSettings();
2440 if (FAILED(rc)) throw rc;
2441 } // end for (itHD = avsdeHDs.begin();
2442
2443 // only now that we're done with all disks, close the session
2444 rc = session->Close();
2445 if (FAILED(rc)) throw rc;
2446 fSessionOpen = false;
2447 }
2448 catch(HRESULT /* aRC */)
2449 {
2450 if (fSourceHdNeedsClosing)
2451 srcHdVBox->Close();
2452
2453 if (fSessionOpen)
2454 session->Close();
2455
2456 throw;
2457 }
2458 }
2459 }
2460 catch(HRESULT aRC)
2461 {
2462 rc = aRC;
2463 }
2464
2465 if (FAILED(rc))
2466 break;
2467
2468 } // for (it = pAppliance->m->llVirtualSystems.begin(),
2469
2470 if (FAILED(rc))
2471 {
2472 // with _whatever_ error we've had, do a complete roll-back of
2473 // machines and disks we've created; unfortunately this is
2474 // not so trivially done...
2475
2476 HRESULT rc2;
2477 // detach all hard disks from all machines we created
2478 list<MyHardDiskAttachment>::iterator itM;
2479 for (itM = llHardDiskAttachments.begin();
2480 itM != llHardDiskAttachments.end();
2481 ++itM)
2482 {
2483 const MyHardDiskAttachment &mhda = *itM;
2484 rc2 = pVirtualBox->OpenSession(session, Bstr(mhda.uuid));
2485 if (SUCCEEDED(rc2))
2486 {
2487 ComPtr<IMachine> sMachine;
2488 rc2 = session->COMGETTER(Machine)(sMachine.asOutParam());
2489 if (SUCCEEDED(rc2))
2490 {
2491 rc2 = sMachine->DetachHardDisk(Bstr(mhda.controllerType), mhda.lChannel, mhda.lDevice);
2492 rc2 = sMachine->SaveSettings();
2493 }
2494 session->Close();
2495 }
2496 }
2497
2498 // now clean up all hard disks we created
2499 list< ComPtr<IHardDisk> >::iterator itHD;
2500 for (itHD = llHardDisksCreated.begin();
2501 itHD != llHardDisksCreated.end();
2502 ++itHD)
2503 {
2504 ComPtr<IHardDisk> pDisk = *itHD;
2505 ComPtr<IProgress> pProgress;
2506 rc2 = pDisk->DeleteStorage(pProgress.asOutParam());
2507 rc2 = pProgress->WaitForCompletion(-1);
2508 }
2509
2510 // finally, deregister and remove all machines
2511 list<Guid>::iterator itID;
2512 for (itID = llMachinesRegistered.begin();
2513 itID != llMachinesRegistered.end();
2514 ++itID)
2515 {
2516 const Guid &guid = *itID;
2517 ComPtr<IMachine> failedMachine;
2518 rc2 = pVirtualBox->UnregisterMachine(guid.toUtf16(), failedMachine.asOutParam());
2519 if (SUCCEEDED(rc2))
2520 rc2 = failedMachine->DeleteSettings();
2521 }
2522 }
2523
2524 task->rc = rc;
2525
2526 if (!task->progress.isNull())
2527 task->progress->notifyComplete(rc);
2528
2529 LogFlowFunc(("rc=%Rhrc\n", rc));
2530 LogFlowFuncLeave();
2531
2532 return VINF_SUCCESS;
2533}
2534
2535struct Appliance::TaskWriteOVF
2536{
2537 enum OVFFormat
2538 {
2539 unspecified,
2540 OVF_0_9,
2541 OVF_1_0
2542 };
2543 enum TaskType
2544 {
2545 Write
2546 };
2547
2548 TaskWriteOVF(OVFFormat aFormat, Appliance *aThat)
2549 : taskType(Write),
2550 storageType(VFSType_File),
2551 enFormat(aFormat),
2552 pAppliance(aThat),
2553 rc(S_OK)
2554 {}
2555 ~TaskWriteOVF() {}
2556
2557 int startThread();
2558 static int uploadProgress(unsigned uPercent, void *pvUser);
2559
2560 TaskType taskType;
2561 VFSType_T storageType;
2562 Utf8Str filepath;
2563 Utf8Str hostname;
2564 Utf8Str username;
2565 Utf8Str password;
2566 OVFFormat enFormat;
2567 Appliance *pAppliance;
2568 ComObjPtr<Progress> progress;
2569 HRESULT rc;
2570};
2571
2572int Appliance::TaskWriteOVF::startThread()
2573{
2574 int vrc = RTThreadCreate(NULL, Appliance::taskThreadWriteOVF, this,
2575 0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
2576 "Appliance::Task");
2577
2578 ComAssertMsgRCRet(vrc,
2579 ("Could not create taskThreadWriteOVF (%Rrc)\n", vrc), E_FAIL);
2580
2581 return S_OK;
2582}
2583
2584/* static */
2585int Appliance::TaskWriteOVF::uploadProgress(unsigned uPercent, void *pvUser)
2586{
2587 Appliance::TaskWriteOVF* pTask = *(Appliance::TaskWriteOVF**)pvUser;
2588
2589 if (pTask &&
2590 !pTask->progress.isNull())
2591 {
2592 BOOL fCanceled;
2593 pTask->progress->COMGETTER(Canceled)(&fCanceled);
2594 if (fCanceled)
2595 return -1;
2596 pTask->progress->setCurrentOperationProgress(uPercent);
2597 }
2598 return VINF_SUCCESS;
2599}
2600
2601STDMETHODIMP Appliance::CreateVFSExplorer(IN_BSTR aURI, IVFSExplorer **aExplorer)
2602{
2603 HRESULT rc = S_OK;
2604
2605 CheckComArgOutPointerValid(aExplorer);
2606
2607 AutoCaller autoCaller(this);
2608 CheckComRCReturnRC(autoCaller.rc());
2609
2610 AutoReadLock(this);
2611
2612 Utf8Str uri(aURI);
2613 /* Check which kind of export the user has requested */
2614 VFSType_T type = VFSType_File;
2615 Utf8Str strProtocol = "";
2616 /* Check the URI for the target format */
2617 if (uri.startsWith("SunCloud://", Utf8Str::CaseInsensitive)) /* Sun Cloud service */
2618 {
2619 throw E_NOTIMPL;
2620// type = VFSType_S3;
2621// strProtocol = "SunCloud://";
2622 }
2623 else if (uri.startsWith("S3://", Utf8Str::CaseInsensitive)) /* S3 service */
2624 {
2625 throw E_NOTIMPL;
2626// type = VFSType_S3;
2627// strProtocol = "S3://";
2628 }
2629 else if (uri.startsWith("webdav://", Utf8Str::CaseInsensitive)) /* webdav service */
2630 throw E_NOTIMPL;
2631
2632 Utf8Str strFilepath;
2633 Utf8Str strHostname;
2634 Utf8Str strUsername;
2635 Utf8Str strPassword;
2636 parseURI(uri, strProtocol, strFilepath, strHostname, strUsername, strPassword);
2637
2638 ComObjPtr<VFSExplorer> explorer;
2639 explorer.createObject();
2640
2641 rc = explorer->init(type, strFilepath, strHostname, strUsername, strPassword, mVirtualBox);
2642
2643 if (SUCCEEDED(rc))
2644 /* Return explorer to the caller */
2645 explorer.queryInterfaceTo(aExplorer);
2646
2647 return rc;
2648}
2649
2650STDMETHODIMP Appliance::Write(IN_BSTR format, IN_BSTR path, IProgress **aProgress)
2651{
2652 HRESULT rc = S_OK;
2653
2654 CheckComArgOutPointerValid(aProgress);
2655
2656 AutoCaller autoCaller(this);
2657 CheckComRCReturnRC(autoCaller.rc());
2658
2659 AutoWriteLock(this);
2660
2661 // see if we can handle this file; for now we insist it has an ".ovf" extension
2662 Utf8Str strPath = path;
2663 if (!strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
2664 return setError(VBOX_E_FILE_ERROR,
2665 tr("Appliance file must have .ovf extension"));
2666
2667 ComObjPtr<Progress> progress;
2668 Utf8Str strFormat(format);
2669 TaskWriteOVF::OVFFormat ovfF;
2670 if (strFormat == "ovf-0.9")
2671 ovfF = TaskWriteOVF::OVF_0_9;
2672 else if (strFormat == "ovf-1.0")
2673 ovfF = TaskWriteOVF::OVF_1_0;
2674 else
2675 return setError(VBOX_E_FILE_ERROR,
2676 tr("Invalid format \"%s\" specified"), strFormat.c_str());
2677
2678 rc = writeImpl(ovfF, strPath, progress);
2679
2680 if (SUCCEEDED(rc))
2681 /* Return progress to the caller */
2682 progress.queryInterfaceTo(aProgress);
2683
2684 return rc;
2685}
2686
2687void Appliance::parseURI(Utf8Str strUri, const Utf8Str &strProtocol, Utf8Str &strFilepath, Utf8Str &strHostname, Utf8Str &strUsername, Utf8Str &strPassword)
2688{
2689 /* Remove the protocol */
2690 if (strUri.startsWith(strProtocol, Utf8Str::CaseInsensitive))
2691 strUri = strUri.substr(strProtocol.length());
2692 size_t uppos = strUri.find("@");
2693 if (uppos != Utf8Str::npos)
2694 {
2695 strUsername = strUri.substr(0, uppos);
2696 strUri = strUri.substr(uppos + 1);
2697 size_t upos = strUsername.find(":");
2698 if (upos != Utf8Str::npos)
2699 {
2700 strPassword = strUsername.substr(upos + 1);
2701 strUsername = strUsername.substr(0, upos);
2702 }
2703 }
2704 size_t hpos = strUri.find("/");
2705 if (hpos != Utf8Str::npos)
2706 {
2707 strHostname = strUri.substr(0, hpos);
2708 strUri = strUri.substr(hpos);
2709 }
2710 strFilepath = strUri;
2711}
2712
2713HRESULT Appliance::writeImpl(int aFormat, Utf8Str aPath, ComObjPtr<Progress> &aProgress)
2714{
2715 HRESULT rc = S_OK;
2716 try
2717 {
2718 m->strPath = aPath;
2719
2720 /* Initialize our worker task */
2721 std::auto_ptr<TaskWriteOVF> task(new TaskWriteOVF((TaskWriteOVF::OVFFormat)aFormat, this));
2722
2723 /* Check which kind of export the user has requested */
2724 Utf8Str strProtocol = "";
2725 /* Check the URI for the target format */
2726 if (m->strPath.startsWith("SunCloud://", Utf8Str::CaseInsensitive)) /* Sun Cloud service */
2727 {
2728 throw E_NOTIMPL;
2729// task->storageType = VFSType_S3;
2730// strProtocol = "SunCloud://";
2731 }
2732 else if (m->strPath.startsWith("S3://", Utf8Str::CaseInsensitive)) /* S3 service */
2733 {
2734 throw E_NOTIMPL;
2735// task->storageType = VFSType_S3;
2736// strProtocol = "S3://";
2737 }
2738 else if (m->strPath.startsWith("webdav://", Utf8Str::CaseInsensitive)) /* webdav service */
2739 throw E_NOTIMPL;
2740
2741 parseURI(m->strPath, strProtocol, task->filepath, task->hostname, task->username, task->password);
2742 Bstr progressDesc = BstrFmt(tr("Export appliance '%s'"),
2743 task->filepath.c_str());
2744
2745 /* todo: This progress init stuff should be done a little bit more generic */
2746 if (task->storageType == VFSType_S3)
2747 rc = setUpProgressUpload(aProgress, progressDesc);
2748 else
2749 rc = setUpProgress(aProgress, progressDesc);
2750 if (FAILED(rc)) throw rc;
2751
2752 task->progress = aProgress;
2753
2754 rc = task->startThread();
2755 CheckComRCThrowRC(rc);
2756
2757 /* Don't destruct on success */
2758 task.release();
2759 }
2760 catch (HRESULT aRC)
2761 {
2762 rc = aRC;
2763 }
2764
2765 return rc;
2766}
2767
2768DECLCALLBACK(int) Appliance::taskThreadWriteOVF(RTTHREAD /* aThread */, void *pvUser)
2769{
2770 std::auto_ptr<TaskWriteOVF> task(static_cast<TaskWriteOVF*>(pvUser));
2771 AssertReturn(task.get(), VERR_GENERAL_FAILURE);
2772
2773 Appliance *pAppliance = task->pAppliance;
2774
2775 LogFlowFuncEnter();
2776 LogFlowFunc(("Appliance %p\n", pAppliance));
2777
2778 HRESULT rc = S_OK;
2779
2780 switch(task->taskType)
2781 {
2782 case TaskWriteOVF::Write:
2783 {
2784 if (task->storageType == VFSType_File)
2785 rc = pAppliance->writeFS(task.get());
2786 else if (task->storageType == VFSType_S3)
2787 rc = pAppliance->writeS3(task.get());
2788 break;
2789 }
2790 }
2791
2792 LogFlowFunc(("rc=%Rhrc\n", rc));
2793 LogFlowFuncLeave();
2794
2795 return VINF_SUCCESS;
2796}
2797
2798/**
2799 * Worker thread implementation for Write() (ovf writer).
2800 * @param aThread
2801 * @param pvUser
2802 */
2803/* static */
2804int Appliance::writeFS(TaskWriteOVF *pTask)
2805{
2806 LogFlowFuncEnter();
2807 LogFlowFunc(("Appliance %p\n", this));
2808
2809 AutoCaller autoCaller(this);
2810 CheckComRCReturnRC(autoCaller.rc());
2811
2812 AutoWriteLock appLock(this);
2813
2814 HRESULT rc = S_OK;
2815
2816 try
2817 {
2818 xml::Document doc;
2819 xml::ElementNode *pelmRoot = doc.createRootElement("Envelope");
2820
2821 pelmRoot->setAttribute("ovf:version", (pTask->enFormat == TaskWriteOVF::OVF_1_0) ? "1.0" : "0.9");
2822 pelmRoot->setAttribute("xml:lang", "en-US");
2823
2824 Utf8Str strNamespace = (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2825 ? "http://www.vmware.com/schema/ovf/1/envelope" // 0.9
2826 : "http://schemas.dmtf.org/ovf/envelope/1"; // 1.0
2827 pelmRoot->setAttribute("xmlns", strNamespace);
2828 pelmRoot->setAttribute("xmlns:ovf", strNamespace);
2829
2830// pelmRoot->setAttribute("xmlns:ovfstr", "http://schema.dmtf.org/ovf/strings/1");
2831 pelmRoot->setAttribute("xmlns:rasd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData");
2832 pelmRoot->setAttribute("xmlns:vssd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData");
2833 pelmRoot->setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
2834// pelmRoot->setAttribute("xsi:schemaLocation", "http://schemas.dmtf.org/ovf/envelope/1 ../ovf-envelope.xsd");
2835
2836 // <Envelope>/<References>
2837 xml::ElementNode *pelmReferences = pelmRoot->createChild("References"); // 0.9 and 1.0
2838
2839 /* <Envelope>/<DiskSection>:
2840 <DiskSection>
2841 <Info>List of the virtual disks used in the package</Info>
2842 <Disk ovf:capacity="4294967296" ovf:diskId="lamp" ovf:format="http://www.vmware.com/specifications/vmdk.html#compressed" ovf:populatedSize="1924967692"/>
2843 </DiskSection> */
2844 xml::ElementNode *pelmDiskSection;
2845 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2846 {
2847 // <Section xsi:type="ovf:DiskSection_Type">
2848 pelmDiskSection = pelmRoot->createChild("Section");
2849 pelmDiskSection->setAttribute("xsi:type", "ovf:DiskSection_Type");
2850 }
2851 else
2852 pelmDiskSection = pelmRoot->createChild("DiskSection");
2853
2854 xml::ElementNode *pelmDiskSectionInfo = pelmDiskSection->createChild("Info");
2855 pelmDiskSectionInfo->addContent("List of the virtual disks used in the package");
2856 // for now, set up a map so we have a list of unique disk names (to make
2857 // sure the same disk name is only added once)
2858 map<Utf8Str, const VirtualSystemDescriptionEntry*> mapDisks;
2859
2860 /* <Envelope>/<NetworkSection>:
2861 <NetworkSection>
2862 <Info>Logical networks used in the package</Info>
2863 <Network ovf:name="VM Network">
2864 <Description>The network that the LAMP Service will be available on</Description>
2865 </Network>
2866 </NetworkSection> */
2867 xml::ElementNode *pelmNetworkSection;
2868 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2869 {
2870 // <Section xsi:type="ovf:NetworkSection_Type">
2871 pelmNetworkSection = pelmRoot->createChild("Section");
2872 pelmNetworkSection->setAttribute("xsi:type", "ovf:NetworkSection_Type");
2873 }
2874 else
2875 pelmNetworkSection = pelmRoot->createChild("NetworkSection");
2876
2877 xml::ElementNode *pelmNetworkSectionInfo = pelmNetworkSection->createChild("Info");
2878 pelmNetworkSectionInfo->addContent("Logical networks used in the package");
2879 // for now, set up a map so we have a list of unique network names (to make
2880 // sure the same network name is only added once)
2881 map<Utf8Str, bool> mapNetworks;
2882 // we fill this later below when we iterate over the networks
2883
2884 // and here come the virtual systems:
2885
2886 // write a collection if we have more than one virtual system _and_ we're
2887 // writing OVF 1.0; otherwise fail since ovftool can't import more than
2888 // one machine, it seems
2889 xml::ElementNode *pelmToAddVirtualSystemsTo;
2890 if (m->virtualSystemDescriptions.size() > 1)
2891 {
2892 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2893 throw setError(VBOX_E_FILE_ERROR,
2894 tr("Cannot export more than one virtual system with OVF 0.9, use OVF 1.0"));
2895
2896 pelmToAddVirtualSystemsTo = pelmRoot->createChild("VirtualSystemCollection");
2897 /* xml::AttributeNode *pattrVirtualSystemCollectionId = */ pelmToAddVirtualSystemsTo->setAttribute("ovf:name", "ExportedVirtualBoxMachines"); // whatever
2898 }
2899 else
2900 pelmToAddVirtualSystemsTo = pelmRoot; // add virtual system directly under root element
2901
2902 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
2903 /* Iterate through all virtual systems of that appliance */
2904 for (it = m->virtualSystemDescriptions.begin();
2905 it != m->virtualSystemDescriptions.end();
2906 ++it)
2907 {
2908 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
2909
2910 xml::ElementNode *pelmVirtualSystem;
2911 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2912 {
2913 // <Section xsi:type="ovf:NetworkSection_Type">
2914 pelmVirtualSystem = pelmToAddVirtualSystemsTo->createChild("Content");
2915 pelmVirtualSystem->setAttribute("xsi:type", "ovf:VirtualSystem_Type");
2916 }
2917 else
2918 pelmVirtualSystem = pelmToAddVirtualSystemsTo->createChild("VirtualSystem");
2919
2920 /*xml::ElementNode *pelmVirtualSystemInfo =*/ pelmVirtualSystem->createChild("Info")->addContent("A virtual machine");
2921
2922 std::list<VirtualSystemDescriptionEntry*> llName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);
2923 if (llName.size() != 1)
2924 throw setError(VBOX_E_NOT_SUPPORTED,
2925 tr("Missing VM name"));
2926 Utf8Str &strVMName = llName.front()->strVbox;
2927 pelmVirtualSystem->setAttribute("ovf:id", strVMName);
2928
2929 // product info
2930 std::list<VirtualSystemDescriptionEntry*> llProduct = vsdescThis->findByType(VirtualSystemDescriptionType_Product);
2931 std::list<VirtualSystemDescriptionEntry*> llProductUrl = vsdescThis->findByType(VirtualSystemDescriptionType_ProductUrl);
2932 std::list<VirtualSystemDescriptionEntry*> llVendor = vsdescThis->findByType(VirtualSystemDescriptionType_Vendor);
2933 std::list<VirtualSystemDescriptionEntry*> llVendorUrl = vsdescThis->findByType(VirtualSystemDescriptionType_VendorUrl);
2934 std::list<VirtualSystemDescriptionEntry*> llVersion = vsdescThis->findByType(VirtualSystemDescriptionType_Version);
2935 bool fProduct = llProduct.size() && !llProduct.front()->strVbox.isEmpty();
2936 bool fProductUrl = llProductUrl.size() && !llProductUrl.front()->strVbox.isEmpty();
2937 bool fVendor = llVendor.size() && !llVendor.front()->strVbox.isEmpty();
2938 bool fVendorUrl = llVendorUrl.size() && !llVendorUrl.front()->strVbox.isEmpty();
2939 bool fVersion = llVersion.size() && !llVersion.front()->strVbox.isEmpty();
2940 if (fProduct ||
2941 fProductUrl ||
2942 fVersion ||
2943 fVendorUrl ||
2944 fVersion)
2945 {
2946 /* <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
2947 <Info>Meta-information about the installed software</Info>
2948 <Product>VAtest</Product>
2949 <Vendor>SUN Microsystems</Vendor>
2950 <Version>10.0</Version>
2951 <ProductUrl>http://blogs.sun.com/VirtualGuru</ProductUrl>
2952 <VendorUrl>http://www.sun.com</VendorUrl>
2953 </Section> */
2954 xml::ElementNode *pelmAnnotationSection;
2955 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2956 {
2957 // <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
2958 pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
2959 pelmAnnotationSection->setAttribute("xsi:type", "ovf:ProductSection_Type");
2960 }
2961 else
2962 pelmAnnotationSection = pelmVirtualSystem->createChild("ProductSection");
2963
2964 pelmAnnotationSection->createChild("Info")->addContent("Meta-information about the installed software");
2965 if (fProduct)
2966 pelmAnnotationSection->createChild("Product")->addContent(llProduct.front()->strVbox);
2967 if (fVendor)
2968 pelmAnnotationSection->createChild("Vendor")->addContent(llVendor.front()->strVbox);
2969 if (fVersion)
2970 pelmAnnotationSection->createChild("Version")->addContent(llVersion.front()->strVbox);
2971 if (fProductUrl)
2972 pelmAnnotationSection->createChild("ProductUrl")->addContent(llProductUrl.front()->strVbox);
2973 if (fVendorUrl)
2974 pelmAnnotationSection->createChild("VendorUrl")->addContent(llVendorUrl.front()->strVbox);
2975 }
2976
2977 // description
2978 std::list<VirtualSystemDescriptionEntry*> llDescription = vsdescThis->findByType(VirtualSystemDescriptionType_Description);
2979 if (llDescription.size() &&
2980 !llDescription.front()->strVbox.isEmpty())
2981 {
2982 /* <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
2983 <Info>A human-readable annotation</Info>
2984 <Annotation>Plan 9</Annotation>
2985 </Section> */
2986 xml::ElementNode *pelmAnnotationSection;
2987 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
2988 {
2989 // <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
2990 pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
2991 pelmAnnotationSection->setAttribute("xsi:type", "ovf:AnnotationSection_Type");
2992 }
2993 else
2994 pelmAnnotationSection = pelmVirtualSystem->createChild("AnnotationSection");
2995
2996 pelmAnnotationSection->createChild("Info")->addContent("A human-readable annotation");
2997 pelmAnnotationSection->createChild("Annotation")->addContent(llDescription.front()->strVbox);
2998 }
2999
3000 // license
3001 std::list<VirtualSystemDescriptionEntry*> llLicense = vsdescThis->findByType(VirtualSystemDescriptionType_License);
3002 if (llLicense.size() &&
3003 !llLicense.front()->strVbox.isEmpty())
3004 {
3005 /* <EulaSection>
3006 <Info ovf:msgid="6">License agreement for the Virtual System.</Info>
3007 <License ovf:msgid="1">License terms can go in here.</License>
3008 </EulaSection> */
3009 xml::ElementNode *pelmEulaSection;
3010 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3011 {
3012 pelmEulaSection = pelmVirtualSystem->createChild("Section");
3013 pelmEulaSection->setAttribute("xsi:type", "ovf:EulaSection_Type");
3014 }
3015 else
3016 pelmEulaSection = pelmVirtualSystem->createChild("EulaSection");
3017
3018 pelmEulaSection->createChild("Info")->addContent("License agreement for the virtual system");
3019 pelmEulaSection->createChild("License")->addContent(llLicense.front()->strVbox);
3020 }
3021
3022 // operating system
3023 std::list<VirtualSystemDescriptionEntry*> llOS = vsdescThis->findByType(VirtualSystemDescriptionType_OS);
3024 if (llOS.size() != 1)
3025 throw setError(VBOX_E_NOT_SUPPORTED,
3026 tr("Missing OS type"));
3027 /* <OperatingSystemSection ovf:id="82">
3028 <Info>Guest Operating System</Info>
3029 <Description>Linux 2.6.x</Description>
3030 </OperatingSystemSection> */
3031 xml::ElementNode *pelmOperatingSystemSection;
3032 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3033 {
3034 pelmOperatingSystemSection = pelmVirtualSystem->createChild("Section");
3035 pelmOperatingSystemSection->setAttribute("xsi:type", "ovf:OperatingSystemSection_Type");
3036 }
3037 else
3038 pelmOperatingSystemSection = pelmVirtualSystem->createChild("OperatingSystemSection");
3039
3040 pelmOperatingSystemSection->setAttribute("ovf:id", llOS.front()->strOvf);
3041 pelmOperatingSystemSection->createChild("Info")->addContent("The kind of installed guest operating system");
3042 Utf8Str strOSDesc;
3043 convertCIMOSType2VBoxOSType(strOSDesc, (CIMOSType_T)llOS.front()->strOvf.toInt32(), "");
3044 pelmOperatingSystemSection->createChild("Description")->addContent(strOSDesc);
3045
3046 // <VirtualHardwareSection ovf:id="hw1" ovf:transport="iso">
3047 xml::ElementNode *pelmVirtualHardwareSection;
3048 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3049 {
3050 // <Section xsi:type="ovf:VirtualHardwareSection_Type">
3051 pelmVirtualHardwareSection = pelmVirtualSystem->createChild("Section");
3052 pelmVirtualHardwareSection->setAttribute("xsi:type", "ovf:VirtualHardwareSection_Type");
3053 }
3054 else
3055 pelmVirtualHardwareSection = pelmVirtualSystem->createChild("VirtualHardwareSection");
3056
3057 pelmVirtualHardwareSection->createChild("Info")->addContent("Virtual hardware requirements for a virtual machine");
3058
3059 /* <System>
3060 <vssd:Description>Description of the virtual hardware section.</vssd:Description>
3061 <vssd:ElementName>vmware</vssd:ElementName>
3062 <vssd:InstanceID>1</vssd:InstanceID>
3063 <vssd:VirtualSystemIdentifier>MyLampService</vssd:VirtualSystemIdentifier>
3064 <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
3065 </System> */
3066 xml::ElementNode *pelmSystem = pelmVirtualHardwareSection->createChild("System");
3067
3068 pelmSystem->createChild("vssd:ElementName")->addContent("Virtual Hardware Family"); // required OVF 1.0
3069
3070 // <vssd:InstanceId>0</vssd:InstanceId>
3071 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3072 pelmSystem->createChild("vssd:InstanceId")->addContent("0");
3073 else // capitalization changed...
3074 pelmSystem->createChild("vssd:InstanceID")->addContent("0");
3075
3076 // <vssd:VirtualSystemIdentifier>VAtest</vssd:VirtualSystemIdentifier>
3077 pelmSystem->createChild("vssd:VirtualSystemIdentifier")->addContent(strVMName);
3078 // <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
3079 const char *pcszHardware = "virtualbox-2.2";
3080 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3081 // pretend to be vmware compatible then
3082 pcszHardware = "vmx-6";
3083 pelmSystem->createChild("vssd:VirtualSystemType")->addContent(pcszHardware);
3084
3085 // loop thru all description entries twice; once to write out all
3086 // devices _except_ disk images, and a second time to assign the
3087 // disk images; this is because disk images need to reference
3088 // IDE controllers, and we can't know their instance IDs without
3089 // assigning them first
3090
3091 uint32_t idIDEController = 0;
3092 int32_t lIDEControllerIndex = 0;
3093 uint32_t idSATAController = 0;
3094 int32_t lSATAControllerIndex = 0;
3095 uint32_t idSCSIController = 0;
3096 int32_t lSCSIControllerIndex = 0;
3097
3098 uint32_t ulInstanceID = 1;
3099 uint32_t cDisks = 0;
3100
3101 for (size_t uLoop = 1;
3102 uLoop <= 2;
3103 ++uLoop)
3104 {
3105 int32_t lIndexThis = 0;
3106 list<VirtualSystemDescriptionEntry>::const_iterator itD;
3107 for (itD = vsdescThis->m->llDescriptions.begin();
3108 itD != vsdescThis->m->llDescriptions.end();
3109 ++itD, ++lIndexThis)
3110 {
3111 const VirtualSystemDescriptionEntry &desc = *itD;
3112
3113 OVFResourceType_T type = (OVFResourceType_T)0; // if this becomes != 0 then we do stuff
3114 Utf8Str strResourceSubType;
3115
3116 Utf8Str strDescription; // results in <rasd:Description>...</rasd:Description> block
3117 Utf8Str strCaption; // results in <rasd:Caption>...</rasd:Caption> block
3118
3119 uint32_t ulParent = 0;
3120
3121 int32_t lVirtualQuantity = -1;
3122 Utf8Str strAllocationUnits;
3123
3124 int32_t lAddress = -1;
3125 int32_t lBusNumber = -1;
3126 int32_t lAddressOnParent = -1;
3127
3128 int32_t lAutomaticAllocation = -1; // 0 means "false", 1 means "true"
3129 Utf8Str strConnection; // results in <rasd:Connection>...</rasd:Connection> block
3130 Utf8Str strHostResource;
3131
3132 uint64_t uTemp;
3133
3134 switch (desc.type)
3135 {
3136 case VirtualSystemDescriptionType_CPU:
3137 /* <Item>
3138 <rasd:Caption>1 virtual CPU</rasd:Caption>
3139 <rasd:Description>Number of virtual CPUs</rasd:Description>
3140 <rasd:ElementName>virtual CPU</rasd:ElementName>
3141 <rasd:InstanceID>1</rasd:InstanceID>
3142 <rasd:ResourceType>3</rasd:ResourceType>
3143 <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
3144 </Item> */
3145 if (uLoop == 1)
3146 {
3147 strDescription = "Number of virtual CPUs";
3148 type = OVFResourceType_Processor; // 3
3149 desc.strVbox.toInt(uTemp);
3150 lVirtualQuantity = uTemp;
3151 strCaption = Utf8StrFmt("%d virtual CPU", lVirtualQuantity); // without this ovftool won't eat the item
3152 }
3153 break;
3154
3155 case VirtualSystemDescriptionType_Memory:
3156 /* <Item>
3157 <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
3158 <rasd:Caption>256 MB of memory</rasd:Caption>
3159 <rasd:Description>Memory Size</rasd:Description>
3160 <rasd:ElementName>Memory</rasd:ElementName>
3161 <rasd:InstanceID>2</rasd:InstanceID>
3162 <rasd:ResourceType>4</rasd:ResourceType>
3163 <rasd:VirtualQuantity>256</rasd:VirtualQuantity>
3164 </Item> */
3165 if (uLoop == 1)
3166 {
3167 strDescription = "Memory Size";
3168 type = OVFResourceType_Memory; // 4
3169 desc.strVbox.toInt(uTemp);
3170 lVirtualQuantity = (int32_t)(uTemp / _1M);
3171 strAllocationUnits = "MegaBytes";
3172 strCaption = Utf8StrFmt("%d MB of memory", lVirtualQuantity); // without this ovftool won't eat the item
3173 }
3174 break;
3175
3176 case VirtualSystemDescriptionType_HardDiskControllerIDE:
3177 /* <Item>
3178 <rasd:Caption>ideController1</rasd:Caption>
3179 <rasd:Description>IDE Controller</rasd:Description>
3180 <rasd:InstanceId>5</rasd:InstanceId>
3181 <rasd:ResourceType>5</rasd:ResourceType>
3182 <rasd:Address>1</rasd:Address>
3183 <rasd:BusNumber>1</rasd:BusNumber>
3184 </Item> */
3185 if (uLoop == 1)
3186 {
3187 strDescription = "IDE Controller";
3188 strCaption = "ideController0";
3189 type = OVFResourceType_IDEController; // 5
3190 strResourceSubType = desc.strVbox;
3191 // it seems that OVFTool always writes these two, and since we can only
3192 // have one IDE controller, we'll use this as well
3193 lAddress = 1;
3194 lBusNumber = 1;
3195
3196 // remember this ID
3197 idIDEController = ulInstanceID;
3198 lIDEControllerIndex = lIndexThis;
3199 }
3200 break;
3201
3202 case VirtualSystemDescriptionType_HardDiskControllerSATA:
3203 /* <Item>
3204 <rasd:Caption>sataController0</rasd:Caption>
3205 <rasd:Description>SATA Controller</rasd:Description>
3206 <rasd:InstanceId>4</rasd:InstanceId>
3207 <rasd:ResourceType>20</rasd:ResourceType>
3208 <rasd:ResourceSubType>ahci</rasd:ResourceSubType>
3209 <rasd:Address>0</rasd:Address>
3210 <rasd:BusNumber>0</rasd:BusNumber>
3211 </Item>
3212 */
3213 if (uLoop == 1)
3214 {
3215 strDescription = "SATA Controller";
3216 strCaption = "sataController0";
3217 type = OVFResourceType_OtherStorageDevice; // 20
3218 // it seems that OVFTool always writes these two, and since we can only
3219 // have one SATA controller, we'll use this as well
3220 lAddress = 0;
3221 lBusNumber = 0;
3222
3223 if ( desc.strVbox.isEmpty() // AHCI is the default in VirtualBox
3224 || (!desc.strVbox.compare("ahci", Utf8Str::CaseInsensitive))
3225 )
3226 strResourceSubType = "AHCI";
3227 else
3228 throw setError(VBOX_E_NOT_SUPPORTED,
3229 tr("Invalid config string \"%s\" in SATA controller"), desc.strVbox.c_str());
3230
3231 // remember this ID
3232 idSATAController = ulInstanceID;
3233 lSATAControllerIndex = lIndexThis;
3234 }
3235 break;
3236
3237 case VirtualSystemDescriptionType_HardDiskControllerSCSI:
3238 /* <Item>
3239 <rasd:Caption>scsiController0</rasd:Caption>
3240 <rasd:Description>SCSI Controller</rasd:Description>
3241 <rasd:InstanceId>4</rasd:InstanceId>
3242 <rasd:ResourceType>6</rasd:ResourceType>
3243 <rasd:ResourceSubType>buslogic</rasd:ResourceSubType>
3244 <rasd:Address>0</rasd:Address>
3245 <rasd:BusNumber>0</rasd:BusNumber>
3246 </Item>
3247 */
3248 if (uLoop == 1)
3249 {
3250 strDescription = "SCSI Controller";
3251 strCaption = "scsiController0";
3252 type = OVFResourceType_ParallelSCSIHBA; // 6
3253 // it seems that OVFTool always writes these two, and since we can only
3254 // have one SATA controller, we'll use this as well
3255 lAddress = 0;
3256 lBusNumber = 0;
3257
3258 if ( desc.strVbox.isEmpty() // LsiLogic is the default in VirtualBox
3259 || (!desc.strVbox.compare("lsilogic", Utf8Str::CaseInsensitive))
3260 )
3261 strResourceSubType = "lsilogic";
3262 else if (!desc.strVbox.compare("buslogic", Utf8Str::CaseInsensitive))
3263 strResourceSubType = "buslogic";
3264 else
3265 throw setError(VBOX_E_NOT_SUPPORTED,
3266 tr("Invalid config string \"%s\" in SCSI controller"), desc.strVbox.c_str());
3267
3268 // remember this ID
3269 idSCSIController = ulInstanceID;
3270 lSCSIControllerIndex = lIndexThis;
3271 }
3272 break;
3273
3274 case VirtualSystemDescriptionType_HardDiskImage:
3275 /* <Item>
3276 <rasd:Caption>disk1</rasd:Caption>
3277 <rasd:InstanceId>8</rasd:InstanceId>
3278 <rasd:ResourceType>17</rasd:ResourceType>
3279 <rasd:HostResource>/disk/vmdisk1</rasd:HostResource>
3280 <rasd:Parent>4</rasd:Parent>
3281 <rasd:AddressOnParent>0</rasd:AddressOnParent>
3282 </Item> */
3283 if (uLoop == 2)
3284 {
3285 Utf8Str strDiskID = Utf8StrFmt("vmdisk%RI32", ++cDisks);
3286
3287 strDescription = "Disk Image";
3288 strCaption = Utf8StrFmt("disk%RI32", cDisks); // this is not used for anything else
3289 type = OVFResourceType_HardDisk; // 17
3290
3291 // the following references the "<Disks>" XML block
3292 strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());
3293
3294 // controller=<index>;channel=<c>
3295 size_t pos1 = desc.strExtraConfig.find("controller=");
3296 size_t pos2 = desc.strExtraConfig.find("channel=");
3297 if (pos1 != Utf8Str::npos)
3298 {
3299 int32_t lControllerIndex = -1;
3300 RTStrToInt32Ex(desc.strExtraConfig.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
3301 if (lControllerIndex == lIDEControllerIndex)
3302 ulParent = idIDEController;
3303 else if (lControllerIndex == lSCSIControllerIndex)
3304 ulParent = idSCSIController;
3305 else if (lControllerIndex == lSATAControllerIndex)
3306 ulParent = idSATAController;
3307 }
3308 if (pos2 != Utf8Str::npos)
3309 RTStrToInt32Ex(desc.strExtraConfig.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
3310
3311 if ( !ulParent
3312 || lAddressOnParent == -1
3313 )
3314 throw setError(VBOX_E_NOT_SUPPORTED,
3315 tr("Missing or bad extra config string in hard disk image: \"%s\""), desc.strExtraConfig.c_str());
3316
3317 mapDisks[strDiskID] = &desc;
3318 }
3319 break;
3320
3321 case VirtualSystemDescriptionType_Floppy:
3322 if (uLoop == 1)
3323 {
3324 strDescription = "Floppy Drive";
3325 strCaption = "floppy0"; // this is what OVFTool writes
3326 type = OVFResourceType_FloppyDrive; // 14
3327 lAutomaticAllocation = 0;
3328 lAddressOnParent = 0; // this is what OVFTool writes
3329 }
3330 break;
3331
3332 case VirtualSystemDescriptionType_CDROM:
3333 if (uLoop == 2)
3334 {
3335 // we can't have a CD without an IDE controller
3336 if (!idIDEController)
3337 throw setError(VBOX_E_NOT_SUPPORTED,
3338 tr("Can't have CD-ROM without IDE controller"));
3339
3340 strDescription = "CD-ROM Drive";
3341 strCaption = "cdrom1"; // this is what OVFTool writes
3342 type = OVFResourceType_CDDrive; // 15
3343 lAutomaticAllocation = 1;
3344 ulParent = idIDEController;
3345 lAddressOnParent = 0; // this is what OVFTool writes
3346 }
3347 break;
3348
3349 case VirtualSystemDescriptionType_NetworkAdapter:
3350 /* <Item>
3351 <rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
3352 <rasd:Caption>Ethernet adapter on 'VM Network'</rasd:Caption>
3353 <rasd:Connection>VM Network</rasd:Connection>
3354 <rasd:ElementName>VM network</rasd:ElementName>
3355 <rasd:InstanceID>3</rasd:InstanceID>
3356 <rasd:ResourceType>10</rasd:ResourceType>
3357 </Item> */
3358 if (uLoop == 1)
3359 {
3360 lAutomaticAllocation = 1;
3361 strCaption = Utf8StrFmt("Ethernet adapter on '%s'", desc.strOvf.c_str());
3362 type = OVFResourceType_EthernetAdapter; // 10
3363 /* Set the hardware type to something useful.
3364 * To be compatible with vmware & others we set
3365 * PCNet32 for our PCNet types & E1000 for the
3366 * E1000 cards. */
3367 switch (desc.strVbox.toInt32())
3368 {
3369 case NetworkAdapterType_Am79C970A:
3370 case NetworkAdapterType_Am79C973: strResourceSubType = "PCNet32"; break;
3371#ifdef VBOX_WITH_E1000
3372 case NetworkAdapterType_I82540EM:
3373 case NetworkAdapterType_I82545EM:
3374 case NetworkAdapterType_I82543GC: strResourceSubType = "E1000"; break;
3375#endif /* VBOX_WITH_E1000 */
3376 }
3377 strConnection = desc.strOvf;
3378
3379 mapNetworks[desc.strOvf] = true;
3380 }
3381 break;
3382
3383 case VirtualSystemDescriptionType_USBController:
3384 /* <Item ovf:required="false">
3385 <rasd:Caption>usb</rasd:Caption>
3386 <rasd:Description>USB Controller</rasd:Description>
3387 <rasd:InstanceId>3</rasd:InstanceId>
3388 <rasd:ResourceType>23</rasd:ResourceType>
3389 <rasd:Address>0</rasd:Address>
3390 <rasd:BusNumber>0</rasd:BusNumber>
3391 </Item> */
3392 if (uLoop == 1)
3393 {
3394 strDescription = "USB Controller";
3395 strCaption = "usb";
3396 type = OVFResourceType_USBController; // 23
3397 lAddress = 0; // this is what OVFTool writes
3398 lBusNumber = 0; // this is what OVFTool writes
3399 }
3400 break;
3401
3402 case VirtualSystemDescriptionType_SoundCard:
3403 /* <Item ovf:required="false">
3404 <rasd:Caption>sound</rasd:Caption>
3405 <rasd:Description>Sound Card</rasd:Description>
3406 <rasd:InstanceId>10</rasd:InstanceId>
3407 <rasd:ResourceType>35</rasd:ResourceType>
3408 <rasd:ResourceSubType>ensoniq1371</rasd:ResourceSubType>
3409 <rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
3410 <rasd:AddressOnParent>3</rasd:AddressOnParent>
3411 </Item> */
3412 if (uLoop == 1)
3413 {
3414 strDescription = "Sound Card";
3415 strCaption = "sound";
3416 type = OVFResourceType_SoundCard; // 35
3417 strResourceSubType = desc.strOvf; // e.g. ensoniq1371
3418 lAutomaticAllocation = 0;
3419 lAddressOnParent = 3; // what gives? this is what OVFTool writes
3420 }
3421 break;
3422 }
3423
3424 if (type)
3425 {
3426 xml::ElementNode *pItem;
3427
3428 pItem = pelmVirtualHardwareSection->createChild("Item");
3429
3430 // NOTE: do not change the order of these items without good reason! While we don't care
3431 // about ordering, VMware's ovftool does and fails if the items are not written in
3432 // exactly this order, as stupid as it seems.
3433
3434 if (!strCaption.isEmpty())
3435 {
3436 pItem->createChild("rasd:Caption")->addContent(strCaption);
3437 if (pTask->enFormat == TaskWriteOVF::OVF_1_0)
3438 pItem->createChild("rasd:ElementName")->addContent(strCaption);
3439 }
3440
3441 if (!strDescription.isEmpty())
3442 pItem->createChild("rasd:Description")->addContent(strDescription);
3443
3444 // <rasd:InstanceID>1</rasd:InstanceID>
3445 xml::ElementNode *pelmInstanceID;
3446 if (pTask->enFormat == TaskWriteOVF::OVF_0_9)
3447 pelmInstanceID = pItem->createChild("rasd:InstanceId");
3448 else
3449 pelmInstanceID = pItem->createChild("rasd:InstanceID"); // capitalization changed...
3450 pelmInstanceID->addContent(Utf8StrFmt("%d", ulInstanceID++));
3451
3452 // <rasd:ResourceType>3</rasd:ResourceType>
3453 pItem->createChild("rasd:ResourceType")->addContent(Utf8StrFmt("%d", type));
3454 if (!strResourceSubType.isEmpty())
3455 pItem->createChild("rasd:ResourceSubType")->addContent(strResourceSubType);
3456
3457 if (!strHostResource.isEmpty())
3458 pItem->createChild("rasd:HostResource")->addContent(strHostResource);
3459
3460 if (!strAllocationUnits.isEmpty())
3461 pItem->createChild("rasd:AllocationUnits")->addContent(strAllocationUnits);
3462
3463 // <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
3464 if (lVirtualQuantity != -1)
3465 pItem->createChild("rasd:VirtualQuantity")->addContent(Utf8StrFmt("%d", lVirtualQuantity));
3466
3467 if (lAutomaticAllocation != -1)
3468 pItem->createChild("rasd:AutomaticAllocation")->addContent( (lAutomaticAllocation) ? "true" : "false" );
3469
3470 if (!strConnection.isEmpty())
3471 pItem->createChild("rasd:Connection")->addContent(strConnection);
3472
3473 if (lAddress != -1)
3474 pItem->createChild("rasd:Address")->addContent(Utf8StrFmt("%d", lAddress));
3475
3476 if (lBusNumber != -1)
3477 if (pTask->enFormat == TaskWriteOVF::OVF_0_9) // BusNumber is invalid OVF 1.0 so only write it in 0.9 mode for OVFTool compatibility
3478 pItem->createChild("rasd:BusNumber")->addContent(Utf8StrFmt("%d", lBusNumber));
3479
3480 if (ulParent)
3481 pItem->createChild("rasd:Parent")->addContent(Utf8StrFmt("%d", ulParent));
3482 if (lAddressOnParent != -1)
3483 pItem->createChild("rasd:AddressOnParent")->addContent(Utf8StrFmt("%d", lAddressOnParent));
3484 }
3485 }
3486 } // for (size_t uLoop = 0; ...
3487 }
3488
3489 // finally, fill in the network section we set up empty above according
3490 // to the networks we found with the hardware items
3491 map<Utf8Str, bool>::const_iterator itN;
3492 for (itN = mapNetworks.begin();
3493 itN != mapNetworks.end();
3494 ++itN)
3495 {
3496 const Utf8Str &strNetwork = itN->first;
3497 xml::ElementNode *pelmNetwork = pelmNetworkSection->createChild("Network");
3498 pelmNetwork->setAttribute("ovf:name", strNetwork.c_str());
3499 pelmNetwork->createChild("Description")->addContent("Logical network used by this appliance.");
3500 }
3501
3502 map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;
3503 uint32_t ulFile = 1;
3504 for (itS = mapDisks.begin();
3505 itS != mapDisks.end();
3506 ++itS)
3507 {
3508 const Utf8Str &strDiskID = itS->first;
3509 const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;
3510
3511 // source path: where the VBox image is
3512 const Utf8Str &strSrcFilePath = pDiskEntry->strVbox;
3513 Bstr bstrSrcFilePath(strSrcFilePath);
3514 if (!RTPathExists(strSrcFilePath.c_str()))
3515 /* This isn't allowed */
3516 throw setError(VBOX_E_FILE_ERROR,
3517 tr("Source virtual disk image file '%s' doesn't exist"),
3518 strSrcFilePath.c_str());
3519
3520 // output filename
3521 const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
3522 // target path needs to be composed from where the output OVF is
3523 Utf8Str strTargetFilePath = stripFilename(m->strPath);
3524 strTargetFilePath.append("/");
3525 strTargetFilePath.append(strTargetFileNameOnly);
3526
3527 // clone the disk:
3528 ComPtr<IHardDisk> pSourceDisk;
3529 ComPtr<IHardDisk> pTargetDisk;
3530 ComPtr<IProgress> pProgress2;
3531
3532 Log(("Finding source disk \"%ls\"\n", bstrSrcFilePath.raw()));
3533 rc = mVirtualBox->FindHardDisk(bstrSrcFilePath, pSourceDisk.asOutParam());
3534 if (FAILED(rc)) throw rc;
3535
3536 /* We are always exporting to vmdfk stream optimized for now */
3537 Bstr bstrSrcFormat = L"VMDK";
3538
3539 // create a new hard disk interface for the destination disk image
3540 Log(("Creating target disk \"%s\"\n", strTargetFilePath.raw()));
3541 rc = mVirtualBox->CreateHardDisk(bstrSrcFormat, Bstr(strTargetFilePath), pTargetDisk.asOutParam());
3542 if (FAILED(rc)) throw rc;
3543
3544 // the target disk is now registered and needs to be removed again,
3545 // both after successful cloning or if anything goes bad!
3546 try
3547 {
3548 // create a flat copy of the source disk image
3549 rc = pSourceDisk->CloneTo(pTargetDisk, HardDiskVariant_VmdkStreamOptimized, NULL, pProgress2.asOutParam());
3550 if (FAILED(rc)) throw rc;
3551
3552 // advance to the next operation
3553 if (!pTask->progress.isNull())
3554 pTask->progress->setNextOperation(BstrFmt(tr("Exporting virtual disk image '%s'"), strSrcFilePath.c_str()),
3555 pDiskEntry->ulSizeMB); // operation's weight, as set up with the IProgress originally);
3556
3557 // now wait for the background disk operation to complete; this throws HRESULTs on error
3558 waitForAsyncProgress(pTask->progress, pProgress2);
3559 }
3560 catch (HRESULT rc3)
3561 {
3562 // upon error after registering, close the disk or
3563 // it'll stick in the registry forever
3564 pTargetDisk->Close();
3565 throw;
3566 }
3567
3568 // we need the following for the XML
3569 uint64_t cbFile = 0; // actual file size
3570 rc = pTargetDisk->COMGETTER(Size)(&cbFile);
3571 if (FAILED(rc)) throw rc;
3572
3573 ULONG64 cbCapacity = 0; // size reported to guest
3574 rc = pTargetDisk->COMGETTER(LogicalSize)(&cbCapacity);
3575 if (FAILED(rc)) throw rc;
3576 // capacity is reported in megabytes, so...
3577 cbCapacity *= _1M;
3578
3579 // upon success, close the disk as well
3580 rc = pTargetDisk->Close();
3581 if (FAILED(rc)) throw rc;
3582
3583 // now handle the XML for the disk:
3584 Utf8StrFmt strFileRef("file%RI32", ulFile++);
3585 // <File ovf:href="WindowsXpProfessional-disk1.vmdk" ovf:id="file1" ovf:size="1710381056"/>
3586 xml::ElementNode *pelmFile = pelmReferences->createChild("File");
3587 pelmFile->setAttribute("ovf:href", strTargetFileNameOnly);
3588 pelmFile->setAttribute("ovf:id", strFileRef);
3589 pelmFile->setAttribute("ovf:size", Utf8StrFmt("%RI64", cbFile).c_str());
3590
3591 // add disk to XML Disks section
3592 // <Disk ovf:capacity="8589934592" ovf:diskId="vmdisk1" ovf:fileRef="file1" ovf:format="http://www.vmware.com/specifications/vmdk.html#sparse"/>
3593 xml::ElementNode *pelmDisk = pelmDiskSection->createChild("Disk");
3594 pelmDisk->setAttribute("ovf:capacity", Utf8StrFmt("%RI64", cbCapacity).c_str());
3595 pelmDisk->setAttribute("ovf:diskId", strDiskID);
3596 pelmDisk->setAttribute("ovf:fileRef", strFileRef);
3597 pelmDisk->setAttribute("ovf:format", "http://www.vmware.com/specifications/vmdk.html#sparse"); // must be sparse or ovftool chokes
3598 }
3599
3600 // now go write the XML
3601 xml::XmlFileWriter writer(doc);
3602 writer.write(m->strPath.c_str());
3603 }
3604 catch(xml::Error &x)
3605 {
3606 rc = setError(VBOX_E_FILE_ERROR,
3607 x.what());
3608 }
3609 catch(HRESULT aRC)
3610 {
3611 rc = aRC;
3612 }
3613
3614 pTask->rc = rc;
3615
3616 if (!pTask->progress.isNull())
3617 pTask->progress->notifyComplete(rc);
3618
3619 LogFlowFunc(("rc=%Rhrc\n", rc));
3620 LogFlowFuncLeave();
3621
3622 return VINF_SUCCESS;
3623}
3624
3625/**
3626 * Worker thread implementation for Upload() (ovf uploader).
3627 * @param aThread
3628 * @param pvUser
3629 */
3630/* static */
3631int Appliance::writeS3(TaskWriteOVF *pTask)
3632{
3633 LogFlowFuncEnter();
3634 LogFlowFunc(("Appliance %p\n", this));
3635
3636 AutoCaller autoCaller(this);
3637 CheckComRCReturnRC(autoCaller.rc());
3638
3639 HRESULT rc = S_OK;
3640
3641 AutoWriteLock appLock(this);
3642
3643 /* Buckets are S3 specific. So parse the bucket out of the file path */
3644 Utf8Str tmpPath = pTask->filepath;
3645 if (!tmpPath.startsWith("/"))
3646 return setError(E_INVALIDARG,
3647 tr("The path '%s' must start with /"), tmpPath.c_str());
3648 Utf8Str bucket;
3649 size_t bpos = tmpPath.find("/", 1);
3650 if (bpos != Utf8Str::npos)
3651 {
3652 bucket = tmpPath.substr(1, bpos - 1); /* The bucket without any slashes */
3653 tmpPath = tmpPath.substr(bpos); /* The rest of the file path */
3654 }
3655 /* If there is no bucket name provided reject the upload */
3656 if (bucket.isEmpty())
3657 return setError(E_INVALIDARG,
3658 tr("You doesn't provide a bucket name in the URI"), tmpPath.c_str());
3659
3660 int vrc = VINF_SUCCESS;
3661 RTS3 hS3 = NULL;
3662 char szOSTmpDir[RTPATH_MAX];
3663 RTPathTemp(szOSTmpDir, sizeof(szOSTmpDir));
3664 /* The template for the temporary directory created below */
3665 char *pszTmpDir;
3666 RTStrAPrintf(&pszTmpDir, "%s"RTPATH_SLASH_STR"vbox-ovf-XXXXXX", szOSTmpDir);
3667 list< pair<Utf8Str, ULONG> > filesList;
3668
3669 // todo:
3670 // - getting the tmp directory (especially on win)
3671 // - usable error codes
3672 // - seems snapshot filenames are problematic {uuid}.vdi
3673 try
3674 {
3675 /* We need a temporary directory which we can put the OVF file & all
3676 * disk images in */
3677 vrc = RTDirCreateTemp(pszTmpDir);
3678 if (RT_FAILURE(rc))
3679 throw setError(VBOX_E_FILE_ERROR,
3680 tr("Cannot create temporary directory '%s'"), pszTmpDir);
3681
3682 /* The temporary name of the target OVF file */
3683 Utf8StrFmt strTmpOvf("%s/%s", pszTmpDir, RTPathFilename(tmpPath));
3684
3685 /* Prepare the temporary writing of the OVF */
3686 ComObjPtr<Progress> progress;
3687 rc = writeImpl(pTask->enFormat, strTmpOvf.c_str(), progress);
3688 if (FAILED(rc)) throw rc;
3689
3690 /* Unlock the appliance for the writing thread */
3691 appLock.unlock();
3692 /* Wait until the writing is done, but report the progress back to the
3693 caller */
3694 ComPtr<IProgress> progressInt(progress);
3695 waitForAsyncProgress(pTask->progress, progressInt); /* Any errors will be thrown */
3696
3697 /* Again lock the appliance for the next steps */
3698 appLock.lock();
3699
3700 vrc = RTPathExists(strTmpOvf.c_str()); /* Paranoid check */
3701 if(RT_FAILURE(vrc))
3702 throw setError(VBOX_E_FILE_ERROR,
3703 tr("Cannot find source file '%s'"), strTmpOvf.c_str());
3704 /* Add the OVF file */
3705 filesList.push_back(pair<Utf8Str, ULONG>(strTmpOvf, m->ulWeightPerOperation)); /* Use 1% of the total for the OVF file upload */
3706
3707 /* Now add every disks of every virtual system */
3708 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
3709 for (it = m->virtualSystemDescriptions.begin();
3710 it != m->virtualSystemDescriptions.end();
3711 ++it)
3712 {
3713 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
3714 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
3715 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
3716 for (itH = avsdeHDs.begin();
3717 itH != avsdeHDs.end();
3718 ++itH)
3719 {
3720 const Utf8Str &strTargetFileNameOnly = (*itH)->strOvf;
3721 /* Target path needs to be composed from where the output OVF is */
3722 Utf8Str strTargetFilePath = stripFilename(m->strPath);
3723 strTargetFilePath.append("/");
3724 strTargetFilePath.append(strTargetFileNameOnly);
3725 vrc = RTPathExists(strTargetFilePath.c_str()); /* Paranoid check */
3726 if(RT_FAILURE(vrc))
3727 throw setError(VBOX_E_FILE_ERROR,
3728 tr("Cannot find source file '%s'"), strTargetFilePath.c_str());
3729 filesList.push_back(pair<Utf8Str, ULONG>(strTargetFilePath, (*itH)->ulSizeMB));
3730 }
3731 }
3732 /* Next we have to upload the OVF & all disk images */
3733 vrc = RTS3Create(&hS3, pTask->username.c_str(), pTask->password.c_str(), pTask->hostname.c_str(), "virtualbox-agent/"VBOX_VERSION_STRING);
3734 if(RT_FAILURE(vrc))
3735 throw setError(VBOX_E_IPRT_ERROR,
3736 tr("Cannot create S3 service handler"));
3737 RTS3SetProgressCallback(hS3, pTask->uploadProgress, &pTask);
3738
3739 /* Upload all files */
3740 for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
3741 {
3742 const pair<Utf8Str, ULONG> &s = (*it1);
3743 char *pszFilename = RTPathFilename(s.first.c_str());
3744 /* Advance to the next operation */
3745 if (!pTask->progress.isNull())
3746 pTask->progress->setNextOperation(BstrFmt(tr("Uploading file '%s'"), pszFilename), s.second);
3747 vrc = RTS3PutKey(hS3, bucket.c_str(), pszFilename, s.first.c_str());
3748 if (RT_FAILURE(vrc))
3749 {
3750 if(vrc == VERR_S3_CANCELED)
3751 break;
3752 else if(vrc == VERR_S3_ACCESS_DENIED)
3753 throw setError(E_ACCESSDENIED,
3754 tr("Cannot upload file '%s' to S3 storage server (Access denied)"), pszFilename);
3755 else if(vrc == VERR_S3_NOT_FOUND)
3756 throw setError(VBOX_E_FILE_ERROR,
3757 tr("Cannot upload file '%s' to S3 storage server (File not found)"), pszFilename);
3758 else
3759 throw setError(VBOX_E_IPRT_ERROR,
3760 tr("Cannot upload file '%s' to S3 storage server (%Rrc)"), pszFilename, vrc);
3761 }
3762 }
3763
3764 }
3765 catch(HRESULT aRC)
3766 {
3767 rc = aRC;
3768 }
3769 /* Cleanup */
3770 if (hS3)
3771 RTS3Destroy(hS3);
3772 /* Delete all files which where temporary created */
3773 for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
3774 {
3775 const pair<Utf8Str, ULONG> &s = (*it1);
3776 vrc = RTFileDelete(s.first.c_str());
3777 if(RT_FAILURE(vrc))
3778 rc = setError(VBOX_E_FILE_ERROR,
3779 tr("Cannot delete file '%s' (%Rrc)"), s.first.c_str(), vrc);
3780 }
3781 /* Delete the temporary directory */
3782 if (RTPathExists(pszTmpDir))
3783 {
3784 vrc = RTDirRemove(pszTmpDir);
3785 if(RT_FAILURE(vrc))
3786 rc = setError(VBOX_E_FILE_ERROR,
3787 tr("Cannot delete temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);
3788 }
3789 if (pszTmpDir)
3790 RTStrFree(pszTmpDir);
3791
3792 pTask->rc = rc;
3793
3794 if (!pTask->progress.isNull())
3795 pTask->progress->notifyComplete(rc);
3796
3797 LogFlowFunc(("rc=%Rhrc\n", rc));
3798 LogFlowFuncLeave();
3799
3800 return VINF_SUCCESS;
3801}
3802
3803/**
3804* Public method implementation.
3805 * @return
3806 */
3807STDMETHODIMP Appliance::GetWarnings(ComSafeArrayOut(BSTR, aWarnings))
3808{
3809 if (ComSafeArrayOutIsNull(aWarnings))
3810 return E_POINTER;
3811
3812 AutoCaller autoCaller(this);
3813 CheckComRCReturnRC(autoCaller.rc());
3814
3815 AutoReadLock alock(this);
3816
3817 com::SafeArray<BSTR> sfaWarnings(m->llWarnings.size());
3818
3819 list<Utf8Str>::const_iterator it;
3820 size_t i = 0;
3821 for (it = m->llWarnings.begin();
3822 it != m->llWarnings.end();
3823 ++it, ++i)
3824 {
3825 Bstr bstr = *it;
3826 bstr.cloneTo(&sfaWarnings[i]);
3827 }
3828
3829 sfaWarnings.detachTo(ComSafeArrayOutArg(aWarnings));
3830
3831 return S_OK;
3832}
3833
3834HRESULT Appliance::searchUniqueVMName(Utf8Str& aName) const
3835{
3836 IMachine *machine = NULL;
3837 char *tmpName = RTStrDup(aName.c_str());
3838 int i = 1;
3839 /* @todo: Maybe too cost-intensive; try to find a lighter way */
3840 while (mVirtualBox->FindMachine(Bstr(tmpName), &machine) != VBOX_E_OBJECT_NOT_FOUND)
3841 {
3842 RTStrFree(tmpName);
3843 RTStrAPrintf(&tmpName, "%s_%d", aName.c_str(), i);
3844 ++i;
3845 }
3846 aName = tmpName;
3847 RTStrFree(tmpName);
3848
3849 return S_OK;
3850}
3851
3852HRESULT Appliance::searchUniqueDiskImageFilePath(Utf8Str& aName) const
3853{
3854 IHardDisk *harddisk = NULL;
3855 char *tmpName = RTStrDup(aName.c_str());
3856 int i = 1;
3857 /* Check if the file exists or if a file with this path is registered
3858 * already */
3859 /* @todo: Maybe too cost-intensive; try to find a lighter way */
3860 while (RTPathExists(tmpName) ||
3861 mVirtualBox->FindHardDisk(Bstr(tmpName), &harddisk) != VBOX_E_OBJECT_NOT_FOUND)
3862 {
3863 RTStrFree(tmpName);
3864 char *tmpDir = RTStrDup(aName.c_str());
3865 RTPathStripFilename(tmpDir);;
3866 char *tmpFile = RTStrDup(RTPathFilename(aName.c_str()));
3867 RTPathStripExt(tmpFile);
3868 const char *tmpExt = RTPathExt(aName.c_str());
3869 RTStrAPrintf(&tmpName, "%s%c%s_%d%s", tmpDir, RTPATH_DELIMITER, tmpFile, i, tmpExt);
3870 RTStrFree(tmpFile);
3871 RTStrFree(tmpDir);
3872 ++i;
3873 }
3874 aName = tmpName;
3875 RTStrFree(tmpName);
3876
3877 return S_OK;
3878}
3879
3880/**
3881 * Sets up the given progress object so that it represents disk images accurately
3882 * during importMachines() and write().
3883 * @param pProgress
3884 * @param bstrDescription
3885 * @return
3886 */
3887HRESULT Appliance::setUpProgress(ComObjPtr<Progress> &pProgress, const Bstr &bstrDescription)
3888{
3889 HRESULT rc;
3890
3891 /* Create the progress object */
3892 pProgress.createObject();
3893
3894 // weigh the disk images according to their sizes
3895 uint32_t ulTotalMB = 0;
3896 uint32_t cDisks = 0;
3897 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
3898 for (it = m->virtualSystemDescriptions.begin();
3899 it != m->virtualSystemDescriptions.end();
3900 ++it)
3901 {
3902 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
3903 /* One for every hard disk of the Virtual System */
3904 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
3905 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
3906 for (itH = avsdeHDs.begin();
3907 itH != avsdeHDs.end();
3908 ++itH)
3909 {
3910 const VirtualSystemDescriptionEntry *pHD = *itH;
3911 ulTotalMB += pHD->ulSizeMB;
3912 ++cDisks;
3913 }
3914 }
3915
3916 ULONG cOperations = 1 + cDisks; // one op per disk plus 1 for the XML
3917
3918 ULONG ulTotalOperationsWeight;
3919 if (ulTotalMB)
3920 {
3921 m->ulWeightPerOperation = (ULONG)((double)ulTotalMB * 1 / 100); // use 1% of the progress for the XML
3922 ulTotalOperationsWeight = ulTotalMB + m->ulWeightPerOperation;
3923 }
3924 else
3925 {
3926 // no disks to export:
3927 ulTotalOperationsWeight = 1;
3928 m->ulWeightPerOperation = 1;
3929 }
3930
3931 Log(("Setting up progress object: ulTotalMB = %d, cDisks = %d, => cOperations = %d, ulTotalOperationsWeight = %d, m->ulWeightPerOperation = %d\n",
3932 ulTotalMB, cDisks, cOperations, ulTotalOperationsWeight, m->ulWeightPerOperation));
3933
3934 rc = pProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
3935 bstrDescription,
3936 TRUE /* aCancelable */,
3937 cOperations, // ULONG cOperations,
3938 ulTotalOperationsWeight, // ULONG ulTotalOperationsWeight,
3939 bstrDescription, // CBSTR bstrFirstOperationDescription,
3940 m->ulWeightPerOperation); // ULONG ulFirstOperationWeight,
3941 return rc;
3942}
3943
3944HRESULT Appliance::setUpProgressUpload(ComObjPtr<Progress> &pProgress, const Bstr &bstrDescription)
3945{
3946 HRESULT rc;
3947
3948 /* Create the progress object */
3949 pProgress.createObject();
3950
3951 // weigh the disk images according to their sizes
3952 uint32_t ulTotalMB = 0;
3953 uint32_t cDisks = 0;
3954 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
3955 for (it = m->virtualSystemDescriptions.begin();
3956 it != m->virtualSystemDescriptions.end();
3957 ++it)
3958 {
3959 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
3960 /* One for every hard disk of the Virtual System */
3961 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
3962 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
3963 for (itH = avsdeHDs.begin();
3964 itH != avsdeHDs.end();
3965 ++itH)
3966 {
3967 const VirtualSystemDescriptionEntry *pHD = *itH;
3968 ulTotalMB += pHD->ulSizeMB;
3969 ++cDisks;
3970 }
3971 }
3972
3973 ULONG cOperations = 1 + 1 + cDisks; // one op per disk plus 1 for the OVF & 1 plus to the temporary creation */
3974
3975 ULONG ulTotalOperationsWeight;
3976 if (ulTotalMB)
3977 {
3978 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)
3979 ulTotalOperationsWeight = ulTotalMB + m->ulWeightPerOperation;
3980 }
3981 else
3982 {
3983 // no disks to export:
3984 ulTotalOperationsWeight = 1;
3985 m->ulWeightPerOperation = 1;
3986 }
3987 ULONG ulOVFCreationWeight = ((double)ulTotalOperationsWeight * 50.0 / 100.0); /* Use 50% for the creation of the OVF & the disks */
3988 ulTotalOperationsWeight += ulOVFCreationWeight;
3989
3990 Log(("Setting up progress object: ulTotalMB = %d, cDisks = %d, => cOperations = %d, ulTotalOperationsWeight = %d, m->ulWeightPerOperation = %d\n",
3991 ulTotalMB, cDisks, cOperations, ulTotalOperationsWeight, m->ulWeightPerOperation));
3992
3993 rc = pProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
3994 bstrDescription,
3995 TRUE /* aCancelable */,
3996 cOperations, // ULONG cOperations,
3997 ulTotalOperationsWeight, // ULONG ulTotalOperationsWeight,
3998 bstrDescription, // CBSTR bstrFirstOperationDescription,
3999 ulOVFCreationWeight); // ULONG ulFirstOperationWeight,
4000 return rc;
4001}
4002
4003/**
4004 * Called from the import and export background threads to synchronize the second
4005 * background disk thread's progress object with the current progress object so
4006 * that the user interface sees progress correctly and that cancel signals are
4007 * passed on to the second thread.
4008 * @param pProgressThis Progress object of the current thread.
4009 * @param pProgressAsync Progress object of asynchronous task running in background.
4010 */
4011void Appliance::waitForAsyncProgress(ComObjPtr<Progress> &pProgressThis,
4012 ComPtr<IProgress> &pProgressAsync)
4013{
4014 HRESULT rc;
4015
4016 // now loop until the asynchronous operation completes and then report its result
4017 BOOL fCompleted;
4018 BOOL fCanceled;
4019 ULONG currentPercent;
4020 while (SUCCEEDED(pProgressAsync->COMGETTER(Completed(&fCompleted))))
4021 {
4022 rc = pProgressThis->COMGETTER(Canceled)(&fCanceled);
4023 if (FAILED(rc)) throw rc;
4024 if (fCanceled)
4025 {
4026 pProgressAsync->Cancel();
4027 break;
4028 }
4029
4030 rc = pProgressAsync->COMGETTER(Percent(&currentPercent));
4031 if (FAILED(rc)) throw rc;
4032 if (!pProgressThis.isNull())
4033 pProgressThis->setCurrentOperationProgress(currentPercent);
4034 if (fCompleted)
4035 break;
4036
4037 /* Make sure the loop is not too tight */
4038 rc = pProgressAsync->WaitForCompletion(100);
4039 if (FAILED(rc)) throw rc;
4040 }
4041 // report result of asynchronous operation
4042 LONG iRc;
4043 rc = pProgressAsync->COMGETTER(ResultCode)(&iRc);
4044 if (FAILED(rc)) throw rc;
4045
4046
4047 // if the thread of the progress object has an error, then
4048 // retrieve the error info from there, or it'll be lost
4049 if (FAILED(iRc))
4050 {
4051 ProgressErrorInfo info(pProgressAsync);
4052 Utf8Str str(info.getText());
4053 const char *pcsz = str.c_str();
4054 HRESULT rc2 = setError(iRc, pcsz);
4055 throw rc2;
4056 }
4057}
4058
4059void Appliance::addWarning(const char* aWarning, ...)
4060{
4061 va_list args;
4062 va_start(args, aWarning);
4063 Utf8StrFmtVA str(aWarning, args);
4064 va_end(args);
4065 m->llWarnings.push_back(str);
4066}
4067
4068////////////////////////////////////////////////////////////////////////////////
4069//
4070// IVirtualSystemDescription constructor / destructor
4071//
4072////////////////////////////////////////////////////////////////////////////////
4073
4074DEFINE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
4075struct shutup3 {};
4076
4077/**
4078 * COM initializer.
4079 * @return
4080 */
4081HRESULT VirtualSystemDescription::init()
4082{
4083 /* Enclose the state transition NotReady->InInit->Ready */
4084 AutoInitSpan autoInitSpan(this);
4085 AssertReturn(autoInitSpan.isOk(), E_FAIL);
4086
4087 /* Initialize data */
4088 m = new Data();
4089
4090 /* Confirm a successful initialization */
4091 autoInitSpan.setSucceeded();
4092 return S_OK;
4093}
4094
4095/**
4096* COM uninitializer.
4097*/
4098
4099void VirtualSystemDescription::uninit()
4100{
4101 delete m;
4102 m = NULL;
4103}
4104
4105////////////////////////////////////////////////////////////////////////////////
4106//
4107// IVirtualSystemDescription public methods
4108//
4109////////////////////////////////////////////////////////////////////////////////
4110
4111/**
4112 * Public method implementation.
4113 * @param
4114 * @return
4115 */
4116STDMETHODIMP VirtualSystemDescription::COMGETTER(Count)(ULONG *aCount)
4117{
4118 if (!aCount)
4119 return E_POINTER;
4120
4121 AutoCaller autoCaller(this);
4122 CheckComRCReturnRC(autoCaller.rc());
4123
4124 AutoReadLock alock(this);
4125
4126 *aCount = (ULONG)m->llDescriptions.size();
4127
4128 return S_OK;
4129}
4130
4131/**
4132 * Public method implementation.
4133 * @return
4134 */
4135STDMETHODIMP VirtualSystemDescription::GetDescription(ComSafeArrayOut(VirtualSystemDescriptionType_T, aTypes),
4136 ComSafeArrayOut(BSTR, aRefs),
4137 ComSafeArrayOut(BSTR, aOrigValues),
4138 ComSafeArrayOut(BSTR, aVboxValues),
4139 ComSafeArrayOut(BSTR, aExtraConfigValues))
4140{
4141 if (ComSafeArrayOutIsNull(aTypes) ||
4142 ComSafeArrayOutIsNull(aRefs) ||
4143 ComSafeArrayOutIsNull(aOrigValues) ||
4144 ComSafeArrayOutIsNull(aVboxValues) ||
4145 ComSafeArrayOutIsNull(aExtraConfigValues))
4146 return E_POINTER;
4147
4148 AutoCaller autoCaller(this);
4149 CheckComRCReturnRC(autoCaller.rc());
4150
4151 AutoReadLock alock(this);
4152
4153 ULONG c = (ULONG)m->llDescriptions.size();
4154 com::SafeArray<VirtualSystemDescriptionType_T> sfaTypes(c);
4155 com::SafeArray<BSTR> sfaRefs(c);
4156 com::SafeArray<BSTR> sfaOrigValues(c);
4157 com::SafeArray<BSTR> sfaVboxValues(c);
4158 com::SafeArray<BSTR> sfaExtraConfigValues(c);
4159
4160 list<VirtualSystemDescriptionEntry>::const_iterator it;
4161 size_t i = 0;
4162 for (it = m->llDescriptions.begin();
4163 it != m->llDescriptions.end();
4164 ++it, ++i)
4165 {
4166 const VirtualSystemDescriptionEntry &vsde = (*it);
4167
4168 sfaTypes[i] = vsde.type;
4169
4170 Bstr bstr = vsde.strRef;
4171 bstr.cloneTo(&sfaRefs[i]);
4172
4173 bstr = vsde.strOvf;
4174 bstr.cloneTo(&sfaOrigValues[i]);
4175
4176 bstr = vsde.strVbox;
4177 bstr.cloneTo(&sfaVboxValues[i]);
4178
4179 bstr = vsde.strExtraConfig;
4180 bstr.cloneTo(&sfaExtraConfigValues[i]);
4181 }
4182
4183 sfaTypes.detachTo(ComSafeArrayOutArg(aTypes));
4184 sfaRefs.detachTo(ComSafeArrayOutArg(aRefs));
4185 sfaOrigValues.detachTo(ComSafeArrayOutArg(aOrigValues));
4186 sfaVboxValues.detachTo(ComSafeArrayOutArg(aVboxValues));
4187 sfaExtraConfigValues.detachTo(ComSafeArrayOutArg(aExtraConfigValues));
4188
4189 return S_OK;
4190}
4191
4192/**
4193 * Public method implementation.
4194 * @return
4195 */
4196STDMETHODIMP VirtualSystemDescription::GetDescriptionByType(VirtualSystemDescriptionType_T aType,
4197 ComSafeArrayOut(VirtualSystemDescriptionType_T, aTypes),
4198 ComSafeArrayOut(BSTR, aRefs),
4199 ComSafeArrayOut(BSTR, aOrigValues),
4200 ComSafeArrayOut(BSTR, aVboxValues),
4201 ComSafeArrayOut(BSTR, aExtraConfigValues))
4202{
4203 if (ComSafeArrayOutIsNull(aTypes) ||
4204 ComSafeArrayOutIsNull(aRefs) ||
4205 ComSafeArrayOutIsNull(aOrigValues) ||
4206 ComSafeArrayOutIsNull(aVboxValues) ||
4207 ComSafeArrayOutIsNull(aExtraConfigValues))
4208 return E_POINTER;
4209
4210 AutoCaller autoCaller(this);
4211 CheckComRCReturnRC(autoCaller.rc());
4212
4213 AutoReadLock alock(this);
4214
4215 std::list<VirtualSystemDescriptionEntry*> vsd = findByType (aType);
4216 ULONG c = (ULONG)vsd.size();
4217 com::SafeArray<VirtualSystemDescriptionType_T> sfaTypes(c);
4218 com::SafeArray<BSTR> sfaRefs(c);
4219 com::SafeArray<BSTR> sfaOrigValues(c);
4220 com::SafeArray<BSTR> sfaVboxValues(c);
4221 com::SafeArray<BSTR> sfaExtraConfigValues(c);
4222
4223 list<VirtualSystemDescriptionEntry*>::const_iterator it;
4224 size_t i = 0;
4225 for (it = vsd.begin();
4226 it != vsd.end();
4227 ++it, ++i)
4228 {
4229 const VirtualSystemDescriptionEntry *vsde = (*it);
4230
4231 sfaTypes[i] = vsde->type;
4232
4233 Bstr bstr = vsde->strRef;
4234 bstr.cloneTo(&sfaRefs[i]);
4235
4236 bstr = vsde->strOvf;
4237 bstr.cloneTo(&sfaOrigValues[i]);
4238
4239 bstr = vsde->strVbox;
4240 bstr.cloneTo(&sfaVboxValues[i]);
4241
4242 bstr = vsde->strExtraConfig;
4243 bstr.cloneTo(&sfaExtraConfigValues[i]);
4244 }
4245
4246 sfaTypes.detachTo(ComSafeArrayOutArg(aTypes));
4247 sfaRefs.detachTo(ComSafeArrayOutArg(aRefs));
4248 sfaOrigValues.detachTo(ComSafeArrayOutArg(aOrigValues));
4249 sfaVboxValues.detachTo(ComSafeArrayOutArg(aVboxValues));
4250 sfaExtraConfigValues.detachTo(ComSafeArrayOutArg(aExtraConfigValues));
4251
4252 return S_OK;
4253}
4254
4255/**
4256 * Public method implementation.
4257 * @return
4258 */
4259STDMETHODIMP VirtualSystemDescription::GetValuesByType(VirtualSystemDescriptionType_T aType,
4260 VirtualSystemDescriptionValueType_T aWhich,
4261 ComSafeArrayOut(BSTR, aValues))
4262{
4263 if (ComSafeArrayOutIsNull(aValues))
4264 return E_POINTER;
4265
4266 AutoCaller autoCaller(this);
4267 CheckComRCReturnRC(autoCaller.rc());
4268
4269 AutoReadLock alock(this);
4270
4271 std::list<VirtualSystemDescriptionEntry*> vsd = findByType (aType);
4272 com::SafeArray<BSTR> sfaValues((ULONG)vsd.size());
4273
4274 list<VirtualSystemDescriptionEntry*>::const_iterator it;
4275 size_t i = 0;
4276 for (it = vsd.begin();
4277 it != vsd.end();
4278 ++it, ++i)
4279 {
4280 const VirtualSystemDescriptionEntry *vsde = (*it);
4281
4282 Bstr bstr;
4283 switch (aWhich)
4284 {
4285 case VirtualSystemDescriptionValueType_Reference: bstr = vsde->strRef; break;
4286 case VirtualSystemDescriptionValueType_Original: bstr = vsde->strOvf; break;
4287 case VirtualSystemDescriptionValueType_Auto: bstr = vsde->strVbox; break;
4288 case VirtualSystemDescriptionValueType_ExtraConfig: bstr = vsde->strExtraConfig; break;
4289 }
4290
4291 bstr.cloneTo(&sfaValues[i]);
4292 }
4293
4294 sfaValues.detachTo(ComSafeArrayOutArg(aValues));
4295
4296 return S_OK;
4297}
4298
4299/**
4300 * Public method implementation.
4301 * @return
4302 */
4303STDMETHODIMP VirtualSystemDescription::SetFinalValues(ComSafeArrayIn(BOOL, aEnabled),
4304 ComSafeArrayIn(IN_BSTR, argVboxValues),
4305 ComSafeArrayIn(IN_BSTR, argExtraConfigValues))
4306{
4307#ifndef RT_OS_WINDOWS
4308 NOREF(aEnabledSize);
4309#endif /* RT_OS_WINDOWS */
4310
4311 CheckComArgSafeArrayNotNull(aEnabled);
4312 CheckComArgSafeArrayNotNull(argVboxValues);
4313 CheckComArgSafeArrayNotNull(argExtraConfigValues);
4314
4315 AutoCaller autoCaller(this);
4316 CheckComRCReturnRC(autoCaller.rc());
4317
4318 AutoWriteLock alock(this);
4319
4320 com::SafeArray<BOOL> sfaEnabled(ComSafeArrayInArg(aEnabled));
4321 com::SafeArray<IN_BSTR> sfaVboxValues(ComSafeArrayInArg(argVboxValues));
4322 com::SafeArray<IN_BSTR> sfaExtraConfigValues(ComSafeArrayInArg(argExtraConfigValues));
4323
4324 if ( (sfaEnabled.size() != m->llDescriptions.size())
4325 || (sfaVboxValues.size() != m->llDescriptions.size())
4326 || (sfaExtraConfigValues.size() != m->llDescriptions.size())
4327 )
4328 return E_INVALIDARG;
4329
4330 list<VirtualSystemDescriptionEntry>::iterator it;
4331 size_t i = 0;
4332 for (it = m->llDescriptions.begin();
4333 it != m->llDescriptions.end();
4334 ++it, ++i)
4335 {
4336 VirtualSystemDescriptionEntry& vsde = *it;
4337
4338 if (sfaEnabled[i])
4339 {
4340 vsde.strVbox = sfaVboxValues[i];
4341 vsde.strExtraConfig = sfaExtraConfigValues[i];
4342 }
4343 else
4344 vsde.type = VirtualSystemDescriptionType_Ignore;
4345 }
4346
4347 return S_OK;
4348}
4349
4350/**
4351 * Public method implementation.
4352 * @return
4353 */
4354STDMETHODIMP VirtualSystemDescription::AddDescription(VirtualSystemDescriptionType_T aType,
4355 IN_BSTR aVboxValue,
4356 IN_BSTR aExtraConfigValue)
4357{
4358 CheckComArgNotNull(aVboxValue);
4359 CheckComArgNotNull(aExtraConfigValue);
4360
4361 AutoCaller autoCaller(this);
4362 CheckComRCReturnRC(autoCaller.rc());
4363
4364 AutoWriteLock alock(this);
4365
4366 addEntry(aType, "", aVboxValue, aVboxValue, 0, aExtraConfigValue);
4367
4368 return S_OK;
4369}
4370
4371/**
4372 * Internal method; adds a new description item to the member list.
4373 * @param aType Type of description for the new item.
4374 * @param strRef Reference item; only used with hard disk controllers.
4375 * @param aOrigValue Corresponding original value from OVF.
4376 * @param aAutoValue Initial configuration value (can be overridden by caller with setFinalValues).
4377 * @param strExtraConfig Extra configuration; meaning dependent on type.
4378 */
4379void VirtualSystemDescription::addEntry(VirtualSystemDescriptionType_T aType,
4380 const Utf8Str &strRef,
4381 const Utf8Str &aOrigValue,
4382 const Utf8Str &aAutoValue,
4383 uint32_t ulSizeMB,
4384 const Utf8Str &strExtraConfig /*= ""*/)
4385{
4386 VirtualSystemDescriptionEntry vsde;
4387 vsde.ulIndex = (uint32_t)m->llDescriptions.size(); // each entry gets an index so the client side can reference them
4388 vsde.type = aType;
4389 vsde.strRef = strRef;
4390 vsde.strOvf = aOrigValue;
4391 vsde.strVbox = aAutoValue;
4392 vsde.strExtraConfig = strExtraConfig;
4393 vsde.ulSizeMB = ulSizeMB;
4394
4395 m->llDescriptions.push_back(vsde);
4396}
4397
4398/**
4399 * Private method; returns a list of description items containing all the items from the member
4400 * description items of this virtual system that match the given type.
4401 * @param aType
4402 * @return
4403 */
4404std::list<VirtualSystemDescriptionEntry*> VirtualSystemDescription::findByType(VirtualSystemDescriptionType_T aType)
4405{
4406 std::list<VirtualSystemDescriptionEntry*> vsd;
4407
4408 list<VirtualSystemDescriptionEntry>::iterator it;
4409 for (it = m->llDescriptions.begin();
4410 it != m->llDescriptions.end();
4411 ++it)
4412 {
4413 if (it->type == aType)
4414 vsd.push_back(&(*it));
4415 }
4416
4417 return vsd;
4418}
4419
4420/**
4421 * Private method; looks thru the member hardware items for the IDE, SATA, or SCSI controller with
4422 * the given reference ID. Useful when needing the controller for a particular
4423 * virtual disk.
4424 * @param id
4425 * @return
4426 */
4427const VirtualSystemDescriptionEntry* VirtualSystemDescription::findControllerFromID(uint32_t id)
4428{
4429 Utf8Str strRef = Utf8StrFmt("%RI32", id);
4430 list<VirtualSystemDescriptionEntry>::const_iterator it;
4431 for (it = m->llDescriptions.begin();
4432 it != m->llDescriptions.end();
4433 ++it)
4434 {
4435 const VirtualSystemDescriptionEntry &d = *it;
4436 switch (d.type)
4437 {
4438 case VirtualSystemDescriptionType_HardDiskControllerIDE:
4439 case VirtualSystemDescriptionType_HardDiskControllerSATA:
4440 case VirtualSystemDescriptionType_HardDiskControllerSCSI:
4441 if (d.strRef == strRef)
4442 return &d;
4443 break;
4444 }
4445 }
4446
4447 return NULL;
4448}
4449
4450////////////////////////////////////////////////////////////////////////////////
4451//
4452// IMachine public methods
4453//
4454////////////////////////////////////////////////////////////////////////////////
4455
4456// This code is here so we won't have to include the appliance headers in the
4457// IMachine implementation, and we also need to access private appliance data.
4458
4459/**
4460* Public method implementation.
4461* @param appliance
4462* @return
4463*/
4464
4465STDMETHODIMP Machine::Export(IAppliance *aAppliance, IVirtualSystemDescription **aDescription)
4466{
4467 HRESULT rc = S_OK;
4468
4469 if (!aAppliance)
4470 return E_POINTER;
4471
4472 AutoCaller autoCaller(this);
4473 CheckComRCReturnRC(autoCaller.rc());
4474
4475 AutoReadLock alock(this);
4476
4477 ComObjPtr<VirtualSystemDescription> pNewDesc;
4478
4479 try
4480 {
4481 Bstr bstrName;
4482 Bstr bstrDescription;
4483 Bstr bstrGuestOSType;
4484 uint32_t cCPUs;
4485 uint32_t ulMemSizeMB;
4486 BOOL fDVDEnabled;
4487 BOOL fFloppyEnabled;
4488 BOOL fUSBEnabled;
4489 BOOL fAudioEnabled;
4490 AudioControllerType_T audioController;
4491
4492 ComPtr<IUSBController> pUsbController;
4493 ComPtr<IAudioAdapter> pAudioAdapter;
4494
4495 // get name
4496 bstrName = mUserData->mName;
4497 // get description
4498 bstrDescription = mUserData->mDescription;
4499 // get guest OS
4500 bstrGuestOSType = mUserData->mOSTypeId;
4501 // CPU count
4502 cCPUs = mHWData->mCPUCount;
4503 // memory size in MB
4504 ulMemSizeMB = mHWData->mMemorySize;
4505 // VRAM size?
4506 // BIOS settings?
4507 // 3D acceleration enabled?
4508 // hardware virtualization enabled?
4509 // nested paging enabled?
4510 // HWVirtExVPIDEnabled?
4511 // PAEEnabled?
4512 // snapshotFolder?
4513 // VRDPServer?
4514
4515 // floppy
4516 rc = mFloppyDrive->COMGETTER(Enabled)(&fFloppyEnabled);
4517 if (FAILED(rc)) throw rc;
4518
4519 // CD-ROM ?!?
4520 // ComPtr<IDVDDrive> pDVDDrive;
4521 fDVDEnabled = 1;
4522
4523 // this is more tricky so use the COM method
4524 rc = COMGETTER(USBController)(pUsbController.asOutParam());
4525 if (FAILED(rc))
4526 fUSBEnabled = false;
4527 else
4528 rc = pUsbController->COMGETTER(Enabled)(&fUSBEnabled);
4529
4530 pAudioAdapter = mAudioAdapter;
4531 rc = pAudioAdapter->COMGETTER(Enabled)(&fAudioEnabled);
4532 if (FAILED(rc)) throw rc;
4533 rc = pAudioAdapter->COMGETTER(AudioController)(&audioController);
4534 if (FAILED(rc)) throw rc;
4535
4536 // create a new virtual system
4537 rc = pNewDesc.createObject();
4538 CheckComRCThrowRC(rc);
4539 rc = pNewDesc->init();
4540 CheckComRCThrowRC(rc);
4541
4542 /* Guest OS type */
4543 Utf8Str strOsTypeVBox(bstrGuestOSType);
4544 CIMOSType_T cim = convertVBoxOSType2CIMOSType(strOsTypeVBox.c_str());
4545 pNewDesc->addEntry(VirtualSystemDescriptionType_OS,
4546 "",
4547 Utf8StrFmt("%RI32", cim),
4548 strOsTypeVBox);
4549
4550 /* VM name */
4551 Utf8Str strVMName(bstrName);
4552 pNewDesc->addEntry(VirtualSystemDescriptionType_Name,
4553 "",
4554 strVMName,
4555 strVMName);
4556
4557 // description
4558 Utf8Str strDescription(bstrDescription);
4559 pNewDesc->addEntry(VirtualSystemDescriptionType_Description,
4560 "",
4561 strDescription,
4562 strDescription);
4563
4564 /* CPU count*/
4565 Utf8Str strCpuCount = Utf8StrFmt("%RI32", cCPUs);
4566 pNewDesc->addEntry(VirtualSystemDescriptionType_CPU,
4567 "",
4568 strCpuCount,
4569 strCpuCount);
4570
4571 /* Memory */
4572 Utf8Str strMemory = Utf8StrFmt("%RI32", (uint64_t)ulMemSizeMB * _1M);
4573 pNewDesc->addEntry(VirtualSystemDescriptionType_Memory,
4574 "",
4575 strMemory,
4576 strMemory);
4577
4578 int32_t lIDEControllerIndex = 0;
4579 int32_t lSATAControllerIndex = 0;
4580 int32_t lSCSIControllerIndex = 0;
4581
4582// <const name="HardDiskControllerIDE" value="6" />
4583 ComPtr<IStorageController> pController;
4584 rc = GetStorageControllerByName(Bstr("IDE"), pController.asOutParam());
4585 if (FAILED(rc)) throw rc;
4586 Utf8Str strVbox;
4587 StorageControllerType_T ctlr;
4588 rc = pController->COMGETTER(ControllerType)(&ctlr);
4589 if (FAILED(rc)) throw rc;
4590 switch(ctlr)
4591 {
4592 case StorageControllerType_PIIX3: strVbox = "PIIX3"; break;
4593 case StorageControllerType_PIIX4: strVbox = "PIIX4"; break;
4594 case StorageControllerType_ICH6: strVbox = "ICH6"; break;
4595 }
4596
4597 if (strVbox.length())
4598 {
4599 lIDEControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
4600 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
4601 Utf8StrFmt("%d", lIDEControllerIndex),
4602 strVbox,
4603 strVbox);
4604 }
4605
4606#ifdef VBOX_WITH_AHCI
4607// <const name="HardDiskControllerSATA" value="7" />
4608 rc = GetStorageControllerByName(Bstr("SATA"), pController.asOutParam());
4609 if (SUCCEEDED(rc))
4610 {
4611 strVbox = "AHCI";
4612 lSATAControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
4613 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,
4614 Utf8StrFmt("%d", lSATAControllerIndex),
4615 strVbox,
4616 strVbox);
4617 }
4618#endif // VBOX_WITH_AHCI
4619
4620#ifdef VBOX_WITH_LSILOGIC
4621// <const name="HardDiskControllerSCSI" value="8" />
4622 rc = GetStorageControllerByName(Bstr("SCSI"), pController.asOutParam());
4623 if (SUCCEEDED(rc))
4624 {
4625 rc = pController->COMGETTER(ControllerType)(&ctlr);
4626 if (SUCCEEDED(rc))
4627 {
4628 strVbox = "LsiLogic"; // the default in VBox
4629 switch(ctlr)
4630 {
4631 case StorageControllerType_LsiLogic: strVbox = "LsiLogic"; break;
4632 case StorageControllerType_BusLogic: strVbox = "BusLogic"; break;
4633 }
4634 lSCSIControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
4635 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,
4636 Utf8StrFmt("%d", lSCSIControllerIndex),
4637 strVbox,
4638 strVbox);
4639 }
4640 else
4641 throw rc;
4642 }
4643#endif // VBOX_WITH_LSILOGIC
4644
4645// <const name="HardDiskImage" value="9" />
4646 HDData::AttachmentList::iterator itA;
4647 for (itA = mHDData->mAttachments.begin();
4648 itA != mHDData->mAttachments.end();
4649 ++itA)
4650 {
4651 ComObjPtr<HardDiskAttachment> pHDA = *itA;
4652
4653 // the attachment's data
4654 ComPtr<IHardDisk> pHardDisk;
4655 ComPtr<IStorageController> ctl;
4656 Bstr controllerName;
4657
4658 rc = pHDA->COMGETTER(Controller)(controllerName.asOutParam());
4659 if (FAILED(rc)) throw rc;
4660
4661 rc = GetStorageControllerByName(controllerName, ctl.asOutParam());
4662 if (FAILED(rc)) throw rc;
4663
4664 StorageBus_T storageBus;
4665 LONG lChannel;
4666 LONG lDevice;
4667
4668 rc = ctl->COMGETTER(Bus)(&storageBus);
4669 if (FAILED(rc)) throw rc;
4670
4671 rc = pHDA->COMGETTER(HardDisk)(pHardDisk.asOutParam());
4672 if (FAILED(rc)) throw rc;
4673
4674 rc = pHDA->COMGETTER(Port)(&lChannel);
4675 if (FAILED(rc)) throw rc;
4676
4677 rc = pHDA->COMGETTER(Device)(&lDevice);
4678 if (FAILED(rc)) throw rc;
4679
4680 Bstr bstrLocation;
4681 rc = pHardDisk->COMGETTER(Location)(bstrLocation.asOutParam());
4682 if (FAILED(rc)) throw rc;
4683 Bstr bstrName;
4684 rc = pHardDisk->COMGETTER(Name)(bstrName.asOutParam());
4685 if (FAILED(rc)) throw rc;
4686
4687 // force reading state, or else size will be returned as 0
4688 MediaState_T ms;
4689 rc = pHardDisk->COMGETTER(State)(&ms);
4690 if (FAILED(rc)) throw rc;
4691
4692 ULONG64 ullSize;
4693 rc = pHardDisk->COMGETTER(Size)(&ullSize);
4694 if (FAILED(rc)) throw rc;
4695
4696 // and how this translates to the virtual system
4697 int32_t lControllerVsys = 0;
4698 LONG lChannelVsys;
4699
4700 switch (storageBus)
4701 {
4702 case StorageBus_IDE:
4703 // this is the exact reverse to what we're doing in Appliance::taskThreadImportMachines,
4704 // and it must be updated when that is changed!
4705
4706 if (lChannel == 0 && lDevice == 0) // primary master
4707 lChannelVsys = 0;
4708 else if (lChannel == 0 && lDevice == 1) // primary slave
4709 lChannelVsys = 1;
4710 else if (lChannel == 1 && lDevice == 1) // secondary slave; secondary master is always CDROM
4711 lChannelVsys = 2;
4712 else
4713 throw setError(VBOX_E_NOT_SUPPORTED,
4714 tr("Cannot handle hard disk attachment: channel is %d, device is %d"), lChannel, lDevice);
4715
4716 lControllerVsys = lIDEControllerIndex;
4717 break;
4718
4719 case StorageBus_SATA:
4720 lChannelVsys = lChannel; // should be between 0 and 29
4721 lControllerVsys = lSATAControllerIndex;
4722 break;
4723
4724 case StorageBus_SCSI:
4725 lChannelVsys = lChannel; // should be between 0 and 15
4726 lControllerVsys = lSCSIControllerIndex;
4727 break;
4728
4729 default:
4730 throw setError(VBOX_E_NOT_SUPPORTED,
4731 tr("Cannot handle hard disk attachment: storageBus is %d, channel is %d, device is %d"), storageBus, lChannel, lDevice);
4732 break;
4733 }
4734
4735 Utf8Str strTargetVmdkName(bstrName);
4736 RTPathStripExt(strTargetVmdkName.mutableRaw());
4737 strTargetVmdkName.append(".vmdk");
4738
4739 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskImage,
4740 strTargetVmdkName, // disk ID: let's use the name
4741 strTargetVmdkName, // OVF value:
4742 Utf8Str(bstrLocation), // vbox value: media path
4743 (uint32_t)(ullSize / _1M),
4744 Utf8StrFmt("controller=%RI32;channel=%RI32", lControllerVsys, lChannelVsys));
4745 }
4746
4747 /* Floppy Drive */
4748 if (fFloppyEnabled)
4749 pNewDesc->addEntry(VirtualSystemDescriptionType_Floppy, "", "", "");
4750
4751 /* CD Drive */
4752 if (fDVDEnabled)
4753 pNewDesc->addEntry(VirtualSystemDescriptionType_CDROM, "", "", "");
4754
4755// <const name="NetworkAdapter" />
4756 size_t a;
4757 for (a = 0;
4758 a < SchemaDefs::NetworkAdapterCount;
4759 ++a)
4760 {
4761 ComPtr<INetworkAdapter> pNetworkAdapter;
4762 BOOL fEnabled;
4763 NetworkAdapterType_T adapterType;
4764 NetworkAttachmentType_T attachmentType;
4765
4766 rc = GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
4767 if (FAILED(rc)) throw rc;
4768 /* Enable the network card & set the adapter type */
4769 rc = pNetworkAdapter->COMGETTER(Enabled)(&fEnabled);
4770 if (FAILED(rc)) throw rc;
4771
4772 if (fEnabled)
4773 {
4774 Utf8Str strAttachmentType;
4775
4776 rc = pNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
4777 if (FAILED(rc)) throw rc;
4778
4779 rc = pNetworkAdapter->COMGETTER(AttachmentType)(&attachmentType);
4780 if (FAILED(rc)) throw rc;
4781
4782 switch (attachmentType)
4783 {
4784 case NetworkAttachmentType_Null:
4785 strAttachmentType = "Null";
4786 break;
4787
4788 case NetworkAttachmentType_NAT:
4789 strAttachmentType = "NAT";
4790 break;
4791
4792 case NetworkAttachmentType_Bridged:
4793 strAttachmentType = "Bridged";
4794 break;
4795
4796 case NetworkAttachmentType_Internal:
4797 strAttachmentType = "Internal";
4798 break;
4799
4800 case NetworkAttachmentType_HostOnly:
4801 strAttachmentType = "HostOnly";
4802 break;
4803 }
4804
4805 pNewDesc->addEntry(VirtualSystemDescriptionType_NetworkAdapter,
4806 "", // ref
4807 strAttachmentType, // orig
4808 Utf8StrFmt("%RI32", (uint32_t)adapterType), // conf
4809 Utf8StrFmt("type=%s", strAttachmentType.c_str())); // extra conf
4810 }
4811 }
4812
4813// <const name="USBController" />
4814#ifdef VBOX_WITH_USB
4815 if (fUSBEnabled)
4816 pNewDesc->addEntry(VirtualSystemDescriptionType_USBController, "", "", "");
4817#endif /* VBOX_WITH_USB */
4818
4819// <const name="SoundCard" />
4820 if (fAudioEnabled)
4821 {
4822 pNewDesc->addEntry(VirtualSystemDescriptionType_SoundCard,
4823 "",
4824 "ensoniq1371", // this is what OVFTool writes and VMware supports
4825 Utf8StrFmt("%RI32", audioController));
4826 }
4827
4828 // finally, add the virtual system to the appliance
4829 Appliance *pAppliance = static_cast<Appliance*>(aAppliance);
4830 AutoCaller autoCaller1(pAppliance);
4831 CheckComRCReturnRC(autoCaller1.rc());
4832
4833 /* We return the new description to the caller */
4834 ComPtr<IVirtualSystemDescription> copy(pNewDesc);
4835 copy.queryInterfaceTo(aDescription);
4836
4837 AutoWriteLock alock(pAppliance);
4838
4839 pAppliance->m->virtualSystemDescriptions.push_back(pNewDesc);
4840 }
4841 catch(HRESULT arc)
4842 {
4843 rc = arc;
4844 }
4845
4846 return rc;
4847}
4848
4849/* 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