VirtualBox

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

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

some Windows warnings in Main

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