VirtualBox

source: vbox/trunk/src/VBox/Main/src-server/ApplianceImplImport.cpp@ 84141

Last change on this file since 84141 was 84141, checked in by vboxsync, 5 years ago

Main/Appliance: There should be no need to store two copies of the manifest. Also, we must not return unsanitized strings thru the API. IFF there is genuine need for non-sanitized data, we must return it as a BYTE array rather than a unicode string. bugref:9699

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 232.1 KB
Line 
1/* $Id: ApplianceImplImport.cpp 84141 2020-05-04 21:15:30Z vboxsync $ */
2/** @file
3 * IAppliance and IVirtualSystem COM class implementations.
4 */
5
6/*
7 * Copyright (C) 2008-2020 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#define LOG_GROUP LOG_GROUP_MAIN_APPLIANCE
19#include <iprt/alloca.h>
20#include <iprt/path.h>
21#include <iprt/cpp/path.h>
22#include <iprt/dir.h>
23#include <iprt/file.h>
24#include <iprt/s3.h>
25#include <iprt/sha.h>
26#include <iprt/manifest.h>
27#include <iprt/tar.h>
28#include <iprt/zip.h>
29#include <iprt/stream.h>
30#include <iprt/crypto/digest.h>
31#include <iprt/crypto/pkix.h>
32#include <iprt/crypto/store.h>
33#include <iprt/crypto/x509.h>
34
35#include <VBox/vd.h>
36#include <VBox/com/array.h>
37
38#include "ApplianceImpl.h"
39#include "VirtualBoxImpl.h"
40#include "GuestOSTypeImpl.h"
41#include "ProgressImpl.h"
42#include "MachineImpl.h"
43#include "MediumImpl.h"
44#include "MediumFormatImpl.h"
45#include "SystemPropertiesImpl.h"
46#include "HostImpl.h"
47
48#include "AutoCaller.h"
49#include "LoggingNew.h"
50
51#include "ApplianceImplPrivate.h"
52#include "CertificateImpl.h"
53#include "ovfreader.h"
54
55#include <VBox/param.h>
56#include <VBox/version.h>
57#include <VBox/settings.h>
58
59#include <set>
60
61using namespace std;
62
63////////////////////////////////////////////////////////////////////////////////
64//
65// IAppliance public methods
66//
67////////////////////////////////////////////////////////////////////////////////
68
69/**
70 * Public method implementation. This opens the OVF with ovfreader.cpp.
71 * Thread implementation is in Appliance::readImpl().
72 *
73 * @param aFile File to read the appliance from.
74 * @param aProgress Progress object.
75 * @return
76 */
77HRESULT Appliance::read(const com::Utf8Str &aFile,
78 ComPtr<IProgress> &aProgress)
79{
80 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
81
82 if (!i_isApplianceIdle())
83 return E_ACCESSDENIED;
84
85 if (m->pReader)
86 {
87 delete m->pReader;
88 m->pReader = NULL;
89 }
90
91 /* Parse all necessary info out of the URI (please not how stupid utterly wasteful
92 this status & allocation error throwing is): */
93 try
94 {
95 i_parseURI(aFile, m->locInfo); /* may trhow rc. */
96 }
97 catch (HRESULT aRC)
98 {
99 return aRC;
100 }
101 catch (std::bad_alloc &)
102 {
103 return E_OUTOFMEMORY;
104 }
105
106 // see if we can handle this file; for now we insist it has an ovf/ova extension
107 if ( m->locInfo.storageType == VFSType_File
108 && !aFile.endsWith(".ovf", Utf8Str::CaseInsensitive)
109 && !aFile.endsWith(".ova", Utf8Str::CaseInsensitive))
110 return setError(VBOX_E_FILE_ERROR, tr("Appliance file must have .ovf or .ova extension"));
111
112 ComObjPtr<Progress> progress;
113 HRESULT hrc = i_readImpl(m->locInfo, progress);
114 if (SUCCEEDED(hrc))
115 progress.queryInterfaceTo(aProgress.asOutParam());
116 return hrc;
117}
118
119/**
120 * Public method implementation. This looks at the output of ovfreader.cpp and creates
121 * VirtualSystemDescription instances.
122 * @return
123 */
124HRESULT Appliance::interpret()
125{
126 /// @todo
127 // - don't use COM methods but the methods directly (faster, but needs appropriate
128 // locking of that objects itself (s. HardDisk))
129 // - Appropriate handle errors like not supported file formats
130 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
131
132 if (!i_isApplianceIdle())
133 return E_ACCESSDENIED;
134
135 HRESULT rc = S_OK;
136
137 /* Clear any previous virtual system descriptions */
138 m->virtualSystemDescriptions.clear();
139
140 if (m->locInfo.storageType == VFSType_File && !m->pReader)
141 return setError(E_FAIL,
142 tr("Cannot interpret appliance without reading it first (call read() before interpret())"));
143
144 // Change the appliance state so we can safely leave the lock while doing time-consuming
145 // medium imports; also the below method calls do all kinds of locking which conflicts with
146 // the appliance object lock
147 m->state = ApplianceImporting;
148 alock.release();
149
150 /* Try/catch so we can clean up on error */
151 try
152 {
153 list<ovf::VirtualSystem>::const_iterator it;
154 /* Iterate through all virtual systems */
155 for (it = m->pReader->m_llVirtualSystems.begin();
156 it != m->pReader->m_llVirtualSystems.end();
157 ++it)
158 {
159 const ovf::VirtualSystem &vsysThis = *it;
160
161 ComObjPtr<VirtualSystemDescription> pNewDesc;
162 rc = pNewDesc.createObject();
163 if (FAILED(rc)) throw rc;
164 rc = pNewDesc->init();
165 if (FAILED(rc)) throw rc;
166
167 // if the virtual system in OVF had a <vbox:Machine> element, have the
168 // VirtualBox settings code parse that XML now
169 if (vsysThis.pelmVBoxMachine)
170 pNewDesc->i_importVBoxMachineXML(*vsysThis.pelmVBoxMachine);
171
172 // Guest OS type
173 // This is taken from one of three places, in this order:
174 Utf8Str strOsTypeVBox;
175 Utf8StrFmt strCIMOSType("%RU32", (uint32_t)vsysThis.cimos);
176 // 1) If there is a <vbox:Machine>, then use the type from there.
177 if ( vsysThis.pelmVBoxMachine
178 && pNewDesc->m->pConfig->machineUserData.strOsType.isNotEmpty()
179 )
180 strOsTypeVBox = pNewDesc->m->pConfig->machineUserData.strOsType;
181 // 2) Otherwise, if there is OperatingSystemSection/vbox:OSType, use that one.
182 else if (vsysThis.strTypeVBox.isNotEmpty()) // OVFReader has found vbox:OSType
183 strOsTypeVBox = vsysThis.strTypeVBox;
184 // 3) Otherwise, make a best guess what the vbox type is from the OVF (CIM) OS type.
185 else
186 convertCIMOSType2VBoxOSType(strOsTypeVBox, vsysThis.cimos, vsysThis.strCimosDesc);
187 pNewDesc->i_addEntry(VirtualSystemDescriptionType_OS,
188 "",
189 strCIMOSType,
190 strOsTypeVBox);
191
192 /* VM name */
193 Utf8Str nameVBox;
194 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
195 if ( vsysThis.pelmVBoxMachine
196 && pNewDesc->m->pConfig->machineUserData.strName.isNotEmpty())
197 nameVBox = pNewDesc->m->pConfig->machineUserData.strName;
198 else
199 nameVBox = vsysThis.strName;
200 /* If there isn't any name specified create a default one out
201 * of the OS type */
202 if (nameVBox.isEmpty())
203 nameVBox = strOsTypeVBox;
204 i_searchUniqueVMName(nameVBox);
205 pNewDesc->i_addEntry(VirtualSystemDescriptionType_Name,
206 "",
207 vsysThis.strName,
208 nameVBox);
209
210 /* VM Primary Group */
211 Utf8Str strPrimaryGroup;
212 if ( vsysThis.pelmVBoxMachine
213 && pNewDesc->m->pConfig->machineUserData.llGroups.size())
214 strPrimaryGroup = pNewDesc->m->pConfig->machineUserData.llGroups.front();
215 if (strPrimaryGroup.isEmpty())
216 strPrimaryGroup = "/";
217 pNewDesc->i_addEntry(VirtualSystemDescriptionType_PrimaryGroup,
218 "",
219 "" /* no direct OVF correspondence */,
220 strPrimaryGroup);
221
222 /* Based on the VM name, create a target machine path. */
223 Bstr bstrSettingsFilename;
224 rc = mVirtualBox->ComposeMachineFilename(Bstr(nameVBox).raw(),
225 Bstr(strPrimaryGroup).raw(),
226 NULL /* aCreateFlags */,
227 NULL /* aBaseFolder */,
228 bstrSettingsFilename.asOutParam());
229 if (FAILED(rc)) throw rc;
230 Utf8Str strMachineFolder(bstrSettingsFilename);
231 strMachineFolder.stripFilename();
232
233#if 1
234 /* The import logic should work exactly the same whether the
235 * following 2 items are present or not, but of course it may have
236 * an influence on the exact presentation of the import settings
237 * of an API client. */
238 Utf8Str strSettingsFilename(bstrSettingsFilename);
239 pNewDesc->i_addEntry(VirtualSystemDescriptionType_SettingsFile,
240 "",
241 "" /* no direct OVF correspondence */,
242 strSettingsFilename);
243 Utf8Str strBaseFolder;
244 mVirtualBox->i_getDefaultMachineFolder(strBaseFolder);
245 pNewDesc->i_addEntry(VirtualSystemDescriptionType_BaseFolder,
246 "",
247 "" /* no direct OVF correspondence */,
248 strBaseFolder);
249#endif
250
251 /* VM Product */
252 if (!vsysThis.strProduct.isEmpty())
253 pNewDesc->i_addEntry(VirtualSystemDescriptionType_Product,
254 "",
255 vsysThis.strProduct,
256 vsysThis.strProduct);
257
258 /* VM Vendor */
259 if (!vsysThis.strVendor.isEmpty())
260 pNewDesc->i_addEntry(VirtualSystemDescriptionType_Vendor,
261 "",
262 vsysThis.strVendor,
263 vsysThis.strVendor);
264
265 /* VM Version */
266 if (!vsysThis.strVersion.isEmpty())
267 pNewDesc->i_addEntry(VirtualSystemDescriptionType_Version,
268 "",
269 vsysThis.strVersion,
270 vsysThis.strVersion);
271
272 /* VM ProductUrl */
273 if (!vsysThis.strProductUrl.isEmpty())
274 pNewDesc->i_addEntry(VirtualSystemDescriptionType_ProductUrl,
275 "",
276 vsysThis.strProductUrl,
277 vsysThis.strProductUrl);
278
279 /* VM VendorUrl */
280 if (!vsysThis.strVendorUrl.isEmpty())
281 pNewDesc->i_addEntry(VirtualSystemDescriptionType_VendorUrl,
282 "",
283 vsysThis.strVendorUrl,
284 vsysThis.strVendorUrl);
285
286 /* VM description */
287 if (!vsysThis.strDescription.isEmpty())
288 pNewDesc->i_addEntry(VirtualSystemDescriptionType_Description,
289 "",
290 vsysThis.strDescription,
291 vsysThis.strDescription);
292
293 /* VM license */
294 if (!vsysThis.strLicenseText.isEmpty())
295 pNewDesc->i_addEntry(VirtualSystemDescriptionType_License,
296 "",
297 vsysThis.strLicenseText,
298 vsysThis.strLicenseText);
299
300 /* Now that we know the OS type, get our internal defaults based on
301 * that, if it is known (otherwise pGuestOSType will be NULL). */
302 ComPtr<IGuestOSType> pGuestOSType;
303 mVirtualBox->GetGuestOSType(Bstr(strOsTypeVBox).raw(), pGuestOSType.asOutParam());
304
305 /* CPU count */
306 ULONG cpuCountVBox;
307 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
308 if ( vsysThis.pelmVBoxMachine
309 && pNewDesc->m->pConfig->hardwareMachine.cCPUs)
310 cpuCountVBox = pNewDesc->m->pConfig->hardwareMachine.cCPUs;
311 else
312 cpuCountVBox = vsysThis.cCPUs;
313 /* Check for the constraints */
314 if (cpuCountVBox > SchemaDefs::MaxCPUCount)
315 {
316 i_addWarning(tr("The virtual system \"%s\" claims support for %u CPU's, but VirtualBox has support for "
317 "max %u CPU's only."),
318 vsysThis.strName.c_str(), cpuCountVBox, SchemaDefs::MaxCPUCount);
319 cpuCountVBox = SchemaDefs::MaxCPUCount;
320 }
321 if (vsysThis.cCPUs == 0)
322 cpuCountVBox = 1;
323 pNewDesc->i_addEntry(VirtualSystemDescriptionType_CPU,
324 "",
325 Utf8StrFmt("%RU32", (uint32_t)vsysThis.cCPUs),
326 Utf8StrFmt("%RU32", (uint32_t)cpuCountVBox));
327
328 /* RAM */
329 uint64_t ullMemSizeVBox;
330 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
331 if ( vsysThis.pelmVBoxMachine
332 && pNewDesc->m->pConfig->hardwareMachine.ulMemorySizeMB)
333 ullMemSizeVBox = pNewDesc->m->pConfig->hardwareMachine.ulMemorySizeMB;
334 else
335 ullMemSizeVBox = vsysThis.ullMemorySize / _1M;
336 /* Check for the constraints */
337 if ( ullMemSizeVBox != 0
338 && ( ullMemSizeVBox < MM_RAM_MIN_IN_MB
339 || ullMemSizeVBox > MM_RAM_MAX_IN_MB
340 )
341 )
342 {
343 i_addWarning(tr("The virtual system \"%s\" claims support for %llu MB RAM size, but VirtualBox has "
344 "support for min %u & max %u MB RAM size only."),
345 vsysThis.strName.c_str(), ullMemSizeVBox, MM_RAM_MIN_IN_MB, MM_RAM_MAX_IN_MB);
346 ullMemSizeVBox = RT_MIN(RT_MAX(ullMemSizeVBox, MM_RAM_MIN_IN_MB), MM_RAM_MAX_IN_MB);
347 }
348 if (vsysThis.ullMemorySize == 0)
349 {
350 /* If the RAM of the OVF is zero, use our predefined values */
351 ULONG memSizeVBox2;
352 if (!pGuestOSType.isNull())
353 {
354 rc = pGuestOSType->COMGETTER(RecommendedRAM)(&memSizeVBox2);
355 if (FAILED(rc)) throw rc;
356 }
357 else
358 memSizeVBox2 = 1024;
359 /* VBox stores that in MByte */
360 ullMemSizeVBox = (uint64_t)memSizeVBox2;
361 }
362 pNewDesc->i_addEntry(VirtualSystemDescriptionType_Memory,
363 "",
364 Utf8StrFmt("%RU64", (uint64_t)vsysThis.ullMemorySize),
365 Utf8StrFmt("%RU64", (uint64_t)ullMemSizeVBox));
366
367 /* Audio */
368 Utf8Str strSoundCard;
369 Utf8Str strSoundCardOrig;
370 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
371 if ( vsysThis.pelmVBoxMachine
372 && pNewDesc->m->pConfig->hardwareMachine.audioAdapter.fEnabled)
373 {
374 strSoundCard = Utf8StrFmt("%RU32",
375 (uint32_t)pNewDesc->m->pConfig->hardwareMachine.audioAdapter.controllerType);
376 }
377 else if (vsysThis.strSoundCardType.isNotEmpty())
378 {
379 /* Set the AC97 always for the simple OVF case.
380 * @todo: figure out the hardware which could be possible */
381 strSoundCard = Utf8StrFmt("%RU32", (uint32_t)AudioControllerType_AC97);
382 strSoundCardOrig = vsysThis.strSoundCardType;
383 }
384 if (strSoundCard.isNotEmpty())
385 pNewDesc->i_addEntry(VirtualSystemDescriptionType_SoundCard,
386 "",
387 strSoundCardOrig,
388 strSoundCard);
389
390#ifdef VBOX_WITH_USB
391 /* USB Controller */
392 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
393 if ( ( vsysThis.pelmVBoxMachine
394 && pNewDesc->m->pConfig->hardwareMachine.usbSettings.llUSBControllers.size() > 0)
395 || vsysThis.fHasUsbController)
396 pNewDesc->i_addEntry(VirtualSystemDescriptionType_USBController, "", "", "");
397#endif /* VBOX_WITH_USB */
398
399 /* Network Controller */
400 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
401 if (vsysThis.pelmVBoxMachine)
402 {
403 uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(pNewDesc->m->pConfig->hardwareMachine.chipsetType);
404
405 const settings::NetworkAdaptersList &llNetworkAdapters = pNewDesc->m->pConfig->hardwareMachine.llNetworkAdapters;
406 /* Check for the constrains */
407 if (llNetworkAdapters.size() > maxNetworkAdapters)
408 i_addWarning(tr("The virtual system \"%s\" claims support for %zu network adapters, but VirtualBox "
409 "has support for max %u network adapter only."),
410 vsysThis.strName.c_str(), llNetworkAdapters.size(), maxNetworkAdapters);
411 /* Iterate through all network adapters. */
412 settings::NetworkAdaptersList::const_iterator it1;
413 size_t a = 0;
414 for (it1 = llNetworkAdapters.begin();
415 it1 != llNetworkAdapters.end() && a < maxNetworkAdapters;
416 ++it1, ++a)
417 {
418 if (it1->fEnabled)
419 {
420 Utf8Str strMode = convertNetworkAttachmentTypeToString(it1->mode);
421 pNewDesc->i_addEntry(VirtualSystemDescriptionType_NetworkAdapter,
422 "", // ref
423 strMode, // orig
424 Utf8StrFmt("%RU32", (uint32_t)it1->type), // conf
425 0,
426 Utf8StrFmt("slot=%RU32;type=%s", it1->ulSlot, strMode.c_str())); // extra conf
427 }
428 }
429 }
430 /* else we use the ovf configuration. */
431 else if (vsysThis.llEthernetAdapters.size() > 0)
432 {
433 size_t cEthernetAdapters = vsysThis.llEthernetAdapters.size();
434 uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(ChipsetType_PIIX3);
435
436 /* Check for the constrains */
437 if (cEthernetAdapters > maxNetworkAdapters)
438 i_addWarning(tr("The virtual system \"%s\" claims support for %zu network adapters, but VirtualBox "
439 "has support for max %u network adapter only."),
440 vsysThis.strName.c_str(), cEthernetAdapters, maxNetworkAdapters);
441
442 /* Get the default network adapter type for the selected guest OS */
443 NetworkAdapterType_T defaultAdapterVBox = NetworkAdapterType_Am79C970A;
444 if (!pGuestOSType.isNull())
445 {
446 rc = pGuestOSType->COMGETTER(AdapterType)(&defaultAdapterVBox);
447 if (FAILED(rc)) throw rc;
448 }
449 else
450 {
451#ifdef VBOX_WITH_E1000
452 defaultAdapterVBox = NetworkAdapterType_I82540EM;
453#else
454 defaultAdapterVBox = NetworkAdapterType_Am79C973A;
455#endif
456 }
457
458 ovf::EthernetAdaptersList::const_iterator itEA;
459 /* Iterate through all abstract networks. Ignore network cards
460 * which exceed the limit of VirtualBox. */
461 size_t a = 0;
462 for (itEA = vsysThis.llEthernetAdapters.begin();
463 itEA != vsysThis.llEthernetAdapters.end() && a < maxNetworkAdapters;
464 ++itEA, ++a)
465 {
466 const ovf::EthernetAdapter &ea = *itEA; // logical network to connect to
467 Utf8Str strNetwork = ea.strNetworkName;
468 // make sure it's one of these two
469 if ( (strNetwork.compare("Null", Utf8Str::CaseInsensitive))
470 && (strNetwork.compare("NAT", Utf8Str::CaseInsensitive))
471 && (strNetwork.compare("Bridged", Utf8Str::CaseInsensitive))
472 && (strNetwork.compare("Internal", Utf8Str::CaseInsensitive))
473 && (strNetwork.compare("HostOnly", Utf8Str::CaseInsensitive))
474 && (strNetwork.compare("Generic", Utf8Str::CaseInsensitive))
475 )
476 strNetwork = "Bridged"; // VMware assumes this is the default apparently
477
478 /* Figure out the hardware type */
479 NetworkAdapterType_T nwAdapterVBox = defaultAdapterVBox;
480 if (!ea.strAdapterType.compare("PCNet32", Utf8Str::CaseInsensitive))
481 {
482 /* If the default adapter is already one of the two
483 * PCNet adapters use the default one. If not use the
484 * Am79C970A as fallback. */
485 if (!(defaultAdapterVBox == NetworkAdapterType_Am79C970A ||
486 defaultAdapterVBox == NetworkAdapterType_Am79C973))
487 nwAdapterVBox = NetworkAdapterType_Am79C970A;
488 }
489#ifdef VBOX_WITH_E1000
490 /* VMWare accidentally write this with VirtualCenter 3.5,
491 so make sure in this case always to use the VMWare one */
492 else if (!ea.strAdapterType.compare("E10000", Utf8Str::CaseInsensitive))
493 nwAdapterVBox = NetworkAdapterType_I82545EM;
494 else if (!ea.strAdapterType.compare("E1000", Utf8Str::CaseInsensitive))
495 {
496 /* Check if this OVF was written by VirtualBox */
497 if (Utf8Str(vsysThis.strVirtualSystemType).contains("virtualbox", Utf8Str::CaseInsensitive))
498 {
499 /* If the default adapter is already one of the three
500 * E1000 adapters use the default one. If not use the
501 * I82545EM as fallback. */
502 if (!(defaultAdapterVBox == NetworkAdapterType_I82540EM ||
503 defaultAdapterVBox == NetworkAdapterType_I82543GC ||
504 defaultAdapterVBox == NetworkAdapterType_I82545EM))
505 nwAdapterVBox = NetworkAdapterType_I82540EM;
506 }
507 else
508 /* Always use this one since it's what VMware uses */
509 nwAdapterVBox = NetworkAdapterType_I82545EM;
510 }
511#endif /* VBOX_WITH_E1000 */
512
513 pNewDesc->i_addEntry(VirtualSystemDescriptionType_NetworkAdapter,
514 "", // ref
515 ea.strNetworkName, // orig
516 Utf8StrFmt("%RU32", (uint32_t)nwAdapterVBox), // conf
517 0,
518 Utf8StrFmt("type=%s", strNetwork.c_str())); // extra conf
519 }
520 }
521
522 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
523 bool fFloppy = false;
524 bool fDVD = false;
525 if (vsysThis.pelmVBoxMachine)
526 {
527 settings::StorageControllersList &llControllers = pNewDesc->m->pConfig->hardwareMachine.storage.llStorageControllers;
528 settings::StorageControllersList::iterator it3;
529 for (it3 = llControllers.begin();
530 it3 != llControllers.end();
531 ++it3)
532 {
533 settings::AttachedDevicesList &llAttachments = it3->llAttachedDevices;
534 settings::AttachedDevicesList::iterator it4;
535 for (it4 = llAttachments.begin();
536 it4 != llAttachments.end();
537 ++it4)
538 {
539 fDVD |= it4->deviceType == DeviceType_DVD;
540 fFloppy |= it4->deviceType == DeviceType_Floppy;
541 if (fFloppy && fDVD)
542 break;
543 }
544 if (fFloppy && fDVD)
545 break;
546 }
547 }
548 else
549 {
550 fFloppy = vsysThis.fHasFloppyDrive;
551 fDVD = vsysThis.fHasCdromDrive;
552 }
553 /* Floppy Drive */
554 if (fFloppy)
555 pNewDesc->i_addEntry(VirtualSystemDescriptionType_Floppy, "", "", "");
556 /* CD Drive */
557 if (fDVD)
558 pNewDesc->i_addEntry(VirtualSystemDescriptionType_CDROM, "", "", "");
559
560 /* Storage Controller */
561 uint16_t cIDEused = 0;
562 uint16_t cSATAused = 0; NOREF(cSATAused);
563 uint16_t cSCSIused = 0; NOREF(cSCSIused);
564 ovf::ControllersMap::const_iterator hdcIt;
565 /* Iterate through all storage controllers */
566 for (hdcIt = vsysThis.mapControllers.begin();
567 hdcIt != vsysThis.mapControllers.end();
568 ++hdcIt)
569 {
570 const ovf::HardDiskController &hdc = hdcIt->second;
571 Utf8Str strControllerID = Utf8StrFmt("%RI32", (uint32_t)hdc.idController);
572
573 switch (hdc.system)
574 {
575 case ovf::HardDiskController::IDE:
576 /* Check for the constrains */
577 if (cIDEused < 4)
578 {
579 /// @todo figure out the IDE types
580 /* Use PIIX4 as default */
581 Utf8Str strType = "PIIX4";
582 if (!hdc.strControllerType.compare("PIIX3", Utf8Str::CaseInsensitive))
583 strType = "PIIX3";
584 else if (!hdc.strControllerType.compare("ICH6", Utf8Str::CaseInsensitive))
585 strType = "ICH6";
586 pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
587 strControllerID, // strRef
588 hdc.strControllerType, // aOvfValue
589 strType); // aVBoxValue
590 }
591 else
592 /* Warn only once */
593 if (cIDEused == 2)
594 i_addWarning(tr("The virtual \"%s\" system requests support for more than two "
595 "IDE controller channels, but VirtualBox supports only two."),
596 vsysThis.strName.c_str());
597
598 ++cIDEused;
599 break;
600
601 case ovf::HardDiskController::SATA:
602 /* Check for the constrains */
603 if (cSATAused < 1)
604 {
605 /// @todo figure out the SATA types
606 /* We only support a plain AHCI controller, so use them always */
607 pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,
608 strControllerID,
609 hdc.strControllerType,
610 "AHCI");
611 }
612 else
613 {
614 /* Warn only once */
615 if (cSATAused == 1)
616 i_addWarning(tr("The virtual system \"%s\" requests support for more than one "
617 "SATA controller, but VirtualBox has support for only one"),
618 vsysThis.strName.c_str());
619
620 }
621 ++cSATAused;
622 break;
623
624 case ovf::HardDiskController::SCSI:
625 /* Check for the constrains */
626 if (cSCSIused < 1)
627 {
628 VirtualSystemDescriptionType_T vsdet = VirtualSystemDescriptionType_HardDiskControllerSCSI;
629 Utf8Str hdcController = "LsiLogic";
630 if (!hdc.strControllerType.compare("lsilogicsas", Utf8Str::CaseInsensitive))
631 {
632 // OVF considers SAS a variant of SCSI but VirtualBox considers it a class of its own
633 vsdet = VirtualSystemDescriptionType_HardDiskControllerSAS;
634 hdcController = "LsiLogicSas";
635 }
636 else if (!hdc.strControllerType.compare("BusLogic", Utf8Str::CaseInsensitive))
637 hdcController = "BusLogic";
638 pNewDesc->i_addEntry(vsdet,
639 strControllerID,
640 hdc.strControllerType,
641 hdcController);
642 }
643 else
644 i_addWarning(tr("The virtual system \"%s\" requests support for an additional "
645 "SCSI controller of type \"%s\" with ID %s, but VirtualBox presently "
646 "supports only one SCSI controller."),
647 vsysThis.strName.c_str(),
648 hdc.strControllerType.c_str(),
649 strControllerID.c_str());
650 ++cSCSIused;
651 break;
652 }
653 }
654
655 /* Storage devices (hard disks/DVDs/...) */
656 if (vsysThis.mapVirtualDisks.size() > 0)
657 {
658 ovf::VirtualDisksMap::const_iterator itVD;
659 /* Iterate through all storage devices */
660 for (itVD = vsysThis.mapVirtualDisks.begin();
661 itVD != vsysThis.mapVirtualDisks.end();
662 ++itVD)
663 {
664 const ovf::VirtualDisk &hd = itVD->second;
665 /* Get the associated image */
666 ovf::DiskImage di;
667 std::map<RTCString, ovf::DiskImage>::iterator foundDisk;
668
669 foundDisk = m->pReader->m_mapDisks.find(hd.strDiskId);
670 if (foundDisk == m->pReader->m_mapDisks.end())
671 continue;
672 else
673 {
674 di = foundDisk->second;
675 }
676
677 /*
678 * Figure out from URI which format the image has.
679 * There is no strict mapping of image URI to image format.
680 * It's possible we aren't able to recognize some URIs.
681 */
682
683 ComObjPtr<MediumFormat> mediumFormat;
684 rc = i_findMediumFormatFromDiskImage(di, mediumFormat);
685 if (FAILED(rc))
686 throw rc;
687
688 Bstr bstrFormatName;
689 rc = mediumFormat->COMGETTER(Name)(bstrFormatName.asOutParam());
690 if (FAILED(rc))
691 throw rc;
692 Utf8Str vdf = Utf8Str(bstrFormatName);
693
694 /// @todo
695 // - figure out all possible vmdk formats we also support
696 // - figure out if there is a url specifier for vhd already
697 // - we need a url specifier for the vdi format
698
699 Utf8Str strFilename = di.strHref;
700 DeviceType_T devType = DeviceType_Null;
701 if (vdf.compare("VMDK", Utf8Str::CaseInsensitive) == 0)
702 {
703 /* If the href is empty use the VM name as filename */
704 if (!strFilename.length())
705 strFilename = Utf8StrFmt("%s.vmdk", hd.strDiskId.c_str());
706 devType = DeviceType_HardDisk;
707 }
708 else if (vdf.compare("RAW", Utf8Str::CaseInsensitive) == 0)
709 {
710 /* If the href is empty use the VM name as filename */
711 if (!strFilename.length())
712 strFilename = Utf8StrFmt("%s.iso", hd.strDiskId.c_str());
713 devType = DeviceType_DVD;
714 }
715 else
716 throw setError(VBOX_E_FILE_ERROR,
717 tr("Unsupported format for virtual disk image %s in OVF: \"%s\""),
718 di.strHref.c_str(),
719 di.strFormat.c_str());
720
721 /*
722 * Remove last extension from the file name if the file is compressed
723 */
724 if (di.strCompression.compare("gzip", Utf8Str::CaseInsensitive)==0)
725 strFilename.stripSuffix();
726
727 i_searchUniqueImageFilePath(strMachineFolder, devType, strFilename); /** @todo check the return code! */
728
729 /* find the description for the storage controller
730 * that has the same ID as hd.idController */
731 const VirtualSystemDescriptionEntry *pController;
732 if (!(pController = pNewDesc->i_findControllerFromID(hd.idController)))
733 throw setError(E_FAIL,
734 tr("Cannot find storage controller with OVF instance ID %RI32 "
735 "to which medium \"%s\" should be attached"),
736 hd.idController,
737 di.strHref.c_str());
738
739 /* controller to attach to, and the bus within that controller */
740 Utf8StrFmt strExtraConfig("controller=%RI16;channel=%RI16",
741 pController->ulIndex,
742 hd.ulAddressOnParent);
743 pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskImage,
744 hd.strDiskId,
745 di.strHref,
746 strFilename,
747 di.ulSuggestedSizeMB,
748 strExtraConfig);
749 }
750 }
751
752 m->virtualSystemDescriptions.push_back(pNewDesc);
753 }
754 }
755 catch (HRESULT aRC)
756 {
757 /* On error we clear the list & return */
758 m->virtualSystemDescriptions.clear();
759 rc = aRC;
760 }
761
762 // reset the appliance state
763 alock.acquire();
764 m->state = ApplianceIdle;
765
766 return rc;
767}
768
769/**
770 * Public method implementation. This creates one or more new machines according to the
771 * VirtualSystemScription instances created by Appliance::Interpret().
772 * Thread implementation is in Appliance::i_importImpl().
773 * @param aOptions Import options.
774 * @param aProgress Progress object.
775 * @return
776 */
777HRESULT Appliance::importMachines(const std::vector<ImportOptions_T> &aOptions,
778 ComPtr<IProgress> &aProgress)
779{
780 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
781
782 if (aOptions.size())
783 {
784 try
785 {
786 m->optListImport.setCapacity(aOptions.size());
787 for (size_t i = 0; i < aOptions.size(); ++i)
788 m->optListImport.insert(i, aOptions[i]);
789 }
790 catch (std::bad_alloc &)
791 {
792 return E_OUTOFMEMORY;
793 }
794 }
795
796 AssertReturn(!( m->optListImport.contains(ImportOptions_KeepAllMACs)
797 && m->optListImport.contains(ImportOptions_KeepNATMACs) )
798 , E_INVALIDARG);
799
800 // do not allow entering this method if the appliance is busy reading or writing
801 if (!i_isApplianceIdle())
802 return E_ACCESSDENIED;
803
804 //check for the local import only. For import from the Cloud m->pReader is always NULL.
805 if (m->locInfo.storageType == VFSType_File && !m->pReader)
806 return setError(E_FAIL,
807 tr("Cannot import machines without reading it first (call read() before i_importMachines())"));
808
809 ComObjPtr<Progress> progress;
810 HRESULT hrc = i_importImpl(m->locInfo, progress);
811 if (SUCCEEDED(hrc))
812 progress.queryInterfaceTo(aProgress.asOutParam());
813
814 return hrc;
815}
816
817////////////////////////////////////////////////////////////////////////////////
818//
819// Appliance private methods
820//
821////////////////////////////////////////////////////////////////////////////////
822
823/**
824 * Ensures that there is a look-ahead object ready.
825 *
826 * @returns true if there's an object handy, false if end-of-stream.
827 * @throws HRESULT if the next object isn't a regular file. Sets error info
828 * (which is why it's a method on Appliance and not the
829 * ImportStack).
830 */
831bool Appliance::i_importEnsureOvaLookAhead(ImportStack &stack)
832{
833 Assert(stack.hVfsFssOva != NULL);
834 if (stack.hVfsIosOvaLookAhead == NIL_RTVFSIOSTREAM)
835 {
836 RTStrFree(stack.pszOvaLookAheadName);
837 stack.pszOvaLookAheadName = NULL;
838
839 RTVFSOBJTYPE enmType;
840 RTVFSOBJ hVfsObj;
841 int vrc = RTVfsFsStrmNext(stack.hVfsFssOva, &stack.pszOvaLookAheadName, &enmType, &hVfsObj);
842 if (RT_SUCCESS(vrc))
843 {
844 stack.hVfsIosOvaLookAhead = RTVfsObjToIoStream(hVfsObj);
845 RTVfsObjRelease(hVfsObj);
846 if ( ( enmType != RTVFSOBJTYPE_FILE
847 && enmType != RTVFSOBJTYPE_IO_STREAM)
848 || stack.hVfsIosOvaLookAhead == NIL_RTVFSIOSTREAM)
849 throw setError(VBOX_E_FILE_ERROR,
850 tr("Malformed OVA. '%s' is not a regular file (%d)."), stack.pszOvaLookAheadName, enmType);
851 }
852 else if (vrc == VERR_EOF)
853 return false;
854 else
855 throw setErrorVrc(vrc, tr("RTVfsFsStrmNext failed (%Rrc)"), vrc);
856 }
857 return true;
858}
859
860HRESULT Appliance::i_preCheckImageAvailability(ImportStack &stack)
861{
862 if (i_importEnsureOvaLookAhead(stack))
863 return S_OK;
864 throw setError(VBOX_E_FILE_ERROR, tr("Unexpected end of OVA package"));
865 /** @todo r=bird: dunno why this bother returning a value and the caller
866 * having a special 'continue' case for it. It always threw all non-OK
867 * status codes. It's possibly to handle out of order stuff, so that
868 * needs adding to the testcase! */
869}
870
871/**
872 * Opens a source file (for reading obviously).
873 *
874 * @param stack
875 * @param rstrSrcPath The source file to open.
876 * @param pszManifestEntry The manifest entry of the source file. This is
877 * used when constructing our manifest using a pass
878 * thru.
879 * @returns I/O stream handle to the source file.
880 * @throws HRESULT error status, error info set.
881 */
882RTVFSIOSTREAM Appliance::i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry)
883{
884 /*
885 * Open the source file. Special considerations for OVAs.
886 */
887 RTVFSIOSTREAM hVfsIosSrc;
888 if (stack.hVfsFssOva != NIL_RTVFSFSSTREAM)
889 {
890 for (uint32_t i = 0;; i++)
891 {
892 if (!i_importEnsureOvaLookAhead(stack))
893 throw setErrorBoth(VBOX_E_FILE_ERROR, VERR_EOF,
894 tr("Unexpected end of OVA / internal error - missing '%s' (skipped %u)"),
895 rstrSrcPath.c_str(), i);
896 if (RTStrICmp(stack.pszOvaLookAheadName, rstrSrcPath.c_str()) == 0)
897 break;
898
899 /* release the current object, loop to get the next. */
900 RTVfsIoStrmRelease(stack.claimOvaLookAHead());
901 }
902 hVfsIosSrc = stack.claimOvaLookAHead();
903 }
904 else
905 {
906 int vrc = RTVfsIoStrmOpenNormal(rstrSrcPath.c_str(), RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, &hVfsIosSrc);
907 if (RT_FAILURE(vrc))
908 throw setErrorVrc(vrc, tr("Error opening '%s' for reading (%Rrc)"), rstrSrcPath.c_str(), vrc);
909 }
910
911 /*
912 * Digest calculation filtering.
913 */
914 hVfsIosSrc = i_manifestSetupDigestCalculationForGivenIoStream(hVfsIosSrc, pszManifestEntry);
915 if (hVfsIosSrc == NIL_RTVFSIOSTREAM)
916 throw E_FAIL;
917
918 return hVfsIosSrc;
919}
920
921/**
922 * Creates the destination file and fills it with bytes from the source stream.
923 *
924 * This assumes that we digest the source when fDigestTypes is non-zero, and
925 * thus calls RTManifestPtIosAddEntryNow when done.
926 *
927 * @param rstrDstPath The path to the destination file. Missing path
928 * components will be created.
929 * @param hVfsIosSrc The source I/O stream.
930 * @param rstrSrcLogNm The name of the source for logging and error
931 * messages.
932 * @returns COM status code.
933 * @throws Nothing (as the caller has VFS handles to release).
934 */
935HRESULT Appliance::i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath, RTVFSIOSTREAM hVfsIosSrc,
936 Utf8Str const &rstrSrcLogNm)
937{
938 int vrc;
939
940 /*
941 * Create the output file, including necessary paths.
942 * Any existing file will be overwritten.
943 */
944 HRESULT hrc = VirtualBox::i_ensureFilePathExists(rstrDstPath, true /*fCreate*/);
945 if (SUCCEEDED(hrc))
946 {
947 RTVFSIOSTREAM hVfsIosDst;
948 vrc = RTVfsIoStrmOpenNormal(rstrDstPath.c_str(),
949 RTFILE_O_CREATE_REPLACE | RTFILE_O_WRITE | RTFILE_O_DENY_ALL,
950 &hVfsIosDst);
951 if (RT_SUCCESS(vrc))
952 {
953 /*
954 * Pump the bytes thru. If we fail, delete the output file.
955 */
956 vrc = RTVfsUtilPumpIoStreams(hVfsIosSrc, hVfsIosDst, 0);
957 if (RT_SUCCESS(vrc))
958 hrc = S_OK;
959 else
960 hrc = setErrorVrc(vrc, tr("Error occured decompressing '%s' to '%s' (%Rrc)"),
961 rstrSrcLogNm.c_str(), rstrDstPath.c_str(), vrc);
962 uint32_t cRefs = RTVfsIoStrmRelease(hVfsIosDst);
963 AssertMsg(cRefs == 0, ("cRefs=%u\n", cRefs)); NOREF(cRefs);
964 if (RT_FAILURE(vrc))
965 RTFileDelete(rstrDstPath.c_str());
966 }
967 else
968 hrc = setErrorVrc(vrc, tr("Error opening destionation image '%s' for writing (%Rrc)"), rstrDstPath.c_str(), vrc);
969 }
970 return hrc;
971}
972
973
974/**
975 *
976 * @param stack Import stack.
977 * @param rstrSrcPath Source path.
978 * @param rstrDstPath Destination path.
979 * @param pszManifestEntry The manifest entry of the source file. This is
980 * used when constructing our manifest using a pass
981 * thru.
982 * @throws HRESULT error status, error info set.
983 */
984void Appliance::i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
985 const char *pszManifestEntry)
986{
987 /*
988 * Open the file (throws error) and add a read ahead thread so we can do
989 * concurrent reads (+digest) and writes.
990 */
991 RTVFSIOSTREAM hVfsIosSrc = i_importOpenSourceFile(stack, rstrSrcPath, pszManifestEntry);
992 RTVFSIOSTREAM hVfsIosReadAhead;
993 int vrc = RTVfsCreateReadAheadForIoStream(hVfsIosSrc, 0 /*fFlags*/, 0 /*cBuffers=default*/, 0 /*cbBuffers=default*/,
994 &hVfsIosReadAhead);
995 if (RT_FAILURE(vrc))
996 {
997 RTVfsIoStrmRelease(hVfsIosSrc);
998 throw setErrorVrc(vrc, tr("Error initializing read ahead thread for '%s' (%Rrc)"), rstrSrcPath.c_str(), vrc);
999 }
1000
1001 /*
1002 * Write the destination file (nothrow).
1003 */
1004 HRESULT hrc = i_importCreateAndWriteDestinationFile(rstrDstPath, hVfsIosReadAhead, rstrSrcPath);
1005 RTVfsIoStrmRelease(hVfsIosReadAhead);
1006
1007 /*
1008 * Before releasing the source stream, make sure we've successfully added
1009 * the digest to our manifest.
1010 */
1011 if (SUCCEEDED(hrc) && m->fDigestTypes)
1012 {
1013 vrc = RTManifestPtIosAddEntryNow(hVfsIosSrc);
1014 if (RT_FAILURE(vrc))
1015 hrc = setErrorVrc(vrc, tr("RTManifestPtIosAddEntryNow failed with %Rrc"), vrc);
1016 }
1017
1018 uint32_t cRefs = RTVfsIoStrmRelease(hVfsIosSrc);
1019 AssertMsg(cRefs == 0, ("cRefs=%u\n", cRefs)); NOREF(cRefs);
1020 if (SUCCEEDED(hrc))
1021 return;
1022 throw hrc;
1023}
1024
1025/**
1026 *
1027 * @param stack
1028 * @param rstrSrcPath
1029 * @param rstrDstPath
1030 * @param pszManifestEntry The manifest entry of the source file. This is
1031 * used when constructing our manifest using a pass
1032 * thru.
1033 * @throws HRESULT error status, error info set.
1034 */
1035void Appliance::i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
1036 const char *pszManifestEntry)
1037{
1038 RTVFSIOSTREAM hVfsIosSrcCompressed = i_importOpenSourceFile(stack, rstrSrcPath, pszManifestEntry);
1039
1040 /*
1041 * Add a read ahead thread here. This means reading and digest calculation
1042 * is done on one thread, while unpacking and writing is one on this thread.
1043 */
1044 RTVFSIOSTREAM hVfsIosReadAhead;
1045 int vrc = RTVfsCreateReadAheadForIoStream(hVfsIosSrcCompressed, 0 /*fFlags*/, 0 /*cBuffers=default*/,
1046 0 /*cbBuffers=default*/, &hVfsIosReadAhead);
1047 if (RT_FAILURE(vrc))
1048 {
1049 RTVfsIoStrmRelease(hVfsIosSrcCompressed);
1050 throw setErrorVrc(vrc, tr("Error initializing read ahead thread for '%s' (%Rrc)"), rstrSrcPath.c_str(), vrc);
1051 }
1052
1053 /*
1054 * Add decompression step.
1055 */
1056 RTVFSIOSTREAM hVfsIosSrc;
1057 vrc = RTZipGzipDecompressIoStream(hVfsIosReadAhead, 0, &hVfsIosSrc);
1058 RTVfsIoStrmRelease(hVfsIosReadAhead);
1059 if (RT_FAILURE(vrc))
1060 {
1061 RTVfsIoStrmRelease(hVfsIosSrcCompressed);
1062 throw setErrorVrc(vrc, tr("Error initializing gzip decompression for '%s' (%Rrc)"), rstrSrcPath.c_str(), vrc);
1063 }
1064
1065 /*
1066 * Write the stream to the destination file (nothrow).
1067 */
1068 HRESULT hrc = i_importCreateAndWriteDestinationFile(rstrDstPath, hVfsIosSrc, rstrSrcPath);
1069
1070 /*
1071 * Before releasing the source stream, make sure we've successfully added
1072 * the digest to our manifest.
1073 */
1074 if (SUCCEEDED(hrc) && m->fDigestTypes)
1075 {
1076 vrc = RTManifestPtIosAddEntryNow(hVfsIosSrcCompressed);
1077 if (RT_FAILURE(vrc))
1078 hrc = setErrorVrc(vrc, tr("RTManifestPtIosAddEntryNow failed with %Rrc"), vrc);
1079 }
1080
1081 uint32_t cRefs = RTVfsIoStrmRelease(hVfsIosSrc);
1082 AssertMsg(cRefs == 0, ("cRefs=%u\n", cRefs)); NOREF(cRefs);
1083
1084 cRefs = RTVfsIoStrmRelease(hVfsIosSrcCompressed);
1085 AssertMsg(cRefs == 0, ("cRefs=%u\n", cRefs)); NOREF(cRefs);
1086
1087 if (SUCCEEDED(hrc))
1088 return;
1089 throw hrc;
1090}
1091
1092/*******************************************************************************
1093 * Read stuff
1094 ******************************************************************************/
1095
1096/**
1097 * Implementation for reading an OVF (via task).
1098 *
1099 * This starts a new thread which will call
1100 * Appliance::taskThreadImportOrExport() which will then call readFS(). This
1101 * will then open the OVF with ovfreader.cpp.
1102 *
1103 * This is in a separate private method because it is used from two locations:
1104 *
1105 * 1) from the public Appliance::Read().
1106 *
1107 * 2) in a second worker thread; in that case, Appliance::ImportMachines() called Appliance::i_importImpl(), which
1108 * called Appliance::readFSOVA(), which called Appliance::i_importImpl(), which then called this again.
1109 *
1110 * @returns COM status with error info set.
1111 * @param aLocInfo The OVF location.
1112 * @param aProgress Where to return the progress object.
1113 */
1114HRESULT Appliance::i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)
1115{
1116 /*
1117 * Create the progress object.
1118 */
1119 HRESULT hrc;
1120 aProgress.createObject();
1121 try
1122 {
1123 if (aLocInfo.storageType == VFSType_Cloud)
1124 {
1125 /* 1 operation only */
1126 hrc = aProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
1127 Utf8Str(tr("Getting cloud instance information")), TRUE /* aCancelable */);
1128
1129 /* Create an empty ovf::OVFReader for manual filling it.
1130 * It's not a normal usage case, but we try to re-use some OVF stuff to friend
1131 * the cloud import with OVF import.
1132 * In the standard case the ovf::OVFReader is created in the Appliance::i_readOVFFile().
1133 * We need the existing m->pReader for Appliance::i_importCloudImpl() where we re-use OVF logic. */
1134 m->pReader = new ovf::OVFReader();
1135 }
1136 else
1137 {
1138 Utf8StrFmt strDesc(tr("Reading appliance '%s'"), aLocInfo.strPath.c_str());
1139 if (aLocInfo.storageType == VFSType_File)
1140 /* 1 operation only */
1141 hrc = aProgress->init(mVirtualBox, static_cast<IAppliance*>(this), strDesc, TRUE /* aCancelable */);
1142 else
1143 /* 4/5 is downloading, 1/5 is reading */
1144 hrc = aProgress->init(mVirtualBox, static_cast<IAppliance*>(this), strDesc, TRUE /* aCancelable */,
1145 2, // ULONG cOperations,
1146 5, // ULONG ulTotalOperationsWeight,
1147 Utf8StrFmt(tr("Download appliance '%s'"),
1148 aLocInfo.strPath.c_str()), // CBSTR bstrFirstOperationDescription,
1149 4); // ULONG ulFirstOperationWeight,
1150 }
1151 }
1152 catch (std::bad_alloc &) /* Utf8Str/Utf8StrFmt */
1153 {
1154 return E_OUTOFMEMORY;
1155 }
1156 if (FAILED(hrc))
1157 return hrc;
1158
1159 /*
1160 * Initialize the worker task.
1161 */
1162 ThreadTask *pTask;
1163 try
1164 {
1165 if (aLocInfo.storageType == VFSType_Cloud)
1166 pTask = new TaskCloud(this, TaskCloud::ReadData, aLocInfo, aProgress);
1167 else
1168 pTask = new TaskOVF(this, TaskOVF::Read, aLocInfo, aProgress);
1169 }
1170 catch (std::bad_alloc &)
1171 {
1172 return E_OUTOFMEMORY;
1173 }
1174
1175 /*
1176 * Kick off the worker thread.
1177 */
1178 hrc = pTask->createThread();
1179 pTask = NULL; /* Note! createThread has consumed the task.*/
1180 if (SUCCEEDED(hrc))
1181 return hrc;
1182 return setError(hrc, tr("Failed to create thread for reading appliance data"));
1183}
1184
1185HRESULT Appliance::i_gettingCloudData(TaskCloud *pTask)
1186{
1187 LogFlowFuncEnter();
1188 LogFlowFunc(("Appliance %p\n", this));
1189
1190 AutoCaller autoCaller(this);
1191 if (FAILED(autoCaller.rc())) return autoCaller.rc();
1192
1193 AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
1194
1195 HRESULT hrc = S_OK;
1196
1197 try
1198 {
1199 Utf8Str strBasename(pTask->locInfo.strPath);
1200 RTCList<RTCString, RTCString *> parts = strBasename.split("/" );
1201 if (parts.size() != 2)//profile + instance id
1202 {
1203 return setErrorVrc(VERR_MISMATCH, tr("%s: The profile name or instance id are absent or"
1204 "contain unsupported characters.", __FUNCTION__));
1205 }
1206
1207 //Get information about the passed cloud instance
1208 ComPtr<ICloudProviderManager> cpm;
1209 hrc = mVirtualBox->COMGETTER(CloudProviderManager)(cpm.asOutParam());
1210 if (FAILED(hrc))
1211 return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud provider manager object wasn't found"), __FUNCTION__);
1212
1213 Utf8Str strProviderName = pTask->locInfo.strProvider;
1214 ComPtr<ICloudProvider> cloudProvider;
1215 ComPtr<ICloudProfile> cloudProfile;
1216 hrc = cpm->GetProviderByShortName(Bstr(strProviderName.c_str()).raw(), cloudProvider.asOutParam());
1217
1218 if (FAILED(hrc))
1219 return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud provider object wasn't found"), __FUNCTION__);
1220
1221 Utf8Str profileName(parts.at(0));//profile
1222 if (profileName.isEmpty())
1223 return setErrorVrc(VBOX_E_OBJECT_NOT_FOUND, tr("%s: Cloud user profile name wasn't found"), __FUNCTION__);
1224
1225 hrc = cloudProvider->GetProfileByName(Bstr(parts.at(0)).raw(), cloudProfile.asOutParam());
1226 if (FAILED(hrc))
1227 return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud profile object wasn't found"), __FUNCTION__);
1228
1229 ComObjPtr<ICloudClient> cloudClient;
1230 hrc = cloudProfile->CreateCloudClient(cloudClient.asOutParam());
1231 if (FAILED(hrc))
1232 return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud client object wasn't found"), __FUNCTION__);
1233
1234 m->virtualSystemDescriptions.clear();//clear all for assurance before creating new
1235 std::vector<ComPtr<IVirtualSystemDescription> > vsdArray;
1236 ULONG requestedVSDnums = 1;
1237 ULONG newVSDnums = 0;
1238 hrc = createVirtualSystemDescriptions(requestedVSDnums, &newVSDnums);
1239 if (FAILED(hrc)) throw hrc;
1240 if (requestedVSDnums != newVSDnums)
1241 throw setErrorVrc(VERR_MISMATCH, tr("%s: Requested and created numbers of VSD are differ."), __FUNCTION__);
1242
1243 hrc = getVirtualSystemDescriptions(vsdArray);
1244 if (FAILED(hrc)) throw hrc;
1245 ComPtr<IVirtualSystemDescription> instanceDescription = vsdArray[0];
1246
1247 LogRel(("%s: calling CloudClient::GetInstanceInfo()\n", __FUNCTION__));
1248
1249 ComPtr<IProgress> pProgress;
1250 hrc = cloudClient->GetInstanceInfo(Bstr(parts.at(1)).raw(), instanceDescription, pProgress.asOutParam());
1251 if (FAILED(hrc)) throw hrc;
1252 hrc = pTask->pProgress->WaitForOtherProgressCompletion(pProgress, 60000);//timeout 1 min = 60000 millisec
1253 if (FAILED(hrc)) throw hrc;
1254
1255 // set cloud profile
1256 instanceDescription->AddDescription(VirtualSystemDescriptionType_CloudProfileName,
1257 Bstr(profileName).raw(),
1258 NULL);
1259
1260 Utf8StrFmt strSetting("VM with id %s imported from the cloud provider %s",
1261 parts.at(1).c_str(), strProviderName.c_str());
1262 // set description
1263 instanceDescription->AddDescription(VirtualSystemDescriptionType_Description,
1264 Bstr(strSetting).raw(),
1265 NULL);
1266 }
1267 catch (HRESULT arc)
1268 {
1269 LogFlowFunc(("arc=%Rhrc\n", arc));
1270 hrc = arc;
1271 }
1272
1273 LogFlowFunc(("rc=%Rhrc\n", hrc));
1274 LogFlowFuncLeave();
1275
1276 return hrc;
1277}
1278
1279void Appliance::i_setApplianceState(const ApplianceState &state)
1280{
1281 AutoWriteLock writeLock(this COMMA_LOCKVAL_SRC_POS);
1282 m->state = state;
1283 writeLock.release();
1284}
1285
1286/**
1287 * Actual worker code for import from the Cloud
1288 *
1289 * @param pTask
1290 * @return
1291 */
1292HRESULT Appliance::i_importCloudImpl(TaskCloud *pTask)
1293{
1294 LogFlowFuncEnter();
1295 LogFlowFunc(("Appliance %p\n", this));
1296
1297 int vrc = VINF_SUCCESS;
1298 HRESULT hrc = S_OK;
1299 bool fKeepDownloadedObject = false;//in the future should be passed from the caller
1300 Utf8Str strLastActualErrorDesc("No errors");
1301
1302 /* Clear the list of imported machines, if any */
1303 m->llGuidsMachinesCreated.clear();
1304
1305 ComPtr<ICloudProviderManager> cpm;
1306 hrc = mVirtualBox->COMGETTER(CloudProviderManager)(cpm.asOutParam());
1307 if (FAILED(hrc))
1308 return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud provider manager object wasn't found"), __FUNCTION__);
1309
1310 Utf8Str strProviderName = pTask->locInfo.strProvider;
1311 ComPtr<ICloudProvider> cloudProvider;
1312 ComPtr<ICloudProfile> cloudProfile;
1313 hrc = cpm->GetProviderByShortName(Bstr(strProviderName.c_str()).raw(), cloudProvider.asOutParam());
1314
1315 if (FAILED(hrc))
1316 return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud provider object wasn't found"), __FUNCTION__);
1317
1318 /* Get the actual VSD, only one VSD object can be there for now so just call the function front() */
1319 ComPtr<IVirtualSystemDescription> vsd = m->virtualSystemDescriptions.front();
1320
1321 Utf8Str vsdData;
1322 com::SafeArray<VirtualSystemDescriptionType_T> retTypes;
1323 com::SafeArray<BSTR> aRefs;
1324 com::SafeArray<BSTR> aOvfValues;
1325 com::SafeArray<BSTR> aVBoxValues;
1326 com::SafeArray<BSTR> aExtraConfigValues;
1327
1328/*
1329 * local #define for better reading the code
1330 * uses only the previously locally declared variable names
1331 * set hrc as the result of operation
1332 */
1333#define GET_VSD_DESCRIPTION_BY_TYPE(aParamType) \
1334 retTypes.setNull(); \
1335 aRefs.setNull(); \
1336 aOvfValues.setNull(); \
1337 aVBoxValues.setNull(); \
1338 aExtraConfigValues.setNull(); \
1339 vsd->GetDescriptionByType(aParamType, \
1340 ComSafeArrayAsOutParam(retTypes), \
1341 ComSafeArrayAsOutParam(aRefs), \
1342 ComSafeArrayAsOutParam(aOvfValues), \
1343 ComSafeArrayAsOutParam(aVBoxValues), \
1344 ComSafeArrayAsOutParam(aExtraConfigValues)); \
1345
1346
1347 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_CloudProfileName)
1348 if (aVBoxValues.size() == 0)
1349 return setErrorVrc(VERR_NOT_FOUND, tr("%s: Cloud user profile name wasn't found"), __FUNCTION__);
1350
1351 Utf8Str profileName(aVBoxValues[0]);
1352 if (profileName.isEmpty())
1353 return setErrorVrc(VERR_INVALID_STATE, tr("%s: Cloud user profile name is empty"), __FUNCTION__);
1354
1355 hrc = cloudProvider->GetProfileByName(aVBoxValues[0], cloudProfile.asOutParam());
1356 if (FAILED(hrc))
1357 return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud profile object wasn't found"), __FUNCTION__);
1358
1359 ComObjPtr<ICloudClient> cloudClient;
1360 hrc = cloudProfile->CreateCloudClient(cloudClient.asOutParam());
1361 if (FAILED(hrc))
1362 return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud client object wasn't found"), __FUNCTION__);
1363
1364 ComPtr<IProgress> pProgress;
1365 hrc = pTask->pProgress.queryInterfaceTo(pProgress.asOutParam());
1366 if (FAILED(hrc))
1367 return hrc;
1368
1369 Utf8Str strOsType;
1370 ComPtr<IGuestOSType> pGuestOSType;
1371 {
1372 VBOXOSTYPE guestOsType = VBOXOSTYPE_Unknown;
1373 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_OS)//aVBoxValues is set in this #define
1374 if (aVBoxValues.size() != 0)
1375 {
1376 strOsType = aVBoxValues[0];
1377 /* Check the OS type */
1378 uint32_t const idxOSType = Global::getOSTypeIndexFromId(strOsType.c_str());
1379 guestOsType = idxOSType < Global::cOSTypes ? Global::sOSTypes[idxOSType].osType : VBOXOSTYPE_Unknown;
1380
1381 /* Case when some invalid OS type or garbage was passed. Set to VBOXOSTYPE_Unknown. */
1382 if (idxOSType > Global::cOSTypes)
1383 {
1384 strOsType = Global::OSTypeId(guestOsType);
1385 vsd->RemoveDescriptionByType(VirtualSystemDescriptionType_OS);
1386 vsd->AddDescription(VirtualSystemDescriptionType_OS,
1387 Bstr(strOsType).raw(),
1388 NULL);
1389 }
1390 }
1391 /* Case when no OS type was passed. Set to VBOXOSTYPE_Unknown. */
1392 else
1393 {
1394 strOsType = Global::OSTypeId(guestOsType);
1395 vsd->AddDescription(VirtualSystemDescriptionType_OS,
1396 Bstr(strOsType).raw(),
1397 NULL);
1398 }
1399
1400 LogRel(("%s: OS type is %s\n", __FUNCTION__, strOsType.c_str()));
1401
1402 /* We can get some default settings from GuestOSType when it's needed */
1403 hrc = mVirtualBox->GetGuestOSType(Bstr(strOsType).raw(), pGuestOSType.asOutParam());
1404 if (FAILED(hrc))
1405 return hrc;
1406 }
1407
1408 /* Should be defined here because it's used later, at least when ComposeMachineFilename() is called */
1409 Utf8Str strVMName("VM_exported_from_cloud");
1410
1411 if (m->virtualSystemDescriptions.size() == 1)
1412 {
1413 do
1414 {
1415 ComPtr<IVirtualBox> VBox(mVirtualBox);
1416
1417 {
1418 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_Name)//aVBoxValues is set in this #define
1419 if (aVBoxValues.size() != 0)//paranoia but anyway...
1420 strVMName = aVBoxValues[0];
1421 LogRel(("%s: VM name is %s\n", __FUNCTION__, strVMName.c_str()));
1422 }
1423
1424// i_searchUniqueVMName(strVMName);//internally calls setError() in the case of absent the registered VM with such name
1425
1426 ComPtr<IMachine> machine;
1427 hrc = mVirtualBox->FindMachine(Bstr(strVMName.c_str()).raw(), machine.asOutParam());
1428 if (SUCCEEDED(hrc))
1429 {
1430 /* what to do? create a new name from the old one with some suffix? */
1431 com::Guid newId;
1432 newId.create();
1433 strVMName.append("__").append(newId.toString());
1434 vsd->RemoveDescriptionByType(VirtualSystemDescriptionType_Name);
1435 vsd->AddDescription(VirtualSystemDescriptionType_Name,
1436 Bstr(strVMName).raw(),
1437 NULL);
1438 /* No check again because it would be weird if a VM with such unique name exists */
1439 }
1440
1441 /* Check the target path. If the path exists and folder isn't empty return an error */
1442 {
1443 Bstr bstrSettingsFilename;
1444 /* Based on the VM name, create a target machine path. */
1445 hrc = mVirtualBox->ComposeMachineFilename(Bstr(strVMName).raw(),
1446 Bstr("/").raw(),
1447 NULL /* aCreateFlags */,
1448 NULL /* aBaseFolder */,
1449 bstrSettingsFilename.asOutParam());
1450 if (FAILED(hrc))
1451 break;
1452
1453 Utf8Str strMachineFolder(bstrSettingsFilename);
1454 strMachineFolder.stripFilename();
1455
1456 RTFSOBJINFO dirInfo;
1457 vrc = RTPathQueryInfo(strMachineFolder.c_str(), &dirInfo, RTFSOBJATTRADD_NOTHING);
1458 if (RT_SUCCESS(vrc))
1459 {
1460 size_t counter = 0;
1461 RTDIR hDir;
1462 vrc = RTDirOpen(&hDir, strMachineFolder.c_str());
1463 if (RT_SUCCESS(vrc))
1464 {
1465 RTDIRENTRY DirEntry;
1466 while (RT_SUCCESS(RTDirRead(hDir, &DirEntry, NULL)))
1467 {
1468 if (RTDirEntryIsStdDotLink(&DirEntry))
1469 continue;
1470 ++counter;
1471 }
1472
1473 if ( hDir != NULL)
1474 vrc = RTDirClose(hDir);
1475 }
1476 else
1477 return setErrorVrc(vrc, tr("Can't open folder %s"), strMachineFolder.c_str());
1478
1479 if (counter > 0)
1480 {
1481 return setErrorVrc(VERR_ALREADY_EXISTS, tr("The target folder %s has already contained some"
1482 " files (%d items). Clear the folder from the files or choose another folder"),
1483 strMachineFolder.c_str(), counter);
1484 }
1485 }
1486 }
1487
1488 Utf8Str strInsId;
1489 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_CloudInstanceId)//aVBoxValues is set in this #define
1490 if (aVBoxValues.size() == 0)
1491 return setErrorVrc(VERR_NOT_FOUND, "%s: Cloud Instance Id wasn't found", __FUNCTION__);
1492
1493 strInsId = aVBoxValues[0];
1494
1495 LogRel(("%s: calling CloudClient::ImportInstance\n", __FUNCTION__));
1496
1497 /* Here it's strongly supposed that cloud import produces ONE object on the disk.
1498 * Because it much easier to manage one object in any case.
1499 * In the case when cloud import creates several object on the disk all of them
1500 * must be combined together into one object by cloud client.
1501 * The most simple way is to create a TAR archive. */
1502 hrc = cloudClient->ImportInstance(m->virtualSystemDescriptions.front(),
1503 pProgress);
1504 if (FAILED(hrc))
1505 {
1506 strLastActualErrorDesc = Utf8StrFmt("%s: Cloud import (cloud phase) failed. "
1507 "Used cloud instance is \'%s\'\n", __FUNCTION__, strInsId.c_str());
1508
1509 LogRel((strLastActualErrorDesc.c_str()));
1510 hrc = setError(hrc, strLastActualErrorDesc.c_str());
1511 break;
1512 }
1513
1514 } while (0);
1515 }
1516 else
1517 {
1518 hrc = setErrorVrc(VERR_NOT_SUPPORTED, tr("Import from Cloud isn't supported for more than one VM instance."));
1519 return hrc;
1520 }
1521
1522
1523 HRESULT original_hrc = hrc;//save the original result
1524
1525 /* In any case we delete the cloud leavings which may exist after the first phase (cloud phase).
1526 * Should they be deleted in the OCICloudClient::importInstance()?
1527 * Because deleting them here is not easy as it in the importInstance(). */
1528 {
1529 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_CloudInstanceId)//aVBoxValues is set in this #define
1530 if (aVBoxValues.size() == 0)
1531 hrc = setErrorVrc(VERR_NOT_FOUND, tr("%s: Cloud cleanup action - the instance wasn't found"), __FUNCTION__);
1532 else
1533 {
1534 vsdData = aVBoxValues[0];
1535
1536 /** @todo
1537 * future function which will eliminate the temporary objects created during the first phase.
1538 * hrc = cloud.EliminateImportLeavings(aVBoxValues[0], pProgress); */
1539/*
1540 if (FAILED(hrc))
1541 {
1542 hrc = setError(hrc, tr("Some leavings may exist in the Cloud."));
1543 LogRel(("%s: Cleanup action - the leavings in the %s after import the "
1544 "instance %s may not have been deleted\n",
1545 __FUNCTION__, strProviderName.c_str(), vsdData.c_str()));
1546 }
1547 else
1548 LogRel(("%s: Cleanup action - the leavings in the %s after import the "
1549 "instance %s have been deleted\n",
1550 __FUNCTION__, strProviderName.c_str(), vsdData.c_str()));
1551*/
1552 }
1553
1554 /* Because during the cleanup phase the hrc may have the good result
1555 * Thus we restore the original error in the case when the cleanup phase was successful
1556 * Otherwise we return not the original error but the last error in the cleanup phase */
1557 hrc = original_hrc;
1558 }
1559
1560 if (FAILED(hrc))
1561 {
1562 Utf8Str generalRollBackErrorMessage("Rollback action for Import Cloud operation failed. "
1563 "Some leavings may exist on the local disk or in the Cloud.");
1564 /*
1565 * Roll-back actions.
1566 * we finish here if:
1567 * 1. Getting the object from the Cloud has been failed.
1568 * 2. Something is wrong with getting data from ComPtr<IVirtualSystemDescription> vsd.
1569 * 3. More than 1 VirtualSystemDescription is presented in the list m->virtualSystemDescriptions.
1570 * Maximum what we have there are:
1571 * 1. The downloaded object, so just check the presence and delete it if one exists
1572 */
1573
1574 {
1575 if (!fKeepDownloadedObject)
1576 {
1577 /* small explanation here, the image here points out to the whole downloaded object (not to the image only)
1578 * filled during the first cloud import stage (in the ICloudClient::importInstance()) */
1579 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_HardDiskImage)//aVBoxValues is set in this #define
1580 if (aVBoxValues.size() == 0)
1581 hrc = setErrorVrc(VERR_NOT_FOUND, generalRollBackErrorMessage.c_str());
1582 else
1583 {
1584 vsdData = aVBoxValues[0];
1585 //try to delete the downloaded object
1586 bool fExist = RTPathExists(vsdData.c_str());
1587 if (fExist)
1588 {
1589 vrc = RTFileDelete(vsdData.c_str());
1590 if (RT_FAILURE(vrc))
1591 {
1592 hrc = setErrorVrc(vrc, generalRollBackErrorMessage.c_str());
1593 LogRel(("%s: Rollback action - the object %s hasn't been deleted\n", __FUNCTION__, vsdData.c_str()));
1594 }
1595 else
1596 LogRel(("%s: Rollback action - the object %s has been deleted\n", __FUNCTION__, vsdData.c_str()));
1597 }
1598 }
1599 }
1600 }
1601
1602 /* Because during the rollback phase the hrc may have the good result
1603 * Thus we restore the original error in the case when the rollback phase was successful
1604 * Otherwise we return not the original error but the last error in the rollback phase */
1605 hrc = original_hrc;
1606 }
1607 else
1608 {
1609 Utf8Str strMachineFolder;
1610 Utf8Str strAbsSrcPath;
1611 Utf8Str strGroup("/");//default VM group
1612 Utf8Str strTargetFormat("VMDK");//default image format
1613 Bstr bstrSettingsFilename;
1614 SystemProperties *pSysProps = NULL;
1615 RTCList<Utf8Str> extraCreatedFiles;/* All extra created files, it's used during cleanup */
1616
1617 /* Put all VFS* declaration here because they are needed to be release by the corresponding
1618 RTVfs***Release functions in the case of exception */
1619 RTVFSOBJ hVfsObj = NIL_RTVFSOBJ;
1620 RTVFSFSSTREAM hVfsFssObject = NIL_RTVFSFSSTREAM;
1621 RTVFSIOSTREAM hVfsIosCurr = NIL_RTVFSIOSTREAM;
1622
1623 try
1624 {
1625 /* Small explanation here, the image here points out to the whole downloaded object (not to the image only)
1626 * filled during the first cloud import stage (in the ICloudClient::importInstance()) */
1627 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_HardDiskImage)//aVBoxValues is set in this #define
1628 if (aVBoxValues.size() == 0)
1629 throw setErrorVrc(VERR_NOT_FOUND, "%s: The description of the downloaded object wasn't found", __FUNCTION__);
1630
1631 strAbsSrcPath = aVBoxValues[0];
1632
1633 /* Based on the VM name, create a target machine path. */
1634 hrc = mVirtualBox->ComposeMachineFilename(Bstr(strVMName).raw(),
1635 Bstr(strGroup).raw(),
1636 NULL /* aCreateFlags */,
1637 NULL /* aBaseFolder */,
1638 bstrSettingsFilename.asOutParam());
1639 if (FAILED(hrc)) throw hrc;
1640
1641 strMachineFolder = bstrSettingsFilename;
1642 strMachineFolder.stripFilename();
1643
1644 /* Get the system properties. */
1645 pSysProps = mVirtualBox->i_getSystemProperties();
1646 if (pSysProps == NULL)
1647 throw VBOX_E_OBJECT_NOT_FOUND;
1648
1649 ComObjPtr<MediumFormat> trgFormat;
1650 trgFormat = pSysProps->i_mediumFormatFromExtension(strTargetFormat);
1651 if (trgFormat.isNull())
1652 throw VBOX_E_OBJECT_NOT_FOUND;
1653
1654 /* Continue and create new VM using data from VSD and downloaded object.
1655 * The downloaded images should be converted to VDI/VMDK if they have another format */
1656 Utf8Str strInstId("default cloud instance id");
1657 {
1658 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_CloudInstanceId)//aVBoxValues is set in this #define
1659 if (aVBoxValues.size() != 0)//paranoia but anyway...
1660 strInstId = aVBoxValues[0];
1661 LogRel(("%s: Importing cloud instance %s\n", __FUNCTION__, strInstId.c_str()));
1662 }
1663
1664 /* Processing the downloaded object (prepare for the local import) */
1665 RTVFSIOSTREAM hVfsIosSrc;
1666 vrc = RTVfsIoStrmOpenNormal(strAbsSrcPath.c_str(), RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, &hVfsIosSrc);
1667 if (RT_FAILURE(vrc))
1668 {
1669 strLastActualErrorDesc = Utf8StrFmt("Error opening '%s' for reading (%Rrc)\n", strAbsSrcPath.c_str(), vrc);
1670 throw setErrorVrc(vrc, strLastActualErrorDesc.c_str());
1671 }
1672
1673 vrc = RTZipTarFsStreamFromIoStream(hVfsIosSrc, 0 /*fFlags*/, &hVfsFssObject);
1674 RTVfsIoStrmRelease(hVfsIosSrc);
1675 if (RT_FAILURE(vrc))
1676 {
1677 strLastActualErrorDesc = Utf8StrFmt("Error reading the downloaded file '%s' (%Rrc)", strAbsSrcPath.c_str(), vrc);
1678 throw setErrorVrc(vrc, strLastActualErrorDesc.c_str());
1679 }
1680
1681 /* Create a new virtual system and work directly on the list copy. */
1682 m->pReader->m_llVirtualSystems.push_back(ovf::VirtualSystem());
1683 ovf::VirtualSystem &vsys = m->pReader->m_llVirtualSystems.back();
1684
1685 /* Try to re-use some OVF stuff here */
1686 {
1687 vsys.strName = strVMName;
1688 uint32_t cpus = 1;
1689 {
1690 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_CPU)//aVBoxValues is set in this #define
1691 if (aVBoxValues.size() != 0)
1692 {
1693 vsdData = aVBoxValues[0];
1694 cpus = vsdData.toUInt32();
1695 }
1696 vsys.cCPUs = (uint16_t)cpus;
1697 LogRel(("%s: Number of CPUs is %s\n", __FUNCTION__, vsdData.c_str()));
1698 }
1699
1700 ULONG memory;//Mb
1701 pGuestOSType->COMGETTER(RecommendedRAM)(&memory);
1702 {
1703 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_Memory)//aVBoxValues is set in this #define
1704 if (aVBoxValues.size() != 0)
1705 {
1706 vsdData = aVBoxValues[0];
1707 if (memory > vsdData.toUInt32())
1708 memory = vsdData.toUInt32();
1709 }
1710 vsys.ullMemorySize = memory;
1711 LogRel(("%s: Size of RAM is %d MB\n", __FUNCTION__, vsys.ullMemorySize));
1712 }
1713
1714 {
1715 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_Description)//aVBoxValues is set in this #define
1716 if (aVBoxValues.size() != 0)
1717 {
1718 vsdData = aVBoxValues[0];
1719 vsys.strDescription = vsdData;
1720 }
1721 LogRel(("%s: VM description \'%s\'\n", __FUNCTION__, vsdData.c_str()));
1722 }
1723
1724 {
1725 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_OS)//aVBoxValues is set in this #define
1726 if (aVBoxValues.size() != 0)
1727 strOsType = aVBoxValues[0];
1728 vsys.strTypeVBox = strOsType;
1729 LogRel(("%s: OS type is %s\n", __FUNCTION__, strOsType.c_str()));
1730 }
1731
1732 ovf::EthernetAdapter ea;
1733 {
1734 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_NetworkAdapter)//aVBoxValues is set in this #define
1735 if (aVBoxValues.size() != 0)
1736 {
1737 ea.strAdapterType = (Utf8Str)(aVBoxValues[0]);
1738 ea.strNetworkName = "NAT";//default
1739 vsys.llEthernetAdapters.push_back(ea);
1740 LogRel(("%s: Network adapter type is %s\n", __FUNCTION__, ea.strAdapterType.c_str()));
1741 }
1742 else
1743 {
1744 NetworkAdapterType_T defaultAdapterType = NetworkAdapterType_Am79C970A;
1745 pGuestOSType->COMGETTER(AdapterType)(&defaultAdapterType);
1746 Utf8StrFmt dat("%RU32", (uint32_t)defaultAdapterType);
1747 vsd->AddDescription(VirtualSystemDescriptionType_NetworkAdapter,
1748 Bstr(dat).raw(),
1749 Bstr(Utf8Str("NAT")).raw());
1750 }
1751 }
1752
1753 ovf::HardDiskController hdc;
1754 {
1755 //It's thought that SATA is supported by any OS types
1756 hdc.system = ovf::HardDiskController::SATA;
1757 hdc.idController = 0;
1758
1759 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_HardDiskControllerSATA)//aVBoxValues is set in this #define
1760 if (aVBoxValues.size() != 0)
1761 hdc.strControllerType = (Utf8Str)(aVBoxValues[0]);
1762 else
1763 hdc.strControllerType = "AHCI";
1764
1765 LogRel(("%s: Hard disk controller type is %s\n", __FUNCTION__, hdc.strControllerType.c_str()));
1766 vsys.mapControllers[hdc.idController] = hdc;
1767
1768 if (aVBoxValues.size() == 0)
1769 {
1770 /* we should do it here because it'll be used later in the OVF logic (inside i_importMachines()) */
1771 vsd->AddDescription(VirtualSystemDescriptionType_HardDiskControllerSATA,
1772 Bstr(hdc.strControllerType).raw(),
1773 NULL);
1774 }
1775 }
1776
1777 {
1778 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_SoundCard)//aVBoxValues is set in this #define
1779 if (aVBoxValues.size() != 0)
1780 vsys.strSoundCardType = (Utf8Str)(aVBoxValues[0]);
1781 else
1782 {
1783 AudioControllerType_T defaultAudioController;
1784 pGuestOSType->COMGETTER(RecommendedAudioController)(&defaultAudioController);
1785 vsys.strSoundCardType = Utf8StrFmt("%RU32", (uint32_t)defaultAudioController);//"ensoniq1371";//"AC97";
1786 vsd->AddDescription(VirtualSystemDescriptionType_SoundCard,
1787 Bstr(vsys.strSoundCardType).raw(),
1788 NULL);
1789 }
1790
1791 LogRel(("%s: Sound card is %s\n", __FUNCTION__, vsys.strSoundCardType.c_str()));
1792 }
1793
1794 vsys.fHasFloppyDrive = false;
1795 vsys.fHasCdromDrive = false;
1796 vsys.fHasUsbController = true;
1797 }
1798
1799 unsigned currImageObjectNum = 0;
1800 hrc = S_OK;
1801 do
1802 {
1803 char *pszName = NULL;
1804 RTVFSOBJTYPE enmType;
1805 vrc = RTVfsFsStrmNext(hVfsFssObject, &pszName, &enmType, &hVfsObj);
1806 if (RT_FAILURE(vrc))
1807 {
1808 if (vrc != VERR_EOF)
1809 {
1810 hrc = setErrorVrc(vrc, tr("%s: Error reading '%s' (%Rrc)"), __FUNCTION__, strAbsSrcPath.c_str(), vrc);
1811 throw hrc;
1812 }
1813 break;
1814 }
1815
1816 /* We only care about entries that are files. Get the I/O stream handle for them. */
1817 if ( enmType == RTVFSOBJTYPE_IO_STREAM
1818 || enmType == RTVFSOBJTYPE_FILE)
1819 {
1820 /* Find the suffix and check if this is a possibly interesting file. */
1821 char *pszSuffix = RTStrToLower(strrchr(pszName, '.'));
1822
1823 /* Get the I/O stream. */
1824 hVfsIosCurr = RTVfsObjToIoStream(hVfsObj);
1825 Assert(hVfsIosCurr != NIL_RTVFSIOSTREAM);
1826
1827 /* Get the source medium format */
1828 ComObjPtr<MediumFormat> srcFormat;
1829 srcFormat = pSysProps->i_mediumFormatFromExtension(pszSuffix + 1);
1830
1831 /* unknown image format so just extract a file without any processing */
1832 if (srcFormat == NULL)
1833 {
1834 /* Read the file into a memory buffer */
1835 void *pvBuffered;
1836 size_t cbBuffered;
1837 RTVFSFILE hVfsDstFile = NIL_RTVFSFILE;
1838 try
1839 {
1840 vrc = RTVfsIoStrmReadAll(hVfsIosCurr, &pvBuffered, &cbBuffered);
1841 RTVfsIoStrmRelease(hVfsIosCurr);
1842 hVfsIosCurr = NIL_RTVFSIOSTREAM;
1843 if (RT_FAILURE(vrc))
1844 throw setErrorVrc(vrc, tr("Could not read the file '%s' (%Rrc)"), strAbsSrcPath.c_str(), vrc);
1845
1846 Utf8StrFmt strAbsDstPath("%s%s%s", strMachineFolder.c_str(), RTPATH_SLASH_STR, pszName);
1847
1848 /* Simple logic - just try to get dir info, in case of absent try to create one.
1849 No deep errors analysis */
1850 RTFSOBJINFO dirInfo;
1851 vrc = RTPathQueryInfo(strMachineFolder.c_str(), &dirInfo, RTFSOBJATTRADD_NOTHING);
1852 if (RT_FAILURE(vrc))
1853 {
1854 if (vrc == VERR_FILE_NOT_FOUND || vrc == VERR_PATH_NOT_FOUND)
1855 {
1856 vrc = RTDirCreateFullPath(strMachineFolder.c_str(), 0755);
1857 if (RT_FAILURE(vrc))
1858 throw setErrorVrc(vrc, tr("Could not create the directory '%s' (%Rrc)"),
1859 strMachineFolder.c_str(), vrc);
1860 }
1861 else
1862 throw setErrorVrc(vrc, tr("Error during getting info about the directory '%s' (%Rrc)"),
1863 strMachineFolder.c_str(), vrc);
1864 }
1865
1866 /* Write the file on the disk */
1867 vrc = RTVfsFileOpenNormal(strAbsDstPath.c_str(),
1868 RTFILE_O_WRITE | RTFILE_O_DENY_ALL | RTFILE_O_CREATE,
1869 &hVfsDstFile);
1870 if (RT_FAILURE(vrc))
1871 throw setErrorVrc(vrc, tr("Could not create the file '%s' (%Rrc)"), strAbsDstPath.c_str(), vrc);
1872
1873 size_t cbWritten;
1874 vrc = RTVfsFileWrite(hVfsDstFile, pvBuffered, cbBuffered, &cbWritten);
1875 if (RT_FAILURE(vrc))
1876 throw setErrorVrc(vrc, tr("Could not write into the file '%s' (%Rrc)"), strAbsDstPath.c_str(), vrc);
1877
1878 /* Remember this file */
1879 extraCreatedFiles.append(strAbsDstPath);
1880 }
1881 catch (HRESULT aRc)
1882 {
1883 hrc = aRc;
1884 strLastActualErrorDesc = Utf8StrFmt("%s: Processing the downloaded object was failed. "
1885 "The exception (%Rrc)\n", __FUNCTION__, hrc);
1886 LogRel((strLastActualErrorDesc.c_str()));
1887 }
1888 catch (int aRc)
1889 {
1890 hrc = setErrorVrc(aRc);
1891 strLastActualErrorDesc = Utf8StrFmt("%s: Processing the downloaded object was failed. "
1892 "The exception (%Rrc)\n", __FUNCTION__, aRc);
1893 LogRel((strLastActualErrorDesc.c_str()));
1894 }
1895 catch (...)
1896 {
1897 hrc = VERR_UNEXPECTED_EXCEPTION;
1898 strLastActualErrorDesc = Utf8StrFmt("%s: Processing the downloaded object was failed. "
1899 "The exception (%Rrc)\n", __FUNCTION__, hrc);
1900 LogRel((strLastActualErrorDesc.c_str()));
1901 }
1902 }
1903 else
1904 {
1905 /* Just skip the rest images if they exist. Only the first image is used as the base image. */
1906 if (currImageObjectNum >= 1)
1907 continue;
1908
1909 /* Image format is supported by VBox so extract the file and try to convert
1910 * one to the default format (which is VMDK for now) */
1911 Utf8Str z(bstrSettingsFilename);
1912 Utf8StrFmt strAbsDstPath("%s_%d.%s",
1913 z.stripSuffix().c_str(),
1914 currImageObjectNum,
1915 strTargetFormat.c_str());
1916
1917 hrc = mVirtualBox->i_findHardDiskByLocation(strAbsDstPath, false, NULL);
1918 if (SUCCEEDED(hrc))
1919 throw setError(VERR_ALREADY_EXISTS, tr("The hard disk '%s' already exists."), strAbsDstPath.c_str());
1920
1921 /* Create an IMedium object. */
1922 ComObjPtr<Medium> pTargetMedium;
1923 pTargetMedium.createObject();
1924 hrc = pTargetMedium->init(mVirtualBox,
1925 strTargetFormat,
1926 strAbsDstPath,
1927 Guid::Empty /* media registry: none yet */,
1928 DeviceType_HardDisk);
1929 if (FAILED(hrc))
1930 throw hrc;
1931
1932 pTask->pProgress->SetNextOperation(BstrFmt(tr("Importing virtual disk image '%s'"), pszName).raw(),
1933 200);
1934 ComObjPtr<Medium> nullParent;
1935 ComPtr<IProgress> pProgressImport;
1936 ComObjPtr<Progress> pProgressImportTmp;
1937 hrc = pProgressImportTmp.createObject();
1938 if (FAILED(hrc))
1939 throw hrc;
1940
1941 hrc = pProgressImportTmp->init(mVirtualBox,
1942 static_cast<IAppliance*>(this),
1943 Utf8StrFmt(tr("Importing medium '%s'"),
1944 pszName),
1945 TRUE);
1946 if (FAILED(hrc))
1947 throw hrc;
1948
1949 pProgressImportTmp.queryInterfaceTo(pProgressImport.asOutParam());
1950
1951 hrc = pTargetMedium->i_importFile(pszName,
1952 srcFormat,
1953 MediumVariant_Standard,
1954 hVfsIosCurr,
1955 nullParent,
1956 pProgressImportTmp,
1957 true /* aNotify */);
1958 RTVfsIoStrmRelease(hVfsIosCurr);
1959 hVfsIosCurr = NIL_RTVFSIOSTREAM;
1960 /* Now wait for the background import operation to complete;
1961 * this throws HRESULTs on error. */
1962 hrc = pTask->pProgress->WaitForOtherProgressCompletion(pProgressImport, 0 /* indefinite wait */);
1963
1964 /* Try to re-use some OVF stuff here */
1965 if (SUCCEEDED(hrc))
1966 {
1967 /* Small trick here.
1968 * We add new item into the actual VSD after successful conversion.
1969 * There is no need to delete any previous records describing the images in the VSD
1970 * because later in the code the search of the images in the VSD will use such records
1971 * with the actual image id (d.strDiskId = pTargetMedium->i_getId().toString()) which is
1972 * used as a key for m->pReader->m_mapDisks, vsys.mapVirtualDisks.
1973 * So all 3 objects are tied via the image id.
1974 * In the OVF case we already have all such records in the VSD after reading OVF
1975 * description file (read() and interpret() functions).*/
1976 ovf::DiskImage d;
1977 d.strDiskId = pTargetMedium->i_getId().toString();
1978 d.strHref = pTargetMedium->i_getLocationFull();
1979 d.strFormat = pTargetMedium->i_getFormat();
1980 d.iSize = pTargetMedium->i_getSize();
1981 d.ulSuggestedSizeMB = (uint32_t)(d.iSize/_1M);
1982
1983 m->pReader->m_mapDisks[d.strDiskId] = d;
1984
1985 ComObjPtr<VirtualSystemDescription> vsdescThis = m->virtualSystemDescriptions.front();
1986
1987 /* It's needed here to use the internal function i_addEntry() instead of the API function
1988 * addDescription() because we should pass the d.strDiskId for the proper handling this
1989 * disk later in the i_importMachineGeneric():
1990 * - find the line like this "if (vsdeHD->strRef == diCurrent.strDiskId)".
1991 * if those code can be eliminated then addDescription() will be used. */
1992 vsdescThis->i_addEntry(VirtualSystemDescriptionType_HardDiskImage,
1993 d.strDiskId,
1994 d.strHref,
1995 d.strHref,
1996 d.ulSuggestedSizeMB);
1997
1998 ovf::VirtualDisk vd;
1999 vd.idController = vsys.mapControllers[0].idController;
2000 vd.ulAddressOnParent = 0;
2001 vd.strDiskId = d.strDiskId;
2002 vsys.mapVirtualDisks[vd.strDiskId] = vd;
2003
2004 ++currImageObjectNum;
2005 }
2006 }
2007
2008 RTVfsIoStrmRelease(hVfsIosCurr);
2009 hVfsIosCurr = NIL_RTVFSIOSTREAM;
2010 }
2011
2012 RTVfsObjRelease(hVfsObj);
2013 hVfsObj = NIL_RTVFSOBJ;
2014
2015 RTStrFree(pszName);
2016
2017 } while (SUCCEEDED(hrc));
2018
2019 RTVfsFsStrmRelease(hVfsFssObject);
2020 hVfsFssObject = NIL_RTVFSFSSTREAM;
2021
2022 if (SUCCEEDED(hrc))
2023 {
2024 pTask->pProgress->SetNextOperation(BstrFmt(tr("Creating new VM '%s'"), strVMName.c_str()).raw(), 50);
2025 /* Create the import stack to comply OVF logic.
2026 * Before we filled some other data structures which are needed by OVF logic too.*/
2027 ImportStack stack(pTask->locInfo, m->pReader->m_mapDisks, pTask->pProgress, NIL_RTVFSFSSTREAM);
2028 i_importMachines(stack);
2029 }
2030
2031 }
2032 catch (HRESULT aRc)
2033 {
2034 hrc = aRc;
2035 strLastActualErrorDesc = Utf8StrFmt("%s: Cloud import (local phase) failed. "
2036 "The exception (%Rrc)\n", __FUNCTION__, hrc);
2037 LogRel((strLastActualErrorDesc.c_str()));
2038 }
2039 catch (int aRc)
2040 {
2041 hrc = setErrorVrc(aRc);
2042 strLastActualErrorDesc = Utf8StrFmt("%s: Cloud import (local phase) failed. "
2043 "The exception (%Rrc)\n", __FUNCTION__, aRc);
2044 LogRel((strLastActualErrorDesc.c_str()));
2045 }
2046 catch (...)
2047 {
2048 hrc = VERR_UNRESOLVED_ERROR;
2049 strLastActualErrorDesc = Utf8StrFmt("%s: Cloud import (local phase) failed. "
2050 "The exception (%Rrc)\n", __FUNCTION__, hrc);
2051 LogRel((strLastActualErrorDesc.c_str()));
2052 }
2053
2054 LogRel(("%s: Cloud import (local phase) final result (%Rrc).\n", __FUNCTION__, hrc));
2055
2056 /* Try to free VFS stuff because some of them might not be released due to the exception */
2057 if (hVfsIosCurr != NIL_RTVFSIOSTREAM)
2058 RTVfsIoStrmRelease(hVfsIosCurr);
2059 if (hVfsObj != NIL_RTVFSOBJ)
2060 RTVfsObjRelease(hVfsObj);
2061 if (hVfsFssObject != NIL_RTVFSFSSTREAM)
2062 RTVfsFsStrmRelease(hVfsFssObject);
2063
2064 /* Small explanation here.
2065 * After adding extracted files into the actual VSD the returned list will contain not only the
2066 * record about the downloaded object but also the records about the extracted files from this object.
2067 * It's needed to go through this list to find the record about the downloaded object.
2068 * But it was the first record added into the list, so aVBoxValues[0] should be correct here.
2069 */
2070 GET_VSD_DESCRIPTION_BY_TYPE(VirtualSystemDescriptionType_HardDiskImage)//aVBoxValues is set in this #define
2071 if (!fKeepDownloadedObject)
2072 {
2073 if (aVBoxValues.size() != 0)
2074 {
2075 vsdData = aVBoxValues[0];
2076 //try to delete the downloaded object
2077 bool fExist = RTPathExists(vsdData.c_str());
2078 if (fExist)
2079 {
2080 vrc = RTFileDelete(vsdData.c_str());
2081 if (RT_FAILURE(vrc))
2082 LogRel(("%s: Cleanup action - the downloaded object %s hasn't been deleted\n", __FUNCTION__, vsdData.c_str()));
2083 else
2084 LogRel(("%s: Cleanup action - the downloaded object %s has been deleted\n", __FUNCTION__, vsdData.c_str()));
2085 }
2086 }
2087 }
2088
2089 if (FAILED(hrc))
2090 {
2091 /* What to do here?
2092 * For now:
2093 * - check the registration of created VM and delete one.
2094 * - check the list of imported images, detach them and next delete if they have still registered in the VBox.
2095 * - check some other leavings and delete them if they exist.
2096 */
2097
2098 /* It's not needed to call "pTask->pProgress->SetNextOperation(BstrFmt("The cleanup phase").raw(), 50)" here
2099 * because, WaitForOtherProgressCompletion() calls the SetNextOperation() iternally.
2100 * At least, it's strange that the operation description is set to the previous value. */
2101
2102 ComPtr<IMachine> pMachine;
2103 Utf8Str machineNameOrId = strVMName;
2104
2105 /* m->llGuidsMachinesCreated is filled in the i_importMachineGeneric()/i_importVBoxMachine()
2106 * after successful registration of new VM */
2107 if (!m->llGuidsMachinesCreated.empty())
2108 machineNameOrId = m->llGuidsMachinesCreated.front().toString();
2109
2110 hrc = mVirtualBox->FindMachine(Bstr(machineNameOrId).raw(), pMachine.asOutParam());
2111
2112 if (SUCCEEDED(hrc))
2113 {
2114 LogRel(("%s: Cleanup action - the VM with the name(or id) %s was found\n", __FUNCTION__, machineNameOrId.c_str()));
2115 SafeIfaceArray<IMedium> aMedia;
2116 hrc = pMachine->Unregister(CleanupMode_DetachAllReturnHardDisksOnly, ComSafeArrayAsOutParam(aMedia));
2117 if (SUCCEEDED(hrc))
2118 {
2119 LogRel(("%s: Cleanup action - the VM %s has been unregistered\n", __FUNCTION__, machineNameOrId.c_str()));
2120 ComPtr<IProgress> pProgress1;
2121 hrc = pMachine->DeleteConfig(ComSafeArrayAsInParam(aMedia), pProgress1.asOutParam());
2122 pTask->pProgress->WaitForOtherProgressCompletion(pProgress1, 0 /* indefinite wait */);
2123
2124 LogRel(("%s: Cleanup action - the VM config file and the attached images have been deleted\n",
2125 __FUNCTION__));
2126 }
2127 }
2128 else
2129 {
2130 /* Re-check the items in the array with the images names (paths).
2131 * if the import fails before creation VM, then VM won't be found
2132 * -> VM can't be unregistered and the images can't be deleted.
2133 * The rest items in the array aVBoxValues are the images which might
2134 * have still been registered in the VBox.
2135 * So go through the array and detach-unregister-delete those images */
2136
2137 /* have to get write lock as the whole find/update sequence must be done
2138 * in one critical section, otherwise there are races which can lead to
2139 * multiple Medium objects with the same content */
2140
2141 AutoWriteLock treeLock(mVirtualBox->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
2142
2143 for (size_t i = 1; i < aVBoxValues.size(); ++i)
2144 {
2145 vsdData = aVBoxValues[i];
2146 ComObjPtr<Medium> poHardDisk;
2147 hrc = mVirtualBox->i_findHardDiskByLocation(vsdData, false, &poHardDisk);
2148 if (SUCCEEDED(hrc))
2149 {
2150 hrc = mVirtualBox->i_unregisterMedium((Medium*)(poHardDisk));
2151 if (SUCCEEDED(hrc))
2152 {
2153 ComPtr<IProgress> pProgress1;
2154 hrc = poHardDisk->DeleteStorage(pProgress1.asOutParam());
2155 pTask->pProgress->WaitForOtherProgressCompletion(pProgress1, 0 /* indefinite wait */);
2156 }
2157 if (SUCCEEDED(hrc))
2158 LogRel(("%s: Cleanup action - the image %s has been deleted\n", __FUNCTION__, vsdData.c_str()));
2159 }
2160 else if (hrc == VBOX_E_OBJECT_NOT_FOUND)
2161 {
2162 LogRel(("%s: Cleanup action - the image %s wasn't found. Nothing to delete.\n", __FUNCTION__, vsdData.c_str()));
2163 hrc = S_OK;
2164 }
2165
2166 }
2167 }
2168
2169 /* Deletion of all additional files which were created during unpacking the downloaded object */
2170 for (size_t i = 0; i < extraCreatedFiles.size(); ++i)
2171 {
2172 vrc = RTFileDelete(extraCreatedFiles.at(i).c_str());
2173 if (RT_FAILURE(vrc))
2174 hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc);
2175 else
2176 LogRel(("%s: Cleanup action - file %s has been deleted\n", __FUNCTION__, extraCreatedFiles.at(i).c_str()));
2177 }
2178
2179 /* Deletion of the other files in the VM folder and the folder itself */
2180 {
2181 RTDIR hDir;
2182 vrc = RTDirOpen(&hDir, strMachineFolder.c_str());
2183 if (RT_SUCCESS(vrc))
2184 {
2185 for (;;)
2186 {
2187 RTDIRENTRYEX Entry;
2188 vrc = RTDirReadEx(hDir, &Entry, NULL /*pcbDirEntry*/, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK);
2189 if (RT_FAILURE(vrc))
2190 {
2191 AssertLogRelMsg(vrc == VERR_NO_MORE_FILES, ("%Rrc\n", vrc));
2192 break;
2193 }
2194 if (RTFS_IS_FILE(Entry.Info.Attr.fMode))
2195 {
2196 vrc = RTFileDelete(Entry.szName);
2197 if (RT_FAILURE(vrc))
2198 hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc);
2199 else
2200 LogRel(("%s: Cleanup action - file %s has been deleted\n", __FUNCTION__, Entry.szName));
2201 }
2202 }
2203 RTDirClose(hDir);
2204 }
2205
2206 vrc = RTDirRemove(strMachineFolder.c_str());
2207 if (RT_FAILURE(vrc))
2208 hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc);
2209 }
2210
2211 if (FAILED(hrc))
2212 LogRel(("%s: Cleanup action - some leavings still may exist in the folder %s\n",
2213 __FUNCTION__, strMachineFolder.c_str()));
2214 }
2215 else
2216 {
2217 /* See explanation in the Appliance::i_importImpl() where Progress was setup */
2218 ULONG operationCount;
2219 ULONG currOperation;
2220 pTask->pProgress->COMGETTER(OperationCount)(&operationCount);
2221 pTask->pProgress->COMGETTER(Operation)(&currOperation);
2222 while (++currOperation < operationCount)
2223 {
2224 pTask->pProgress->SetNextOperation(BstrFmt("Skipping the cleanup phase. All right.").raw(), 1);
2225 LogRel(("%s: Skipping the cleanup step %d\n", __FUNCTION__, currOperation));
2226 }
2227 }
2228 }
2229
2230 LogFlowFunc(("rc=%Rhrc\n", hrc));
2231 LogFlowFuncLeave();
2232 return hrc;
2233}
2234
2235/**
2236 * Actual worker code for reading an OVF from disk. This is called from Appliance::taskThreadImportOrExport()
2237 * and therefore runs on the OVF read worker thread. This opens the OVF with ovfreader.cpp.
2238 *
2239 * This runs in one context:
2240 *
2241 * 1) in a first worker thread; in that case, Appliance::Read() called Appliance::readImpl();
2242 *
2243 * @param pTask
2244 * @return
2245 */
2246HRESULT Appliance::i_readFS(TaskOVF *pTask)
2247{
2248 LogFlowFuncEnter();
2249 LogFlowFunc(("Appliance %p\n", this));
2250
2251 AutoCaller autoCaller(this);
2252 if (FAILED(autoCaller.rc())) return autoCaller.rc();
2253
2254 AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
2255
2256 HRESULT rc;
2257 if (pTask->locInfo.strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
2258 rc = i_readFSOVF(pTask);
2259 else
2260 rc = i_readFSOVA(pTask);
2261
2262 LogFlowFunc(("rc=%Rhrc\n", rc));
2263 LogFlowFuncLeave();
2264
2265 return rc;
2266}
2267
2268HRESULT Appliance::i_readFSOVF(TaskOVF *pTask)
2269{
2270 LogFlowFunc(("'%s'\n", pTask->locInfo.strPath.c_str()));
2271
2272 /*
2273 * Allocate a buffer for filenames and prep it for suffix appending.
2274 */
2275 char *pszNameBuf = (char *)alloca(pTask->locInfo.strPath.length() + 16);
2276 AssertReturn(pszNameBuf, VERR_NO_TMP_MEMORY);
2277 memcpy(pszNameBuf, pTask->locInfo.strPath.c_str(), pTask->locInfo.strPath.length() + 1);
2278 RTPathStripSuffix(pszNameBuf);
2279 size_t const cchBaseName = strlen(pszNameBuf);
2280
2281 /*
2282 * Open the OVF file first since that is what this is all about.
2283 */
2284 RTVFSIOSTREAM hIosOvf;
2285 int vrc = RTVfsIoStrmOpenNormal(pTask->locInfo.strPath.c_str(),
2286 RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, &hIosOvf);
2287 if (RT_FAILURE(vrc))
2288 return setErrorVrc(vrc, tr("Failed to open OVF file '%s' (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
2289
2290 HRESULT hrc = i_readOVFFile(pTask, hIosOvf, RTPathFilename(pTask->locInfo.strPath.c_str())); /* consumes hIosOvf */
2291 if (FAILED(hrc))
2292 return hrc;
2293
2294 /*
2295 * Try open the manifest file (for signature purposes and to determine digest type(s)).
2296 */
2297 RTVFSIOSTREAM hIosMf;
2298 strcpy(&pszNameBuf[cchBaseName], ".mf");
2299 vrc = RTVfsIoStrmOpenNormal(pszNameBuf, RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, &hIosMf);
2300 if (RT_SUCCESS(vrc))
2301 {
2302 const char * const pszFilenamePart = RTPathFilename(pszNameBuf);
2303 hrc = i_readManifestFile(pTask, hIosMf /*consumed*/, pszFilenamePart);
2304 if (FAILED(hrc))
2305 return hrc;
2306
2307 /*
2308 * Check for the signature file.
2309 */
2310 RTVFSIOSTREAM hIosCert;
2311 strcpy(&pszNameBuf[cchBaseName], ".cert");
2312 vrc = RTVfsIoStrmOpenNormal(pszNameBuf, RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, &hIosCert);
2313 if (RT_SUCCESS(vrc))
2314 {
2315 hrc = i_readSignatureFile(pTask, hIosCert /*consumed*/, pszFilenamePart);
2316 if (FAILED(hrc))
2317 return hrc;
2318 }
2319 else if (vrc != VERR_FILE_NOT_FOUND && vrc != VERR_PATH_NOT_FOUND)
2320 return setErrorVrc(vrc, tr("Failed to open the signature file '%s' (%Rrc)"), pszNameBuf, vrc);
2321
2322 }
2323 else if (vrc == VERR_FILE_NOT_FOUND || vrc == VERR_PATH_NOT_FOUND)
2324 {
2325 m->fDeterminedDigestTypes = true;
2326 m->fDigestTypes = 0;
2327 }
2328 else
2329 return setErrorVrc(vrc, tr("Failed to open the manifest file '%s' (%Rrc)"), pszNameBuf, vrc);
2330
2331 /*
2332 * Do tail processing (check the signature).
2333 */
2334 hrc = i_readTailProcessing(pTask);
2335
2336 LogFlowFunc(("returns %Rhrc\n", hrc));
2337 return hrc;
2338}
2339
2340HRESULT Appliance::i_readFSOVA(TaskOVF *pTask)
2341{
2342 LogFlowFunc(("'%s'\n", pTask->locInfo.strPath.c_str()));
2343
2344 /*
2345 * Open the tar file as file stream.
2346 */
2347 RTVFSIOSTREAM hVfsIosOva;
2348 int vrc = RTVfsIoStrmOpenNormal(pTask->locInfo.strPath.c_str(),
2349 RTFILE_O_READ | RTFILE_O_DENY_NONE | RTFILE_O_OPEN, &hVfsIosOva);
2350 if (RT_FAILURE(vrc))
2351 return setErrorVrc(vrc, tr("Error opening the OVA file '%s' (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
2352
2353 RTVFSFSSTREAM hVfsFssOva;
2354 vrc = RTZipTarFsStreamFromIoStream(hVfsIosOva, 0 /*fFlags*/, &hVfsFssOva);
2355 RTVfsIoStrmRelease(hVfsIosOva);
2356 if (RT_FAILURE(vrc))
2357 return setErrorVrc(vrc, tr("Error reading the OVA file '%s' (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
2358
2359 /*
2360 * Since jumping thru an OVA file with seekable disk backing is rather
2361 * efficient, we can process .ovf, .mf and .cert files here without any
2362 * strict ordering restrictions.
2363 *
2364 * (Technically, the .ovf-file comes first, while the manifest and its
2365 * optional signature file either follows immediately or at the very end of
2366 * the OVA. The manifest is optional.)
2367 */
2368 char *pszOvfNameBase = NULL;
2369 size_t cchOvfNameBase = 0; NOREF(cchOvfNameBase);
2370 unsigned cLeftToFind = 3;
2371 HRESULT hrc = S_OK;
2372 do
2373 {
2374 char *pszName = NULL;
2375 RTVFSOBJTYPE enmType;
2376 RTVFSOBJ hVfsObj;
2377 vrc = RTVfsFsStrmNext(hVfsFssOva, &pszName, &enmType, &hVfsObj);
2378 if (RT_FAILURE(vrc))
2379 {
2380 if (vrc != VERR_EOF)
2381 hrc = setErrorVrc(vrc, tr("Error reading OVA '%s' (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
2382 break;
2383 }
2384
2385 /* We only care about entries that are files. Get the I/O stream handle for them. */
2386 if ( enmType == RTVFSOBJTYPE_IO_STREAM
2387 || enmType == RTVFSOBJTYPE_FILE)
2388 {
2389 /* Find the suffix and check if this is a possibly interesting file. */
2390 char *pszSuffix = strrchr(pszName, '.');
2391 if ( pszSuffix
2392 && ( RTStrICmp(pszSuffix + 1, "ovf") == 0
2393 || RTStrICmp(pszSuffix + 1, "mf") == 0
2394 || RTStrICmp(pszSuffix + 1, "cert") == 0) )
2395 {
2396 /* Match the OVF base name. */
2397 *pszSuffix = '\0';
2398 if ( pszOvfNameBase == NULL
2399 || RTStrICmp(pszName, pszOvfNameBase) == 0)
2400 {
2401 *pszSuffix = '.';
2402
2403 /* Since we're pretty sure we'll be processing this file, get the I/O stream. */
2404 RTVFSIOSTREAM hVfsIos = RTVfsObjToIoStream(hVfsObj);
2405 Assert(hVfsIos != NIL_RTVFSIOSTREAM);
2406
2407 /* Check for the OVF (should come first). */
2408 if (RTStrICmp(pszSuffix + 1, "ovf") == 0)
2409 {
2410 if (pszOvfNameBase == NULL)
2411 {
2412 hrc = i_readOVFFile(pTask, hVfsIos, pszName);
2413 hVfsIos = NIL_RTVFSIOSTREAM;
2414
2415 /* Set the base name. */
2416 *pszSuffix = '\0';
2417 pszOvfNameBase = pszName;
2418 cchOvfNameBase = strlen(pszName);
2419 pszName = NULL;
2420 cLeftToFind--;
2421 }
2422 else
2423 LogRel(("i_readFSOVA: '%s' contains more than one OVF file ('%s'), picking the first one\n",
2424 pTask->locInfo.strPath.c_str(), pszName));
2425 }
2426 /* Check for manifest. */
2427 else if (RTStrICmp(pszSuffix + 1, "mf") == 0)
2428 {
2429 if (m->hMemFileTheirManifest == NIL_RTVFSFILE)
2430 {
2431 hrc = i_readManifestFile(pTask, hVfsIos, pszName);
2432 hVfsIos = NIL_RTVFSIOSTREAM; /*consumed*/
2433 cLeftToFind--;
2434 }
2435 else
2436 LogRel(("i_readFSOVA: '%s' contains more than one manifest file ('%s'), picking the first one\n",
2437 pTask->locInfo.strPath.c_str(), pszName));
2438 }
2439 /* Check for signature. */
2440 else if (RTStrICmp(pszSuffix + 1, "cert") == 0)
2441 {
2442 if (!m->fSignerCertLoaded)
2443 {
2444 hrc = i_readSignatureFile(pTask, hVfsIos, pszName);
2445 hVfsIos = NIL_RTVFSIOSTREAM; /*consumed*/
2446 cLeftToFind--;
2447 }
2448 else
2449 LogRel(("i_readFSOVA: '%s' contains more than one signature file ('%s'), picking the first one\n",
2450 pTask->locInfo.strPath.c_str(), pszName));
2451 }
2452 else
2453 AssertFailed();
2454 if (hVfsIos != NIL_RTVFSIOSTREAM)
2455 RTVfsIoStrmRelease(hVfsIos);
2456 }
2457 }
2458 }
2459 RTVfsObjRelease(hVfsObj);
2460 RTStrFree(pszName);
2461 } while (cLeftToFind > 0 && SUCCEEDED(hrc));
2462
2463 RTVfsFsStrmRelease(hVfsFssOva);
2464 RTStrFree(pszOvfNameBase);
2465
2466 /*
2467 * Check that we found and OVF file.
2468 */
2469 if (SUCCEEDED(hrc) && !pszOvfNameBase)
2470 hrc = setError(VBOX_E_FILE_ERROR, tr("OVA '%s' does not contain an .ovf-file"), pTask->locInfo.strPath.c_str());
2471 if (SUCCEEDED(hrc))
2472 {
2473 /*
2474 * Do tail processing (check the signature).
2475 */
2476 hrc = i_readTailProcessing(pTask);
2477 }
2478 LogFlowFunc(("returns %Rhrc\n", hrc));
2479 return hrc;
2480}
2481
2482/**
2483 * Reads & parses the OVF file.
2484 *
2485 * @param pTask The read task.
2486 * @param hVfsIosOvf The I/O stream for the OVF. The reference is
2487 * always consumed.
2488 * @param pszManifestEntry The manifest entry name.
2489 * @returns COM status code, error info set.
2490 * @throws Nothing
2491 */
2492HRESULT Appliance::i_readOVFFile(TaskOVF *pTask, RTVFSIOSTREAM hVfsIosOvf, const char *pszManifestEntry)
2493{
2494 LogFlowFunc(("%s[%s]\n", pTask->locInfo.strPath.c_str(), pszManifestEntry));
2495
2496 /*
2497 * Set the OVF manifest entry name (needed for tweaking the manifest
2498 * validation during import).
2499 */
2500 try { m->strOvfManifestEntry = pszManifestEntry; }
2501 catch (...) { return E_OUTOFMEMORY; }
2502
2503 /*
2504 * Set up digest calculation.
2505 */
2506 hVfsIosOvf = i_manifestSetupDigestCalculationForGivenIoStream(hVfsIosOvf, pszManifestEntry);
2507 if (hVfsIosOvf == NIL_RTVFSIOSTREAM)
2508 return VBOX_E_FILE_ERROR;
2509
2510 /*
2511 * Read the OVF into a memory buffer and parse it.
2512 */
2513 void *pvBufferedOvf;
2514 size_t cbBufferedOvf;
2515 int vrc = RTVfsIoStrmReadAll(hVfsIosOvf, &pvBufferedOvf, &cbBufferedOvf);
2516 uint32_t cRefs = RTVfsIoStrmRelease(hVfsIosOvf); /* consumes stream handle. */
2517 NOREF(cRefs);
2518 Assert(cRefs == 0);
2519 if (RT_FAILURE(vrc))
2520 return setErrorVrc(vrc, tr("Could not read the OVF file for '%s' (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
2521
2522 HRESULT hrc;
2523 try
2524 {
2525 m->pReader = new ovf::OVFReader(pvBufferedOvf, cbBufferedOvf, pTask->locInfo.strPath);
2526 hrc = S_OK;
2527 }
2528 catch (RTCError &rXcpt) // includes all XML exceptions
2529 {
2530 hrc = setError(VBOX_E_FILE_ERROR, rXcpt.what());
2531 }
2532 catch (HRESULT aRC)
2533 {
2534 hrc = aRC;
2535 }
2536 catch (...)
2537 {
2538 hrc = E_FAIL;
2539 }
2540 LogFlowFunc(("OVFReader(%s) -> rc=%Rhrc\n", pTask->locInfo.strPath.c_str(), hrc));
2541
2542 RTVfsIoStrmReadAllFree(pvBufferedOvf, cbBufferedOvf);
2543 if (SUCCEEDED(hrc))
2544 {
2545 /*
2546 * If we see an OVF v2.0 envelope, select only the SHA-256 digest.
2547 */
2548 if ( !m->fDeterminedDigestTypes
2549 && m->pReader->m_envelopeData.getOVFVersion() == ovf::OVFVersion_2_0)
2550 m->fDigestTypes &= ~RTMANIFEST_ATTR_SHA256;
2551 }
2552
2553 return hrc;
2554}
2555
2556/**
2557 * Reads & parses the manifest file.
2558 *
2559 * @param pTask The read task.
2560 * @param hVfsIosMf The I/O stream for the manifest file. The
2561 * reference is always consumed.
2562 * @param pszSubFileNm The manifest filename (no path) for error
2563 * messages, logging and strManifestName.
2564 * @returns COM status code, error info set.
2565 * @throws Nothing
2566 */
2567HRESULT Appliance::i_readManifestFile(TaskOVF *pTask, RTVFSIOSTREAM hVfsIosMf, const char *pszSubFileNm)
2568{
2569 LogFlowFunc(("%s[%s]\n", pTask->locInfo.strPath.c_str(), pszSubFileNm));
2570
2571 /* Remember the manifet file name */
2572 HRESULT hrc = m->strManifestName.assignEx(pszSubFileNm);
2573 AssertReturn(SUCCEEDED(hrc), hrc);
2574
2575 /*
2576 * Copy the manifest into a memory backed file so we can later do signature
2577 * validation indepentend of the algorithms used by the signature.
2578 */
2579 int vrc = RTVfsMemorizeIoStreamAsFile(hVfsIosMf, RTFILE_O_READ, &m->hMemFileTheirManifest);
2580 RTVfsIoStrmRelease(hVfsIosMf); /* consumes stream handle. */
2581 if (RT_FAILURE(vrc))
2582 return setErrorVrc(vrc, tr("Error reading the manifest file '%s' for '%s' (%Rrc)"),
2583 pszSubFileNm, pTask->locInfo.strPath.c_str(), vrc);
2584
2585 /*
2586 * Parse the manifest.
2587 */
2588 Assert(m->hTheirManifest == NIL_RTMANIFEST);
2589 vrc = RTManifestCreate(0 /*fFlags*/, &m->hTheirManifest);
2590 AssertStmt(RT_SUCCESS(vrc), Global::vboxStatusCodeToCOM(vrc));
2591
2592 char szErr[256];
2593 RTVFSIOSTREAM hVfsIos = RTVfsFileToIoStream(m->hMemFileTheirManifest);
2594 vrc = RTManifestReadStandardEx(m->hTheirManifest, hVfsIos, szErr, sizeof(szErr));
2595 RTVfsIoStrmRelease(hVfsIos);
2596 if (RT_FAILURE(vrc))
2597 return setErrorVrc(vrc, tr("Failed to parse manifest file '%s' for '%s' (%Rrc): %s"),
2598 pszSubFileNm, pTask->locInfo.strPath.c_str(), vrc, szErr);
2599
2600 /*
2601 * Check which digest files are used.
2602 * Note! the file could be empty, in which case fDigestTypes is set to 0.
2603 */
2604 vrc = RTManifestQueryAllAttrTypes(m->hTheirManifest, true /*fEntriesOnly*/, &m->fDigestTypes);
2605 AssertRCReturn(vrc, Global::vboxStatusCodeToCOM(vrc));
2606 m->fDeterminedDigestTypes = true;
2607
2608 return S_OK;
2609}
2610
2611/**
2612 * Reads the signature & certificate file.
2613 *
2614 * @param pTask The read task.
2615 * @param hVfsIosCert The I/O stream for the signature file. The
2616 * reference is always consumed.
2617 * @param pszSubFileNm The signature filename (no path) for error
2618 * messages and logging. Used to construct
2619 * .mf-file name.
2620 * @returns COM status code, error info set.
2621 * @throws Nothing
2622 */
2623HRESULT Appliance::i_readSignatureFile(TaskOVF *pTask, RTVFSIOSTREAM hVfsIosCert, const char *pszSubFileNm)
2624{
2625 LogFlowFunc(("%s[%s]\n", pTask->locInfo.strPath.c_str(), pszSubFileNm));
2626
2627 /*
2628 * Construct the manifest filename from pszSubFileNm.
2629 */
2630 Utf8Str strManifestName;
2631 try
2632 {
2633 const char *pszSuffix = strrchr(pszSubFileNm, '.');
2634 AssertReturn(pszSuffix, E_FAIL);
2635 strManifestName = Utf8Str(pszSubFileNm, pszSuffix - pszSubFileNm);
2636 strManifestName.append(".mf");
2637 }
2638 catch (...)
2639 {
2640 return E_OUTOFMEMORY;
2641 }
2642
2643 /*
2644 * Copy the manifest into a memory buffer. We'll do the signature processing
2645 * later to not force any specific order in the OVAs or any other archive we
2646 * may be accessing later.
2647 */
2648 void *pvSignature;
2649 size_t cbSignature;
2650 int vrc = RTVfsIoStrmReadAll(hVfsIosCert, &pvSignature, &cbSignature);
2651 RTVfsIoStrmRelease(hVfsIosCert); /* consumes stream handle. */
2652 if (RT_FAILURE(vrc))
2653 return setErrorVrc(vrc, tr("Error reading the signature file '%s' for '%s' (%Rrc)"),
2654 pszSubFileNm, pTask->locInfo.strPath.c_str(), vrc);
2655
2656 /*
2657 * Parse the signing certificate. Unlike the manifest parser we use below,
2658 * this API ignores parse of the file that aren't relevant.
2659 */
2660 RTERRINFOSTATIC StaticErrInfo;
2661 vrc = RTCrX509Certificate_ReadFromBuffer(&m->SignerCert, pvSignature, cbSignature,
2662 RTCRX509CERT_READ_F_PEM_ONLY,
2663 &g_RTAsn1DefaultAllocator, RTErrInfoInitStatic(&StaticErrInfo), pszSubFileNm);
2664 HRESULT hrc;
2665 if (RT_SUCCESS(vrc))
2666 {
2667 m->fSignerCertLoaded = true;
2668 m->fCertificateIsSelfSigned = RTCrX509Certificate_IsSelfSigned(&m->SignerCert);
2669
2670 /*
2671 * Find the start of the certificate part of the file, so we can avoid
2672 * upsetting the manifest parser with it.
2673 */
2674 char *pszSplit = (char *)RTCrPemFindFirstSectionInContent(pvSignature, cbSignature,
2675 g_aRTCrX509CertificateMarkers, g_cRTCrX509CertificateMarkers);
2676 if (pszSplit)
2677 while ( pszSplit != (char *)pvSignature
2678 && pszSplit[-1] != '\n'
2679 && pszSplit[-1] != '\r')
2680 pszSplit--;
2681 else
2682 {
2683 AssertLogRelMsgFailed(("Failed to find BEGIN CERTIFICATE markers in '%s'::'%s' - impossible unless it's a DER encoded certificate!",
2684 pTask->locInfo.strPath.c_str(), pszSubFileNm));
2685 pszSplit = (char *)pvSignature + cbSignature;
2686 }
2687 *pszSplit = '\0';
2688
2689 /*
2690 * Now, read the manifest part. We use the IPRT manifest reader here
2691 * to avoid duplicating code and be somewhat flexible wrt the digest
2692 * type choosen by the signer.
2693 */
2694 RTMANIFEST hSignedDigestManifest;
2695 vrc = RTManifestCreate(0 /*fFlags*/, &hSignedDigestManifest);
2696 if (RT_SUCCESS(vrc))
2697 {
2698 RTVFSIOSTREAM hVfsIosTmp;
2699 vrc = RTVfsIoStrmFromBuffer(RTFILE_O_READ, pvSignature, pszSplit - (char *)pvSignature, &hVfsIosTmp);
2700 if (RT_SUCCESS(vrc))
2701 {
2702 vrc = RTManifestReadStandardEx(hSignedDigestManifest, hVfsIosTmp, StaticErrInfo.szMsg, sizeof(StaticErrInfo.szMsg));
2703 RTVfsIoStrmRelease(hVfsIosTmp);
2704 if (RT_SUCCESS(vrc))
2705 {
2706 /*
2707 * Get signed digest, we prefer SHA-2, so explicitly query those first.
2708 */
2709 uint32_t fDigestType;
2710 char szSignedDigest[_8K + 1];
2711 vrc = RTManifestEntryQueryAttr(hSignedDigestManifest, strManifestName.c_str(), NULL,
2712 RTMANIFEST_ATTR_SHA512 | RTMANIFEST_ATTR_SHA256,
2713 szSignedDigest, sizeof(szSignedDigest), &fDigestType);
2714 if (vrc == VERR_MANIFEST_ATTR_TYPE_NOT_FOUND)
2715 vrc = RTManifestEntryQueryAttr(hSignedDigestManifest, strManifestName.c_str(), NULL,
2716 RTMANIFEST_ATTR_ANY, szSignedDigest, sizeof(szSignedDigest), &fDigestType);
2717 if (RT_SUCCESS(vrc))
2718 {
2719 const char *pszSignedDigest = RTStrStrip(szSignedDigest);
2720 size_t cbSignedDigest = strlen(pszSignedDigest) / 2;
2721 uint8_t abSignedDigest[sizeof(szSignedDigest) / 2];
2722 vrc = RTStrConvertHexBytes(szSignedDigest, abSignedDigest, cbSignedDigest, 0 /*fFlags*/);
2723 if (RT_SUCCESS(vrc))
2724 {
2725 /*
2726 * Convert it to RTDIGESTTYPE_XXX and save the binary value for later use.
2727 */
2728 switch (fDigestType)
2729 {
2730 case RTMANIFEST_ATTR_SHA1: m->enmSignedDigestType = RTDIGESTTYPE_SHA1; break;
2731 case RTMANIFEST_ATTR_SHA256: m->enmSignedDigestType = RTDIGESTTYPE_SHA256; break;
2732 case RTMANIFEST_ATTR_SHA512: m->enmSignedDigestType = RTDIGESTTYPE_SHA512; break;
2733 case RTMANIFEST_ATTR_MD5: m->enmSignedDigestType = RTDIGESTTYPE_MD5; break;
2734 default: AssertFailed(); m->enmSignedDigestType = RTDIGESTTYPE_INVALID; break;
2735 }
2736 if (m->enmSignedDigestType != RTDIGESTTYPE_INVALID)
2737 {
2738 m->pbSignedDigest = (uint8_t *)RTMemDup(abSignedDigest, cbSignedDigest);
2739 m->cbSignedDigest = cbSignedDigest;
2740 hrc = S_OK;
2741 }
2742 else
2743 hrc = setError(E_FAIL, tr("Unsupported signed digest type (%#x)"), fDigestType);
2744 }
2745 else
2746 hrc = setErrorVrc(vrc, tr("Error reading signed manifest digest: %Rrc"), vrc);
2747 }
2748 else if (vrc == VERR_NOT_FOUND)
2749 hrc = setErrorVrc(vrc, tr("Could not locate signed digest for '%s' in the cert-file for '%s'"),
2750 strManifestName.c_str(), pTask->locInfo.strPath.c_str());
2751 else
2752 hrc = setErrorVrc(vrc, tr("RTManifestEntryQueryAttr failed unexpectedly: %Rrc"), vrc);
2753 }
2754 else
2755 hrc = setErrorVrc(vrc, tr("Error parsing the .cert-file for '%s': %s"),
2756 pTask->locInfo.strPath.c_str(), StaticErrInfo.szMsg);
2757 }
2758 else
2759 hrc = E_OUTOFMEMORY;
2760 RTManifestRelease(hSignedDigestManifest);
2761 }
2762 else
2763 hrc = E_OUTOFMEMORY;
2764 }
2765 else if (vrc == VERR_NOT_FOUND || vrc == VERR_EOF)
2766 hrc = setErrorBoth(E_FAIL, vrc, tr("Malformed .cert-file for '%s': Signer's certificate not found (%Rrc)"),
2767 pTask->locInfo.strPath.c_str(), vrc);
2768 else
2769 hrc = setErrorVrc(vrc, tr("Error reading the signer's certificate from '%s' for '%s' (%Rrc): %s"),
2770 pszSubFileNm, pTask->locInfo.strPath.c_str(), vrc, StaticErrInfo.Core.pszMsg);
2771
2772 RTVfsIoStrmReadAllFree(pvSignature, cbSignature);
2773 LogFlowFunc(("returns %Rhrc (%Rrc)\n", hrc, vrc));
2774 return hrc;
2775}
2776
2777
2778/**
2779 * Does tail processing after the files have been read in.
2780 *
2781 * @param pTask The read task.
2782 * @returns COM status.
2783 * @throws Nothing!
2784 */
2785HRESULT Appliance::i_readTailProcessing(TaskOVF *pTask)
2786{
2787 /*
2788 * Parse and validate the signature file.
2789 *
2790 * The signature file has two parts, manifest part and a PEM encoded
2791 * certificate. The former contains an entry for the manifest file with a
2792 * digest that is encrypted with the certificate in the latter part.
2793 */
2794 if (m->pbSignedDigest)
2795 {
2796 /* Since we're validating the digest of the manifest, there have to be
2797 a manifest. We cannot allow a the manifest to be missing. */
2798 if (m->hMemFileTheirManifest == NIL_RTVFSFILE)
2799 return setError(VBOX_E_FILE_ERROR, tr("Found .cert-file but no .mf-file for '%s'"), pTask->locInfo.strPath.c_str());
2800
2801 /*
2802 * Validate the signed digest.
2803 *
2804 * It's possible we should allow the user to ignore signature
2805 * mismatches, but for now it is a solid show stopper.
2806 */
2807 HRESULT hrc;
2808 RTERRINFOSTATIC StaticErrInfo;
2809
2810 /* Calc the digest of the manifest using the algorithm found above. */
2811 RTCRDIGEST hDigest;
2812 int vrc = RTCrDigestCreateByType(&hDigest, m->enmSignedDigestType);
2813 if (RT_SUCCESS(vrc))
2814 {
2815 vrc = RTCrDigestUpdateFromVfsFile(hDigest, m->hMemFileTheirManifest, true /*fRewindFile*/);
2816 if (RT_SUCCESS(vrc))
2817 {
2818 /* Compare the signed digest with the one we just calculated. (This
2819 API will do the verification twice, once using IPRT's own crypto
2820 and once using OpenSSL. Both must OK it for success.) */
2821 vrc = RTCrPkixPubKeyVerifySignedDigestByCertPubKeyInfo(&m->SignerCert.TbsCertificate.SubjectPublicKeyInfo,
2822 m->pbSignedDigest, m->cbSignedDigest, hDigest,
2823 RTErrInfoInitStatic(&StaticErrInfo));
2824 if (RT_SUCCESS(vrc))
2825 {
2826 m->fSignatureValid = true;
2827 hrc = S_OK;
2828 }
2829 else if (vrc == VERR_CR_PKIX_SIGNATURE_MISMATCH)
2830 hrc = setErrorVrc(vrc, tr("The manifest signature does not match"));
2831 else
2832 hrc = setErrorVrc(vrc,
2833 tr("Error validating the manifest signature (%Rrc, %s)"), vrc, StaticErrInfo.Core.pszMsg);
2834 }
2835 else
2836 hrc = setErrorVrc(vrc, tr("RTCrDigestUpdateFromVfsFile failed: %Rrc"), vrc);
2837 RTCrDigestRelease(hDigest);
2838 }
2839 else
2840 hrc = setErrorVrc(vrc, tr("RTCrDigestCreateByType failed: %Rrc"), vrc);
2841
2842 /*
2843 * Validate the certificate.
2844 *
2845 * We don't fail here on if we cannot validate the certificate, we postpone
2846 * that till the import stage, so that we can allow the user to ignore it.
2847 *
2848 * The certificate validity time is deliberately left as warnings as the
2849 * OVF specification does not provision for any timestamping of the
2850 * signature. This is course a security concern, but the whole signing
2851 * of OVFs is currently weirdly trusting (self signed * certs), so this
2852 * is the least of our current problems.
2853 *
2854 * While we try build and verify certificate paths properly, the
2855 * "neighbours" quietly ignores this and seems only to check the signature
2856 * and not whether the certificate is trusted. Also, we don't currently
2857 * complain about self-signed certificates either (ditto "neighbours").
2858 * The OVF creator is also a bit restricted wrt to helping us build the
2859 * path as he cannot supply intermediate certificates. Anyway, we issue
2860 * warnings (goes to /dev/null, am I right?) for self-signed certificates
2861 * and certificates we cannot build and verify a root path for.
2862 *
2863 * (The OVF sillibuggers should've used PKCS#7, CMS or something else
2864 * that's already been standardized instead of combining manifests with
2865 * certificate PEM files in some very restrictive manner! I wonder if
2866 * we could add a PKCS#7 section to the .cert file in addition to the CERT
2867 * and manifest stuff dictated by the standard. Would depend on how others
2868 * deal with it.)
2869 */
2870 Assert(!m->fCertificateValid);
2871 Assert(m->fCertificateMissingPath);
2872 Assert(!m->fCertificateValidTime);
2873 Assert(m->strCertError.isEmpty());
2874 Assert(m->fCertificateIsSelfSigned == RTCrX509Certificate_IsSelfSigned(&m->SignerCert));
2875
2876 HRESULT hrc2 = S_OK;
2877 if (m->fCertificateIsSelfSigned)
2878 {
2879 /*
2880 * It's a self signed certificate. We assume the frontend will
2881 * present this fact to the user and give a choice whether this
2882 * is acceptible. But, first make sure it makes internal sense.
2883 */
2884 m->fCertificateMissingPath = true; /** @todo need to check if the certificate is trusted by the system! */
2885 vrc = RTCrX509Certificate_VerifySignatureSelfSigned(&m->SignerCert, RTErrInfoInitStatic(&StaticErrInfo));
2886 if (RT_SUCCESS(vrc))
2887 {
2888 m->fCertificateValid = true;
2889
2890 /* Check whether the certificate is currently valid, just warn if not. */
2891 RTTIMESPEC Now;
2892 if (RTCrX509Validity_IsValidAtTimeSpec(&m->SignerCert.TbsCertificate.Validity, RTTimeNow(&Now)))
2893 {
2894 m->fCertificateValidTime = true;
2895 i_addWarning(tr("A self signed certificate was used to sign '%s'"), pTask->locInfo.strPath.c_str());
2896 }
2897 else
2898 i_addWarning(tr("Self signed certificate used to sign '%s' is not currently valid"),
2899 pTask->locInfo.strPath.c_str());
2900
2901 /* Just warn if it's not a CA. Self-signed certificates are
2902 hardly trustworthy to start with without the user's consent. */
2903 if ( !m->SignerCert.TbsCertificate.T3.pBasicConstraints
2904 || !m->SignerCert.TbsCertificate.T3.pBasicConstraints->CA.fValue)
2905 i_addWarning(tr("Self signed certificate used to sign '%s' is not marked as certificate authority (CA)"),
2906 pTask->locInfo.strPath.c_str());
2907 }
2908 else
2909 {
2910 try { m->strCertError = Utf8StrFmt(tr("Verification of the self signed certificate failed (%Rrc, %s)"),
2911 vrc, StaticErrInfo.Core.pszMsg); }
2912 catch (...) { AssertFailed(); }
2913 i_addWarning(tr("Verification of the self signed certificate used to sign '%s' failed (%Rrc): %s"),
2914 pTask->locInfo.strPath.c_str(), vrc, StaticErrInfo.Core.pszMsg);
2915 }
2916 }
2917 else
2918 {
2919 /*
2920 * The certificate is not self-signed. Use the system certificate
2921 * stores to try build a path that validates successfully.
2922 */
2923 RTCRX509CERTPATHS hCertPaths;
2924 vrc = RTCrX509CertPathsCreate(&hCertPaths, &m->SignerCert);
2925 if (RT_SUCCESS(vrc))
2926 {
2927 /* Get trusted certificates from the system and add them to the path finding mission. */
2928 RTCRSTORE hTrustedCerts;
2929 vrc = RTCrStoreCreateSnapshotOfUserAndSystemTrustedCAsAndCerts(&hTrustedCerts,
2930 RTErrInfoInitStatic(&StaticErrInfo));
2931 if (RT_SUCCESS(vrc))
2932 {
2933 vrc = RTCrX509CertPathsSetTrustedStore(hCertPaths, hTrustedCerts);
2934 if (RT_FAILURE(vrc))
2935 hrc2 = setErrorBoth(E_FAIL, vrc, tr("RTCrX509CertPathsSetTrustedStore failed (%Rrc)"), vrc);
2936 RTCrStoreRelease(hTrustedCerts);
2937 }
2938 else
2939 hrc2 = setErrorBoth(E_FAIL, vrc,
2940 tr("Failed to query trusted CAs and Certificates from the system and for the current user (%Rrc, %s)"),
2941 vrc, StaticErrInfo.Core.pszMsg);
2942
2943 /* Add untrusted intermediate certificates. */
2944 if (RT_SUCCESS(vrc))
2945 {
2946 /// @todo RTCrX509CertPathsSetUntrustedStore(hCertPaths, hAdditionalCerts);
2947 /// By scanning for additional certificates in the .cert file? It would be
2948 /// convenient to be able to supply intermediate certificates for the user,
2949 /// right? Or would that be unacceptable as it may weaken security?
2950 ///
2951 /// Anyway, we should look for intermediate certificates on the system, at
2952 /// least.
2953 }
2954 if (RT_SUCCESS(vrc))
2955 {
2956 /*
2957 * Do the building and verification of certificate paths.
2958 */
2959 vrc = RTCrX509CertPathsBuild(hCertPaths, RTErrInfoInitStatic(&StaticErrInfo));
2960 if (RT_SUCCESS(vrc))
2961 {
2962 vrc = RTCrX509CertPathsValidateAll(hCertPaths, NULL, RTErrInfoInitStatic(&StaticErrInfo));
2963 if (RT_SUCCESS(vrc))
2964 {
2965 /*
2966 * Mark the certificate as good.
2967 */
2968 /** @todo check the certificate purpose? If so, share with self-signed. */
2969 m->fCertificateValid = true;
2970 m->fCertificateMissingPath = false;
2971
2972 /*
2973 * We add a warning if the certificate path isn't valid at the current
2974 * time. Since the time is only considered during path validation and we
2975 * can repeat the validation process (but not building), it's easy to check.
2976 */
2977 RTTIMESPEC Now;
2978 vrc = RTCrX509CertPathsSetValidTimeSpec(hCertPaths, RTTimeNow(&Now));
2979 if (RT_SUCCESS(vrc))
2980 {
2981 vrc = RTCrX509CertPathsValidateAll(hCertPaths, NULL, RTErrInfoInitStatic(&StaticErrInfo));
2982 if (RT_SUCCESS(vrc))
2983 m->fCertificateValidTime = true;
2984 else
2985 i_addWarning(tr("The certificate used to sign '%s' (or a certificate in the path) is not currently valid (%Rrc)"),
2986 pTask->locInfo.strPath.c_str(), vrc);
2987 }
2988 else
2989 hrc2 = setErrorVrc(vrc, "RTCrX509CertPathsSetValidTimeSpec failed: %Rrc", vrc);
2990 }
2991 else if (vrc == VERR_CR_X509_CPV_NO_TRUSTED_PATHS)
2992 {
2993 m->fCertificateValid = true;
2994 i_addWarning(tr("No trusted certificate paths"));
2995
2996 /* Add another warning if the pathless certificate is not valid at present. */
2997 RTTIMESPEC Now;
2998 if (RTCrX509Validity_IsValidAtTimeSpec(&m->SignerCert.TbsCertificate.Validity, RTTimeNow(&Now)))
2999 m->fCertificateValidTime = true;
3000 else
3001 i_addWarning(tr("The certificate used to sign '%s' is not currently valid"),
3002 pTask->locInfo.strPath.c_str());
3003 }
3004 else
3005 hrc2 = setErrorBoth(E_FAIL, vrc, tr("Certificate path validation failed (%Rrc, %s)"),
3006 vrc, StaticErrInfo.Core.pszMsg);
3007 }
3008 else
3009 hrc2 = setErrorBoth(E_FAIL, vrc, tr("Certificate path building failed (%Rrc, %s)"),
3010 vrc, StaticErrInfo.Core.pszMsg);
3011 }
3012 RTCrX509CertPathsRelease(hCertPaths);
3013 }
3014 else
3015 hrc2 = setErrorVrc(vrc, tr("RTCrX509CertPathsCreate failed: %Rrc"), vrc);
3016 }
3017
3018 /* Merge statuses from signature and certificate validation, prefering the signature one. */
3019 if (SUCCEEDED(hrc) && FAILED(hrc2))
3020 hrc = hrc2;
3021 if (FAILED(hrc))
3022 return hrc;
3023 }
3024
3025 /** @todo provide details about the signatory, signature, etc. */
3026 if (m->fSignerCertLoaded)
3027 {
3028 m->ptrCertificateInfo.createObject();
3029 m->ptrCertificateInfo->initCertificate(&m->SignerCert,
3030 m->fCertificateValid && !m->fCertificateMissingPath,
3031 !m->fCertificateValidTime);
3032 }
3033
3034 /*
3035 * If there is a manifest, check that the OVF digest matches up (if present).
3036 */
3037
3038 NOREF(pTask);
3039 return S_OK;
3040}
3041
3042
3043
3044/*******************************************************************************
3045 * Import stuff
3046 ******************************************************************************/
3047
3048/**
3049 * Implementation for importing OVF data into VirtualBox. This starts a new thread which will call
3050 * Appliance::taskThreadImportOrExport().
3051 *
3052 * This creates one or more new machines according to the VirtualSystemScription instances created by
3053 * Appliance::Interpret().
3054 *
3055 * This is in a separate private method because it is used from one location:
3056 *
3057 * 1) from the public Appliance::ImportMachines().
3058 *
3059 * @param locInfo
3060 * @param progress
3061 * @return
3062 */
3063HRESULT Appliance::i_importImpl(const LocationInfo &locInfo,
3064 ComObjPtr<Progress> &progress)
3065{
3066 HRESULT rc;
3067
3068 /* Initialize our worker task */
3069 ThreadTask *pTask;
3070 if (locInfo.storageType != VFSType_Cloud)
3071 {
3072 rc = i_setUpProgress(progress, Utf8StrFmt(tr("Importing appliance '%s'"), locInfo.strPath.c_str()),
3073 locInfo.storageType == VFSType_File ? ImportFile : ImportS3);
3074 if (FAILED(rc))
3075 return setError(rc, tr("Failed to create task for importing appliance into VirtualBox"));
3076 try
3077 {
3078 pTask = new TaskOVF(this, TaskOVF::Import, locInfo, progress);
3079 }
3080 catch (std::bad_alloc &)
3081 {
3082 return E_OUTOFMEMORY;
3083 }
3084 }
3085 else
3086 {
3087 if (locInfo.strProvider.equals("OCI"))
3088 {
3089 /*
3090 * 1. Create a custom image from the instance:
3091 * - 2 operations (starting and waiting)
3092 * 2. Import the custom image into the Object Storage (OCI format - TAR file with QCOW2 image and JSON file):
3093 * - 2 operations (starting and waiting)
3094 * 3. Download the object from the Object Storage:
3095 * - 1 operation (starting and downloadind is one operation)
3096 * 4. Open the object, extract an image and convert one to VDI:
3097 * - 1 operation (extracting and conversion are piped) because only 1 base bootable image is imported for now
3098 * 5. Create VM with user settings and attach the converted image to VM:
3099 * - 1 operation.
3100 * 6. Cleanup phase.
3101 * - 1 to N operations.
3102 * The number of the correct Progress operations are much tricky here.
3103 * Whether Machine::deleteConfig() is called or Medium::deleteStorage() is called in the loop.
3104 * Both require a new Progress object. To work with these functions the original Progress object uses
3105 * the function Progress::waitForOtherProgressCompletion().
3106 *
3107 * Some speculation here...
3108 * Total: 2+2+1(cloud) + 1+1(local) + 1+1+1(cleanup) = 10 operations
3109 * or
3110 * Total: 2+2+1(cloud) + 1+1(local) + 1(cleanup) = 8 operations
3111 * if VM wasn't created we would have only 1 registered image for cleanup.
3112 *
3113 * Weight "#define"s for the Cloud operations are located in the file OCICloudClient.h.
3114 * Weight of cloud import operations (1-3 items from above):
3115 * Total = 750 = 25+75(start and wait)+25+375(start and wait)+250(download)
3116 *
3117 * Weight of local import operations (4-5 items from above):
3118 * Total = 150 = 100 (extract and convert) + 50 (create VM, attach disks)
3119 *
3120 * Weight of local cleanup operations (6 item from above):
3121 * Some speculation here...
3122 * Total = 3 = 1 (1 image) + 1 (1 setting file)+ 1 (1 prev setting file) - quick operations
3123 * or
3124 * Total = 1 (1 image) if VM wasn't created we would have only 1 registered image for now.
3125 */
3126 try
3127 {
3128 rc = progress.createObject();
3129 if (SUCCEEDED(rc))
3130 rc = progress->init(mVirtualBox, static_cast<IAppliance *>(this),
3131 Utf8Str(tr("Importing VM from Cloud...")),
3132 TRUE /* aCancelable */,
3133 10, // ULONG cOperations,
3134 1000, // ULONG ulTotalOperationsWeight,
3135 Utf8Str(tr("Start import VM from the Cloud...")), // aFirstOperationDescription
3136 25); // ULONG ulFirstOperationWeight
3137 if (SUCCEEDED(rc))
3138 pTask = new TaskCloud(this, TaskCloud::Import, locInfo, progress);
3139 else
3140 pTask = NULL; /* shut up vcc */
3141 }
3142 catch (std::bad_alloc &)
3143 {
3144 return E_OUTOFMEMORY;
3145 }
3146 if (FAILED(rc))
3147 return setError(rc, tr("Failed to create task for importing appliance into VirtualBox"));
3148 }
3149 else
3150 return setError(E_NOTIMPL, tr("Only \"OCI\" cloud provider is supported for now. \"%s\" isn't supported."),
3151 locInfo.strProvider.c_str());
3152 }
3153
3154 /*
3155 * Start the task thread.
3156 */
3157 rc = pTask->createThread();
3158 pTask = NULL;
3159 if (SUCCEEDED(rc))
3160 return rc;
3161 return setError(rc, tr("Failed to start thread for importing appliance into VirtualBox"));
3162}
3163
3164/**
3165 * Actual worker code for importing OVF data into VirtualBox.
3166 *
3167 * This is called from Appliance::taskThreadImportOrExport() and therefore runs
3168 * on the OVF import worker thread. This creates one or more new machines
3169 * according to the VirtualSystemScription instances created by
3170 * Appliance::Interpret().
3171 *
3172 * This runs in two contexts:
3173 *
3174 * 1) in a first worker thread; in that case, Appliance::ImportMachines() called
3175 * Appliance::i_importImpl();
3176 *
3177 * 2) in a second worker thread; in that case, Appliance::ImportMachines()
3178 * called Appliance::i_importImpl(), which called Appliance::i_importFSOVA(),
3179 * which called Appliance::i_importImpl(), which then called this again.
3180 *
3181 * @param pTask The OVF task data.
3182 * @return COM status code.
3183 */
3184HRESULT Appliance::i_importFS(TaskOVF *pTask)
3185{
3186 LogFlowFuncEnter();
3187 LogFlowFunc(("Appliance %p\n", this));
3188
3189 /* Change the appliance state so we can safely leave the lock while doing
3190 * time-consuming image imports; also the below method calls do all kinds of
3191 * locking which conflicts with the appliance object lock. */
3192 AutoWriteLock writeLock(this COMMA_LOCKVAL_SRC_POS);
3193 /* Check if the appliance is currently busy. */
3194 if (!i_isApplianceIdle())
3195 return E_ACCESSDENIED;
3196 /* Set the internal state to importing. */
3197 m->state = ApplianceImporting;
3198
3199 HRESULT rc = S_OK;
3200
3201 /* Clear the list of imported machines, if any */
3202 m->llGuidsMachinesCreated.clear();
3203
3204 if (pTask->locInfo.strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
3205 rc = i_importFSOVF(pTask, writeLock);
3206 else
3207 rc = i_importFSOVA(pTask, writeLock);
3208 if (FAILED(rc))
3209 {
3210 /* With _whatever_ error we've had, do a complete roll-back of
3211 * machines and images we've created */
3212 writeLock.release();
3213 ErrorInfoKeeper eik;
3214 for (list<Guid>::iterator itID = m->llGuidsMachinesCreated.begin();
3215 itID != m->llGuidsMachinesCreated.end();
3216 ++itID)
3217 {
3218 Guid guid = *itID;
3219 Bstr bstrGuid = guid.toUtf16();
3220 ComPtr<IMachine> failedMachine;
3221 HRESULT rc2 = mVirtualBox->FindMachine(bstrGuid.raw(), failedMachine.asOutParam());
3222 if (SUCCEEDED(rc2))
3223 {
3224 SafeIfaceArray<IMedium> aMedia;
3225 rc2 = failedMachine->Unregister(CleanupMode_DetachAllReturnHardDisksOnly, ComSafeArrayAsOutParam(aMedia));
3226 ComPtr<IProgress> pProgress2;
3227 rc2 = failedMachine->DeleteConfig(ComSafeArrayAsInParam(aMedia), pProgress2.asOutParam());
3228 pProgress2->WaitForCompletion(-1);
3229 }
3230 }
3231 writeLock.acquire();
3232 }
3233
3234 /* Reset the state so others can call methods again */
3235 m->state = ApplianceIdle;
3236
3237 LogFlowFunc(("rc=%Rhrc\n", rc));
3238 LogFlowFuncLeave();
3239 return rc;
3240}
3241
3242HRESULT Appliance::i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock)
3243{
3244 return i_importDoIt(pTask, rWriteLock);
3245}
3246
3247HRESULT Appliance::i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock)
3248{
3249 LogFlowFuncEnter();
3250
3251 /*
3252 * Open the tar file as file stream.
3253 */
3254 RTVFSIOSTREAM hVfsIosOva;
3255 int vrc = RTVfsIoStrmOpenNormal(pTask->locInfo.strPath.c_str(),
3256 RTFILE_O_READ | RTFILE_O_DENY_NONE | RTFILE_O_OPEN, &hVfsIosOva);
3257 if (RT_FAILURE(vrc))
3258 return setErrorVrc(vrc, tr("Error opening the OVA file '%s' (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
3259
3260 RTVFSFSSTREAM hVfsFssOva;
3261 vrc = RTZipTarFsStreamFromIoStream(hVfsIosOva, 0 /*fFlags*/, &hVfsFssOva);
3262 RTVfsIoStrmRelease(hVfsIosOva);
3263 if (RT_FAILURE(vrc))
3264 return setErrorVrc(vrc, tr("Error reading the OVA file '%s' (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
3265
3266 /*
3267 * Join paths with the i_importFSOVF code.
3268 *
3269 * Note! We don't need to skip the OVF, manifest or signature files, as the
3270 * i_importMachineGeneric, i_importVBoxMachine and i_importOpenSourceFile
3271 * code will deal with this (as there could be other files in the OVA
3272 * that we don't process, like 'de-DE-resources.xml' in EXAMPLE 1,
3273 * Appendix D.1, OVF v2.1.0).
3274 */
3275 HRESULT hrc = i_importDoIt(pTask, rWriteLock, hVfsFssOva);
3276
3277 RTVfsFsStrmRelease(hVfsFssOva);
3278
3279 LogFlowFunc(("returns %Rhrc\n", hrc));
3280 return hrc;
3281}
3282
3283/**
3284 * Does the actual importing after the caller has made the source accessible.
3285 *
3286 * @param pTask The import task.
3287 * @param rWriteLock The write lock the caller's caller is holding,
3288 * will be released for some reason.
3289 * @param hVfsFssOva The file system stream if OVA, NIL if not.
3290 * @returns COM status code.
3291 * @throws Nothing.
3292 */
3293HRESULT Appliance::i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva /*= NIL_RTVFSFSSTREAM*/)
3294{
3295 rWriteLock.release();
3296
3297 HRESULT hrc = E_FAIL;
3298 try
3299 {
3300 /*
3301 * Create the import stack for the rollback on errors.
3302 */
3303 ImportStack stack(pTask->locInfo, m->pReader->m_mapDisks, pTask->pProgress, hVfsFssOva);
3304
3305 try
3306 {
3307 /* Do the importing. */
3308 i_importMachines(stack);
3309
3310 /* We should've processed all the files now, so compare. */
3311 hrc = i_verifyManifestFile(stack);
3312
3313 /* If everything was successful so far check if some extension
3314 * pack wants to do file sanity checking. */
3315 if (SUCCEEDED(hrc))
3316 {
3317 /** @todo */;
3318 }
3319 }
3320 catch (HRESULT hrcXcpt)
3321 {
3322 hrc = hrcXcpt;
3323 }
3324 catch (...)
3325 {
3326 AssertFailed();
3327 hrc = E_FAIL;
3328 }
3329 if (FAILED(hrc))
3330 {
3331 /*
3332 * Restoring original UUID from OVF description file.
3333 * During import VBox creates new UUIDs for imported images and
3334 * assigns them to the images. In case of failure we have to restore
3335 * the original UUIDs because those new UUIDs are obsolete now and
3336 * won't be used anymore.
3337 */
3338 ErrorInfoKeeper eik; /* paranoia */
3339 list< ComObjPtr<VirtualSystemDescription> >::const_iterator itvsd;
3340 /* Iterate through all virtual systems of that appliance */
3341 for (itvsd = m->virtualSystemDescriptions.begin();
3342 itvsd != m->virtualSystemDescriptions.end();
3343 ++itvsd)
3344 {
3345 ComObjPtr<VirtualSystemDescription> vsdescThis = (*itvsd);
3346 settings::MachineConfigFile *pConfig = vsdescThis->m->pConfig;
3347 if(vsdescThis->m->pConfig!=NULL)
3348 stack.restoreOriginalUUIDOfAttachedDevice(pConfig);
3349 }
3350 }
3351 }
3352 catch (...)
3353 {
3354 hrc = E_FAIL;
3355 AssertFailed();
3356 }
3357
3358 rWriteLock.acquire();
3359 return hrc;
3360}
3361
3362/**
3363 * Undocumented, you figure it from the name.
3364 *
3365 * @returns Undocumented
3366 * @param stack Undocumented.
3367 */
3368HRESULT Appliance::i_verifyManifestFile(ImportStack &stack)
3369{
3370 LogFlowThisFuncEnter();
3371 HRESULT hrc;
3372 int vrc;
3373
3374 /*
3375 * No manifest is fine, it always matches.
3376 */
3377 if (m->hTheirManifest == NIL_RTMANIFEST)
3378 hrc = S_OK;
3379 else
3380 {
3381 /*
3382 * Hack: If the manifest we just read doesn't have a digest for the OVF, copy
3383 * it from the manifest we got from the caller.
3384 * @bugref{6022#c119}
3385 */
3386 if ( !RTManifestEntryExists(m->hTheirManifest, m->strOvfManifestEntry.c_str())
3387 && RTManifestEntryExists(m->hOurManifest, m->strOvfManifestEntry.c_str()) )
3388 {
3389 uint32_t fType = 0;
3390 char szDigest[512 + 1];
3391 vrc = RTManifestEntryQueryAttr(m->hOurManifest, m->strOvfManifestEntry.c_str(), NULL, RTMANIFEST_ATTR_ANY,
3392 szDigest, sizeof(szDigest), &fType);
3393 if (RT_SUCCESS(vrc))
3394 vrc = RTManifestEntrySetAttr(m->hTheirManifest, m->strOvfManifestEntry.c_str(),
3395 NULL /*pszAttr*/, szDigest, fType);
3396 if (RT_FAILURE(vrc))
3397 return setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("Error fudging missing OVF digest in manifest: %Rrc"), vrc);
3398 }
3399
3400 /*
3401 * Compare with the digests we've created while read/processing the import.
3402 *
3403 * We specify the RTMANIFEST_EQUALS_IGN_MISSING_ATTRS to ignore attributes
3404 * (SHA1, SHA256, etc) that are only present in one of the manifests, as long
3405 * as each entry has at least one common attribute that we can check. This
3406 * is important for the OVF in OVAs, for which we generates several digests
3407 * since we don't know which are actually used in the manifest (OVF comes
3408 * first in an OVA, then manifest).
3409 */
3410 char szErr[256];
3411 vrc = RTManifestEqualsEx(m->hTheirManifest, m->hOurManifest, NULL /*papszIgnoreEntries*/,
3412 NULL /*papszIgnoreAttrs*/,
3413 RTMANIFEST_EQUALS_IGN_MISSING_ATTRS | RTMANIFEST_EQUALS_IGN_MISSING_ENTRIES_2ND,
3414 szErr, sizeof(szErr));
3415 if (RT_SUCCESS(vrc))
3416 hrc = S_OK;
3417 else
3418 hrc = setErrorVrc(vrc, tr("Digest mismatch (%Rrc): %s"), vrc, szErr);
3419 }
3420
3421 NOREF(stack);
3422 LogFlowThisFunc(("returns %Rhrc\n", hrc));
3423 return hrc;
3424}
3425
3426/**
3427 * Helper that converts VirtualSystem attachment values into VirtualBox attachment values.
3428 * Throws HRESULT values on errors!
3429 *
3430 * @param hdc in: the HardDiskController structure to attach to.
3431 * @param ulAddressOnParent in: the AddressOnParent parameter from OVF.
3432 * @param controllerName out: the name of the storage controller to attach to (e.g. "IDE").
3433 * @param lControllerPort out: the channel (controller port) of the controller to attach to.
3434 * @param lDevice out: the device number to attach to.
3435 */
3436void Appliance::i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
3437 uint32_t ulAddressOnParent,
3438 Utf8Str &controllerName,
3439 int32_t &lControllerPort,
3440 int32_t &lDevice)
3441{
3442 Log(("Appliance::i_convertDiskAttachmentValues: hdc.system=%d, hdc.fPrimary=%d, ulAddressOnParent=%d\n",
3443 hdc.system,
3444 hdc.fPrimary,
3445 ulAddressOnParent));
3446
3447 switch (hdc.system)
3448 {
3449 case ovf::HardDiskController::IDE:
3450 // For the IDE bus, the port parameter can be either 0 or 1, to specify the primary
3451 // or secondary IDE controller, respectively. For the primary controller of the IDE bus,
3452 // the device number can be either 0 or 1, to specify the master or the slave device,
3453 // respectively. For the secondary IDE controller, the device number is always 1 because
3454 // the master device is reserved for the CD-ROM drive.
3455 controllerName = "IDE";
3456 switch (ulAddressOnParent)
3457 {
3458 case 0: // master
3459 if (!hdc.fPrimary)
3460 {
3461 // secondary master
3462 lControllerPort = (long)1;
3463 lDevice = (long)0;
3464 }
3465 else // primary master
3466 {
3467 lControllerPort = (long)0;
3468 lDevice = (long)0;
3469 }
3470 break;
3471
3472 case 1: // slave
3473 if (!hdc.fPrimary)
3474 {
3475 // secondary slave
3476 lControllerPort = (long)1;
3477 lDevice = (long)1;
3478 }
3479 else // primary slave
3480 {
3481 lControllerPort = (long)0;
3482 lDevice = (long)1;
3483 }
3484 break;
3485
3486 // used by older VBox exports
3487 case 2: // interpret this as secondary master
3488 lControllerPort = (long)1;
3489 lDevice = (long)0;
3490 break;
3491
3492 // used by older VBox exports
3493 case 3: // interpret this as secondary slave
3494 lControllerPort = (long)1;
3495 lDevice = (long)1;
3496 break;
3497
3498 default:
3499 throw setError(VBOX_E_NOT_SUPPORTED,
3500 tr("Invalid channel %RI16 specified; IDE controllers support only 0, 1 or 2"),
3501 ulAddressOnParent);
3502 break;
3503 }
3504 break;
3505
3506 case ovf::HardDiskController::SATA:
3507 controllerName = "SATA";
3508 lControllerPort = (long)ulAddressOnParent;
3509 lDevice = (long)0;
3510 break;
3511
3512 case ovf::HardDiskController::SCSI:
3513 {
3514 if(hdc.strControllerType.compare("lsilogicsas")==0)
3515 controllerName = "SAS";
3516 else
3517 controllerName = "SCSI";
3518 lControllerPort = (long)ulAddressOnParent;
3519 lDevice = (long)0;
3520 break;
3521 }
3522
3523 default: break;
3524 }
3525
3526 Log(("=> lControllerPort=%d, lDevice=%d\n", lControllerPort, lDevice));
3527}
3528
3529/**
3530 * Imports one image.
3531 *
3532 * This is common code shared between
3533 * -- i_importMachineGeneric() for the OVF case; in that case the information comes from
3534 * the OVF virtual systems;
3535 * -- i_importVBoxMachine(); in that case, the information comes from the <vbox:Machine>
3536 * tag.
3537 *
3538 * Both ways of describing machines use the OVF disk references section, so in both cases
3539 * the caller needs to pass in the ovf::DiskImage structure from ovfreader.cpp.
3540 *
3541 * As a result, in both cases, if di.strHref is empty, we create a new image as per the OVF
3542 * spec, even though this cannot really happen in the vbox:Machine case since such data
3543 * would never have been exported.
3544 *
3545 * This advances stack.pProgress by one operation with the image's weight.
3546 *
3547 * @param di ovfreader.cpp structure describing the image from the OVF that is to be imported
3548 * @param strDstPath Where to create the target image.
3549 * @param pTargetMedium out: The newly created target medium. This also gets pushed on stack.llHardDisksCreated for cleanup.
3550 * @param stack
3551 *
3552 * @throws HRESULT
3553 */
3554void Appliance::i_importOneDiskImage(const ovf::DiskImage &di,
3555 const Utf8Str &strDstPath,
3556 ComObjPtr<Medium> &pTargetMedium,
3557 ImportStack &stack)
3558{
3559 HRESULT rc;
3560
3561 Utf8Str strAbsDstPath;
3562 int vrc = RTPathAbsExCxx(strAbsDstPath, stack.strMachineFolder, strDstPath);
3563 AssertRCStmt(vrc, throw Global::vboxStatusCodeToCOM(vrc));
3564
3565 /* Get the system properties. */
3566 SystemProperties *pSysProps = mVirtualBox->i_getSystemProperties();
3567
3568 /* Keep the source file ref handy for later. */
3569 const Utf8Str &strSourceOVF = di.strHref;
3570
3571 /* Construct source file path */
3572 Utf8Str strSrcFilePath;
3573 if (stack.hVfsFssOva != NIL_RTVFSFSSTREAM)
3574 strSrcFilePath = strSourceOVF;
3575 else
3576 {
3577 strSrcFilePath = stack.strSourceDir;
3578 strSrcFilePath.append(RTPATH_SLASH_STR);
3579 strSrcFilePath.append(strSourceOVF);
3580 }
3581
3582 /* First of all check if the original (non-absolute) destination path is
3583 * a valid medium UUID. If so, the user wants to import the image into
3584 * an existing path. This is useful for iSCSI for example. */
3585 /** @todo r=klaus the code structure after this point is totally wrong,
3586 * full of unnecessary code duplication and other issues. 4.2 still had
3587 * the right structure for importing into existing medium objects, which
3588 * the current code can't possibly handle. */
3589 RTUUID uuid;
3590 vrc = RTUuidFromStr(&uuid, strDstPath.c_str());
3591 if (vrc == VINF_SUCCESS)
3592 {
3593 rc = mVirtualBox->i_findHardDiskById(Guid(uuid), true, &pTargetMedium);
3594 if (FAILED(rc)) throw rc;
3595 }
3596 else
3597 {
3598 RTVFSIOSTREAM hVfsIosSrc = NIL_RTVFSIOSTREAM;
3599
3600 /* check read file to GZIP compression */
3601 bool const fGzipped = di.strCompression.compare("gzip", Utf8Str::CaseInsensitive) == 0;
3602 Utf8Str strDeleteTemp;
3603 try
3604 {
3605 Utf8Str strTrgFormat = "VMDK";
3606 ComObjPtr<MediumFormat> trgFormat;
3607 Bstr bstrFormatName;
3608 ULONG lCabs = 0;
3609
3610 char *pszSuff = RTPathSuffix(strAbsDstPath.c_str());
3611 if (pszSuff != NULL)
3612 {
3613 /*
3614 * Figure out which format the user like to have. Default is VMDK
3615 * or it can be VDI if according command-line option is set
3616 */
3617
3618 /*
3619 * We need a proper target format
3620 * if target format has been changed by user via GUI import wizard
3621 * or via VBoxManage import command (option --importtovdi)
3622 * then we need properly process such format like ISO
3623 * Because there is no conversion ISO to VDI
3624 */
3625 trgFormat = pSysProps->i_mediumFormatFromExtension(++pszSuff);
3626 if (trgFormat.isNull())
3627 throw setError(E_FAIL, tr("Unsupported medium format for disk image '%s'"), di.strHref.c_str());
3628
3629 rc = trgFormat->COMGETTER(Name)(bstrFormatName.asOutParam());
3630 if (FAILED(rc)) throw rc;
3631
3632 strTrgFormat = Utf8Str(bstrFormatName);
3633
3634 if ( m->optListImport.contains(ImportOptions_ImportToVDI)
3635 && strTrgFormat.compare("RAW", Utf8Str::CaseInsensitive) != 0)
3636 {
3637 /* change the target extension */
3638 strTrgFormat = "vdi";
3639 trgFormat = pSysProps->i_mediumFormatFromExtension(strTrgFormat);
3640 strAbsDstPath.stripSuffix();
3641 strAbsDstPath.append(".");
3642 strAbsDstPath.append(strTrgFormat.c_str());
3643 }
3644
3645 /* Check the capabilities. We need create capabilities. */
3646 lCabs = 0;
3647 com::SafeArray <MediumFormatCapabilities_T> mediumFormatCap;
3648 rc = trgFormat->COMGETTER(Capabilities)(ComSafeArrayAsOutParam(mediumFormatCap));
3649
3650 if (FAILED(rc))
3651 throw rc;
3652
3653 for (ULONG j = 0; j < mediumFormatCap.size(); j++)
3654 lCabs |= mediumFormatCap[j];
3655
3656 if ( !(lCabs & MediumFormatCapabilities_CreateFixed)
3657 && !(lCabs & MediumFormatCapabilities_CreateDynamic) )
3658 throw setError(VBOX_E_NOT_SUPPORTED,
3659 tr("Could not find a valid medium format for the target disk '%s'"),
3660 strAbsDstPath.c_str());
3661 }
3662 else
3663 {
3664 throw setError(VBOX_E_FILE_ERROR,
3665 tr("The target disk '%s' has no extension "),
3666 strAbsDstPath.c_str(), VERR_INVALID_NAME);
3667 }
3668
3669 /*CD/DVD case*/
3670 if (strTrgFormat.compare("RAW", Utf8Str::CaseInsensitive) == 0)
3671 {
3672 try
3673 {
3674 if (fGzipped)
3675 i_importDecompressFile(stack, strSrcFilePath, strAbsDstPath, strSourceOVF.c_str());
3676 else
3677 i_importCopyFile(stack, strSrcFilePath, strAbsDstPath, strSourceOVF.c_str());
3678
3679 ComPtr<IMedium> pTmp;
3680 rc = mVirtualBox->OpenMedium(Bstr(strAbsDstPath).raw(),
3681 DeviceType_DVD,
3682 AccessMode_ReadWrite,
3683 false,
3684 pTmp.asOutParam());
3685 if (FAILED(rc))
3686 throw rc;
3687
3688 IMedium *iM = pTmp;
3689 pTargetMedium = static_cast<Medium*>(iM);
3690 }
3691 catch (HRESULT /*arc*/)
3692 {
3693 throw;
3694 }
3695
3696 /* Advance to the next operation. */
3697 /* operation's weight, as set up with the IProgress originally */
3698 stack.pProgress->SetNextOperation(BstrFmt(tr("Importing virtual disk image '%s'"),
3699 RTPathFilename(strSourceOVF.c_str())).raw(),
3700 di.ulSuggestedSizeMB);
3701 }
3702 else/* HDD case*/
3703 {
3704 /* Create an IMedium object. */
3705 pTargetMedium.createObject();
3706
3707 rc = pTargetMedium->init(mVirtualBox,
3708 strTrgFormat,
3709 strAbsDstPath,
3710 Guid::Empty /* media registry: none yet */,
3711 DeviceType_HardDisk);
3712 if (FAILED(rc)) throw rc;
3713
3714 ComPtr<IProgress> pProgressImport;
3715 /* If strHref is empty we have to create a new file. */
3716 if (strSourceOVF.isEmpty())
3717 {
3718 com::SafeArray<MediumVariant_T> mediumVariant;
3719 mediumVariant.push_back(MediumVariant_Standard);
3720
3721 /* Kick off the creation of a dynamic growing disk image with the given capacity. */
3722 rc = pTargetMedium->CreateBaseStorage(di.iCapacity / _1M,
3723 ComSafeArrayAsInParam(mediumVariant),
3724 pProgressImport.asOutParam());
3725 if (FAILED(rc)) throw rc;
3726
3727 /* Advance to the next operation. */
3728 /* operation's weight, as set up with the IProgress originally */
3729 stack.pProgress->SetNextOperation(BstrFmt(tr("Creating disk image '%s'"),
3730 strAbsDstPath.c_str()).raw(),
3731 di.ulSuggestedSizeMB);
3732 }
3733 else
3734 {
3735 /* We need a proper source format description */
3736 /* Which format to use? */
3737 ComObjPtr<MediumFormat> srcFormat;
3738 rc = i_findMediumFormatFromDiskImage(di, srcFormat);
3739 if (FAILED(rc))
3740 throw setError(VBOX_E_NOT_SUPPORTED,
3741 tr("Could not find a valid medium format for the source disk '%s' "
3742 "Check correctness of the image format URL in the OVF description file "
3743 "or extension of the image"),
3744 RTPathFilename(strSourceOVF.c_str()));
3745
3746 /* If gzipped, decompress the GZIP file and save a new file in the target path */
3747 if (fGzipped)
3748 {
3749 Utf8Str strTargetFilePath(strAbsDstPath);
3750 strTargetFilePath.stripFilename();
3751 strTargetFilePath.append(RTPATH_SLASH_STR);
3752 strTargetFilePath.append("temp_");
3753 strTargetFilePath.append(RTPathFilename(strSrcFilePath.c_str()));
3754 strDeleteTemp = strTargetFilePath;
3755
3756 i_importDecompressFile(stack, strSrcFilePath, strTargetFilePath, strSourceOVF.c_str());
3757
3758 /* Correct the source and the target with the actual values */
3759 strSrcFilePath = strTargetFilePath;
3760
3761 /* Open the new source file. */
3762 vrc = RTVfsIoStrmOpenNormal(strSrcFilePath.c_str(), RTFILE_O_READ | RTFILE_O_DENY_NONE | RTFILE_O_OPEN,
3763 &hVfsIosSrc);
3764 if (RT_FAILURE(vrc))
3765 throw setErrorVrc(vrc, tr("Error opening decompressed image file '%s' (%Rrc)"),
3766 strSrcFilePath.c_str(), vrc);
3767 }
3768 else
3769 hVfsIosSrc = i_importOpenSourceFile(stack, strSrcFilePath, strSourceOVF.c_str());
3770
3771 /* Add a read ahead thread to try speed things up with concurrent reads and
3772 writes going on in different threads. */
3773 RTVFSIOSTREAM hVfsIosReadAhead;
3774 vrc = RTVfsCreateReadAheadForIoStream(hVfsIosSrc, 0 /*fFlags*/, 0 /*cBuffers=default*/,
3775 0 /*cbBuffers=default*/, &hVfsIosReadAhead);
3776 RTVfsIoStrmRelease(hVfsIosSrc);
3777 if (RT_FAILURE(vrc))
3778 throw setErrorVrc(vrc, tr("Error initializing read ahead thread for '%s' (%Rrc)"),
3779 strSrcFilePath.c_str(), vrc);
3780
3781 /* Start the source image cloning operation. */
3782 ComObjPtr<Medium> nullParent;
3783 ComObjPtr<Progress> pProgressImportTmp;
3784 rc = pProgressImportTmp.createObject();
3785 if (FAILED(rc)) throw rc;
3786 rc = pProgressImportTmp->init(mVirtualBox,
3787 static_cast<IAppliance*>(this),
3788 Utf8StrFmt(tr("Importing medium '%s'"),
3789 strAbsDstPath.c_str()),
3790 TRUE);
3791 if (FAILED(rc)) throw rc;
3792 pProgressImportTmp.queryInterfaceTo(pProgressImport.asOutParam());
3793 /* pProgressImportTmp is in parameter for Medium::i_importFile,
3794 * which is somewhat unusual and might be changed later. */
3795 rc = pTargetMedium->i_importFile(strSrcFilePath.c_str(),
3796 srcFormat,
3797 MediumVariant_Standard,
3798 hVfsIosReadAhead,
3799 nullParent,
3800 pProgressImportTmp,
3801 true /* aNotify */);
3802 RTVfsIoStrmRelease(hVfsIosReadAhead);
3803 hVfsIosSrc = NIL_RTVFSIOSTREAM;
3804 if (FAILED(rc))
3805 throw rc;
3806
3807 /* Advance to the next operation. */
3808 /* operation's weight, as set up with the IProgress originally */
3809 stack.pProgress->SetNextOperation(BstrFmt(tr("Importing virtual disk image '%s'"),
3810 RTPathFilename(strSourceOVF.c_str())).raw(),
3811 di.ulSuggestedSizeMB);
3812 }
3813
3814 /* Now wait for the background import operation to complete; this throws
3815 * HRESULTs on error. */
3816 stack.pProgress->WaitForOtherProgressCompletion(pProgressImport, 0 /* indefinite wait */);
3817
3818 /* The creating/importing has placed the medium in the global
3819 * media registry since the VM isn't created yet. Remove it
3820 * again to let it added to the right registry when the VM
3821 * has been created below. */
3822 pTargetMedium->i_removeRegistry(mVirtualBox->i_getGlobalRegistryId());
3823 }
3824 }
3825 catch (...)
3826 {
3827 if (strDeleteTemp.isNotEmpty())
3828 RTFileDelete(strDeleteTemp.c_str());
3829 throw;
3830 }
3831
3832 /* Make sure the source file is closed. */
3833 if (hVfsIosSrc != NIL_RTVFSIOSTREAM)
3834 RTVfsIoStrmRelease(hVfsIosSrc);
3835
3836 /*
3837 * Delete the temp gunzip result, if any.
3838 */
3839 if (strDeleteTemp.isNotEmpty())
3840 {
3841 vrc = RTFileDelete(strSrcFilePath.c_str());
3842 if (RT_FAILURE(vrc))
3843 setWarning(VBOX_E_FILE_ERROR,
3844 tr("Failed to delete the temporary file '%s' (%Rrc)"), strSrcFilePath.c_str(), vrc);
3845 }
3846 }
3847}
3848
3849/**
3850 * Imports one OVF virtual system (described by the given ovf::VirtualSystem and VirtualSystemDescription)
3851 * into VirtualBox by creating an IMachine instance, which is returned.
3852 *
3853 * This throws HRESULT error codes for anything that goes wrong, in which case the caller must clean
3854 * up any leftovers from this function. For this, the given ImportStack instance has received information
3855 * about what needs cleaning up (to support rollback).
3856 *
3857 * @param vsysThis OVF virtual system (machine) to import.
3858 * @param vsdescThis Matching virtual system description (machine) to import.
3859 * @param pNewMachine out: Newly created machine.
3860 * @param stack Cleanup stack for when this throws.
3861 */
3862void Appliance::i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
3863 ComObjPtr<VirtualSystemDescription> &vsdescThis,
3864 ComPtr<IMachine> &pNewMachine,
3865 ImportStack &stack)
3866{
3867 LogFlowFuncEnter();
3868 HRESULT rc;
3869
3870 // Get the instance of IGuestOSType which matches our string guest OS type so we
3871 // can use recommended defaults for the new machine where OVF doesn't provide any
3872 ComPtr<IGuestOSType> osType;
3873 rc = mVirtualBox->GetGuestOSType(Bstr(stack.strOsTypeVBox).raw(), osType.asOutParam());
3874 if (FAILED(rc)) throw rc;
3875
3876 /* Create the machine */
3877 SafeArray<BSTR> groups; /* no groups, or maybe one group... */
3878 if (!stack.strPrimaryGroup.isEmpty() && stack.strPrimaryGroup != "/")
3879 Bstr(stack.strPrimaryGroup).detachTo(groups.appendedRaw());
3880 rc = mVirtualBox->CreateMachine(Bstr(stack.strSettingsFilename).raw(),
3881 Bstr(stack.strNameVBox).raw(),
3882 ComSafeArrayAsInParam(groups),
3883 Bstr(stack.strOsTypeVBox).raw(),
3884 NULL, /* aCreateFlags */
3885 pNewMachine.asOutParam());
3886 if (FAILED(rc)) throw rc;
3887
3888 // set the description
3889 if (!stack.strDescription.isEmpty())
3890 {
3891 rc = pNewMachine->COMSETTER(Description)(Bstr(stack.strDescription).raw());
3892 if (FAILED(rc)) throw rc;
3893 }
3894
3895 // CPU count
3896 rc = pNewMachine->COMSETTER(CPUCount)(stack.cCPUs);
3897 if (FAILED(rc)) throw rc;
3898
3899 if (stack.fForceHWVirt)
3900 {
3901 rc = pNewMachine->SetHWVirtExProperty(HWVirtExPropertyType_Enabled, TRUE);
3902 if (FAILED(rc)) throw rc;
3903 }
3904
3905 // RAM
3906 rc = pNewMachine->COMSETTER(MemorySize)(stack.ulMemorySizeMB);
3907 if (FAILED(rc)) throw rc;
3908
3909 /* VRAM */
3910 /* Get the recommended VRAM for this guest OS type */
3911 ULONG vramVBox;
3912 rc = osType->COMGETTER(RecommendedVRAM)(&vramVBox);
3913 if (FAILED(rc)) throw rc;
3914
3915 /* Set the VRAM */
3916 ComPtr<IGraphicsAdapter> pGraphicsAdapter;
3917 rc = pNewMachine->COMGETTER(GraphicsAdapter)(pGraphicsAdapter.asOutParam());
3918 if (FAILED(rc)) throw rc;
3919 rc = pGraphicsAdapter->COMSETTER(VRAMSize)(vramVBox);
3920 if (FAILED(rc)) throw rc;
3921
3922 // I/O APIC: Generic OVF has no setting for this. Enable it if we
3923 // import a Windows VM because if if Windows was installed without IOAPIC,
3924 // it will not mind finding an one later on, but if Windows was installed
3925 // _with_ an IOAPIC, it will bluescreen if it's not found
3926 if (!stack.fForceIOAPIC)
3927 {
3928 Bstr bstrFamilyId;
3929 rc = osType->COMGETTER(FamilyId)(bstrFamilyId.asOutParam());
3930 if (FAILED(rc)) throw rc;
3931 if (bstrFamilyId == "Windows")
3932 stack.fForceIOAPIC = true;
3933 }
3934
3935 if (stack.fForceIOAPIC)
3936 {
3937 ComPtr<IBIOSSettings> pBIOSSettings;
3938 rc = pNewMachine->COMGETTER(BIOSSettings)(pBIOSSettings.asOutParam());
3939 if (FAILED(rc)) throw rc;
3940
3941 rc = pBIOSSettings->COMSETTER(IOAPICEnabled)(TRUE);
3942 if (FAILED(rc)) throw rc;
3943 }
3944
3945 if (stack.strFirmwareType.isNotEmpty())
3946 {
3947 FirmwareType_T firmwareType = FirmwareType_BIOS;
3948 if (stack.strFirmwareType.contains("EFI"))
3949 {
3950 if (stack.strFirmwareType.contains("32"))
3951 firmwareType = FirmwareType_EFI32;
3952 if (stack.strFirmwareType.contains("64"))
3953 firmwareType = FirmwareType_EFI64;
3954 else
3955 firmwareType = FirmwareType_EFI;
3956 }
3957 rc = pNewMachine->COMSETTER(FirmwareType)(firmwareType);
3958 if (FAILED(rc)) throw rc;
3959 }
3960
3961 if (!stack.strAudioAdapter.isEmpty())
3962 if (stack.strAudioAdapter.compare("null", Utf8Str::CaseInsensitive) != 0)
3963 {
3964 uint32_t audio = RTStrToUInt32(stack.strAudioAdapter.c_str()); // should be 0 for AC97
3965 ComPtr<IAudioAdapter> audioAdapter;
3966 rc = pNewMachine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam());
3967 if (FAILED(rc)) throw rc;
3968 rc = audioAdapter->COMSETTER(Enabled)(true);
3969 if (FAILED(rc)) throw rc;
3970 rc = audioAdapter->COMSETTER(AudioController)(static_cast<AudioControllerType_T>(audio));
3971 if (FAILED(rc)) throw rc;
3972 }
3973
3974#ifdef VBOX_WITH_USB
3975 /* USB Controller */
3976 if (stack.fUSBEnabled)
3977 {
3978 ComPtr<IUSBController> usbController;
3979 rc = pNewMachine->AddUSBController(Bstr("OHCI").raw(), USBControllerType_OHCI, usbController.asOutParam());
3980 if (FAILED(rc)) throw rc;
3981 }
3982#endif /* VBOX_WITH_USB */
3983
3984 /* Change the network adapters */
3985 uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(ChipsetType_PIIX3);
3986
3987 std::list<VirtualSystemDescriptionEntry*> vsdeNW = vsdescThis->i_findByType(VirtualSystemDescriptionType_NetworkAdapter);
3988 if (vsdeNW.empty())
3989 {
3990 /* No network adapters, so we have to disable our default one */
3991 ComPtr<INetworkAdapter> nwVBox;
3992 rc = pNewMachine->GetNetworkAdapter(0, nwVBox.asOutParam());
3993 if (FAILED(rc)) throw rc;
3994 rc = nwVBox->COMSETTER(Enabled)(false);
3995 if (FAILED(rc)) throw rc;
3996 }
3997 else if (vsdeNW.size() > maxNetworkAdapters)
3998 throw setError(VBOX_E_FILE_ERROR,
3999 tr("Too many network adapters: OVF requests %d network adapters, "
4000 "but VirtualBox only supports %d"),
4001 vsdeNW.size(), maxNetworkAdapters);
4002 else
4003 {
4004 list<VirtualSystemDescriptionEntry*>::const_iterator nwIt;
4005 size_t a = 0;
4006 for (nwIt = vsdeNW.begin();
4007 nwIt != vsdeNW.end();
4008 ++nwIt, ++a)
4009 {
4010 const VirtualSystemDescriptionEntry* pvsys = *nwIt;
4011
4012 const Utf8Str &nwTypeVBox = pvsys->strVBoxCurrent;
4013 uint32_t tt1 = RTStrToUInt32(nwTypeVBox.c_str());
4014 ComPtr<INetworkAdapter> pNetworkAdapter;
4015 rc = pNewMachine->GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
4016 if (FAILED(rc)) throw rc;
4017 /* Enable the network card & set the adapter type */
4018 rc = pNetworkAdapter->COMSETTER(Enabled)(true);
4019 if (FAILED(rc)) throw rc;
4020 rc = pNetworkAdapter->COMSETTER(AdapterType)(static_cast<NetworkAdapterType_T>(tt1));
4021 if (FAILED(rc)) throw rc;
4022
4023 // default is NAT; change to "bridged" if extra conf says so
4024 if (pvsys->strExtraConfigCurrent.endsWith("type=Bridged", Utf8Str::CaseInsensitive))
4025 {
4026 /* Attach to the right interface */
4027 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_Bridged);
4028 if (FAILED(rc)) throw rc;
4029 ComPtr<IHost> host;
4030 rc = mVirtualBox->COMGETTER(Host)(host.asOutParam());
4031 if (FAILED(rc)) throw rc;
4032 com::SafeIfaceArray<IHostNetworkInterface> nwInterfaces;
4033 rc = host->COMGETTER(NetworkInterfaces)(ComSafeArrayAsOutParam(nwInterfaces));
4034 if (FAILED(rc)) throw rc;
4035 // We search for the first host network interface which
4036 // is usable for bridged networking
4037 for (size_t j = 0;
4038 j < nwInterfaces.size();
4039 ++j)
4040 {
4041 HostNetworkInterfaceType_T itype;
4042 rc = nwInterfaces[j]->COMGETTER(InterfaceType)(&itype);
4043 if (FAILED(rc)) throw rc;
4044 if (itype == HostNetworkInterfaceType_Bridged)
4045 {
4046 Bstr name;
4047 rc = nwInterfaces[j]->COMGETTER(Name)(name.asOutParam());
4048 if (FAILED(rc)) throw rc;
4049 /* Set the interface name to attach to */
4050 rc = pNetworkAdapter->COMSETTER(BridgedInterface)(name.raw());
4051 if (FAILED(rc)) throw rc;
4052 break;
4053 }
4054 }
4055 }
4056 /* Next test for host only interfaces */
4057 else if (pvsys->strExtraConfigCurrent.endsWith("type=HostOnly", Utf8Str::CaseInsensitive))
4058 {
4059 /* Attach to the right interface */
4060 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_HostOnly);
4061 if (FAILED(rc)) throw rc;
4062 ComPtr<IHost> host;
4063 rc = mVirtualBox->COMGETTER(Host)(host.asOutParam());
4064 if (FAILED(rc)) throw rc;
4065 com::SafeIfaceArray<IHostNetworkInterface> nwInterfaces;
4066 rc = host->COMGETTER(NetworkInterfaces)(ComSafeArrayAsOutParam(nwInterfaces));
4067 if (FAILED(rc)) throw rc;
4068 // We search for the first host network interface which
4069 // is usable for host only networking
4070 for (size_t j = 0;
4071 j < nwInterfaces.size();
4072 ++j)
4073 {
4074 HostNetworkInterfaceType_T itype;
4075 rc = nwInterfaces[j]->COMGETTER(InterfaceType)(&itype);
4076 if (FAILED(rc)) throw rc;
4077 if (itype == HostNetworkInterfaceType_HostOnly)
4078 {
4079 Bstr name;
4080 rc = nwInterfaces[j]->COMGETTER(Name)(name.asOutParam());
4081 if (FAILED(rc)) throw rc;
4082 /* Set the interface name to attach to */
4083 rc = pNetworkAdapter->COMSETTER(HostOnlyInterface)(name.raw());
4084 if (FAILED(rc)) throw rc;
4085 break;
4086 }
4087 }
4088 }
4089 /* Next test for internal interfaces */
4090 else if (pvsys->strExtraConfigCurrent.endsWith("type=Internal", Utf8Str::CaseInsensitive))
4091 {
4092 /* Attach to the right interface */
4093 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_Internal);
4094 if (FAILED(rc)) throw rc;
4095 }
4096 /* Next test for Generic interfaces */
4097 else if (pvsys->strExtraConfigCurrent.endsWith("type=Generic", Utf8Str::CaseInsensitive))
4098 {
4099 /* Attach to the right interface */
4100 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_Generic);
4101 if (FAILED(rc)) throw rc;
4102 }
4103
4104 /* Next test for NAT network interfaces */
4105 else if (pvsys->strExtraConfigCurrent.endsWith("type=NATNetwork", Utf8Str::CaseInsensitive))
4106 {
4107 /* Attach to the right interface */
4108 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_NATNetwork);
4109 if (FAILED(rc)) throw rc;
4110 com::SafeIfaceArray<INATNetwork> nwNATNetworks;
4111 rc = mVirtualBox->COMGETTER(NATNetworks)(ComSafeArrayAsOutParam(nwNATNetworks));
4112 if (FAILED(rc)) throw rc;
4113 // Pick the first NAT network (if there is any)
4114 if (nwNATNetworks.size())
4115 {
4116 Bstr name;
4117 rc = nwNATNetworks[0]->COMGETTER(NetworkName)(name.asOutParam());
4118 if (FAILED(rc)) throw rc;
4119 /* Set the NAT network name to attach to */
4120 rc = pNetworkAdapter->COMSETTER(NATNetwork)(name.raw());
4121 if (FAILED(rc)) throw rc;
4122 break;
4123 }
4124 }
4125 }
4126 }
4127
4128 // Storage controller IDE
4129 std::list<VirtualSystemDescriptionEntry*> vsdeHDCIDE =
4130 vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskControllerIDE);
4131 /*
4132 * In OVF (at least VMware's version of it), an IDE controller has two ports,
4133 * so VirtualBox's single IDE controller with two channels and two ports each counts as
4134 * two OVF IDE controllers -- so we accept one or two such IDE controllers
4135 */
4136 size_t cIDEControllers = vsdeHDCIDE.size();
4137 if (cIDEControllers > 2)
4138 throw setError(VBOX_E_FILE_ERROR,
4139 tr("Too many IDE controllers in OVF; import facility only supports two"));
4140 if (!vsdeHDCIDE.empty())
4141 {
4142 // one or two IDE controllers present in OVF: add one VirtualBox controller
4143 ComPtr<IStorageController> pController;
4144 rc = pNewMachine->AddStorageController(Bstr("IDE").raw(), StorageBus_IDE, pController.asOutParam());
4145 if (FAILED(rc)) throw rc;
4146
4147 const char *pcszIDEType = vsdeHDCIDE.front()->strVBoxCurrent.c_str();
4148 if (!strcmp(pcszIDEType, "PIIX3"))
4149 rc = pController->COMSETTER(ControllerType)(StorageControllerType_PIIX3);
4150 else if (!strcmp(pcszIDEType, "PIIX4"))
4151 rc = pController->COMSETTER(ControllerType)(StorageControllerType_PIIX4);
4152 else if (!strcmp(pcszIDEType, "ICH6"))
4153 rc = pController->COMSETTER(ControllerType)(StorageControllerType_ICH6);
4154 else
4155 throw setError(VBOX_E_FILE_ERROR,
4156 tr("Invalid IDE controller type \"%s\""),
4157 pcszIDEType);
4158 if (FAILED(rc)) throw rc;
4159 }
4160
4161 /* Storage controller SATA */
4162 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSATA =
4163 vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskControllerSATA);
4164 if (vsdeHDCSATA.size() > 1)
4165 throw setError(VBOX_E_FILE_ERROR,
4166 tr("Too many SATA controllers in OVF; import facility only supports one"));
4167 if (!vsdeHDCSATA.empty())
4168 {
4169 ComPtr<IStorageController> pController;
4170 const Utf8Str &hdcVBox = vsdeHDCSATA.front()->strVBoxCurrent;
4171 if (hdcVBox == "AHCI")
4172 {
4173 rc = pNewMachine->AddStorageController(Bstr("SATA").raw(),
4174 StorageBus_SATA,
4175 pController.asOutParam());
4176 if (FAILED(rc)) throw rc;
4177 }
4178 else
4179 throw setError(VBOX_E_FILE_ERROR,
4180 tr("Invalid SATA controller type \"%s\""),
4181 hdcVBox.c_str());
4182 }
4183
4184 /* Storage controller SCSI */
4185 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSCSI =
4186 vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskControllerSCSI);
4187 if (vsdeHDCSCSI.size() > 1)
4188 throw setError(VBOX_E_FILE_ERROR,
4189 tr("Too many SCSI controllers in OVF; import facility only supports one"));
4190 if (!vsdeHDCSCSI.empty())
4191 {
4192 ComPtr<IStorageController> pController;
4193 Utf8Str strName("SCSI");
4194 StorageBus_T busType = StorageBus_SCSI;
4195 StorageControllerType_T controllerType;
4196 const Utf8Str &hdcVBox = vsdeHDCSCSI.front()->strVBoxCurrent;
4197 if (hdcVBox == "LsiLogic")
4198 controllerType = StorageControllerType_LsiLogic;
4199 else if (hdcVBox == "LsiLogicSas")
4200 {
4201 // OVF treats LsiLogicSas as a SCSI controller but VBox considers it a class of its own
4202 strName = "SAS";
4203 busType = StorageBus_SAS;
4204 controllerType = StorageControllerType_LsiLogicSas;
4205 }
4206 else if (hdcVBox == "BusLogic")
4207 controllerType = StorageControllerType_BusLogic;
4208 else
4209 throw setError(VBOX_E_FILE_ERROR,
4210 tr("Invalid SCSI controller type \"%s\""),
4211 hdcVBox.c_str());
4212
4213 rc = pNewMachine->AddStorageController(Bstr(strName).raw(), busType, pController.asOutParam());
4214 if (FAILED(rc)) throw rc;
4215 rc = pController->COMSETTER(ControllerType)(controllerType);
4216 if (FAILED(rc)) throw rc;
4217 }
4218
4219 /* Storage controller SAS */
4220 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSAS =
4221 vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskControllerSAS);
4222 if (vsdeHDCSAS.size() > 1)
4223 throw setError(VBOX_E_FILE_ERROR,
4224 tr("Too many SAS controllers in OVF; import facility only supports one"));
4225 if (!vsdeHDCSAS.empty())
4226 {
4227 ComPtr<IStorageController> pController;
4228 rc = pNewMachine->AddStorageController(Bstr(L"SAS").raw(),
4229 StorageBus_SAS,
4230 pController.asOutParam());
4231 if (FAILED(rc)) throw rc;
4232 rc = pController->COMSETTER(ControllerType)(StorageControllerType_LsiLogicSas);
4233 if (FAILED(rc)) throw rc;
4234 }
4235
4236 /* Now its time to register the machine before we add any storage devices */
4237 rc = mVirtualBox->RegisterMachine(pNewMachine);
4238 if (FAILED(rc)) throw rc;
4239
4240 // store new machine for roll-back in case of errors
4241 Bstr bstrNewMachineId;
4242 rc = pNewMachine->COMGETTER(Id)(bstrNewMachineId.asOutParam());
4243 if (FAILED(rc)) throw rc;
4244 Guid uuidNewMachine(bstrNewMachineId);
4245 m->llGuidsMachinesCreated.push_back(uuidNewMachine);
4246
4247 // Add floppies and CD-ROMs to the appropriate controllers.
4248 std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsdescThis->i_findByType(VirtualSystemDescriptionType_Floppy);
4249 if (vsdeFloppy.size() > 1)
4250 throw setError(VBOX_E_FILE_ERROR,
4251 tr("Too many floppy controllers in OVF; import facility only supports one"));
4252 std::list<VirtualSystemDescriptionEntry*> vsdeCDROM = vsdescThis->i_findByType(VirtualSystemDescriptionType_CDROM);
4253 if ( !vsdeFloppy.empty()
4254 || !vsdeCDROM.empty()
4255 )
4256 {
4257 // If there's an error here we need to close the session, so
4258 // we need another try/catch block.
4259
4260 try
4261 {
4262 // to attach things we need to open a session for the new machine
4263 rc = pNewMachine->LockMachine(stack.pSession, LockType_Write);
4264 if (FAILED(rc)) throw rc;
4265 stack.fSessionOpen = true;
4266
4267 ComPtr<IMachine> sMachine;
4268 rc = stack.pSession->COMGETTER(Machine)(sMachine.asOutParam());
4269 if (FAILED(rc)) throw rc;
4270
4271 // floppy first
4272 if (vsdeFloppy.size() == 1)
4273 {
4274 ComPtr<IStorageController> pController;
4275 rc = sMachine->AddStorageController(Bstr("Floppy").raw(),
4276 StorageBus_Floppy,
4277 pController.asOutParam());
4278 if (FAILED(rc)) throw rc;
4279
4280 Bstr bstrName;
4281 rc = pController->COMGETTER(Name)(bstrName.asOutParam());
4282 if (FAILED(rc)) throw rc;
4283
4284 // this is for rollback later
4285 MyHardDiskAttachment mhda;
4286 mhda.pMachine = pNewMachine;
4287 mhda.controllerName = bstrName;
4288 mhda.lControllerPort = 0;
4289 mhda.lDevice = 0;
4290
4291 Log(("Attaching floppy\n"));
4292
4293 rc = sMachine->AttachDevice(Bstr(mhda.controllerName).raw(),
4294 mhda.lControllerPort,
4295 mhda.lDevice,
4296 DeviceType_Floppy,
4297 NULL);
4298 if (FAILED(rc)) throw rc;
4299
4300 stack.llHardDiskAttachments.push_back(mhda);
4301 }
4302
4303 rc = sMachine->SaveSettings();
4304 if (FAILED(rc)) throw rc;
4305
4306 // only now that we're done with all storage devices, close the session
4307 rc = stack.pSession->UnlockMachine();
4308 if (FAILED(rc)) throw rc;
4309 stack.fSessionOpen = false;
4310 }
4311 catch(HRESULT aRC)
4312 {
4313 com::ErrorInfo info;
4314
4315 if (stack.fSessionOpen)
4316 stack.pSession->UnlockMachine();
4317
4318 if (info.isFullAvailable())
4319 throw setError(aRC, Utf8Str(info.getText()).c_str());
4320 else
4321 throw setError(aRC, "Unknown error during OVF import");
4322 }
4323 }
4324
4325 // create the storage devices & connect them to the appropriate controllers
4326 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskImage);
4327 if (!avsdeHDs.empty())
4328 {
4329 // If there's an error here we need to close the session, so
4330 // we need another try/catch block.
4331 try
4332 {
4333#ifdef LOG_ENABLED
4334 if (LogIsEnabled())
4335 {
4336 size_t i = 0;
4337 for (list<VirtualSystemDescriptionEntry*>::const_iterator itHD = avsdeHDs.begin();
4338 itHD != avsdeHDs.end(); ++itHD, i++)
4339 Log(("avsdeHDs[%zu]: strRef=%s strOvf=%s\n", i, (*itHD)->strRef.c_str(), (*itHD)->strOvf.c_str()));
4340 i = 0;
4341 for (ovf::DiskImagesMap::const_iterator itDisk = stack.mapDisks.begin(); itDisk != stack.mapDisks.end(); ++itDisk)
4342 Log(("mapDisks[%zu]: strDiskId=%s strHref=%s\n",
4343 i, itDisk->second.strDiskId.c_str(), itDisk->second.strHref.c_str()));
4344
4345 }
4346#endif
4347
4348 // to attach things we need to open a session for the new machine
4349 rc = pNewMachine->LockMachine(stack.pSession, LockType_Write);
4350 if (FAILED(rc)) throw rc;
4351 stack.fSessionOpen = true;
4352
4353 /* get VM name from virtual system description. Only one record is possible (size of list is equal 1). */
4354 std::list<VirtualSystemDescriptionEntry*> vmName = vsdescThis->i_findByType(VirtualSystemDescriptionType_Name);
4355 std::list<VirtualSystemDescriptionEntry*>::iterator vmNameIt = vmName.begin();
4356 VirtualSystemDescriptionEntry* vmNameEntry = *vmNameIt;
4357
4358
4359 ovf::DiskImagesMap::const_iterator oit = stack.mapDisks.begin();
4360 std::set<RTCString> disksResolvedNames;
4361
4362 uint32_t cImportedDisks = 0;
4363
4364 while (oit != stack.mapDisks.end() && cImportedDisks != avsdeHDs.size())
4365 {
4366/** @todo r=bird: Most of the code here is duplicated in the other machine
4367 * import method, factor out. */
4368 ovf::DiskImage diCurrent = oit->second;
4369
4370 Log(("diCurrent.strDiskId=%s diCurrent.strHref=%s\n", diCurrent.strDiskId.c_str(), diCurrent.strHref.c_str()));
4371 /* Iterate over all given images of the virtual system
4372 * description. We need to find the target image path,
4373 * which could be changed by the user. */
4374 VirtualSystemDescriptionEntry *vsdeTargetHD = NULL;
4375 for (list<VirtualSystemDescriptionEntry*>::const_iterator itHD = avsdeHDs.begin();
4376 itHD != avsdeHDs.end();
4377 ++itHD)
4378 {
4379 VirtualSystemDescriptionEntry *vsdeHD = *itHD;
4380 if (vsdeHD->strRef == diCurrent.strDiskId)
4381 {
4382 vsdeTargetHD = vsdeHD;
4383 break;
4384 }
4385 }
4386 if (!vsdeTargetHD)
4387 {
4388 /* possible case if an image belongs to other virtual system (OVF package with multiple VMs inside) */
4389 Log1Warning(("OVA/OVF import: Disk image %s was missed during import of VM %s\n",
4390 oit->first.c_str(), vmNameEntry->strOvf.c_str()));
4391 NOREF(vmNameEntry);
4392 ++oit;
4393 continue;
4394 }
4395
4396 //diCurrent.strDiskId contains the image identifier (e.g. "vmdisk1"), which should exist
4397 //in the virtual system's images map under that ID and also in the global images map
4398 ovf::VirtualDisksMap::const_iterator itVDisk = vsysThis.mapVirtualDisks.find(diCurrent.strDiskId);
4399 if (itVDisk == vsysThis.mapVirtualDisks.end())
4400 throw setError(E_FAIL,
4401 tr("Internal inconsistency looking up disk image '%s'"),
4402 diCurrent.strHref.c_str());
4403
4404 /*
4405 * preliminary check availability of the image
4406 * This step is useful if image is placed in the OVA (TAR) package
4407 */
4408 if (stack.hVfsFssOva != NIL_RTVFSFSSTREAM)
4409 {
4410 /* It means that we possibly have imported the storage earlier on the previous loop steps*/
4411 std::set<RTCString>::const_iterator h = disksResolvedNames.find(diCurrent.strHref);
4412 if (h != disksResolvedNames.end())
4413 {
4414 /* Yes, image name was found, we can skip it*/
4415 ++oit;
4416 continue;
4417 }
4418l_skipped:
4419 rc = i_preCheckImageAvailability(stack);
4420 if (SUCCEEDED(rc))
4421 {
4422 /* current opened file isn't the same as passed one */
4423 if (RTStrICmp(diCurrent.strHref.c_str(), stack.pszOvaLookAheadName) != 0)
4424 {
4425 /* availableImage contains the image file reference (e.g. "disk1.vmdk"), which should
4426 * exist in the global images map.
4427 * And find the image from the OVF's disk list */
4428 ovf::DiskImagesMap::const_iterator itDiskImage;
4429 for (itDiskImage = stack.mapDisks.begin();
4430 itDiskImage != stack.mapDisks.end();
4431 itDiskImage++)
4432 if (itDiskImage->second.strHref.compare(stack.pszOvaLookAheadName,
4433 Utf8Str::CaseInsensitive) == 0)
4434 break;
4435 if (itDiskImage == stack.mapDisks.end())
4436 {
4437 LogFunc(("Skipping '%s'\n", stack.pszOvaLookAheadName));
4438 RTVfsIoStrmRelease(stack.claimOvaLookAHead());
4439 goto l_skipped;
4440 }
4441
4442 /* replace with a new found image */
4443 diCurrent = *(&itDiskImage->second);
4444
4445 /*
4446 * Again iterate over all given images of the virtual system
4447 * description using the found image
4448 */
4449 for (list<VirtualSystemDescriptionEntry*>::const_iterator itHD = avsdeHDs.begin();
4450 itHD != avsdeHDs.end();
4451 ++itHD)
4452 {
4453 VirtualSystemDescriptionEntry *vsdeHD = *itHD;
4454 if (vsdeHD->strRef == diCurrent.strDiskId)
4455 {
4456 vsdeTargetHD = vsdeHD;
4457 break;
4458 }
4459 }
4460
4461 /*
4462 * in this case it's an error because something is wrong with the OVF description file.
4463 * May be VBox imports OVA package with wrong file sequence inside the archive.
4464 */
4465 if (!vsdeTargetHD)
4466 throw setError(E_FAIL,
4467 tr("Internal inconsistency looking up disk image '%s'"),
4468 diCurrent.strHref.c_str());
4469
4470 itVDisk = vsysThis.mapVirtualDisks.find(diCurrent.strDiskId);
4471 if (itVDisk == vsysThis.mapVirtualDisks.end())
4472 throw setError(E_FAIL,
4473 tr("Internal inconsistency looking up disk image '%s'"),
4474 diCurrent.strHref.c_str());
4475 }
4476 else
4477 {
4478 ++oit;
4479 }
4480 }
4481 else
4482 {
4483 ++oit;
4484 continue;
4485 }
4486 }
4487 else
4488 {
4489 /* just continue with normal files */
4490 ++oit;
4491 }
4492
4493 /* very important to store image name for the next checks */
4494 disksResolvedNames.insert(diCurrent.strHref);
4495////// end of duplicated code.
4496 const ovf::VirtualDisk &ovfVdisk = itVDisk->second;
4497
4498 ComObjPtr<Medium> pTargetMedium;
4499 if (stack.locInfo.storageType == VFSType_Cloud)
4500 {
4501 /* We have already all disks prepared (converted and registered in the VBox)
4502 * and in the correct place (VM machine folder).
4503 * so what is needed is to get the disk uuid from VirtualDisk::strDiskId
4504 * and find the Medium object with this uuid.
4505 * next just attach the Medium object to new VM.
4506 * VirtualDisk::strDiskId is filled in the */
4507
4508 Guid id(ovfVdisk.strDiskId);
4509 rc = mVirtualBox->i_findHardDiskById(id, false, &pTargetMedium);
4510 if (FAILED(rc))
4511 throw rc;
4512 }
4513 else
4514 {
4515 i_importOneDiskImage(diCurrent,
4516 vsdeTargetHD->strVBoxCurrent,
4517 pTargetMedium,
4518 stack);
4519 }
4520
4521 // now use the new uuid to attach the medium to our new machine
4522 ComPtr<IMachine> sMachine;
4523 rc = stack.pSession->COMGETTER(Machine)(sMachine.asOutParam());
4524 if (FAILED(rc))
4525 throw rc;
4526
4527 // find the hard disk controller to which we should attach
4528 ovf::HardDiskController hdc = (*vsysThis.mapControllers.find(ovfVdisk.idController)).second;
4529
4530 // this is for rollback later
4531 MyHardDiskAttachment mhda;
4532 mhda.pMachine = pNewMachine;
4533
4534 i_convertDiskAttachmentValues(hdc,
4535 ovfVdisk.ulAddressOnParent,
4536 mhda.controllerName,
4537 mhda.lControllerPort,
4538 mhda.lDevice);
4539
4540 Log(("Attaching disk %s to port %d on device %d\n",
4541 vsdeTargetHD->strVBoxCurrent.c_str(), mhda.lControllerPort, mhda.lDevice));
4542
4543 DeviceType_T devType = DeviceType_Null;
4544 rc = pTargetMedium->COMGETTER(DeviceType)(&devType);
4545 if (FAILED(rc))
4546 throw rc;
4547
4548 rc = sMachine->AttachDevice(Bstr(mhda.controllerName).raw(),// name
4549 mhda.lControllerPort, // long controllerPort
4550 mhda.lDevice, // long device
4551 devType, // DeviceType_T type
4552 pTargetMedium);
4553 if (FAILED(rc))
4554 throw rc;
4555
4556 stack.llHardDiskAttachments.push_back(mhda);
4557
4558 rc = sMachine->SaveSettings();
4559 if (FAILED(rc))
4560 throw rc;
4561
4562 ++cImportedDisks;
4563
4564 } // end while(oit != stack.mapDisks.end())
4565
4566 /*
4567 * quantity of the imported disks isn't equal to the size of the avsdeHDs list.
4568 */
4569 if(cImportedDisks < avsdeHDs.size())
4570 {
4571 Log1Warning(("Not all disk images were imported for VM %s. Check OVF description file.",
4572 vmNameEntry->strOvf.c_str()));
4573 }
4574
4575 // only now that we're done with all disks, close the session
4576 rc = stack.pSession->UnlockMachine();
4577 if (FAILED(rc))
4578 throw rc;
4579 stack.fSessionOpen = false;
4580 }
4581 catch(HRESULT aRC)
4582 {
4583 com::ErrorInfo info;
4584 if (stack.fSessionOpen)
4585 stack.pSession->UnlockMachine();
4586
4587 if (info.isFullAvailable())
4588 throw setError(aRC, Utf8Str(info.getText()).c_str());
4589 else
4590 throw setError(aRC, "Unknown error during OVF import");
4591 }
4592 }
4593 LogFlowFuncLeave();
4594}
4595
4596/**
4597 * Imports one OVF virtual system (described by a vbox:Machine tag represented by the given config
4598 * structure) into VirtualBox by creating an IMachine instance, which is returned.
4599 *
4600 * This throws HRESULT error codes for anything that goes wrong, in which case the caller must clean
4601 * up any leftovers from this function. For this, the given ImportStack instance has received information
4602 * about what needs cleaning up (to support rollback).
4603 *
4604 * The machine config stored in the settings::MachineConfigFile structure contains the UUIDs of
4605 * the disk attachments used by the machine when it was exported. We also add vbox:uuid attributes
4606 * to the OVF disks sections so we can look them up. While importing these UUIDs into a second host
4607 * will most probably work, reimporting them into the same host will cause conflicts, so we always
4608 * generate new ones on import. This involves the following:
4609 *
4610 * 1) Scan the machine config for disk attachments.
4611 *
4612 * 2) For each disk attachment found, look up the OVF disk image from the disk references section
4613 * and import the disk into VirtualBox, which creates a new UUID for it. In the machine config,
4614 * replace the old UUID with the new one.
4615 *
4616 * 3) Change the machine config according to the OVF virtual system descriptions, in case the
4617 * caller has modified them using setFinalValues().
4618 *
4619 * 4) Create the VirtualBox machine with the modfified machine config.
4620 *
4621 * @param vsdescThis
4622 * @param pReturnNewMachine
4623 * @param stack
4624 */
4625void Appliance::i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
4626 ComPtr<IMachine> &pReturnNewMachine,
4627 ImportStack &stack)
4628{
4629 LogFlowFuncEnter();
4630 Assert(vsdescThis->m->pConfig);
4631
4632 HRESULT rc = S_OK;
4633
4634 settings::MachineConfigFile &config = *vsdescThis->m->pConfig;
4635
4636 /*
4637 * step 1): modify machine config according to OVF config, in case the user
4638 * has modified them using setFinalValues()
4639 */
4640
4641 /* OS Type */
4642 config.machineUserData.strOsType = stack.strOsTypeVBox;
4643 /* Groups */
4644 if (stack.strPrimaryGroup.isEmpty() || stack.strPrimaryGroup == "/")
4645 {
4646 config.machineUserData.llGroups.clear();
4647 config.machineUserData.llGroups.push_back("/");
4648 }
4649 else
4650 {
4651 /* Replace the primary group if there is one, otherwise add it. */
4652 if (config.machineUserData.llGroups.size())
4653 config.machineUserData.llGroups.pop_front();
4654 config.machineUserData.llGroups.push_front(stack.strPrimaryGroup);
4655 }
4656 /* Description */
4657 config.machineUserData.strDescription = stack.strDescription;
4658 /* CPU count & extented attributes */
4659 config.hardwareMachine.cCPUs = stack.cCPUs;
4660 if (stack.fForceIOAPIC)
4661 config.hardwareMachine.fHardwareVirt = true;
4662 if (stack.fForceIOAPIC)
4663 config.hardwareMachine.biosSettings.fIOAPICEnabled = true;
4664 /* RAM size */
4665 config.hardwareMachine.ulMemorySizeMB = stack.ulMemorySizeMB;
4666
4667/*
4668 <const name="HardDiskControllerIDE" value="14" />
4669 <const name="HardDiskControllerSATA" value="15" />
4670 <const name="HardDiskControllerSCSI" value="16" />
4671 <const name="HardDiskControllerSAS" value="17" />
4672*/
4673
4674#ifdef VBOX_WITH_USB
4675 /* USB controller */
4676 if (stack.fUSBEnabled)
4677 {
4678 /** @todo r=klaus add support for arbitrary USB controller types, this can't handle
4679 * multiple controllers due to its design anyway */
4680 /* Usually the OHCI controller is enabled already, need to check. But
4681 * do this only if there is no xHCI controller. */
4682 bool fOHCIEnabled = false;
4683 bool fXHCIEnabled = false;
4684 settings::USBControllerList &llUSBControllers = config.hardwareMachine.usbSettings.llUSBControllers;
4685 settings::USBControllerList::iterator it;
4686 for (it = llUSBControllers.begin(); it != llUSBControllers.end(); ++it)
4687 {
4688 if (it->enmType == USBControllerType_OHCI)
4689 fOHCIEnabled = true;
4690 if (it->enmType == USBControllerType_XHCI)
4691 fXHCIEnabled = true;
4692 }
4693
4694 if (!fXHCIEnabled && !fOHCIEnabled)
4695 {
4696 settings::USBController ctrl;
4697 ctrl.strName = "OHCI";
4698 ctrl.enmType = USBControllerType_OHCI;
4699
4700 llUSBControllers.push_back(ctrl);
4701 }
4702 }
4703 else
4704 config.hardwareMachine.usbSettings.llUSBControllers.clear();
4705#endif
4706 /* Audio adapter */
4707 if (stack.strAudioAdapter.isNotEmpty())
4708 {
4709 config.hardwareMachine.audioAdapter.fEnabled = true;
4710 config.hardwareMachine.audioAdapter.controllerType = (AudioControllerType_T)stack.strAudioAdapter.toUInt32();
4711 }
4712 else
4713 config.hardwareMachine.audioAdapter.fEnabled = false;
4714 /* Network adapter */
4715 settings::NetworkAdaptersList &llNetworkAdapters = config.hardwareMachine.llNetworkAdapters;
4716 /* First disable all network cards, they will be enabled below again. */
4717 settings::NetworkAdaptersList::iterator it1;
4718 bool fKeepAllMACs = m->optListImport.contains(ImportOptions_KeepAllMACs);
4719 bool fKeepNATMACs = m->optListImport.contains(ImportOptions_KeepNATMACs);
4720 for (it1 = llNetworkAdapters.begin(); it1 != llNetworkAdapters.end(); ++it1)
4721 {
4722 it1->fEnabled = false;
4723 if (!( fKeepAllMACs
4724 || (fKeepNATMACs && it1->mode == NetworkAttachmentType_NAT)
4725 || (fKeepNATMACs && it1->mode == NetworkAttachmentType_NATNetwork)))
4726 /* Force generation of new MAC address below. */
4727 it1->strMACAddress.setNull();
4728 }
4729 /* Now iterate over all network entries. */
4730 std::list<VirtualSystemDescriptionEntry*> avsdeNWs = vsdescThis->i_findByType(VirtualSystemDescriptionType_NetworkAdapter);
4731 if (!avsdeNWs.empty())
4732 {
4733 /* Iterate through all network adapter entries and search for the
4734 * corresponding one in the machine config. If one is found, configure
4735 * it based on the user settings. */
4736 list<VirtualSystemDescriptionEntry*>::const_iterator itNW;
4737 for (itNW = avsdeNWs.begin();
4738 itNW != avsdeNWs.end();
4739 ++itNW)
4740 {
4741 VirtualSystemDescriptionEntry *vsdeNW = *itNW;
4742 if ( vsdeNW->strExtraConfigCurrent.startsWith("slot=", Utf8Str::CaseInsensitive)
4743 && vsdeNW->strExtraConfigCurrent.length() > 6)
4744 {
4745 uint32_t iSlot = vsdeNW->strExtraConfigCurrent.substr(5).toUInt32();
4746 /* Iterate through all network adapters in the machine config. */
4747 for (it1 = llNetworkAdapters.begin();
4748 it1 != llNetworkAdapters.end();
4749 ++it1)
4750 {
4751 /* Compare the slots. */
4752 if (it1->ulSlot == iSlot)
4753 {
4754 it1->fEnabled = true;
4755 if (it1->strMACAddress.isEmpty())
4756 Host::i_generateMACAddress(it1->strMACAddress);
4757 it1->type = (NetworkAdapterType_T)vsdeNW->strVBoxCurrent.toUInt32();
4758 break;
4759 }
4760 }
4761 }
4762 }
4763 }
4764
4765 /* Floppy controller */
4766 bool fFloppy = vsdescThis->i_findByType(VirtualSystemDescriptionType_Floppy).size() > 0;
4767 /* DVD controller */
4768 bool fDVD = vsdescThis->i_findByType(VirtualSystemDescriptionType_CDROM).size() > 0;
4769 /* Iterate over all storage controller check the attachments and remove
4770 * them when necessary. Also detect broken configs with more than one
4771 * attachment. Old VirtualBox versions (prior to 3.2.10) had all disk
4772 * attachments pointing to the last hard disk image, which causes import
4773 * failures. A long fixed bug, however the OVF files are long lived. */
4774 settings::StorageControllersList &llControllers = config.hardwareMachine.storage.llStorageControllers;
4775 Guid hdUuid;
4776 uint32_t cDisks = 0;
4777 bool fInconsistent = false;
4778 bool fRepairDuplicate = false;
4779 settings::StorageControllersList::iterator it3;
4780 for (it3 = llControllers.begin();
4781 it3 != llControllers.end();
4782 ++it3)
4783 {
4784 settings::AttachedDevicesList &llAttachments = it3->llAttachedDevices;
4785 settings::AttachedDevicesList::iterator it4 = llAttachments.begin();
4786 while (it4 != llAttachments.end())
4787 {
4788 if ( ( !fDVD
4789 && it4->deviceType == DeviceType_DVD)
4790 ||
4791 ( !fFloppy
4792 && it4->deviceType == DeviceType_Floppy))
4793 {
4794 it4 = llAttachments.erase(it4);
4795 continue;
4796 }
4797 else if (it4->deviceType == DeviceType_HardDisk)
4798 {
4799 const Guid &thisUuid = it4->uuid;
4800 cDisks++;
4801 if (cDisks == 1)
4802 {
4803 if (hdUuid.isZero())
4804 hdUuid = thisUuid;
4805 else
4806 fInconsistent = true;
4807 }
4808 else
4809 {
4810 if (thisUuid.isZero())
4811 fInconsistent = true;
4812 else if (thisUuid == hdUuid)
4813 fRepairDuplicate = true;
4814 }
4815 }
4816 ++it4;
4817 }
4818 }
4819 /* paranoia... */
4820 if (fInconsistent || cDisks == 1)
4821 fRepairDuplicate = false;
4822
4823 /*
4824 * step 2: scan the machine config for media attachments
4825 */
4826 /* get VM name from virtual system description. Only one record is possible (size of list is equal 1). */
4827 std::list<VirtualSystemDescriptionEntry*> vmName = vsdescThis->i_findByType(VirtualSystemDescriptionType_Name);
4828 std::list<VirtualSystemDescriptionEntry*>::iterator vmNameIt = vmName.begin();
4829 VirtualSystemDescriptionEntry* vmNameEntry = *vmNameIt;
4830
4831 /* Get all hard disk descriptions. */
4832 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskImage);
4833 std::list<VirtualSystemDescriptionEntry*>::iterator avsdeHDsIt = avsdeHDs.begin();
4834 /* paranoia - if there is no 1:1 match do not try to repair. */
4835 if (cDisks != avsdeHDs.size())
4836 fRepairDuplicate = false;
4837
4838 // there must be an image in the OVF disk structs with the same UUID
4839
4840 ovf::DiskImagesMap::const_iterator oit = stack.mapDisks.begin();
4841 std::set<RTCString> disksResolvedNames;
4842
4843 uint32_t cImportedDisks = 0;
4844
4845 while (oit != stack.mapDisks.end() && cImportedDisks != avsdeHDs.size())
4846 {
4847/** @todo r=bird: Most of the code here is duplicated in the other machine
4848 * import method, factor out. */
4849 ovf::DiskImage diCurrent = oit->second;
4850
4851 Log(("diCurrent.strDiskId=%s diCurrent.strHref=%s\n", diCurrent.strDiskId.c_str(), diCurrent.strHref.c_str()));
4852
4853 /* Iterate over all given disk images of the virtual system
4854 * disks description. We need to find the target disk path,
4855 * which could be changed by the user. */
4856 VirtualSystemDescriptionEntry *vsdeTargetHD = NULL;
4857 for (list<VirtualSystemDescriptionEntry*>::const_iterator itHD = avsdeHDs.begin();
4858 itHD != avsdeHDs.end();
4859 ++itHD)
4860 {
4861 VirtualSystemDescriptionEntry *vsdeHD = *itHD;
4862 if (vsdeHD->strRef == oit->first)
4863 {
4864 vsdeTargetHD = vsdeHD;
4865 break;
4866 }
4867 }
4868 if (!vsdeTargetHD)
4869 {
4870 /* possible case if a disk image belongs to other virtual system (OVF package with multiple VMs inside) */
4871 Log1Warning(("OVA/OVF import: Disk image %s was missed during import of VM %s\n",
4872 oit->first.c_str(), vmNameEntry->strOvf.c_str()));
4873 NOREF(vmNameEntry);
4874 ++oit;
4875 continue;
4876 }
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886 /*
4887 * preliminary check availability of the image
4888 * This step is useful if image is placed in the OVA (TAR) package
4889 */
4890 if (stack.hVfsFssOva != NIL_RTVFSFSSTREAM)
4891 {
4892 /* It means that we possibly have imported the storage earlier on a previous loop step. */
4893 std::set<RTCString>::const_iterator h = disksResolvedNames.find(diCurrent.strHref);
4894 if (h != disksResolvedNames.end())
4895 {
4896 /* Yes, disk name was found, we can skip it*/
4897 ++oit;
4898 continue;
4899 }
4900l_skipped:
4901 rc = i_preCheckImageAvailability(stack);
4902 if (SUCCEEDED(rc))
4903 {
4904 /* current opened file isn't the same as passed one */
4905 if (RTStrICmp(diCurrent.strHref.c_str(), stack.pszOvaLookAheadName) != 0)
4906 {
4907 // availableImage contains the disk identifier (e.g. "vmdisk1"), which should exist
4908 // in the virtual system's disks map under that ID and also in the global images map
4909 // and find the disk from the OVF's disk list
4910 ovf::DiskImagesMap::const_iterator itDiskImage;
4911 for (itDiskImage = stack.mapDisks.begin();
4912 itDiskImage != stack.mapDisks.end();
4913 itDiskImage++)
4914 if (itDiskImage->second.strHref.compare(stack.pszOvaLookAheadName,
4915 Utf8Str::CaseInsensitive) == 0)
4916 break;
4917 if (itDiskImage == stack.mapDisks.end())
4918 {
4919 LogFunc(("Skipping '%s'\n", stack.pszOvaLookAheadName));
4920 RTVfsIoStrmRelease(stack.claimOvaLookAHead());
4921 goto l_skipped;
4922 }
4923 //throw setError(E_FAIL,
4924 // tr("Internal inconsistency looking up disk image '%s'. "
4925 // "Check compliance OVA package structure and file names "
4926 // "references in the section <References> in the OVF file."),
4927 // stack.pszOvaLookAheadName);
4928
4929 /* replace with a new found disk image */
4930 diCurrent = *(&itDiskImage->second);
4931
4932 /*
4933 * Again iterate over all given disk images of the virtual system
4934 * disks description using the found disk image
4935 */
4936 vsdeTargetHD = NULL;
4937 for (list<VirtualSystemDescriptionEntry*>::const_iterator itHD = avsdeHDs.begin();
4938 itHD != avsdeHDs.end();
4939 ++itHD)
4940 {
4941 VirtualSystemDescriptionEntry *vsdeHD = *itHD;
4942 if (vsdeHD->strRef == diCurrent.strDiskId)
4943 {
4944 vsdeTargetHD = vsdeHD;
4945 break;
4946 }
4947 }
4948
4949 /*
4950 * in this case it's an error because something is wrong with the OVF description file.
4951 * May be VBox imports OVA package with wrong file sequence inside the archive.
4952 */
4953 if (!vsdeTargetHD)
4954 throw setError(E_FAIL,
4955 tr("Internal inconsistency looking up disk image '%s'"),
4956 diCurrent.strHref.c_str());
4957
4958
4959
4960
4961
4962 }
4963 else
4964 {
4965 ++oit;
4966 }
4967 }
4968 else
4969 {
4970 ++oit;
4971 continue;
4972 }
4973 }
4974 else
4975 {
4976 /* just continue with normal files*/
4977 ++oit;
4978 }
4979
4980 /* Important! to store disk name for the next checks */
4981 disksResolvedNames.insert(diCurrent.strHref);
4982////// end of duplicated code.
4983 // there must be an image in the OVF disk structs with the same UUID
4984 bool fFound = false;
4985 Utf8Str strUuid;
4986
4987 // for each storage controller...
4988 for (settings::StorageControllersList::iterator sit = config.hardwareMachine.storage.llStorageControllers.begin();
4989 sit != config.hardwareMachine.storage.llStorageControllers.end();
4990 ++sit)
4991 {
4992 settings::StorageController &sc = *sit;
4993
4994 // for each medium attachment to this controller...
4995 for (settings::AttachedDevicesList::iterator dit = sc.llAttachedDevices.begin();
4996 dit != sc.llAttachedDevices.end();
4997 ++dit)
4998 {
4999 settings::AttachedDevice &d = *dit;
5000
5001 if (d.uuid.isZero())
5002 // empty DVD and floppy media
5003 continue;
5004
5005 // When repairing a broken VirtualBox xml config section (written
5006 // by VirtualBox versions earlier than 3.2.10) assume the disks
5007 // show up in the same order as in the OVF description.
5008 if (fRepairDuplicate)
5009 {
5010 VirtualSystemDescriptionEntry *vsdeHD = *avsdeHDsIt;
5011 ovf::DiskImagesMap::const_iterator itDiskImage = stack.mapDisks.find(vsdeHD->strRef);
5012 if (itDiskImage != stack.mapDisks.end())
5013 {
5014 const ovf::DiskImage &di = itDiskImage->second;
5015 d.uuid = Guid(di.uuidVBox);
5016 }
5017 ++avsdeHDsIt;
5018 }
5019
5020 // convert the Guid to string
5021 strUuid = d.uuid.toString();
5022
5023 if (diCurrent.uuidVBox != strUuid)
5024 {
5025 continue;
5026 }
5027
5028 /*
5029 * step 3: import disk
5030 */
5031 ComObjPtr<Medium> pTargetMedium;
5032 i_importOneDiskImage(diCurrent,
5033 vsdeTargetHD->strVBoxCurrent,
5034 pTargetMedium,
5035 stack);
5036
5037 // ... and replace the old UUID in the machine config with the one of
5038 // the imported disk that was just created
5039 Bstr hdId;
5040 rc = pTargetMedium->COMGETTER(Id)(hdId.asOutParam());
5041 if (FAILED(rc)) throw rc;
5042
5043 /*
5044 * 1. saving original UUID for restoring in case of failure.
5045 * 2. replacement of original UUID by new UUID in the current VM config (settings::MachineConfigFile).
5046 */
5047 {
5048 rc = stack.saveOriginalUUIDOfAttachedDevice(d, Utf8Str(hdId));
5049 d.uuid = hdId;
5050 }
5051
5052 fFound = true;
5053 break;
5054 } // for (settings::AttachedDevicesList::const_iterator dit = sc.llAttachedDevices.begin();
5055 } // for (settings::StorageControllersList::const_iterator sit = config.hardwareMachine.storage.llStorageControllers.begin();
5056
5057 // no disk with such a UUID found:
5058 if (!fFound)
5059 throw setError(E_FAIL,
5060 tr("<vbox:Machine> element in OVF contains a medium attachment for the disk image %s "
5061 "but the OVF describes no such image"),
5062 strUuid.c_str());
5063
5064 ++cImportedDisks;
5065
5066 }// while(oit != stack.mapDisks.end())
5067
5068
5069 /*
5070 * quantity of the imported disks isn't equal to the size of the avsdeHDs list.
5071 */
5072 if(cImportedDisks < avsdeHDs.size())
5073 {
5074 Log1Warning(("Not all disk images were imported for VM %s. Check OVF description file.",
5075 vmNameEntry->strOvf.c_str()));
5076 }
5077
5078 /*
5079 * step 4): create the machine and have it import the config
5080 */
5081
5082 ComObjPtr<Machine> pNewMachine;
5083 rc = pNewMachine.createObject();
5084 if (FAILED(rc)) throw rc;
5085
5086 // this magic constructor fills the new machine object with the MachineConfig
5087 // instance that we created from the vbox:Machine
5088 rc = pNewMachine->init(mVirtualBox,
5089 stack.strNameVBox,// name from OVF preparations; can be suffixed to avoid duplicates
5090 stack.strSettingsFilename,
5091 config); // the whole machine config
5092 if (FAILED(rc)) throw rc;
5093
5094 pReturnNewMachine = ComPtr<IMachine>(pNewMachine);
5095
5096 // and register it
5097 rc = mVirtualBox->RegisterMachine(pNewMachine);
5098 if (FAILED(rc)) throw rc;
5099
5100 // store new machine for roll-back in case of errors
5101 Bstr bstrNewMachineId;
5102 rc = pNewMachine->COMGETTER(Id)(bstrNewMachineId.asOutParam());
5103 if (FAILED(rc)) throw rc;
5104 m->llGuidsMachinesCreated.push_back(Guid(bstrNewMachineId));
5105
5106 LogFlowFuncLeave();
5107}
5108
5109/**
5110 * @throws HRESULT errors.
5111 */
5112void Appliance::i_importMachines(ImportStack &stack)
5113{
5114 // this is safe to access because this thread only gets started
5115 const ovf::OVFReader &reader = *m->pReader;
5116
5117 // create a session for the machine + disks we manipulate below
5118 HRESULT rc = stack.pSession.createInprocObject(CLSID_Session);
5119 ComAssertComRCThrowRC(rc);
5120
5121 list<ovf::VirtualSystem>::const_iterator it;
5122 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it1;
5123 /* Iterate through all virtual systems of that appliance */
5124 size_t i = 0;
5125 for (it = reader.m_llVirtualSystems.begin(), it1 = m->virtualSystemDescriptions.begin();
5126 it != reader.m_llVirtualSystems.end() && it1 != m->virtualSystemDescriptions.end();
5127 ++it, ++it1, ++i)
5128 {
5129 const ovf::VirtualSystem &vsysThis = *it;
5130 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it1);
5131
5132 ComPtr<IMachine> pNewMachine;
5133
5134 // there are two ways in which we can create a vbox machine from OVF:
5135 // -- either this OVF was written by vbox 3.2 or later, in which case there is a <vbox:Machine> element
5136 // in the <VirtualSystem>; then the VirtualSystemDescription::Data has a settings::MachineConfigFile
5137 // with all the machine config pretty-parsed;
5138 // -- or this is an OVF from an older vbox or an external source, and then we need to translate the
5139 // VirtualSystemDescriptionEntry and do import work
5140
5141 // Even for the vbox:Machine case, there are a number of configuration items that will be taken from
5142 // the OVF because otherwise the "override import parameters" mechanism in the GUI won't work.
5143
5144 // VM name
5145 std::list<VirtualSystemDescriptionEntry*> vsdeName = vsdescThis->i_findByType(VirtualSystemDescriptionType_Name);
5146 if (vsdeName.size() < 1)
5147 throw setError(VBOX_E_FILE_ERROR,
5148 tr("Missing VM name"));
5149 stack.strNameVBox = vsdeName.front()->strVBoxCurrent;
5150
5151 // Primary group, which is entirely optional.
5152 stack.strPrimaryGroup.setNull();
5153 std::list<VirtualSystemDescriptionEntry*> vsdePrimaryGroup = vsdescThis->i_findByType(VirtualSystemDescriptionType_PrimaryGroup);
5154 if (vsdePrimaryGroup.size() >= 1)
5155 {
5156 stack.strPrimaryGroup = vsdePrimaryGroup.front()->strVBoxCurrent;
5157 if (stack.strPrimaryGroup.isEmpty())
5158 stack.strPrimaryGroup = "/";
5159 }
5160
5161 // Draw the right conclusions from the (possibly modified) VM settings
5162 // file name and base folder. If the VM settings file name is modified,
5163 // it takes precedence, otherwise it is recreated from the base folder
5164 // and the primary group.
5165 stack.strSettingsFilename.setNull();
5166 std::list<VirtualSystemDescriptionEntry*> vsdeSettingsFile = vsdescThis->i_findByType(VirtualSystemDescriptionType_SettingsFile);
5167 if (vsdeSettingsFile.size() >= 1)
5168 {
5169 VirtualSystemDescriptionEntry *vsdeSF1 = vsdeSettingsFile.front();
5170 if (vsdeSF1->strVBoxCurrent != vsdeSF1->strVBoxSuggested)
5171 stack.strSettingsFilename = vsdeSF1->strVBoxCurrent;
5172 }
5173 if (stack.strSettingsFilename.isEmpty())
5174 {
5175 Utf8Str strBaseFolder;
5176 std::list<VirtualSystemDescriptionEntry*> vsdeBaseFolder = vsdescThis->i_findByType(VirtualSystemDescriptionType_BaseFolder);
5177 if (vsdeBaseFolder.size() >= 1)
5178 strBaseFolder = vsdeBaseFolder.front()->strVBoxCurrent;
5179 Bstr bstrSettingsFilename;
5180 rc = mVirtualBox->ComposeMachineFilename(Bstr(stack.strNameVBox).raw(),
5181 Bstr(stack.strPrimaryGroup).raw(),
5182 NULL /* aCreateFlags */,
5183 Bstr(strBaseFolder).raw(),
5184 bstrSettingsFilename.asOutParam());
5185 if (FAILED(rc)) throw rc;
5186 stack.strSettingsFilename = bstrSettingsFilename;
5187 }
5188
5189 // Determine the machine folder from the settings file.
5190 LogFunc(("i=%zu strName=%s strSettingsFilename=%s\n", i, stack.strNameVBox.c_str(), stack.strSettingsFilename.c_str()));
5191 stack.strMachineFolder = stack.strSettingsFilename;
5192 stack.strMachineFolder.stripFilename();
5193
5194 // guest OS type
5195 std::list<VirtualSystemDescriptionEntry*> vsdeOS;
5196 vsdeOS = vsdescThis->i_findByType(VirtualSystemDescriptionType_OS);
5197 if (vsdeOS.size() < 1)
5198 throw setError(VBOX_E_FILE_ERROR,
5199 tr("Missing guest OS type"));
5200 stack.strOsTypeVBox = vsdeOS.front()->strVBoxCurrent;
5201
5202 // Firmware
5203 std::list<VirtualSystemDescriptionEntry*> firmware = vsdescThis->i_findByType(VirtualSystemDescriptionType_BootingFirmware);
5204 if (firmware.size() != 1)
5205 stack.strFirmwareType = "BIOS";//try default BIOS type
5206 else
5207 stack.strFirmwareType = firmware.front()->strVBoxCurrent;
5208
5209 // CPU count
5210 std::list<VirtualSystemDescriptionEntry*> vsdeCPU = vsdescThis->i_findByType(VirtualSystemDescriptionType_CPU);
5211 if (vsdeCPU.size() != 1)
5212 throw setError(VBOX_E_FILE_ERROR, tr("CPU count missing"));
5213
5214 stack.cCPUs = vsdeCPU.front()->strVBoxCurrent.toUInt32();
5215 // We need HWVirt & IO-APIC if more than one CPU is requested
5216 if (stack.cCPUs > 1)
5217 {
5218 stack.fForceHWVirt = true;
5219 stack.fForceIOAPIC = true;
5220 }
5221
5222 // RAM
5223 std::list<VirtualSystemDescriptionEntry*> vsdeRAM = vsdescThis->i_findByType(VirtualSystemDescriptionType_Memory);
5224 if (vsdeRAM.size() != 1)
5225 throw setError(VBOX_E_FILE_ERROR, tr("RAM size missing"));
5226 stack.ulMemorySizeMB = (ULONG)vsdeRAM.front()->strVBoxCurrent.toUInt64();
5227
5228#ifdef VBOX_WITH_USB
5229 // USB controller
5230 std::list<VirtualSystemDescriptionEntry*> vsdeUSBController =
5231 vsdescThis->i_findByType(VirtualSystemDescriptionType_USBController);
5232 // USB support is enabled if there's at least one such entry; to disable USB support,
5233 // the type of the USB item would have been changed to "ignore"
5234 stack.fUSBEnabled = !vsdeUSBController.empty();
5235#endif
5236 // audio adapter
5237 std::list<VirtualSystemDescriptionEntry*> vsdeAudioAdapter =
5238 vsdescThis->i_findByType(VirtualSystemDescriptionType_SoundCard);
5239 /** @todo we support one audio adapter only */
5240 if (!vsdeAudioAdapter.empty())
5241 stack.strAudioAdapter = vsdeAudioAdapter.front()->strVBoxCurrent;
5242
5243 // for the description of the new machine, always use the OVF entry, the user may have changed it in the import config
5244 std::list<VirtualSystemDescriptionEntry*> vsdeDescription =
5245 vsdescThis->i_findByType(VirtualSystemDescriptionType_Description);
5246 if (!vsdeDescription.empty())
5247 stack.strDescription = vsdeDescription.front()->strVBoxCurrent;
5248
5249 // import vbox:machine or OVF now
5250 if (vsdescThis->m->pConfig)
5251 // vbox:Machine config
5252 i_importVBoxMachine(vsdescThis, pNewMachine, stack);
5253 else
5254 // generic OVF config
5255 i_importMachineGeneric(vsysThis, vsdescThis, pNewMachine, stack);
5256
5257 } // for (it = pAppliance->m->llVirtualSystems.begin() ...
5258}
5259
5260HRESULT Appliance::ImportStack::saveOriginalUUIDOfAttachedDevice(settings::AttachedDevice &device,
5261 const Utf8Str &newlyUuid)
5262{
5263 HRESULT rc = S_OK;
5264
5265 /* save for restoring */
5266 mapNewUUIDsToOriginalUUIDs.insert(std::make_pair(newlyUuid, device.uuid.toString()));
5267
5268 return rc;
5269}
5270
5271HRESULT Appliance::ImportStack::restoreOriginalUUIDOfAttachedDevice(settings::MachineConfigFile *config)
5272{
5273 HRESULT rc = S_OK;
5274
5275 settings::StorageControllersList &llControllers = config->hardwareMachine.storage.llStorageControllers;
5276 settings::StorageControllersList::iterator itscl;
5277 for (itscl = llControllers.begin();
5278 itscl != llControllers.end();
5279 ++itscl)
5280 {
5281 settings::AttachedDevicesList &llAttachments = itscl->llAttachedDevices;
5282 settings::AttachedDevicesList::iterator itadl = llAttachments.begin();
5283 while (itadl != llAttachments.end())
5284 {
5285 std::map<Utf8Str , Utf8Str>::iterator it =
5286 mapNewUUIDsToOriginalUUIDs.find(itadl->uuid.toString());
5287 if(it!=mapNewUUIDsToOriginalUUIDs.end())
5288 {
5289 Utf8Str uuidOriginal = it->second;
5290 itadl->uuid = Guid(uuidOriginal);
5291 mapNewUUIDsToOriginalUUIDs.erase(it->first);
5292 }
5293 ++itadl;
5294 }
5295 }
5296
5297 return rc;
5298}
5299
5300/**
5301 * @throws Nothing
5302 */
5303RTVFSIOSTREAM Appliance::ImportStack::claimOvaLookAHead(void)
5304{
5305 RTVFSIOSTREAM hVfsIos = this->hVfsIosOvaLookAhead;
5306 this->hVfsIosOvaLookAhead = NIL_RTVFSIOSTREAM;
5307 /* We don't free the name since it may be referenced in error messages and such. */
5308 return hVfsIos;
5309}
5310
Note: See TracBrowser for help on using the repository browser.

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