ApplianceImplExport.cpp@ 79812

Last change on this file since 79812 was 79597, checked in by vboxsync, 5 years ago
bugref:9495. Changed OCICloudClient::exportLaunchVM -> OCICloudClient::exportVM.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 121.4 KB

Line
1	/* $Id: ApplianceImplExport.cpp 79597 2019-07-08 15:22:37Z vboxsync $ */
2	/** @file
3	* IAppliance and IVirtualSystem COM class implementations.
4	*/
5
6	/*
7	* Copyright (C) 2008-2019 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#define LOG_GROUP LOG_GROUP_MAIN_APPLIANCE
19	#include <iprt/path.h>
20	#include <iprt/dir.h>
21	#include <iprt/param.h>
22	#include <iprt/s3.h>
23	#include <iprt/manifest.h>
24	#include <iprt/stream.h>
25	#include <iprt/zip.h>
26
27	#include <VBox/version.h>
28
29	#include "ApplianceImpl.h"
30	#include "VirtualBoxImpl.h"
31	#include "ProgressImpl.h"
32	#include "MachineImpl.h"
33	#include "MediumImpl.h"
34	#include "LoggingNew.h"
35	#include "Global.h"
36	#include "MediumFormatImpl.h"
37	#include "SystemPropertiesImpl.h"
38
39	#include "AutoCaller.h"
40
41	#include "ApplianceImplPrivate.h"
42
43	using namespace std;
44
45	////////////////////////////////////////////////////////////////////////////////
46	//
47	// IMachine public methods
48	//
49	////////////////////////////////////////////////////////////////////////////////
50
51	// This code is here so we won't have to include the appliance headers in the
52	// IMachine implementation, and we also need to access private appliance data.
53
54	/**
55	* Public method implementation.
56	* @param aAppliance Appliance object.
57	* @param aLocation Where to store the appliance.
58	* @param aDescription Appliance description.
59	* @return
60	*/
61	HRESULT Machine::exportTo(const ComPtr<IAppliance> &aAppliance, const com::Utf8Str &aLocation,
62	ComPtr<IVirtualSystemDescription> &aDescription)
63	{
64	HRESULT rc = S_OK;
65
66	if (!aAppliance)
67	return E_POINTER;
68
69	ComObjPtr<VirtualSystemDescription> pNewDesc;
70
71	try
72	{
73	IAppliance *iAppliance = aAppliance;
74	Appliance pAppliance = static_cast<Appliance>(iAppliance);
75
76	LocationInfo locInfo;
77	i_parseURI(aLocation, locInfo);
78
79	Utf8Str strBasename(locInfo.strPath);
80	strBasename.stripPath().stripSuffix();
81	if (locInfo.strPath.endsWith(".tar.gz", Utf8Str::CaseSensitive))
82	strBasename.stripSuffix();
83
84	// create a new virtual system to store in the appliance
85	rc = pNewDesc.createObject();
86	if (FAILED(rc)) throw rc;
87	rc = pNewDesc->init();
88	if (FAILED(rc)) throw rc;
89
90	// store the machine object so we can dump the XML in Appliance::Write()
91	pNewDesc->m->pMachine = this;
92
93	// first, call the COM methods, as they request locks
94	BOOL fUSBEnabled = FALSE;
95	com::SafeIfaceArray<IUSBController> usbControllers;
96	rc = COMGETTER(USBControllers)(ComSafeArrayAsOutParam(usbControllers));
97	if (SUCCEEDED(rc))
98	{
99	for (unsigned i = 0; i < usbControllers.size(); ++i)
100	{
101	USBControllerType_T enmType;
102
103	rc = usbControllers[i]->COMGETTER(Type)(&enmType);
104	if (FAILED(rc)) throw rc;
105
106	if (enmType == USBControllerType_OHCI)
107	fUSBEnabled = TRUE;
108	}
109	}
110
111	// request the machine lock while accessing internal members
112	AutoReadLock alock1(this COMMA_LOCKVAL_SRC_POS);
113
114	ComPtr<IAudioAdapter> pAudioAdapter = mAudioAdapter;
115	BOOL fAudioEnabled;
116	rc = pAudioAdapter->COMGETTER(Enabled)(&fAudioEnabled);
117	if (FAILED(rc)) throw rc;
118	AudioControllerType_T audioController;
119	rc = pAudioAdapter->COMGETTER(AudioController)(&audioController);
120	if (FAILED(rc)) throw rc;
121
122	// get name
123	Utf8Str strVMName = mUserData->s.strName;
124	// get description
125	Utf8Str strDescription = mUserData->s.strDescription;
126	// get guest OS
127	Utf8Str strOsTypeVBox = mUserData->s.strOsType;
128	// CPU count
129	uint32_t cCPUs = mHWData->mCPUCount;
130	// memory size in MB
131	uint32_t ulMemSizeMB = mHWData->mMemorySize;
132	// VRAM size?
133	// BIOS settings?
134	// 3D acceleration enabled?
135	// hardware virtualization enabled?
136	// nested paging enabled?
137	// HWVirtExVPIDEnabled?
138	// PAEEnabled?
139	// Long mode enabled?
140	BOOL fLongMode;
141	rc = GetCPUProperty(CPUPropertyType_LongMode, &fLongMode);
142	if (FAILED(rc)) throw rc;
143
144	// snapshotFolder?
145	// VRDPServer?
146
147	/* Guest OS type */
148	ovf::CIMOSType_T cim = convertVBoxOSType2CIMOSType(strOsTypeVBox.c_str(), fLongMode);
149	pNewDesc->i_addEntry(VirtualSystemDescriptionType_OS,
150	"",
151	Utf8StrFmt("%RI32", cim),
152	strOsTypeVBox);
153
154	/* VM name */
155	pNewDesc->i_addEntry(VirtualSystemDescriptionType_Name,
156	"",
157	strVMName,
158	strVMName);
159
160	// description
161	pNewDesc->i_addEntry(VirtualSystemDescriptionType_Description,
162	"",
163	strDescription,
164	strDescription);
165
166	/* CPU count*/
167	Utf8Str strCpuCount = Utf8StrFmt("%RI32", cCPUs);
168	pNewDesc->i_addEntry(VirtualSystemDescriptionType_CPU,
169	"",
170	strCpuCount,
171	strCpuCount);
172
173	/* Memory */
174	Utf8Str strMemory = Utf8StrFmt("%RI64", (uint64_t)ulMemSizeMB * _1M);
175	pNewDesc->i_addEntry(VirtualSystemDescriptionType_Memory,
176	"",
177	strMemory,
178	strMemory);
179
180	// the one VirtualBox IDE controller has two channels with two ports each, which is
181	// considered two IDE controllers with two ports each by OVF, so export it as two
182	int32_t lIDEControllerPrimaryIndex = 0;
183	int32_t lIDEControllerSecondaryIndex = 0;
184	int32_t lSATAControllerIndex = 0;
185	int32_t lSCSIControllerIndex = 0;
186
187	/* Fetch all available storage controllers */
188	com::SafeIfaceArray<IStorageController> nwControllers;
189	rc = COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(nwControllers));
190	if (FAILED(rc)) throw rc;
191
192	ComPtr<IStorageController> pIDEController;
193	ComPtr<IStorageController> pSATAController;
194	ComPtr<IStorageController> pSCSIController;
195	ComPtr<IStorageController> pSASController;
196	for (size_t j = 0; j < nwControllers.size(); ++j)
197	{
198	StorageBus_T eType;
199	rc = nwControllers[j]->COMGETTER(Bus)(&eType);
200	if (FAILED(rc)) throw rc;
201	if ( eType == StorageBus_IDE
202	&& pIDEController.isNull())
203	pIDEController = nwControllers[j];
204	else if ( eType == StorageBus_SATA
205	&& pSATAController.isNull())
206	pSATAController = nwControllers[j];
207	else if ( eType == StorageBus_SCSI
208	&& pSATAController.isNull())
209	pSCSIController = nwControllers[j];
210	else if ( eType == StorageBus_SAS
211	&& pSASController.isNull())
212	pSASController = nwControllers[j];
213	}
214
215	// <const name="HardDiskControllerIDE" value="6" />
216	if (!pIDEController.isNull())
217	{
218	StorageControllerType_T ctlr;
219	rc = pIDEController->COMGETTER(ControllerType)(&ctlr);
220	if (FAILED(rc)) throw rc;
221
222	Utf8Str strVBox;
223	switch (ctlr)
224	{
225	case StorageControllerType_PIIX3: strVBox = "PIIX3"; break;
226	case StorageControllerType_PIIX4: strVBox = "PIIX4"; break;
227	case StorageControllerType_ICH6: strVBox = "ICH6"; break;
228	default: break; /* Shut up MSC. */
229	}
230
231	if (strVBox.length())
232	{
233	lIDEControllerPrimaryIndex = (int32_t)pNewDesc->m->maDescriptions.size();
234	pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
235	Utf8StrFmt("%d", lIDEControllerPrimaryIndex), // strRef
236	strVBox, // aOvfValue
237	strVBox); // aVBoxValue
238	lIDEControllerSecondaryIndex = lIDEControllerPrimaryIndex + 1;
239	pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
240	Utf8StrFmt("%d", lIDEControllerSecondaryIndex),
241	strVBox,
242	strVBox);
243	}
244	}
245
246	// <const name="HardDiskControllerSATA" value="7" />
247	if (!pSATAController.isNull())
248	{
249	Utf8Str strVBox = "AHCI";
250	lSATAControllerIndex = (int32_t)pNewDesc->m->maDescriptions.size();
251	pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,
252	Utf8StrFmt("%d", lSATAControllerIndex),
253	strVBox,
254	strVBox);
255	}
256
257	// <const name="HardDiskControllerSCSI" value="8" />
258	if (!pSCSIController.isNull())
259	{
260	StorageControllerType_T ctlr;
261	rc = pSCSIController->COMGETTER(ControllerType)(&ctlr);
262	if (SUCCEEDED(rc))
263	{
264	Utf8Str strVBox = "LsiLogic"; // the default in VBox
265	switch (ctlr)
266	{
267	case StorageControllerType_LsiLogic: strVBox = "LsiLogic"; break;
268	case StorageControllerType_BusLogic: strVBox = "BusLogic"; break;
269	default: break; /* Shut up MSC. */
270	}
271	lSCSIControllerIndex = (int32_t)pNewDesc->m->maDescriptions.size();
272	pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,
273	Utf8StrFmt("%d", lSCSIControllerIndex),
274	strVBox,
275	strVBox);
276	}
277	else
278	throw rc;
279	}
280
281	if (!pSASController.isNull())
282	{
283	// VirtualBox considers the SAS controller a class of its own but in OVF
284	// it should be a SCSI controller
285	Utf8Str strVBox = "LsiLogicSas";
286	lSCSIControllerIndex = (int32_t)pNewDesc->m->maDescriptions.size();
287	pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerSAS,
288	Utf8StrFmt("%d", lSCSIControllerIndex),
289	strVBox,
290	strVBox);
291	}
292
293	// <const name="HardDiskImage" value="9" />
294	// <const name="Floppy" value="18" />
295	// <const name="CDROM" value="19" />
296
297	for (MediumAttachmentList::const_iterator
298	it = mMediumAttachments->begin();
299	it != mMediumAttachments->end();
300	++it)
301	{
302	ComObjPtr<MediumAttachment> pHDA = *it;
303
304	// the attachment's data
305	ComPtr<IMedium> pMedium;
306	ComPtr<IStorageController> ctl;
307	Bstr controllerName;
308
309	rc = pHDA->COMGETTER(Controller)(controllerName.asOutParam());
310	if (FAILED(rc)) throw rc;
311
312	rc = GetStorageControllerByName(controllerName.raw(), ctl.asOutParam());
313	if (FAILED(rc)) throw rc;
314
315	StorageBus_T storageBus;
316	DeviceType_T deviceType;
317	LONG lChannel;
318	LONG lDevice;
319
320	rc = ctl->COMGETTER(Bus)(&storageBus);
321	if (FAILED(rc)) throw rc;
322
323	rc = pHDA->COMGETTER(Type)(&deviceType);
324	if (FAILED(rc)) throw rc;
325
326	rc = pHDA->COMGETTER(Medium)(pMedium.asOutParam());
327	if (FAILED(rc)) throw rc;
328
329	rc = pHDA->COMGETTER(Port)(&lChannel);
330	if (FAILED(rc)) throw rc;
331
332	rc = pHDA->COMGETTER(Device)(&lDevice);
333	if (FAILED(rc)) throw rc;
334
335	Utf8Str strTargetImageName;
336	Utf8Str strLocation;
337	LONG64 llSize = 0;
338
339	if ( deviceType == DeviceType_HardDisk
340	&& pMedium)
341	{
342	Bstr bstrLocation;
343
344	rc = pMedium->COMGETTER(Location)(bstrLocation.asOutParam());
345	if (FAILED(rc)) throw rc;
346	strLocation = bstrLocation;
347
348	// find the source's base medium for two things:
349	// 1) we'll use its name to determine the name of the target disk, which is readable,
350	// as opposed to the UUID filename of a differencing image, if pMedium is one
351	// 2) we need the size of the base image so we can give it to addEntry(), and later
352	// on export, the progress will be based on that (and not the diff image)
353	ComPtr<IMedium> pBaseMedium;
354	rc = pMedium->COMGETTER(Base)(pBaseMedium.asOutParam());
355	// returns pMedium if there are no diff images
356	if (FAILED(rc)) throw rc;
357
358	strTargetImageName = Utf8StrFmt("%s-disk%.3d.vmdk", strBasename.c_str(), ++pAppliance->m->cDisks);
359	if (strTargetImageName.length() > RTTAR_NAME_MAX)
360	throw setError(VBOX_E_NOT_SUPPORTED,
361	tr("Cannot attach disk '%s' -- file name too long"), strTargetImageName.c_str());
362
363	// force reading state, or else size will be returned as 0
364	MediumState_T ms;
365	rc = pBaseMedium->RefreshState(&ms);
366	if (FAILED(rc)) throw rc;
367
368	rc = pBaseMedium->COMGETTER(Size)(&llSize);
369	if (FAILED(rc)) throw rc;
370
371	/* If the medium is encrypted add the key identifier to the list. */
372	IMedium *iBaseMedium = pBaseMedium;
373	Medium pBase = static_cast<Medium>(iBaseMedium);
374	const com::Utf8Str strKeyId = pBase->i_getKeyId();
375	if (!strKeyId.isEmpty())
376	{
377	IMedium *iMedium = pMedium;
378	Medium pMed = static_cast<Medium>(iMedium);
379	com::Guid mediumUuid = pMed->i_getId();
380	bool fKnown = false;
381
382	/* Check whether the ID is already in our sequence, add it otherwise. */
383	for (unsigned i = 0; i < pAppliance->m->m_vecPasswordIdentifiers.size(); i++)
384	{
385	if (strKeyId.equals(pAppliance->m->m_vecPasswordIdentifiers[i]))
386	{
387	fKnown = true;
388	break;
389	}
390	}
391
392	if (!fKnown)
393	{
394	GUIDVEC vecMediumIds;
395
396	vecMediumIds.push_back(mediumUuid);
397	pAppliance->m->m_vecPasswordIdentifiers.push_back(strKeyId);
398	pAppliance->m->m_mapPwIdToMediumIds.insert(std::pair<com::Utf8Str, GUIDVEC>(strKeyId, vecMediumIds));
399	}
400	else
401	{
402	std::map<com::Utf8Str, GUIDVEC>::iterator itMap = pAppliance->m->m_mapPwIdToMediumIds.find(strKeyId);
403	if (itMap == pAppliance->m->m_mapPwIdToMediumIds.end())
404	throw setError(E_FAIL, tr("Internal error adding a medium UUID to the map"));
405	itMap->second.push_back(mediumUuid);
406	}
407	}
408	}
409	else if ( deviceType == DeviceType_DVD
410	&& pMedium)
411	{
412	/*
413	* check the minimal rules to grant access to export an image
414	* 1. no host drive CD/DVD image
415	* 2. the image must be accessible and readable
416	* 3. only ISO image is exported
417	*/
418
419	//1. no host drive CD/DVD image
420	BOOL fHostDrive = false;
421	rc = pMedium->COMGETTER(HostDrive)(&fHostDrive);
422	if (FAILED(rc)) throw rc;
423
424	if(fHostDrive)
425	continue;
426
427	//2. the image must be accessible and readable
428	MediumState_T ms;
429	rc = pMedium->RefreshState(&ms);
430	if (FAILED(rc)) throw rc;
431
432	if (ms != MediumState_Created)
433	continue;
434
435	//3. only ISO image is exported
436	Bstr bstrLocation;
437	rc = pMedium->COMGETTER(Location)(bstrLocation.asOutParam());
438	if (FAILED(rc)) throw rc;
439
440	strLocation = bstrLocation;
441
442	Utf8Str ext = strLocation;
443	ext.assignEx(RTPathSuffix(strLocation.c_str()));//returns extension with dot (".iso")
444
445	int eq = ext.compare(".iso", Utf8Str::CaseInsensitive);
446	if (eq != 0)
447	continue;
448
449	strTargetImageName = Utf8StrFmt("%s-disk%.3d.iso", strBasename.c_str(), ++pAppliance->m->cDisks);
450	if (strTargetImageName.length() > RTTAR_NAME_MAX)
451	throw setError(VBOX_E_NOT_SUPPORTED,
452	tr("Cannot attach image '%s' -- file name too long"), strTargetImageName.c_str());
453
454	rc = pMedium->COMGETTER(Size)(&llSize);
455	if (FAILED(rc)) throw rc;
456	}
457	// and how this translates to the virtual system
458	int32_t lControllerVsys = 0;
459	LONG lChannelVsys;
460
461	switch (storageBus)
462	{
463	case StorageBus_IDE:
464	// this is the exact reverse to what we're doing in Appliance::taskThreadImportMachines,
465	// and it must be updated when that is changed!
466	// Before 3.2 we exported one IDE controller with channel 0-3, but we now maintain
467	// compatibility with what VMware does and export two IDE controllers with two channels each
468
469	if (lChannel == 0 && lDevice == 0) // primary master
470	{
471	lControllerVsys = lIDEControllerPrimaryIndex;
472	lChannelVsys = 0;
473	}
474	else if (lChannel == 0 && lDevice == 1) // primary slave
475	{
476	lControllerVsys = lIDEControllerPrimaryIndex;
477	lChannelVsys = 1;
478	}
479	else if (lChannel == 1 && lDevice == 0) // secondary master; by default this is the CD-ROM but
480	// as of VirtualBox 3.1 that can change
481	{
482	lControllerVsys = lIDEControllerSecondaryIndex;
483	lChannelVsys = 0;
484	}
485	else if (lChannel == 1 && lDevice == 1) // secondary slave
486	{
487	lControllerVsys = lIDEControllerSecondaryIndex;
488	lChannelVsys = 1;
489	}
490	else
491	throw setError(VBOX_E_NOT_SUPPORTED,
492	tr("Cannot handle medium attachment: channel is %d, device is %d"), lChannel, lDevice);
493	break;
494
495	case StorageBus_SATA:
496	lChannelVsys = lChannel; // should be between 0 and 29
497	lControllerVsys = lSATAControllerIndex;
498	break;
499
500	case StorageBus_SCSI:
501	case StorageBus_SAS:
502	lChannelVsys = lChannel; // should be between 0 and 15
503	lControllerVsys = lSCSIControllerIndex;
504	break;
505
506	case StorageBus_Floppy:
507	lChannelVsys = 0;
508	lControllerVsys = 0;
509	break;
510
511	default:
512	throw setError(VBOX_E_NOT_SUPPORTED,
513	tr("Cannot handle medium attachment: storageBus is %d, channel is %d, device is %d"),
514	storageBus, lChannel, lDevice);
515	}
516
517	Utf8StrFmt strExtra("controller=%RI32;channel=%RI32", lControllerVsys, lChannelVsys);
518	Utf8Str strEmpty;
519
520	switch (deviceType)
521	{
522	case DeviceType_HardDisk:
523	Log(("Adding VirtualSystemDescriptionType_HardDiskImage, disk size: %RI64\n", llSize));
524	pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskImage,
525	strTargetImageName, // disk ID: let's use the name
526	strTargetImageName, // OVF value:
527	strLocation, // vbox value: media path
528	(uint32_t)(llSize / _1M),
529	strExtra);
530	break;
531
532	case DeviceType_DVD:
533	Log(("Adding VirtualSystemDescriptionType_CDROM, disk size: %RI64\n", llSize));
534	pNewDesc->i_addEntry(VirtualSystemDescriptionType_CDROM,
535	strTargetImageName, // disk ID
536	strTargetImageName, // OVF value
537	strLocation, // vbox value
538	(uint32_t)(llSize / _1M),// ulSize
539	strExtra);
540	break;
541
542	case DeviceType_Floppy:
543	pNewDesc->i_addEntry(VirtualSystemDescriptionType_Floppy,
544	strEmpty, // disk ID
545	strEmpty, // OVF value
546	strEmpty, // vbox value
547	1, // ulSize
548	strExtra);
549	break;
550
551	default: break; /* Shut up MSC. */
552	}
553	}
554
555	// <const name="NetworkAdapter" />
556	uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(i_getChipsetType());
557	size_t a;
558	for (a = 0; a < maxNetworkAdapters; ++a)
559	{
560	ComPtr<INetworkAdapter> pNetworkAdapter;
561	BOOL fEnabled;
562	NetworkAdapterType_T adapterType;
563	NetworkAttachmentType_T attachmentType;
564
565	rc = GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
566	if (FAILED(rc)) throw rc;
567	/* Enable the network card & set the adapter type */
568	rc = pNetworkAdapter->COMGETTER(Enabled)(&fEnabled);
569	if (FAILED(rc)) throw rc;
570
571	if (fEnabled)
572	{
573	rc = pNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
574	if (FAILED(rc)) throw rc;
575
576	rc = pNetworkAdapter->COMGETTER(AttachmentType)(&attachmentType);
577	if (FAILED(rc)) throw rc;
578
579	Utf8Str strAttachmentType = convertNetworkAttachmentTypeToString(attachmentType);
580	pNewDesc->i_addEntry(VirtualSystemDescriptionType_NetworkAdapter,
581	"", // ref
582	strAttachmentType, // orig
583	Utf8StrFmt("%RI32", (uint32_t)adapterType), // conf
584	0,
585	Utf8StrFmt("type=%s", strAttachmentType.c_str())); // extra conf
586	}
587	}
588
589	// <const name="USBController" />
590	#ifdef VBOX_WITH_USB
591	if (fUSBEnabled)
592	pNewDesc->i_addEntry(VirtualSystemDescriptionType_USBController, "", "", "");
593	#endif /* VBOX_WITH_USB */
594
595	// <const name="SoundCard" />
596	if (fAudioEnabled)
597	pNewDesc->i_addEntry(VirtualSystemDescriptionType_SoundCard,
598	"",
599	"ensoniq1371", // this is what OVFTool writes and VMware supports
600	Utf8StrFmt("%RI32", audioController));
601
602	/* We return the new description to the caller */
603	ComPtr<IVirtualSystemDescription> copy(pNewDesc);
604	copy.queryInterfaceTo(aDescription.asOutParam());
605
606	AutoWriteLock alock(pAppliance COMMA_LOCKVAL_SRC_POS);
607	// finally, add the virtual system to the appliance
608	pAppliance->m->virtualSystemDescriptions.push_back(pNewDesc);
609	}
610	catch(HRESULT arc)
611	{
612	rc = arc;
613	}
614
615	return rc;
616	}
617
618	////////////////////////////////////////////////////////////////////////////////
619	//
620	// IAppliance public methods
621	//
622	////////////////////////////////////////////////////////////////////////////////
623
624	/**
625	* Public method implementation.
626	* @param aFormat Appliance format.
627	* @param aOptions Export options.
628	* @param aPath Path to write the appliance to.
629	* @param aProgress Progress object.
630	* @return
631	*/
632	HRESULT Appliance::write(const com::Utf8Str &aFormat,
633	const std::vector<ExportOptions_T> &aOptions,
634	const com::Utf8Str &aPath,
635	ComPtr<IProgress> &aProgress)
636	{
637	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
638
639	m->optListExport.clear();
640	if (aOptions.size())
641	{
642	for (size_t i = 0; i < aOptions.size(); ++i)
643	{
644	m->optListExport.insert(i, aOptions[i]);
645	}
646	}
647
648	HRESULT rc = S_OK;
649	// AssertReturn(!(m->optListExport.contains(ExportOptions_CreateManifest)
650	// && m->optListExport.contains(ExportOptions_ExportDVDImages)), E_INVALIDARG);
651
652	/* Parse all necessary info out of the URI */
653	i_parseURI(aPath, m->locInfo);
654
655	if (m->locInfo.storageType == VFSType_Cloud)
656	{
657	rc = S_OK;
658	ComObjPtr<Progress> progress;
659	try
660	{
661	rc = i_writeCloudImpl(m->locInfo, progress);
662	}
663	catch (HRESULT aRC)
664	{
665	rc = aRC;
666	}
667
668	if (SUCCEEDED(rc))
669	/* Return progress to the caller */
670	progress.queryInterfaceTo(aProgress.asOutParam());
671	}
672	else
673	{
674	m->fExportISOImages = m->optListExport.contains(ExportOptions_ExportDVDImages);
675
676	if (!m->fExportISOImages)/* remove all ISO images from VirtualSystemDescription */
677	{
678	for (list<ComObjPtr<VirtualSystemDescription> >::const_iterator
679	it = m->virtualSystemDescriptions.begin();
680	it != m->virtualSystemDescriptions.end();
681	++it)
682	{
683	ComObjPtr<VirtualSystemDescription> vsdescThis = *it;
684	std::list<VirtualSystemDescriptionEntry*> skipped = vsdescThis->i_findByType(VirtualSystemDescriptionType_CDROM);
685	std::list<VirtualSystemDescriptionEntry*>::const_iterator itSkipped = skipped.begin();
686	while (itSkipped != skipped.end())
687	{
688	(*itSkipped)->skipIt = true;
689	++itSkipped;
690	}
691	}
692	}
693
694	// do not allow entering this method if the appliance is busy reading or writing
695	if (!i_isApplianceIdle())
696	return E_ACCESSDENIED;
697
698	// figure the export format. We exploit the unknown version value for oracle public cloud.
699	ovf::OVFVersion_T ovfF;
700	if (aFormat == "ovf-0.9")
701	ovfF = ovf::OVFVersion_0_9;
702	else if (aFormat == "ovf-1.0")
703	ovfF = ovf::OVFVersion_1_0;
704	else if (aFormat == "ovf-2.0")
705	ovfF = ovf::OVFVersion_2_0;
706	else if (aFormat == "opc-1.0")
707	ovfF = ovf::OVFVersion_unknown;
708	else
709	return setError(VBOX_E_FILE_ERROR,
710	tr("Invalid format \"%s\" specified"), aFormat.c_str());
711
712	// Check the extension.
713	if (ovfF == ovf::OVFVersion_unknown)
714	{
715	if (!aPath.endsWith(".tar.gz", Utf8Str::CaseInsensitive))
716	return setError(VBOX_E_FILE_ERROR,
717	tr("OPC appliance file must have .tar.gz extension"));
718	}
719	else if ( !aPath.endsWith(".ovf", Utf8Str::CaseInsensitive)
720	&& !aPath.endsWith(".ova", Utf8Str::CaseInsensitive))
721	return setError(VBOX_E_FILE_ERROR, tr("Appliance file must have .ovf or .ova extension"));
722
723
724	/* As of OVF 2.0 we have to use SHA-256 in the manifest. */
725	m->fManifest = m->optListExport.contains(ExportOptions_CreateManifest);
726	if (m->fManifest)
727	m->fDigestTypes = ovfF >= ovf::OVFVersion_2_0 ? RTMANIFEST_ATTR_SHA256 : RTMANIFEST_ATTR_SHA1;
728	Assert(m->hOurManifest == NIL_RTMANIFEST);
729
730	/* Check whether all passwords are supplied or error out. */
731	if (m->m_cPwProvided < m->m_vecPasswordIdentifiers.size())
732	return setError(VBOX_E_INVALID_OBJECT_STATE,
733	tr("Appliance export failed because not all passwords were provided for all encrypted media"));
734
735	ComObjPtr<Progress> progress;
736	rc = S_OK;
737	try
738	{
739	/* Parse all necessary info out of the URI */
740	i_parseURI(aPath, m->locInfo);
741
742	switch (ovfF)
743	{
744	case ovf::OVFVersion_unknown:
745	rc = i_writeOPCImpl(ovfF, m->locInfo, progress);
746	break;
747	default:
748	rc = i_writeImpl(ovfF, m->locInfo, progress);
749	break;
750	}
751
752	}
753	catch (HRESULT aRC)
754	{
755	rc = aRC;
756	}
757
758	if (SUCCEEDED(rc))
759	/* Return progress to the caller */
760	progress.queryInterfaceTo(aProgress.asOutParam());
761	}
762
763	return rc;
764	}
765
766	////////////////////////////////////////////////////////////////////////////////
767	//
768	// Appliance private methods
769	//
770	////////////////////////////////////////////////////////////////////////////////
771
772	/*******************************************************************************
773	* Export stuff
774	******************************************************************************/
775
776	/**
777	* Implementation for writing out the OVF to disk. This starts a new thread which will call
778	* Appliance::taskThreadWriteOVF().
779	*
780	* This is in a separate private method because it is used from two locations:
781	*
782	* 1) from the public Appliance::Write().
783	*
784	* 2) in a second worker thread; in that case, Appliance::Write() called Appliance::i_writeImpl(), which
785	* called Appliance::i_writeFSOVA(), which called Appliance::i_writeImpl(), which then called this again.
786	*
787	* @param aFormat
788	* @param aLocInfo
789	* @param aProgress
790	* @return
791	*/
792	HRESULT Appliance::i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)
793	{
794	/* Prepare progress object: */
795	HRESULT hrc;
796	try
797	{
798	hrc = i_setUpProgress(aProgress,
799	Utf8StrFmt(tr("Export appliance '%s'"), aLocInfo.strPath.c_str()),
800	aLocInfo.storageType == VFSType_File ? WriteFile : WriteS3);
801	}
802	catch (std::bad_alloc &) /* only Utf8StrFmt */
803	{
804	hrc = E_OUTOFMEMORY;
805	}
806	if (SUCCEEDED(hrc))
807	{
808	/* Create our worker task: */
809	TaskOVF *pTask = NULL;
810	try
811	{
812	pTask = new TaskOVF(this, TaskOVF::Write, aLocInfo, aProgress);
813	}
814	catch (std::bad_alloc &)
815	{
816	return E_OUTOFMEMORY;
817	}
818
819	/* The OVF version to produce: */
820	pTask->enFormat = aFormat;
821
822	/* Start the thread: */
823	hrc = pTask->createThread();
824	pTask = NULL;
825	}
826	return hrc;
827	}
828
829
830	HRESULT Appliance::i_writeCloudImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)
831	{
832	for (list<ComObjPtr<VirtualSystemDescription> >::const_iterator
833	it = m->virtualSystemDescriptions.begin();
834	it != m->virtualSystemDescriptions.end();
835	++it)
836	{
837	ComObjPtr<VirtualSystemDescription> vsdescThis = *it;
838	std::list<VirtualSystemDescriptionEntry*> skipped = vsdescThis->i_findByType(VirtualSystemDescriptionType_CDROM);
839	std::list<VirtualSystemDescriptionEntry*>::const_iterator itSkipped = skipped.begin();
840	while (itSkipped != skipped.end())
841	{
842	(*itSkipped)->skipIt = true;
843	++itSkipped;
844	}
845
846	//remove all disks from the VirtualSystemDescription exept one
847	skipped = vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskImage);
848	itSkipped = skipped.begin();
849
850	Utf8Str strBootLocation;
851	while (itSkipped != skipped.end())
852	{
853	if (strBootLocation.isEmpty())
854	strBootLocation = (*itSkipped)->strVBoxCurrent;
855	else
856	(*itSkipped)->skipIt = true;
857	++itSkipped;
858	}
859
860	//just in case
861	if (vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskImage).empty())
862	return setError(VBOX_E_OBJECT_NOT_FOUND, tr("There are no images to export to Cloud after preparation steps"));
863
864	/*
865	* Fills out the OCI settings
866	*/
867	std::list<VirtualSystemDescriptionEntry*> profileName
868	= vsdescThis->i_findByType(VirtualSystemDescriptionType_CloudProfileName);
869	if (profileName.size() > 1)
870	return setError(VBOX_E_OBJECT_NOT_FOUND, tr("Cloud: More than one profile name was found."));
871	if (profileName.empty())
872	return setError(VBOX_E_OBJECT_NOT_FOUND, tr("Cloud: Profile name wasn't specified."));
873
874	if (profileName.front()->strVBoxCurrent.isEmpty())
875	return setError(VBOX_E_OBJECT_NOT_FOUND, tr("Cloud: Cloud user profile name is empty"));
876
877	LogRel(("profile name: %s\n", profileName.front()->strVBoxCurrent.c_str()));
878	}
879
880	// we need to do that as otherwise Task won't be created successfully
881	/// @todo r=bird: What's 'that' here exactly?
882	HRESULT hrc = aProgress.createObject();
883	if (SUCCEEDED(hrc))
884	{
885	if (aLocInfo.strProvider.equals("OCI"))
886	{
887	hrc = aProgress->init(mVirtualBox, static_cast<IAppliance *>(this),
888	Utf8Str(tr("Exporting VM to Cloud...")),
889	TRUE /* aCancelable */,
890	5, // ULONG cOperations,
891	1000, // ULONG ulTotalOperationsWeight,
892	Utf8Str(tr("Exporting VM to Cloud...")), // aFirstOperationDescription
893	10); // ULONG ulFirstOperationWeight
894	}
895	else
896	hrc = setErrorVrc(VBOX_E_NOT_SUPPORTED,
897	tr("Only \"OCI\" cloud provider is supported for now. \"%s\" isn't supported."),
898	aLocInfo.strProvider.c_str());
899	if (SUCCEEDED(hrc))
900	{
901	/* Initialize the worker task: */
902	TaskCloud *pTask = NULL;
903	try
904	{
905	pTask = new Appliance::TaskCloud(this, TaskCloud::Export, aLocInfo, aProgress);
906	}
907	catch (std::bad_alloc &)
908	{
909	pTask = NULL;
910	hrc = E_OUTOFMEMORY;
911	}
912	if (SUCCEEDED(hrc))
913	{
914	/* Kick off the worker task: */
915	hrc = pTask->createThread();
916	pTask = NULL;
917	}
918	}
919	}
920	return hrc;
921	}
922
923	HRESULT Appliance::i_writeOPCImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)
924	{
925	RT_NOREF(aFormat);
926
927	/* Prepare progress object: */
928	HRESULT hrc;
929	try
930	{
931	hrc = i_setUpProgress(aProgress,
932	Utf8StrFmt(tr("Export appliance '%s'"), aLocInfo.strPath.c_str()),
933	aLocInfo.storageType == VFSType_File ? WriteFile : WriteS3);
934	}
935	catch (std::bad_alloc &) /* only Utf8StrFmt */
936	{
937	hrc = E_OUTOFMEMORY;
938	}
939	if (SUCCEEDED(hrc))
940	{
941	/* Create our worker task: */
942	TaskOPC *pTask = NULL;
943	try
944	{
945	pTask = new Appliance::TaskOPC(this, TaskOPC::Export, aLocInfo, aProgress);
946	}
947	catch (std::bad_alloc &)
948	{
949	return E_OUTOFMEMORY;
950	}
951
952	/* Kick it off: */
953	hrc = pTask->createThread();
954	pTask = NULL;
955	}
956	return hrc;
957	}
958
959
960	/**
961	* Called from Appliance::i_writeFS() for creating a XML document for this
962	* Appliance.
963	*
964	* @param writeLock The current write lock.
965	* @param doc The xml document to fill.
966	* @param stack Structure for temporary private
967	* data shared with caller.
968	* @param strPath Path to the target OVF.
969	* instance for which to write XML.
970	* @param enFormat OVF format (0.9 or 1.0).
971	*/
972	void Appliance::i_buildXML(AutoWriteLockBase& writeLock,
973	xml::Document &doc,
974	XMLStack &stack,
975	const Utf8Str &strPath,
976	ovf::OVFVersion_T enFormat)
977	{
978	xml::ElementNode *pelmRoot = doc.createRootElement("Envelope");
979
980	pelmRoot->setAttribute("ovf:version", enFormat == ovf::OVFVersion_2_0 ? "2.0"
981	: enFormat == ovf::OVFVersion_1_0 ? "1.0"
982	: "0.9");
983	pelmRoot->setAttribute("xml:lang", "en-US");
984
985	Utf8Str strNamespace;
986
987	if (enFormat == ovf::OVFVersion_0_9)
988	{
989	strNamespace = ovf::OVF09_URI_string;
990	}
991	else if (enFormat == ovf::OVFVersion_1_0)
992	{
993	strNamespace = ovf::OVF10_URI_string;
994	}
995	else
996	{
997	strNamespace = ovf::OVF20_URI_string;
998	}
999
1000	pelmRoot->setAttribute("xmlns", strNamespace);
1001	pelmRoot->setAttribute("xmlns:ovf", strNamespace);
1002
1003	// pelmRoot->setAttribute("xmlns:ovfstr", "http://schema.dmtf.org/ovf/strings/1");
1004	pelmRoot->setAttribute("xmlns:rasd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData");
1005	pelmRoot->setAttribute("xmlns:vssd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData");
1006	pelmRoot->setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
1007	pelmRoot->setAttribute("xmlns:vbox", "http://www.virtualbox.org/ovf/machine");
1008	// pelmRoot->setAttribute("xsi:schemaLocation", "http://schemas.dmtf.org/ovf/envelope/1 ../ovf-envelope.xsd");
1009
1010	if (enFormat == ovf::OVFVersion_2_0)
1011	{
1012	pelmRoot->setAttribute("xmlns:epasd",
1013	"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_EthernetPortAllocationSettingData.xsd");
1014	pelmRoot->setAttribute("xmlns:sasd",
1015	"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_StorageAllocationSettingData.xsd");
1016	}
1017
1018	// <Envelope>/<References>
1019	xml::ElementNode *pelmReferences = pelmRoot->createChild("References"); // 0.9 and 1.0
1020
1021	/* <Envelope>/<DiskSection>:
1022	<DiskSection>
1023	<Info>List of the virtual disks used in the package</Info>
1024	<Disk ovf:capacity="4294967296" ovf:diskId="lamp" ovf:format="..." ovf:populatedSize="1924967692"/>
1025	</DiskSection> */
1026	xml::ElementNode *pelmDiskSection;
1027	if (enFormat == ovf::OVFVersion_0_9)
1028	{
1029	// <Section xsi:type="ovf:DiskSection_Type">
1030	pelmDiskSection = pelmRoot->createChild("Section");
1031	pelmDiskSection->setAttribute("xsi:type", "ovf:DiskSection_Type");
1032	}
1033	else
1034	pelmDiskSection = pelmRoot->createChild("DiskSection");
1035
1036	xml::ElementNode *pelmDiskSectionInfo = pelmDiskSection->createChild("Info");
1037	pelmDiskSectionInfo->addContent("List of the virtual disks used in the package");
1038
1039	/* <Envelope>/<NetworkSection>:
1040	<NetworkSection>
1041	<Info>Logical networks used in the package</Info>
1042	<Network ovf:name="VM Network">
1043	<Description>The network that the LAMP Service will be available on</Description>
1044	</Network>
1045	</NetworkSection> */
1046	xml::ElementNode *pelmNetworkSection;
1047	if (enFormat == ovf::OVFVersion_0_9)
1048	{
1049	// <Section xsi:type="ovf:NetworkSection_Type">
1050	pelmNetworkSection = pelmRoot->createChild("Section");
1051	pelmNetworkSection->setAttribute("xsi:type", "ovf:NetworkSection_Type");
1052	}
1053	else
1054	pelmNetworkSection = pelmRoot->createChild("NetworkSection");
1055
1056	xml::ElementNode *pelmNetworkSectionInfo = pelmNetworkSection->createChild("Info");
1057	pelmNetworkSectionInfo->addContent("Logical networks used in the package");
1058
1059	// and here come the virtual systems:
1060
1061	// write a collection if we have more than one virtual system _and_ we're
1062	// writing OVF 1.0; otherwise fail since ovftool can't import more than
1063	// one machine, it seems
1064	xml::ElementNode *pelmToAddVirtualSystemsTo;
1065	if (m->virtualSystemDescriptions.size() > 1)
1066	{
1067	if (enFormat == ovf::OVFVersion_0_9)
1068	throw setError(VBOX_E_FILE_ERROR,
1069	tr("Cannot export more than one virtual system with OVF 0.9, use OVF 1.0"));
1070
1071	pelmToAddVirtualSystemsTo = pelmRoot->createChild("VirtualSystemCollection");
1072	pelmToAddVirtualSystemsTo->setAttribute("ovf:name", "ExportedVirtualBoxMachines"); // whatever
1073	}
1074	else
1075	pelmToAddVirtualSystemsTo = pelmRoot; // add virtual system directly under root element
1076
1077	// this list receives pointers to the XML elements in the machine XML which
1078	// might have UUIDs that need fixing after we know the UUIDs of the exported images
1079	std::list<xml::ElementNode*> llElementsWithUuidAttributes;
1080	uint32_t ulFile = 1;
1081	/* Iterate through all virtual systems of that appliance */
1082	for (list<ComObjPtr<VirtualSystemDescription> >::const_iterator
1083	itV = m->virtualSystemDescriptions.begin();
1084	itV != m->virtualSystemDescriptions.end();
1085	++itV)
1086	{
1087	ComObjPtr<VirtualSystemDescription> vsdescThis = *itV;
1088	i_buildXMLForOneVirtualSystem(writeLock,
1089	*pelmToAddVirtualSystemsTo,
1090	&llElementsWithUuidAttributes,
1091	vsdescThis,
1092	enFormat,
1093	stack); // disks and networks stack
1094
1095	list<Utf8Str> diskList;
1096
1097	for (list<Utf8Str>::const_iterator
1098	itDisk = stack.mapDiskSequenceForOneVM.begin();
1099	itDisk != stack.mapDiskSequenceForOneVM.end();
1100	++itDisk)
1101	{
1102	const Utf8Str &strDiskID = *itDisk;
1103	const VirtualSystemDescriptionEntry *pDiskEntry = stack.mapDisks[strDiskID];
1104
1105	// source path: where the VBox image is
1106	const Utf8Str &strSrcFilePath = pDiskEntry->strVBoxCurrent;
1107	Bstr bstrSrcFilePath(strSrcFilePath);
1108
1109	//skip empty Medium. There are no information to add into section <References> or <DiskSection>
1110	if (strSrcFilePath.isEmpty() \|\|
1111	pDiskEntry->skipIt == true)
1112	continue;
1113
1114	// Do NOT check here whether the file exists. FindMedium will figure
1115	// that out, and filesystem-based tests are simply wrong in the
1116	// general case (think of iSCSI).
1117
1118	// We need some info from the source disks
1119	ComPtr<IMedium> pSourceDisk;
1120	//DeviceType_T deviceType = DeviceType_HardDisk;// by default
1121
1122	Log(("Finding source disk \"%ls\"\n", bstrSrcFilePath.raw()));
1123
1124	HRESULT rc;
1125
1126	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)
1127	{
1128	rc = mVirtualBox->OpenMedium(bstrSrcFilePath.raw(),
1129	DeviceType_HardDisk,
1130	AccessMode_ReadWrite,
1131	FALSE /* fForceNewUuid */,
1132	pSourceDisk.asOutParam());
1133	if (FAILED(rc))
1134	throw rc;
1135	}
1136	else if (pDiskEntry->type == VirtualSystemDescriptionType_CDROM)//may be, this is CD/DVD
1137	{
1138	rc = mVirtualBox->OpenMedium(bstrSrcFilePath.raw(),
1139	DeviceType_DVD,
1140	AccessMode_ReadOnly,
1141	FALSE,
1142	pSourceDisk.asOutParam());
1143	if (FAILED(rc))
1144	throw rc;
1145	}
1146
1147	Bstr uuidSource;
1148	rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());
1149	if (FAILED(rc)) throw rc;
1150	Guid guidSource(uuidSource);
1151
1152	// output filename
1153	const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
1154
1155	// target path needs to be composed from where the output OVF is
1156	Utf8Str strTargetFilePath(strPath);
1157	strTargetFilePath.stripFilename();
1158	strTargetFilePath.append("/");
1159	strTargetFilePath.append(strTargetFileNameOnly);
1160
1161	// We are always exporting to VMDK stream optimized for now
1162	//Bstr bstrSrcFormat = L"VMDK";//not used
1163
1164	diskList.push_back(strTargetFilePath);
1165
1166	LONG64 cbCapacity = 0; // size reported to guest
1167	rc = pSourceDisk->COMGETTER(LogicalSize)(&cbCapacity);
1168	if (FAILED(rc)) throw rc;
1169	/// @todo r=poetzsch: wrong it is reported in bytes ...
1170	// capacity is reported in megabytes, so...
1171	//cbCapacity *= _1M;
1172
1173	Guid guidTarget; /* Creates a new uniq number for the target disk. */
1174	guidTarget.create();
1175
1176	// now handle the XML for the disk:
1177	Utf8StrFmt strFileRef("file%RI32", ulFile++);
1178	// <File ovf:href="WindowsXpProfessional-disk1.vmdk" ovf:id="file1" ovf:size="1710381056"/>
1179	xml::ElementNode *pelmFile = pelmReferences->createChild("File");
1180	pelmFile->setAttribute("ovf:id", strFileRef);
1181	pelmFile->setAttribute("ovf:href", strTargetFileNameOnly);
1182	/// @todo the actual size is not available at this point of time,
1183	// cause the disk will be compressed. The 1.0 standard says this is
1184	// optional! 1.1 isn't fully clear if the "gzip" format is used.
1185	// Need to be checked. */
1186	// pelmFile->setAttribute("ovf:size", Utf8StrFmt("%RI64", cbFile).c_str());
1187
1188	// add disk to XML Disks section
1189	// <Disk ovf:capacity="8589934592" ovf:diskId="vmdisk1" ovf:fileRef="file1" ovf:format="..."/>
1190	xml::ElementNode *pelmDisk = pelmDiskSection->createChild("Disk");
1191	pelmDisk->setAttribute("ovf:capacity", Utf8StrFmt("%RI64", cbCapacity).c_str());
1192	pelmDisk->setAttribute("ovf:diskId", strDiskID);
1193	pelmDisk->setAttribute("ovf:fileRef", strFileRef);
1194
1195	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)//deviceType == DeviceType_HardDisk
1196	{
1197	pelmDisk->setAttribute("ovf:format",
1198	(enFormat == ovf::OVFVersion_0_9)
1199	? "http://www.vmware.com/specifications/vmdk.html#sparse" // must be sparse or ovftoo
1200	: "http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized"
1201	// correct string as communicated to us by VMware (public bug #6612)
1202	);
1203	}
1204	else //pDiskEntry->type == VirtualSystemDescriptionType_CDROM, deviceType == DeviceType_DVD
1205	{
1206	pelmDisk->setAttribute("ovf:format",
1207	"http://www.ecma-international.org/publications/standards/Ecma-119.htm"
1208	);
1209	}
1210
1211	// add the UUID of the newly target image to the OVF disk element, but in the
1212	// vbox: namespace since it's not part of the standard
1213	pelmDisk->setAttribute("vbox:uuid", Utf8StrFmt("%RTuuid", guidTarget.raw()).c_str());
1214
1215	// now, we might have other XML elements from vbox:Machine pointing to this image,
1216	// but those would refer to the UUID of the _source_ image (which we created the
1217	// export image from); those UUIDs need to be fixed to the export image
1218	Utf8Str strGuidSourceCurly = guidSource.toStringCurly();
1219	for (std::list<xml::ElementNode*>::const_iterator
1220	it = llElementsWithUuidAttributes.begin();
1221	it != llElementsWithUuidAttributes.end();
1222	++it)
1223	{
1224	xml::ElementNode pelmImage = it;
1225	Utf8Str strUUID;
1226	pelmImage->getAttributeValue("uuid", strUUID);
1227	if (strUUID == strGuidSourceCurly)
1228	// overwrite existing uuid attribute
1229	pelmImage->setAttribute("uuid", guidTarget.toStringCurly());
1230	}
1231	}
1232	llElementsWithUuidAttributes.clear();
1233	stack.mapDiskSequenceForOneVM.clear();
1234	}
1235
1236	// now, fill in the network section we set up empty above according
1237	// to the networks we found with the hardware items
1238	for (map<Utf8Str, bool>::const_iterator
1239	it = stack.mapNetworks.begin();
1240	it != stack.mapNetworks.end();
1241	++it)
1242	{
1243	const Utf8Str &strNetwork = it->first;
1244	xml::ElementNode *pelmNetwork = pelmNetworkSection->createChild("Network");
1245	pelmNetwork->setAttribute("ovf:name", strNetwork.c_str());
1246	pelmNetwork->createChild("Description")->addContent("Logical network used by this appliance.");
1247	}
1248
1249	}
1250
1251	/**
1252	* Called from Appliance::i_buildXML() for each virtual system (machine) that
1253	* needs XML written out.
1254	*
1255	* @param writeLock The current write lock.
1256	* @param elmToAddVirtualSystemsTo XML element to append elements to.
1257	* @param pllElementsWithUuidAttributes out: list of XML elements produced here
1258	* with UUID attributes for quick
1259	* fixing by caller later
1260	* @param vsdescThis The IVirtualSystemDescription
1261	* instance for which to write XML.
1262	* @param enFormat OVF format (0.9 or 1.0).
1263	* @param stack Structure for temporary private
1264	* data shared with caller.
1265	*/
1266	void Appliance::i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
1267	xml::ElementNode &elmToAddVirtualSystemsTo,
1268	std::list<xml::ElementNode> pllElementsWithUuidAttributes,
1269	ComObjPtr<VirtualSystemDescription> &vsdescThis,
1270	ovf::OVFVersion_T enFormat,
1271	XMLStack &stack)
1272	{
1273	LogFlowFunc(("ENTER appliance %p\n", this));
1274
1275	xml::ElementNode *pelmVirtualSystem;
1276	if (enFormat == ovf::OVFVersion_0_9)
1277	{
1278	// <Section xsi:type="ovf:NetworkSection_Type">
1279	pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("Content");
1280	pelmVirtualSystem->setAttribute("xsi:type", "ovf:VirtualSystem_Type");
1281	}
1282	else
1283	pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("VirtualSystem");
1284
1285	/xml::ElementNode pelmVirtualSystemInfo =*/ pelmVirtualSystem->createChild("Info")->addContent("A virtual machine");
1286
1287	std::list<VirtualSystemDescriptionEntry*> llName = vsdescThis->i_findByType(VirtualSystemDescriptionType_Name);
1288	if (llName.empty())
1289	throw setError(VBOX_E_NOT_SUPPORTED, tr("Missing VM name"));
1290	Utf8Str &strVMName = llName.back()->strVBoxCurrent;
1291	pelmVirtualSystem->setAttribute("ovf:id", strVMName);
1292
1293	// product info
1294	std::list<VirtualSystemDescriptionEntry*> llProduct = vsdescThis->i_findByType(VirtualSystemDescriptionType_Product);
1295	std::list<VirtualSystemDescriptionEntry*> llProductUrl = vsdescThis->i_findByType(VirtualSystemDescriptionType_ProductUrl);
1296	std::list<VirtualSystemDescriptionEntry*> llVendor = vsdescThis->i_findByType(VirtualSystemDescriptionType_Vendor);
1297	std::list<VirtualSystemDescriptionEntry*> llVendorUrl = vsdescThis->i_findByType(VirtualSystemDescriptionType_VendorUrl);
1298	std::list<VirtualSystemDescriptionEntry*> llVersion = vsdescThis->i_findByType(VirtualSystemDescriptionType_Version);
1299	bool fProduct = llProduct.size() && !llProduct.back()->strVBoxCurrent.isEmpty();
1300	bool fProductUrl = llProductUrl.size() && !llProductUrl.back()->strVBoxCurrent.isEmpty();
1301	bool fVendor = llVendor.size() && !llVendor.back()->strVBoxCurrent.isEmpty();
1302	bool fVendorUrl = llVendorUrl.size() && !llVendorUrl.back()->strVBoxCurrent.isEmpty();
1303	bool fVersion = llVersion.size() && !llVersion.back()->strVBoxCurrent.isEmpty();
1304	if (fProduct \|\| fProductUrl \|\| fVendor \|\| fVendorUrl \|\| fVersion)
1305	{
1306	/* <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
1307	<Info>Meta-information about the installed software</Info>
1308	<Product>VAtest</Product>
1309	<Vendor>SUN Microsystems</Vendor>
1310	<Version>10.0</Version>
1311	<ProductUrl>http://blogs.sun.com/VirtualGuru</ProductUrl>
1312	<VendorUrl>http://www.sun.com</VendorUrl>
1313	</Section> */
1314	xml::ElementNode *pelmAnnotationSection;
1315	if (enFormat == ovf::OVFVersion_0_9)
1316	{
1317	// <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
1318	pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
1319	pelmAnnotationSection->setAttribute("xsi:type", "ovf:ProductSection_Type");
1320	}
1321	else
1322	pelmAnnotationSection = pelmVirtualSystem->createChild("ProductSection");
1323
1324	pelmAnnotationSection->createChild("Info")->addContent("Meta-information about the installed software");
1325	if (fProduct)
1326	pelmAnnotationSection->createChild("Product")->addContent(llProduct.back()->strVBoxCurrent);
1327	if (fVendor)
1328	pelmAnnotationSection->createChild("Vendor")->addContent(llVendor.back()->strVBoxCurrent);
1329	if (fVersion)
1330	pelmAnnotationSection->createChild("Version")->addContent(llVersion.back()->strVBoxCurrent);
1331	if (fProductUrl)
1332	pelmAnnotationSection->createChild("ProductUrl")->addContent(llProductUrl.back()->strVBoxCurrent);
1333	if (fVendorUrl)
1334	pelmAnnotationSection->createChild("VendorUrl")->addContent(llVendorUrl.back()->strVBoxCurrent);
1335	}
1336
1337	// description
1338	std::list<VirtualSystemDescriptionEntry*> llDescription = vsdescThis->i_findByType(VirtualSystemDescriptionType_Description);
1339	if (llDescription.size() &&
1340	!llDescription.back()->strVBoxCurrent.isEmpty())
1341	{
1342	/* <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
1343	<Info>A human-readable annotation</Info>
1344	<Annotation>Plan 9</Annotation>
1345	</Section> */
1346	xml::ElementNode *pelmAnnotationSection;
1347	if (enFormat == ovf::OVFVersion_0_9)
1348	{
1349	// <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
1350	pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
1351	pelmAnnotationSection->setAttribute("xsi:type", "ovf:AnnotationSection_Type");
1352	}
1353	else
1354	pelmAnnotationSection = pelmVirtualSystem->createChild("AnnotationSection");
1355
1356	pelmAnnotationSection->createChild("Info")->addContent("A human-readable annotation");
1357	pelmAnnotationSection->createChild("Annotation")->addContent(llDescription.back()->strVBoxCurrent);
1358	}
1359
1360	// license
1361	std::list<VirtualSystemDescriptionEntry*> llLicense = vsdescThis->i_findByType(VirtualSystemDescriptionType_License);
1362	if (llLicense.size() &&
1363	!llLicense.back()->strVBoxCurrent.isEmpty())
1364	{
1365	/* <EulaSection>
1366	<Info ovf:msgid="6">License agreement for the Virtual System.</Info>
1367	<License ovf:msgid="1">License terms can go in here.</License>
1368	</EulaSection> */
1369	xml::ElementNode *pelmEulaSection;
1370	if (enFormat == ovf::OVFVersion_0_9)
1371	{
1372	pelmEulaSection = pelmVirtualSystem->createChild("Section");
1373	pelmEulaSection->setAttribute("xsi:type", "ovf:EulaSection_Type");
1374	}
1375	else
1376	pelmEulaSection = pelmVirtualSystem->createChild("EulaSection");
1377
1378	pelmEulaSection->createChild("Info")->addContent("License agreement for the virtual system");
1379	pelmEulaSection->createChild("License")->addContent(llLicense.back()->strVBoxCurrent);
1380	}
1381
1382	// operating system
1383	std::list<VirtualSystemDescriptionEntry*> llOS = vsdescThis->i_findByType(VirtualSystemDescriptionType_OS);
1384	if (llOS.empty())
1385	throw setError(VBOX_E_NOT_SUPPORTED, tr("Missing OS type"));
1386	/* <OperatingSystemSection ovf:id="82">
1387	<Info>Guest Operating System</Info>
1388	<Description>Linux 2.6.x</Description>
1389	</OperatingSystemSection> */
1390	VirtualSystemDescriptionEntry *pvsdeOS = llOS.back();
1391	xml::ElementNode *pelmOperatingSystemSection;
1392	if (enFormat == ovf::OVFVersion_0_9)
1393	{
1394	pelmOperatingSystemSection = pelmVirtualSystem->createChild("Section");
1395	pelmOperatingSystemSection->setAttribute("xsi:type", "ovf:OperatingSystemSection_Type");
1396	}
1397	else
1398	pelmOperatingSystemSection = pelmVirtualSystem->createChild("OperatingSystemSection");
1399
1400	pelmOperatingSystemSection->setAttribute("ovf:id", pvsdeOS->strOvf);
1401	pelmOperatingSystemSection->createChild("Info")->addContent("The kind of installed guest operating system");
1402	Utf8Str strOSDesc;
1403	convertCIMOSType2VBoxOSType(strOSDesc, (ovf::CIMOSType_T)pvsdeOS->strOvf.toInt32(), "");
1404	pelmOperatingSystemSection->createChild("Description")->addContent(strOSDesc);
1405	// add the VirtualBox ostype in a custom tag in a different namespace
1406	xml::ElementNode *pelmVBoxOSType = pelmOperatingSystemSection->createChild("vbox:OSType");
1407	pelmVBoxOSType->setAttribute("ovf:required", "false");
1408	pelmVBoxOSType->addContent(pvsdeOS->strVBoxCurrent);
1409
1410	// <VirtualHardwareSection ovf:id="hw1" ovf:transport="iso">
1411	xml::ElementNode *pelmVirtualHardwareSection;
1412	if (enFormat == ovf::OVFVersion_0_9)
1413	{
1414	// <Section xsi:type="ovf:VirtualHardwareSection_Type">
1415	pelmVirtualHardwareSection = pelmVirtualSystem->createChild("Section");
1416	pelmVirtualHardwareSection->setAttribute("xsi:type", "ovf:VirtualHardwareSection_Type");
1417	}
1418	else
1419	pelmVirtualHardwareSection = pelmVirtualSystem->createChild("VirtualHardwareSection");
1420
1421	pelmVirtualHardwareSection->createChild("Info")->addContent("Virtual hardware requirements for a virtual machine");
1422
1423	/* <System>
1424	<vssd:Description>Description of the virtual hardware section.</vssd:Description>
1425	<vssd:ElementName>vmware</vssd:ElementName>
1426	<vssd:InstanceID>1</vssd:InstanceID>
1427	<vssd:VirtualSystemIdentifier>MyLampService</vssd:VirtualSystemIdentifier>
1428	<vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
1429	</System> */
1430	xml::ElementNode *pelmSystem = pelmVirtualHardwareSection->createChild("System");
1431
1432	pelmSystem->createChild("vssd:ElementName")->addContent("Virtual Hardware Family"); // required OVF 1.0
1433
1434	// <vssd:InstanceId>0</vssd:InstanceId>
1435	if (enFormat == ovf::OVFVersion_0_9)
1436	pelmSystem->createChild("vssd:InstanceId")->addContent("0");
1437	else // capitalization changed...
1438	pelmSystem->createChild("vssd:InstanceID")->addContent("0");
1439
1440	// <vssd:VirtualSystemIdentifier>VAtest</vssd:VirtualSystemIdentifier>
1441	pelmSystem->createChild("vssd:VirtualSystemIdentifier")->addContent(strVMName);
1442	// <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
1443	const char *pcszHardware = "virtualbox-2.2";
1444	if (enFormat == ovf::OVFVersion_0_9)
1445	// pretend to be vmware compatible then
1446	pcszHardware = "vmx-6";
1447	pelmSystem->createChild("vssd:VirtualSystemType")->addContent(pcszHardware);
1448
1449	// loop thru all description entries twice; once to write out all
1450	// devices _except_ disk images, and a second time to assign the
1451	// disk images; this is because disk images need to reference
1452	// IDE controllers, and we can't know their instance IDs without
1453	// assigning them first
1454
1455	uint32_t idIDEPrimaryController = 0;
1456	int32_t lIDEPrimaryControllerIndex = 0;
1457	uint32_t idIDESecondaryController = 0;
1458	int32_t lIDESecondaryControllerIndex = 0;
1459	uint32_t idSATAController = 0;
1460	int32_t lSATAControllerIndex = 0;
1461	uint32_t idSCSIController = 0;
1462	int32_t lSCSIControllerIndex = 0;
1463
1464	uint32_t ulInstanceID = 1;
1465
1466	uint32_t cDVDs = 0;
1467
1468	for (size_t uLoop = 1; uLoop <= 2; ++uLoop)
1469	{
1470	int32_t lIndexThis = 0;
1471	for (vector<VirtualSystemDescriptionEntry>::const_iterator
1472	it = vsdescThis->m->maDescriptions.begin();
1473	it != vsdescThis->m->maDescriptions.end();
1474	++it, ++lIndexThis)
1475	{
1476	const VirtualSystemDescriptionEntry &desc = *it;
1477
1478	LogFlowFunc(("Loop %u: handling description entry ulIndex=%u, type=%s, strRef=%s, strOvf=%s, strVBox=%s, strExtraConfig=%s\n",
1479	uLoop,
1480	desc.ulIndex,
1481	( desc.type == VirtualSystemDescriptionType_HardDiskControllerIDE ? "HardDiskControllerIDE"
1482	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSATA ? "HardDiskControllerSATA"
1483	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSCSI ? "HardDiskControllerSCSI"
1484	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSAS ? "HardDiskControllerSAS"
1485	: desc.type == VirtualSystemDescriptionType_HardDiskImage ? "HardDiskImage"
1486	: Utf8StrFmt("%d", desc.type).c_str()),
1487	desc.strRef.c_str(),
1488	desc.strOvf.c_str(),
1489	desc.strVBoxCurrent.c_str(),
1490	desc.strExtraConfigCurrent.c_str()));
1491
1492	ovf::ResourceType_T type = (ovf::ResourceType_T)0; // if this becomes != 0 then we do stuff
1493	Utf8Str strResourceSubType;
1494
1495	Utf8Str strDescription; // results in <rasd:Description>...</rasd:Description> block
1496	Utf8Str strCaption; // results in <rasd:Caption>...</rasd:Caption> block
1497
1498	uint32_t ulParent = 0;
1499
1500	int32_t lVirtualQuantity = -1;
1501	Utf8Str strAllocationUnits;
1502
1503	int32_t lAddress = -1;
1504	int32_t lBusNumber = -1;
1505	int32_t lAddressOnParent = -1;
1506
1507	int32_t lAutomaticAllocation = -1; // 0 means "false", 1 means "true"
1508	Utf8Str strConnection; // results in <rasd:Connection>...</rasd:Connection> block
1509	Utf8Str strHostResource;
1510
1511	uint64_t uTemp;
1512
1513	ovf::VirtualHardwareItem vhi;
1514	ovf::StorageItem si;
1515	ovf::EthernetPortItem epi;
1516
1517	switch (desc.type)
1518	{
1519	case VirtualSystemDescriptionType_CPU:
1520	/* <Item>
1521	<rasd:Caption>1 virtual CPU</rasd:Caption>
1522	<rasd:Description>Number of virtual CPUs</rasd:Description>
1523	<rasd:ElementName>virtual CPU</rasd:ElementName>
1524	<rasd:InstanceID>1</rasd:InstanceID>
1525	<rasd:ResourceType>3</rasd:ResourceType>
1526	<rasd:VirtualQuantity>1</rasd:VirtualQuantity>
1527	</Item> */
1528	if (uLoop == 1)
1529	{
1530	strDescription = "Number of virtual CPUs";
1531	type = ovf::ResourceType_Processor; // 3
1532	desc.strVBoxCurrent.toInt(uTemp);
1533	lVirtualQuantity = (int32_t)uTemp;
1534	strCaption = Utf8StrFmt("%d virtual CPU", lVirtualQuantity); // without this ovftool
1535	// won't eat the item
1536	}
1537	break;
1538
1539	case VirtualSystemDescriptionType_Memory:
1540	/* <Item>
1541	<rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
1542	<rasd:Caption>256 MB of memory</rasd:Caption>
1543	<rasd:Description>Memory Size</rasd:Description>
1544	<rasd:ElementName>Memory</rasd:ElementName>
1545	<rasd:InstanceID>2</rasd:InstanceID>
1546	<rasd:ResourceType>4</rasd:ResourceType>
1547	<rasd:VirtualQuantity>256</rasd:VirtualQuantity>
1548	</Item> */
1549	if (uLoop == 1)
1550	{
1551	strDescription = "Memory Size";
1552	type = ovf::ResourceType_Memory; // 4
1553	desc.strVBoxCurrent.toInt(uTemp);
1554	lVirtualQuantity = (int32_t)(uTemp / _1M);
1555	strAllocationUnits = "MegaBytes";
1556	strCaption = Utf8StrFmt("%d MB of memory", lVirtualQuantity); // without this ovftool
1557	// won't eat the item
1558	}
1559	break;
1560
1561	case VirtualSystemDescriptionType_HardDiskControllerIDE:
1562	/* <Item>
1563	<rasd:Caption>ideController1</rasd:Caption>
1564	<rasd:Description>IDE Controller</rasd:Description>
1565	<rasd:InstanceId>5</rasd:InstanceId>
1566	<rasd:ResourceType>5</rasd:ResourceType>
1567	<rasd:Address>1</rasd:Address>
1568	<rasd:BusNumber>1</rasd:BusNumber>
1569	</Item> */
1570	if (uLoop == 1)
1571	{
1572	strDescription = "IDE Controller";
1573	type = ovf::ResourceType_IDEController; // 5
1574	strResourceSubType = desc.strVBoxCurrent;
1575
1576	if (!lIDEPrimaryControllerIndex)
1577	{
1578	// first IDE controller:
1579	strCaption = "ideController0";
1580	lAddress = 0;
1581	lBusNumber = 0;
1582	// remember this ID
1583	idIDEPrimaryController = ulInstanceID;
1584	lIDEPrimaryControllerIndex = lIndexThis;
1585	}
1586	else
1587	{
1588	// second IDE controller:
1589	strCaption = "ideController1";
1590	lAddress = 1;
1591	lBusNumber = 1;
1592	// remember this ID
1593	idIDESecondaryController = ulInstanceID;
1594	lIDESecondaryControllerIndex = lIndexThis;
1595	}
1596	}
1597	break;
1598
1599	case VirtualSystemDescriptionType_HardDiskControllerSATA:
1600	/* <Item>
1601	<rasd:Caption>sataController0</rasd:Caption>
1602	<rasd:Description>SATA Controller</rasd:Description>
1603	<rasd:InstanceId>4</rasd:InstanceId>
1604	<rasd:ResourceType>20</rasd:ResourceType>
1605	<rasd:ResourceSubType>ahci</rasd:ResourceSubType>
1606	<rasd:Address>0</rasd:Address>
1607	<rasd:BusNumber>0</rasd:BusNumber>
1608	</Item>
1609	*/
1610	if (uLoop == 1)
1611	{
1612	strDescription = "SATA Controller";
1613	strCaption = "sataController0";
1614	type = ovf::ResourceType_OtherStorageDevice; // 20
1615	// it seems that OVFTool always writes these two, and since we can only
1616	// have one SATA controller, we'll use this as well
1617	lAddress = 0;
1618	lBusNumber = 0;
1619
1620	if ( desc.strVBoxCurrent.isEmpty() // AHCI is the default in VirtualBox
1621	\|\| (!desc.strVBoxCurrent.compare("ahci", Utf8Str::CaseInsensitive))
1622	)
1623	strResourceSubType = "AHCI";
1624	else
1625	throw setError(VBOX_E_NOT_SUPPORTED,
1626	tr("Invalid config string \"%s\" in SATA controller"), desc.strVBoxCurrent.c_str());
1627
1628	// remember this ID
1629	idSATAController = ulInstanceID;
1630	lSATAControllerIndex = lIndexThis;
1631	}
1632	break;
1633
1634	case VirtualSystemDescriptionType_HardDiskControllerSCSI:
1635	case VirtualSystemDescriptionType_HardDiskControllerSAS:
1636	/* <Item>
1637	<rasd:Caption>scsiController0</rasd:Caption>
1638	<rasd:Description>SCSI Controller</rasd:Description>
1639	<rasd:InstanceId>4</rasd:InstanceId>
1640	<rasd:ResourceType>6</rasd:ResourceType>
1641	<rasd:ResourceSubType>buslogic</rasd:ResourceSubType>
1642	<rasd:Address>0</rasd:Address>
1643	<rasd:BusNumber>0</rasd:BusNumber>
1644	</Item>
1645	*/
1646	if (uLoop == 1)
1647	{
1648	strDescription = "SCSI Controller";
1649	strCaption = "scsiController0";
1650	type = ovf::ResourceType_ParallelSCSIHBA; // 6
1651	// it seems that OVFTool always writes these two, and since we can only
1652	// have one SATA controller, we'll use this as well
1653	lAddress = 0;
1654	lBusNumber = 0;
1655
1656	if ( desc.strVBoxCurrent.isEmpty() // LsiLogic is the default in VirtualBox
1657	\|\| (!desc.strVBoxCurrent.compare("lsilogic", Utf8Str::CaseInsensitive))
1658	)
1659	strResourceSubType = "lsilogic";
1660	else if (!desc.strVBoxCurrent.compare("buslogic", Utf8Str::CaseInsensitive))
1661	strResourceSubType = "buslogic";
1662	else if (!desc.strVBoxCurrent.compare("lsilogicsas", Utf8Str::CaseInsensitive))
1663	strResourceSubType = "lsilogicsas";
1664	else
1665	throw setError(VBOX_E_NOT_SUPPORTED,
1666	tr("Invalid config string \"%s\" in SCSI/SAS controller"),
1667	desc.strVBoxCurrent.c_str());
1668
1669	// remember this ID
1670	idSCSIController = ulInstanceID;
1671	lSCSIControllerIndex = lIndexThis;
1672	}
1673	break;
1674
1675	case VirtualSystemDescriptionType_HardDiskImage:
1676	/* <Item>
1677	<rasd:Caption>disk1</rasd:Caption>
1678	<rasd:InstanceId>8</rasd:InstanceId>
1679	<rasd:ResourceType>17</rasd:ResourceType>
1680	<rasd:HostResource>/disk/vmdisk1</rasd:HostResource>
1681	<rasd:Parent>4</rasd:Parent>
1682	<rasd:AddressOnParent>0</rasd:AddressOnParent>
1683	</Item> */
1684	if (uLoop == 2)
1685	{
1686	uint32_t cDisks = (uint32_t)stack.mapDisks.size();
1687	Utf8Str strDiskID = Utf8StrFmt("vmdisk%RI32", ++cDisks);
1688
1689	strDescription = "Disk Image";
1690	strCaption = Utf8StrFmt("disk%RI32", cDisks); // this is not used for anything else
1691	type = ovf::ResourceType_HardDisk; // 17
1692
1693	// the following references the "<Disks>" XML block
1694	strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());
1695
1696	// controller=<index>;channel=<c>
1697	size_t pos1 = desc.strExtraConfigCurrent.find("controller=");
1698	size_t pos2 = desc.strExtraConfigCurrent.find("channel=");
1699	int32_t lControllerIndex = -1;
1700	if (pos1 != Utf8Str::npos)
1701	{
1702	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
1703	if (lControllerIndex == lIDEPrimaryControllerIndex)
1704	ulParent = idIDEPrimaryController;
1705	else if (lControllerIndex == lIDESecondaryControllerIndex)
1706	ulParent = idIDESecondaryController;
1707	else if (lControllerIndex == lSCSIControllerIndex)
1708	ulParent = idSCSIController;
1709	else if (lControllerIndex == lSATAControllerIndex)
1710	ulParent = idSATAController;
1711	}
1712	if (pos2 != Utf8Str::npos)
1713	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
1714
1715	LogFlowFunc(("HardDiskImage details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",
1716	pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex, lIDESecondaryControllerIndex,
1717	ulParent, lAddressOnParent));
1718
1719	if ( !ulParent
1720	\|\| lAddressOnParent == -1
1721	)
1722	throw setError(VBOX_E_NOT_SUPPORTED,
1723	tr("Missing or bad extra config string in hard disk image: \"%s\""),
1724	desc.strExtraConfigCurrent.c_str());
1725
1726	stack.mapDisks[strDiskID] = &desc;
1727
1728	//use the list stack.mapDiskSequence where the disks go as the "VirtualSystem" should be placed
1729	//in the OVF description file.
1730	stack.mapDiskSequence.push_back(strDiskID);
1731	stack.mapDiskSequenceForOneVM.push_back(strDiskID);
1732	}
1733	break;
1734
1735	case VirtualSystemDescriptionType_Floppy:
1736	if (uLoop == 1)
1737	{
1738	strDescription = "Floppy Drive";
1739	strCaption = "floppy0"; // this is what OVFTool writes
1740	type = ovf::ResourceType_FloppyDrive; // 14
1741	lAutomaticAllocation = 0;
1742	lAddressOnParent = 0; // this is what OVFTool writes
1743	}
1744	break;
1745
1746	case VirtualSystemDescriptionType_CDROM:
1747	/* <Item>
1748	<rasd:Caption>cdrom1</rasd:Caption>
1749	<rasd:InstanceId>8</rasd:InstanceId>
1750	<rasd:ResourceType>15</rasd:ResourceType>
1751	<rasd:HostResource>/disk/cdrom1</rasd:HostResource>
1752	<rasd:Parent>4</rasd:Parent>
1753	<rasd:AddressOnParent>0</rasd:AddressOnParent>
1754	</Item> */
1755	if (uLoop == 2)
1756	{
1757	uint32_t cDisks = (uint32_t)stack.mapDisks.size();
1758	Utf8Str strDiskID = Utf8StrFmt("iso%RI32", ++cDisks);
1759	++cDVDs;
1760	strDescription = "CD-ROM Drive";
1761	strCaption = Utf8StrFmt("cdrom%RI32", cDVDs); // OVFTool starts with 1
1762	type = ovf::ResourceType_CDDrive; // 15
1763	lAutomaticAllocation = 1;
1764
1765	//skip empty Medium. There are no information to add into section <References> or <DiskSection>
1766	if (desc.strVBoxCurrent.isNotEmpty() &&
1767	desc.skipIt == false)
1768	{
1769	// the following references the "<Disks>" XML block
1770	strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());
1771	}
1772
1773	// controller=<index>;channel=<c>
1774	size_t pos1 = desc.strExtraConfigCurrent.find("controller=");
1775	size_t pos2 = desc.strExtraConfigCurrent.find("channel=");
1776	int32_t lControllerIndex = -1;
1777	if (pos1 != Utf8Str::npos)
1778	{
1779	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
1780	if (lControllerIndex == lIDEPrimaryControllerIndex)
1781	ulParent = idIDEPrimaryController;
1782	else if (lControllerIndex == lIDESecondaryControllerIndex)
1783	ulParent = idIDESecondaryController;
1784	else if (lControllerIndex == lSCSIControllerIndex)
1785	ulParent = idSCSIController;
1786	else if (lControllerIndex == lSATAControllerIndex)
1787	ulParent = idSATAController;
1788	}
1789	if (pos2 != Utf8Str::npos)
1790	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
1791
1792	LogFlowFunc(("DVD drive details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",
1793	pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex,
1794	lIDESecondaryControllerIndex, ulParent, lAddressOnParent));
1795
1796	if ( !ulParent
1797	\|\| lAddressOnParent == -1
1798	)
1799	throw setError(VBOX_E_NOT_SUPPORTED,
1800	tr("Missing or bad extra config string in DVD drive medium: \"%s\""),
1801	desc.strExtraConfigCurrent.c_str());
1802
1803	stack.mapDisks[strDiskID] = &desc;
1804
1805	//use the list stack.mapDiskSequence where the disks go as the "VirtualSystem" should be placed
1806	//in the OVF description file.
1807	stack.mapDiskSequence.push_back(strDiskID);
1808	stack.mapDiskSequenceForOneVM.push_back(strDiskID);
1809	// there is no DVD drive map to update because it is
1810	// handled completely with this entry.
1811	}
1812	break;
1813
1814	case VirtualSystemDescriptionType_NetworkAdapter:
1815	/* <Item>
1816	<rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
1817	<rasd:Caption>Ethernet adapter on 'VM Network'</rasd:Caption>
1818	<rasd:Connection>VM Network</rasd:Connection>
1819	<rasd:ElementName>VM network</rasd:ElementName>
1820	<rasd:InstanceID>3</rasd:InstanceID>
1821	<rasd:ResourceType>10</rasd:ResourceType>
1822	</Item> */
1823	if (uLoop == 2)
1824	{
1825	lAutomaticAllocation = 1;
1826	strCaption = Utf8StrFmt("Ethernet adapter on '%s'", desc.strOvf.c_str());
1827	type = ovf::ResourceType_EthernetAdapter; // 10
1828	/* Set the hardware type to something useful.
1829	* To be compatible with vmware & others we set
1830	* PCNet32 for our PCNet types & E1000 for the
1831	* E1000 cards. */
1832	switch (desc.strVBoxCurrent.toInt32())
1833	{
1834	case NetworkAdapterType_Am79C970A:
1835	case NetworkAdapterType_Am79C973: strResourceSubType = "PCNet32"; break;
1836	#ifdef VBOX_WITH_E1000
1837	case NetworkAdapterType_I82540EM:
1838	case NetworkAdapterType_I82545EM:
1839	case NetworkAdapterType_I82543GC: strResourceSubType = "E1000"; break;
1840	#endif /* VBOX_WITH_E1000 */
1841	}
1842	strConnection = desc.strOvf;
1843
1844	stack.mapNetworks[desc.strOvf] = true;
1845	}
1846	break;
1847
1848	case VirtualSystemDescriptionType_USBController:
1849	/* <Item ovf:required="false">
1850	<rasd:Caption>usb</rasd:Caption>
1851	<rasd:Description>USB Controller</rasd:Description>
1852	<rasd:InstanceId>3</rasd:InstanceId>
1853	<rasd:ResourceType>23</rasd:ResourceType>
1854	<rasd:Address>0</rasd:Address>
1855	<rasd:BusNumber>0</rasd:BusNumber>
1856	</Item> */
1857	if (uLoop == 1)
1858	{
1859	strDescription = "USB Controller";
1860	strCaption = "usb";
1861	type = ovf::ResourceType_USBController; // 23
1862	lAddress = 0; // this is what OVFTool writes
1863	lBusNumber = 0; // this is what OVFTool writes
1864	}
1865	break;
1866
1867	case VirtualSystemDescriptionType_SoundCard:
1868	/* <Item ovf:required="false">
1869	<rasd:Caption>sound</rasd:Caption>
1870	<rasd:Description>Sound Card</rasd:Description>
1871	<rasd:InstanceId>10</rasd:InstanceId>
1872	<rasd:ResourceType>35</rasd:ResourceType>
1873	<rasd:ResourceSubType>ensoniq1371</rasd:ResourceSubType>
1874	<rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
1875	<rasd:AddressOnParent>3</rasd:AddressOnParent>
1876	</Item> */
1877	if (uLoop == 1)
1878	{
1879	strDescription = "Sound Card";
1880	strCaption = "sound";
1881	type = ovf::ResourceType_SoundCard; // 35
1882	strResourceSubType = desc.strOvf; // e.g. ensoniq1371
1883	lAutomaticAllocation = 0;
1884	lAddressOnParent = 3; // what gives? this is what OVFTool writes
1885	}
1886	break;
1887
1888	default: break; /* Shut up MSC. */
1889	}
1890
1891	if (type)
1892	{
1893	xml::ElementNode *pItem;
1894	xml::ElementNode *pItemHelper;
1895	RTCString itemElement;
1896	RTCString itemElementHelper;
1897
1898	if (enFormat == ovf::OVFVersion_2_0)
1899	{
1900	if(uLoop == 2)
1901	{
1902	if (desc.type == VirtualSystemDescriptionType_NetworkAdapter)
1903	{
1904	itemElement = "epasd:";
1905	pItem = pelmVirtualHardwareSection->createChild("EthernetPortItem");
1906	}
1907	else if (desc.type == VirtualSystemDescriptionType_CDROM \|\|
1908	desc.type == VirtualSystemDescriptionType_HardDiskImage)
1909	{
1910	itemElement = "sasd:";
1911	pItem = pelmVirtualHardwareSection->createChild("StorageItem");
1912	}
1913	else
1914	pItem = NULL;
1915	}
1916	else
1917	{
1918	itemElement = "rasd:";
1919	pItem = pelmVirtualHardwareSection->createChild("Item");
1920	}
1921	}
1922	else
1923	{
1924	itemElement = "rasd:";
1925	pItem = pelmVirtualHardwareSection->createChild("Item");
1926	}
1927
1928	// NOTE: DO NOT CHANGE THE ORDER of these items! The OVF standards prescribes that
1929	// the elements from the rasd: namespace must be sorted by letter, and VMware
1930	// actually requires this as well (see public bug #6612)
1931
1932	if (lAddress != -1)
1933	{
1934	//pItem->createChild("rasd:Address")->addContent(Utf8StrFmt("%d", lAddress));
1935	itemElementHelper = itemElement;
1936	pItemHelper = pItem->createChild(itemElementHelper.append("Address").c_str());
1937	pItemHelper->addContent(Utf8StrFmt("%d", lAddress));
1938	}
1939
1940	if (lAddressOnParent != -1)
1941	{
1942	//pItem->createChild("rasd:AddressOnParent")->addContent(Utf8StrFmt("%d", lAddressOnParent));
1943	itemElementHelper = itemElement;
1944	pItemHelper = pItem->createChild(itemElementHelper.append("AddressOnParent").c_str());
1945	pItemHelper->addContent(Utf8StrFmt("%d", lAddressOnParent));
1946	}
1947
1948	if (!strAllocationUnits.isEmpty())
1949	{
1950	//pItem->createChild("rasd:AllocationUnits")->addContent(strAllocationUnits);
1951	itemElementHelper = itemElement;
1952	pItemHelper = pItem->createChild(itemElementHelper.append("AllocationUnits").c_str());
1953	pItemHelper->addContent(strAllocationUnits);
1954	}
1955
1956	if (lAutomaticAllocation != -1)
1957	{
1958	//pItem->createChild("rasd:AutomaticAllocation")->addContent( (lAutomaticAllocation) ? "true" : "false" );
1959	itemElementHelper = itemElement;
1960	pItemHelper = pItem->createChild(itemElementHelper.append("AutomaticAllocation").c_str());
1961	pItemHelper->addContent((lAutomaticAllocation) ? "true" : "false" );
1962	}
1963
1964	if (lBusNumber != -1)
1965	{
1966	if (enFormat == ovf::OVFVersion_0_9)
1967	{
1968	// BusNumber is invalid OVF 1.0 so only write it in 0.9 mode for OVFTool
1969	//pItem->createChild("rasd:BusNumber")->addContent(Utf8StrFmt("%d", lBusNumber));
1970	itemElementHelper = itemElement;
1971	pItemHelper = pItem->createChild(itemElementHelper.append("BusNumber").c_str());
1972	pItemHelper->addContent(Utf8StrFmt("%d", lBusNumber));
1973	}
1974	}
1975
1976	if (!strCaption.isEmpty())
1977	{
1978	//pItem->createChild("rasd:Caption")->addContent(strCaption);
1979	itemElementHelper = itemElement;
1980	pItemHelper = pItem->createChild(itemElementHelper.append("Caption").c_str());
1981	pItemHelper->addContent(strCaption);
1982	}
1983
1984	if (!strConnection.isEmpty())
1985	{
1986	//pItem->createChild("rasd:Connection")->addContent(strConnection);
1987	itemElementHelper = itemElement;
1988	pItemHelper = pItem->createChild(itemElementHelper.append("Connection").c_str());
1989	pItemHelper->addContent(strConnection);
1990	}
1991
1992	if (!strDescription.isEmpty())
1993	{
1994	//pItem->createChild("rasd:Description")->addContent(strDescription);
1995	itemElementHelper = itemElement;
1996	pItemHelper = pItem->createChild(itemElementHelper.append("Description").c_str());
1997	pItemHelper->addContent(strDescription);
1998	}
1999
2000	if (!strCaption.isEmpty())
2001	{
2002	if (enFormat == ovf::OVFVersion_1_0)
2003	{
2004	//pItem->createChild("rasd:ElementName")->addContent(strCaption);
2005	itemElementHelper = itemElement;
2006	pItemHelper = pItem->createChild(itemElementHelper.append("ElementName").c_str());
2007	pItemHelper->addContent(strCaption);
2008	}
2009	}
2010
2011	if (!strHostResource.isEmpty())
2012	{
2013	//pItem->createChild("rasd:HostResource")->addContent(strHostResource);
2014	itemElementHelper = itemElement;
2015	pItemHelper = pItem->createChild(itemElementHelper.append("HostResource").c_str());
2016	pItemHelper->addContent(strHostResource);
2017	}
2018
2019	{
2020	// <rasd:InstanceID>1</rasd:InstanceID>
2021	itemElementHelper = itemElement;
2022	if (enFormat == ovf::OVFVersion_0_9)
2023	//pelmInstanceID = pItem->createChild("rasd:InstanceId");
2024	pItemHelper = pItem->createChild(itemElementHelper.append("InstanceId").c_str());
2025	else
2026	//pelmInstanceID = pItem->createChild("rasd:InstanceID"); // capitalization changed...
2027	pItemHelper = pItem->createChild(itemElementHelper.append("InstanceID").c_str());
2028
2029	pItemHelper->addContent(Utf8StrFmt("%d", ulInstanceID++));
2030	}
2031
2032	if (ulParent)
2033	{
2034	//pItem->createChild("rasd:Parent")->addContent(Utf8StrFmt("%d", ulParent));
2035	itemElementHelper = itemElement;
2036	pItemHelper = pItem->createChild(itemElementHelper.append("Parent").c_str());
2037	pItemHelper->addContent(Utf8StrFmt("%d", ulParent));
2038	}
2039
2040	if (!strResourceSubType.isEmpty())
2041	{
2042	//pItem->createChild("rasd:ResourceSubType")->addContent(strResourceSubType);
2043	itemElementHelper = itemElement;
2044	pItemHelper = pItem->createChild(itemElementHelper.append("ResourceSubType").c_str());
2045	pItemHelper->addContent(strResourceSubType);
2046	}
2047
2048	{
2049	// <rasd:ResourceType>3</rasd:ResourceType>
2050	//pItem->createChild("rasd:ResourceType")->addContent(Utf8StrFmt("%d", type));
2051	itemElementHelper = itemElement;
2052	pItemHelper = pItem->createChild(itemElementHelper.append("ResourceType").c_str());
2053	pItemHelper->addContent(Utf8StrFmt("%d", type));
2054	}
2055
2056	// <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
2057	if (lVirtualQuantity != -1)
2058	{
2059	//pItem->createChild("rasd:VirtualQuantity")->addContent(Utf8StrFmt("%d", lVirtualQuantity));
2060	itemElementHelper = itemElement;
2061	pItemHelper = pItem->createChild(itemElementHelper.append("VirtualQuantity").c_str());
2062	pItemHelper->addContent(Utf8StrFmt("%d", lVirtualQuantity));
2063	}
2064	}
2065	}
2066	} // for (size_t uLoop = 1; uLoop <= 2; ++uLoop)
2067
2068	// now that we're done with the official OVF <Item> tags under <VirtualSystem>, write out VirtualBox XML
2069	// under the vbox: namespace
2070	xml::ElementNode *pelmVBoxMachine = pelmVirtualSystem->createChild("vbox:Machine");
2071	// ovf:required="false" tells other OVF parsers that they can ignore this thing
2072	pelmVBoxMachine->setAttribute("ovf:required", "false");
2073	// ovf:Info element is required or VMware will bail out on the vbox:Machine element
2074	pelmVBoxMachine->createChild("ovf:Info")->addContent("Complete VirtualBox machine configuration in VirtualBox format");
2075
2076	// create an empty machine config
2077	// use the same settings version as the current VM settings file
2078	settings::MachineConfigFile *pConfig = new settings::MachineConfigFile(&vsdescThis->m->pMachine->i_getSettingsFileFull());
2079
2080	writeLock.release();
2081	try
2082	{
2083	AutoWriteLock machineLock(vsdescThis->m->pMachine COMMA_LOCKVAL_SRC_POS);
2084	// fill the machine config
2085	vsdescThis->m->pMachine->i_copyMachineDataToSettings(*pConfig);
2086	pConfig->machineUserData.strName = strVMName;
2087
2088	// Apply export tweaks to machine settings
2089	bool fStripAllMACs = m->optListExport.contains(ExportOptions_StripAllMACs);
2090	bool fStripAllNonNATMACs = m->optListExport.contains(ExportOptions_StripAllNonNATMACs);
2091	if (fStripAllMACs \|\| fStripAllNonNATMACs)
2092	{
2093	for (settings::NetworkAdaptersList::iterator
2094	it = pConfig->hardwareMachine.llNetworkAdapters.begin();
2095	it != pConfig->hardwareMachine.llNetworkAdapters.end();
2096	++it)
2097	{
2098	settings::NetworkAdapter &nic = *it;
2099	if (fStripAllMACs \|\| (fStripAllNonNATMACs && nic.mode != NetworkAttachmentType_NAT))
2100	nic.strMACAddress.setNull();
2101	}
2102	}
2103
2104	// write the machine config to the vbox:Machine element
2105	pConfig->buildMachineXML(*pelmVBoxMachine,
2106	settings::MachineConfigFile::BuildMachineXML_WriteVBoxVersionAttribute
2107	/\| settings::MachineConfigFile::BuildMachineXML_SkipRemovableMedia/
2108	\| settings::MachineConfigFile::BuildMachineXML_SuppressSavedState,
2109	// but not BuildMachineXML_IncludeSnapshots nor BuildMachineXML_MediaRegistry
2110	pllElementsWithUuidAttributes);
2111	delete pConfig;
2112	}
2113	catch (...)
2114	{
2115	writeLock.acquire();
2116	delete pConfig;
2117	throw;
2118	}
2119	writeLock.acquire();
2120	}
2121
2122	/**
2123	* Actual worker code for writing out OVF/OVA to disk. This is called from Appliance::taskThreadWriteOVF()
2124	* and therefore runs on the OVF/OVA write worker thread.
2125	*
2126	* This runs in one context:
2127	*
2128	* 1) in a first worker thread; in that case, Appliance::Write() called Appliance::i_writeImpl();
2129	*
2130	* @param pTask
2131	* @return
2132	*/
2133	HRESULT Appliance::i_writeFS(TaskOVF *pTask)
2134	{
2135	LogFlowFuncEnter();
2136	LogFlowFunc(("ENTER appliance %p\n", this));
2137
2138	AutoCaller autoCaller(this);
2139	if (FAILED(autoCaller.rc())) return autoCaller.rc();
2140
2141	HRESULT rc = S_OK;
2142
2143	// Lock the media tree early to make sure nobody else tries to make changes
2144	// to the tree. Also lock the IAppliance object for writing.
2145	AutoMultiWriteLock2 multiLock(&mVirtualBox->i_getMediaTreeLockHandle(), this->lockHandle() COMMA_LOCKVAL_SRC_POS);
2146	// Additional protect the IAppliance object, cause we leave the lock
2147	// when starting the disk export and we don't won't block other
2148	// callers on this lengthy operations.
2149	m->state = ApplianceExporting;
2150
2151	if (pTask->locInfo.strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
2152	rc = i_writeFSOVF(pTask, multiLock);
2153	else
2154	rc = i_writeFSOVA(pTask, multiLock);
2155
2156	// reset the state so others can call methods again
2157	m->state = ApplianceIdle;
2158
2159	LogFlowFunc(("rc=%Rhrc\n", rc));
2160	LogFlowFuncLeave();
2161	return rc;
2162	}
2163
2164	HRESULT Appliance::i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock)
2165	{
2166	LogFlowFuncEnter();
2167
2168	/*
2169	* Create write-to-dir file system stream for the target directory.
2170	* This unifies the disk access with the TAR based OVA variant.
2171	*/
2172	HRESULT hrc;
2173	int vrc;
2174	RTVFSFSSTREAM hVfsFss2Dir = NIL_RTVFSFSSTREAM;
2175	try
2176	{
2177	Utf8Str strTargetDir(pTask->locInfo.strPath);
2178	strTargetDir.stripFilename();
2179	vrc = RTVfsFsStrmToNormalDir(strTargetDir.c_str(), 0 /fFlags/, &hVfsFss2Dir);
2180	if (RT_SUCCESS(vrc))
2181	hrc = S_OK;
2182	else
2183	hrc = setErrorVrc(vrc, tr("Failed to open directory '%s' (%Rrc)"), strTargetDir.c_str(), vrc);
2184	}
2185	catch (std::bad_alloc &)
2186	{
2187	hrc = E_OUTOFMEMORY;
2188	}
2189	if (SUCCEEDED(hrc))
2190	{
2191	/*
2192	* Join i_writeFSOVA. On failure, delete (undo) anything we might
2193	* have written to the disk before failing.
2194	*/
2195	hrc = i_writeFSImpl(pTask, writeLock, hVfsFss2Dir);
2196	if (FAILED(hrc))
2197	RTVfsFsStrmToDirUndo(hVfsFss2Dir);
2198	RTVfsFsStrmRelease(hVfsFss2Dir);
2199	}
2200
2201	LogFlowFuncLeave();
2202	return hrc;
2203	}
2204
2205	HRESULT Appliance::i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase &writeLock)
2206	{
2207	LogFlowFuncEnter();
2208
2209	/*
2210	* Open the output file and attach a TAR creator to it.
2211	* The OVF 1.1.0 spec specifies the TAR format to be compatible with USTAR
2212	* according to POSIX 1003.1-2008. We use the 1988 spec here as it's the
2213	* only variant we currently implement.
2214	*/
2215	HRESULT hrc;
2216	RTVFSIOSTREAM hVfsIosTar;
2217	int vrc = RTVfsIoStrmOpenNormal(pTask->locInfo.strPath.c_str(),
2218	RTFILE_O_CREATE \| RTFILE_O_WRITE \| RTFILE_O_DENY_WRITE,
2219	&hVfsIosTar);
2220	if (RT_SUCCESS(vrc))
2221	{
2222	RTVFSFSSTREAM hVfsFssTar;
2223	vrc = RTZipTarFsStreamToIoStream(hVfsIosTar, RTZIPTARFORMAT_USTAR, 0 /fFlags/, &hVfsFssTar);
2224	RTVfsIoStrmRelease(hVfsIosTar);
2225	if (RT_SUCCESS(vrc))
2226	{
2227	RTZipTarFsStreamSetFileMode(hVfsFssTar, 0660, 0440);
2228	RTZipTarFsStreamSetOwner(hVfsFssTar, VBOX_VERSION_MAJOR,
2229	pTask->enFormat == ovf::OVFVersion_0_9 ? "vboxovf09"
2230	: pTask->enFormat == ovf::OVFVersion_1_0 ? "vboxovf10"
2231	: pTask->enFormat == ovf::OVFVersion_2_0 ? "vboxovf20"
2232	: "vboxovf");
2233	RTZipTarFsStreamSetGroup(hVfsFssTar, VBOX_VERSION_MINOR,
2234	"vbox_v" RT_XSTR(VBOX_VERSION_MAJOR) "." RT_XSTR(VBOX_VERSION_MINOR) "."
2235	RT_XSTR(VBOX_VERSION_BUILD) "r" RT_XSTR(VBOX_SVN_REV));
2236
2237	hrc = i_writeFSImpl(pTask, writeLock, hVfsFssTar);
2238	RTVfsFsStrmRelease(hVfsFssTar);
2239	}
2240	else
2241	hrc = setErrorVrc(vrc, tr("Failed create TAR creator for '%s' (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
2242
2243	/* Delete the OVA on failure. */
2244	if (FAILED(hrc))
2245	RTFileDelete(pTask->locInfo.strPath.c_str());
2246	}
2247	else
2248	hrc = setErrorVrc(vrc, tr("Failed to open '%s' for writing (%Rrc)"), pTask->locInfo.strPath.c_str(), vrc);
2249
2250	LogFlowFuncLeave();
2251	return hrc;
2252	}
2253
2254	/**
2255	* Upload the image to the OCI Storage service, next import the
2256	* uploaded image into internal OCI image format and launch an
2257	* instance with this image in the OCI Compute service.
2258	*/
2259	HRESULT Appliance::i_exportCloudImpl(TaskCloud *pTask)
2260	{
2261	LogFlowFuncEnter();
2262
2263	HRESULT hrc = S_OK;
2264	ComPtr<ICloudProviderManager> cpm;
2265	hrc = mVirtualBox->COMGETTER(CloudProviderManager)(cpm.asOutParam());
2266	if (FAILED(hrc))
2267	return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%: Cloud provider manager object wasn't found", __FUNCTION__));
2268
2269	Utf8Str strProviderName = pTask->locInfo.strProvider;
2270	ComPtr<ICloudProvider> cloudProvider;
2271	ComPtr<ICloudProfile> cloudProfile;
2272	hrc = cpm->GetProviderByShortName(Bstr(strProviderName.c_str()).raw(), cloudProvider.asOutParam());
2273
2274	if (FAILED(hrc))
2275	return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud provider object wasn't found", __FUNCTION__));
2276
2277	ComPtr<IVirtualSystemDescription> vsd = m->virtualSystemDescriptions.front();
2278
2279	com::SafeArray<VirtualSystemDescriptionType_T> retTypes;
2280	com::SafeArray<BSTR> aRefs;
2281	com::SafeArray<BSTR> aOvfValues;
2282	com::SafeArray<BSTR> aVBoxValues;
2283	com::SafeArray<BSTR> aExtraConfigValues;
2284
2285	hrc = vsd->GetDescriptionByType(VirtualSystemDescriptionType_CloudProfileName,
2286	ComSafeArrayAsOutParam(retTypes),
2287	ComSafeArrayAsOutParam(aRefs),
2288	ComSafeArrayAsOutParam(aOvfValues),
2289	ComSafeArrayAsOutParam(aVBoxValues),
2290	ComSafeArrayAsOutParam(aExtraConfigValues));
2291	if (FAILED(hrc))
2292	return hrc;
2293
2294	Utf8Str profileName(aVBoxValues[0]);
2295	if (profileName.isEmpty())
2296	return setErrorVrc(VBOX_E_OBJECT_NOT_FOUND, tr("%s: Cloud user profile name wasn't found", __FUNCTION__));
2297
2298	hrc = cloudProvider->GetProfileByName(aVBoxValues[0], cloudProfile.asOutParam());
2299	if (FAILED(hrc))
2300	return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud profile object wasn't found", __FUNCTION__));
2301
2302	ComObjPtr<ICloudClient> cloudClient;
2303	hrc = cloudProfile->CreateCloudClient(cloudClient.asOutParam());
2304	if (FAILED(hrc))
2305	return setErrorVrc(VERR_COM_OBJECT_NOT_FOUND, tr("%s: Cloud client object wasn't found", __FUNCTION__));
2306
2307	if (m->virtualSystemDescriptions.size() == 1)
2308	{
2309	ComPtr<IVirtualBox> VBox(mVirtualBox);
2310	hrc = cloudClient->ExportVM(m->virtualSystemDescriptions.front(), pTask->pProgress, VBox);
2311	}
2312	else
2313	hrc = setErrorVrc(VERR_MISMATCH, tr("Export to Cloud isn't supported for more than one VM instance."));
2314
2315	LogFlowFuncLeave();
2316	return hrc;
2317	}
2318
2319
2320	/**
2321	* Writes the Oracle Public Cloud appliance.
2322	*
2323	* It expect raw disk images inside a gzipped tarball. We enable sparse files
2324	* to save diskspace on the target host system.
2325	*/
2326	HRESULT Appliance::i_writeFSOPC(TaskOPC *pTask)
2327	{
2328	LogFlowFuncEnter();
2329	HRESULT hrc = S_OK;
2330
2331	// Lock the media tree early to make sure nobody else tries to make changes
2332	// to the tree. Also lock the IAppliance object for writing.
2333	AutoMultiWriteLock2 multiLock(&mVirtualBox->i_getMediaTreeLockHandle(), this->lockHandle() COMMA_LOCKVAL_SRC_POS);
2334	// Additional protect the IAppliance object, cause we leave the lock
2335	// when starting the disk export and we don't won't block other
2336	// callers on this lengthy operations.
2337	m->state = ApplianceExporting;
2338
2339	/*
2340	* We're duplicating parts of i_writeFSImpl here because that's simpler
2341	* and creates less spaghetti code.
2342	*/
2343	std::list<Utf8Str> lstTarballs;
2344
2345	/*
2346	* Use i_buildXML to build a stack of disk images. We don't care about the XML doc here.
2347	*/
2348	XMLStack stack;
2349	{
2350	xml::Document doc;
2351	i_buildXML(multiLock, doc, stack, pTask->locInfo.strPath, ovf::OVFVersion_2_0);
2352	}
2353
2354	/*
2355	* Process the disk images.
2356	*/
2357	unsigned cTarballs = 0;
2358	for (list<Utf8Str>::const_iterator it = stack.mapDiskSequence.begin();
2359	it != stack.mapDiskSequence.end();
2360	++it)
2361	{
2362	const Utf8Str &strDiskID = *it;
2363	const VirtualSystemDescriptionEntry *pDiskEntry = stack.mapDisks[strDiskID];
2364	const Utf8Str &strSrcFilePath = pDiskEntry->strVBoxCurrent; // where the VBox image is
2365
2366	/*
2367	* Some skipping.
2368	*/
2369	if (pDiskEntry->skipIt)
2370	continue;
2371
2372	/* Skip empty media (DVD-ROM, floppy). */
2373	if (strSrcFilePath.isEmpty())
2374	continue;
2375
2376	/* Only deal with harddisk and DVD-ROMs, skip any floppies for now. */
2377	if ( pDiskEntry->type != VirtualSystemDescriptionType_HardDiskImage
2378	&& pDiskEntry->type != VirtualSystemDescriptionType_CDROM)
2379	continue;
2380
2381	/*
2382	* Locate the Medium object for this entry (by location/path).
2383	*/
2384	Log(("Finding source disk \"%s\"\n", strSrcFilePath.c_str()));
2385	ComObjPtr<Medium> ptrSourceDisk;
2386	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)
2387	hrc = mVirtualBox->i_findHardDiskByLocation(strSrcFilePath, true /aSetError/, &ptrSourceDisk);
2388	else
2389	hrc = mVirtualBox->i_findDVDOrFloppyImage(DeviceType_DVD, NULL /aId/, strSrcFilePath,
2390	true /aSetError/, &ptrSourceDisk);
2391	if (FAILED(hrc))
2392	break;
2393	if (strSrcFilePath.isEmpty())
2394	continue;
2395
2396	/*
2397	* Figure out the names.
2398	*/
2399
2400	/* The name inside the tarball. Replace the suffix of harddisk images with ".img". */
2401	Utf8Str strInsideName = pDiskEntry->strOvf;
2402	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)
2403	strInsideName.stripSuffix().append(".img");
2404
2405	/* The first tarball we create uses the specified name. Subsequent
2406	takes the name from the disk entry or something. */
2407	Utf8Str strTarballPath = pTask->locInfo.strPath;
2408	if (cTarballs > 0)
2409	{
2410	strTarballPath.stripFilename().append(RTPATH_SLASH_STR).append(pDiskEntry->strOvf);
2411	const char *pszExt = RTPathSuffix(pDiskEntry->strOvf.c_str());
2412	if (pszExt && pszExt[0] == '.' && pszExt[1] != '\0')
2413	{
2414	strTarballPath.stripSuffix();
2415	if (pDiskEntry->type != VirtualSystemDescriptionType_HardDiskImage)
2416	strTarballPath.append("_").append(&pszExt[1]);
2417	}
2418	strTarballPath.append(".tar.gz");
2419	}
2420	cTarballs++;
2421
2422	/*
2423	* Create the tar output stream.
2424	*/
2425	RTVFSIOSTREAM hVfsIosFile;
2426	int vrc = RTVfsIoStrmOpenNormal(strTarballPath.c_str(),
2427	RTFILE_O_CREATE \| RTFILE_O_WRITE \| RTFILE_O_DENY_WRITE,
2428	&hVfsIosFile);
2429	if (RT_SUCCESS(vrc))
2430	{
2431	RTVFSIOSTREAM hVfsIosGzip = NIL_RTVFSIOSTREAM;
2432	vrc = RTZipGzipCompressIoStream(hVfsIosFile, 0 /fFlags/, 6 /uLevel/, &hVfsIosGzip);
2433	RTVfsIoStrmRelease(hVfsIosFile);
2434
2435	/** @todo insert I/O thread here between gzip and the tar creator. Needs
2436	* implementing. */
2437
2438	RTVFSFSSTREAM hVfsFssTar = NIL_RTVFSFSSTREAM;
2439	if (RT_SUCCESS(vrc))
2440	vrc = RTZipTarFsStreamToIoStream(hVfsIosGzip, RTZIPTARFORMAT_GNU, RTZIPTAR_C_SPARSE, &hVfsFssTar);
2441	RTVfsIoStrmRelease(hVfsIosGzip);
2442	if (RT_SUCCESS(vrc))
2443	{
2444	RTZipTarFsStreamSetFileMode(hVfsFssTar, 0660, 0440);
2445	RTZipTarFsStreamSetOwner(hVfsFssTar, VBOX_VERSION_MAJOR, "vboxopc10");
2446	RTZipTarFsStreamSetGroup(hVfsFssTar, VBOX_VERSION_MINOR,
2447	"vbox_v" RT_XSTR(VBOX_VERSION_MAJOR) "." RT_XSTR(VBOX_VERSION_MINOR) "."
2448	RT_XSTR(VBOX_VERSION_BUILD) "r" RT_XSTR(VBOX_SVN_REV));
2449
2450	/*
2451	* Let the Medium code do the heavy work.
2452	*
2453	* The exporting requests a lock on the media tree. So temporarily
2454	* leave the appliance lock.
2455	*/
2456	multiLock.release();
2457
2458	pTask->pProgress->SetNextOperation(BstrFmt(tr("Exporting to disk image '%Rbn'"), strTarballPath.c_str()).raw(),
2459	pDiskEntry->ulSizeMB); // operation's weight, as set up
2460	// with the IProgress originally
2461	hrc = ptrSourceDisk->i_addRawToFss(strInsideName.c_str(), m->m_pSecretKeyStore, hVfsFssTar,
2462	pTask->pProgress, true /fSparse/);
2463
2464	multiLock.acquire();
2465	if (SUCCEEDED(hrc))
2466	{
2467	/*
2468	* Complete and close the tarball.
2469	*/
2470	vrc = RTVfsFsStrmEnd(hVfsFssTar);
2471	RTVfsFsStrmRelease(hVfsFssTar);
2472	hVfsFssTar = NIL_RTVFSFSSTREAM;
2473	if (RT_SUCCESS(vrc))
2474	{
2475	/* Remember the tarball name for cleanup. */
2476	try
2477	{
2478	lstTarballs.push_back(strTarballPath.c_str());
2479	strTarballPath.setNull();
2480	}
2481	catch (std::bad_alloc &)
2482	{ hrc = E_OUTOFMEMORY; }
2483	}
2484	else
2485	hrc = setErrorBoth(VBOX_E_FILE_ERROR, vrc,
2486	tr("Error completing TAR file '%s' (%Rrc)"), strTarballPath.c_str(), vrc);
2487	}
2488	}
2489	else
2490	hrc = setErrorVrc(vrc, tr("Failed to TAR creator instance for '%s' (%Rrc)"), strTarballPath.c_str(), vrc);
2491
2492	if (FAILED(hrc) && strTarballPath.isNotEmpty())
2493	RTFileDelete(strTarballPath.c_str());
2494	}
2495	else
2496	hrc = setErrorVrc(vrc, tr("Failed to create '%s' (%Rrc)"), strTarballPath.c_str(), vrc);
2497	if (FAILED(hrc))
2498	break;
2499	}
2500
2501	/*
2502	* Delete output files on failure.
2503	*/
2504	if (FAILED(hrc))
2505	for (list<Utf8Str>::const_iterator it = lstTarballs.begin(); it != lstTarballs.end(); ++it)
2506	RTFileDelete(it->c_str());
2507
2508	// reset the state so others can call methods again
2509	m->state = ApplianceIdle;
2510
2511	LogFlowFuncLeave();
2512	return hrc;
2513
2514	}
2515
2516	HRESULT Appliance::i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase &writeLock, RTVFSFSSTREAM hVfsFssDst)
2517	{
2518	LogFlowFuncEnter();
2519
2520	HRESULT rc = S_OK;
2521	int vrc;
2522	try
2523	{
2524	// the XML stack contains two maps for disks and networks, which allows us to
2525	// a) have a list of unique disk names (to make sure the same disk name is only added once)
2526	// and b) keep a list of all networks
2527	XMLStack stack;
2528	// Scope this to free the memory as soon as this is finished
2529	{
2530	/* Construct the OVF name. */
2531	Utf8Str strOvfFile(pTask->locInfo.strPath);
2532	strOvfFile.stripPath().stripSuffix().append(".ovf");
2533
2534	/* Render a valid ovf document into a memory buffer. The unknown
2535	version upgrade relates to the OPC hack up in Appliance::write(). */
2536	xml::Document doc;
2537	i_buildXML(writeLock, doc, stack, pTask->locInfo.strPath,
2538	pTask->enFormat != ovf::OVFVersion_unknown ? pTask->enFormat : ovf::OVFVersion_2_0);
2539
2540	void *pvBuf = NULL;
2541	size_t cbSize = 0;
2542	xml::XmlMemWriter writer;
2543	writer.write(doc, &pvBuf, &cbSize);
2544	if (RT_UNLIKELY(!pvBuf))
2545	throw setError(VBOX_E_FILE_ERROR, tr("Could not create OVF file '%s'"), strOvfFile.c_str());
2546
2547	/* Write the ovf file to "disk". */
2548	rc = i_writeBufferToFile(hVfsFssDst, strOvfFile.c_str(), pvBuf, cbSize);
2549	if (FAILED(rc))
2550	throw rc;
2551	}
2552
2553	// We need a proper format description
2554	ComObjPtr<MediumFormat> formatTemp;
2555
2556	ComObjPtr<MediumFormat> format;
2557	// Scope for the AutoReadLock
2558	{
2559	SystemProperties *pSysProps = mVirtualBox->i_getSystemProperties();
2560	AutoReadLock propsLock(pSysProps COMMA_LOCKVAL_SRC_POS);
2561	// We are always exporting to VMDK stream optimized for now
2562	formatTemp = pSysProps->i_mediumFormatFromExtension("iso");
2563
2564	format = pSysProps->i_mediumFormat("VMDK");
2565	if (format.isNull())
2566	throw setError(VBOX_E_NOT_SUPPORTED,
2567	tr("Invalid medium storage format"));
2568	}
2569
2570	// Finally, write out the disks!
2571	//use the list stack.mapDiskSequence where the disks were put as the "VirtualSystem"s had been placed
2572	//in the OVF description file. I.e. we have one "VirtualSystem" in the OVF file, we extract all disks
2573	//attached to it. And these disks are stored in the stack.mapDiskSequence. Next we shift to the next
2574	//"VirtualSystem" and repeat the operation.
2575	//And here we go through the list and extract all disks in the same sequence
2576	for (list<Utf8Str>::const_iterator
2577	it = stack.mapDiskSequence.begin();
2578	it != stack.mapDiskSequence.end();
2579	++it)
2580	{
2581	const Utf8Str &strDiskID = *it;
2582	const VirtualSystemDescriptionEntry *pDiskEntry = stack.mapDisks[strDiskID];
2583
2584	// source path: where the VBox image is
2585	const Utf8Str &strSrcFilePath = pDiskEntry->strVBoxCurrent;
2586
2587	//skip empty Medium. In common, It's may be empty CD/DVD
2588	if (strSrcFilePath.isEmpty() \|\|
2589	pDiskEntry->skipIt == true)
2590	continue;
2591
2592	// Do NOT check here whether the file exists. findHardDisk will
2593	// figure that out, and filesystem-based tests are simply wrong
2594	// in the general case (think of iSCSI).
2595
2596	// clone the disk:
2597	ComObjPtr<Medium> pSourceDisk;
2598
2599	Log(("Finding source disk \"%s\"\n", strSrcFilePath.c_str()));
2600
2601	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)
2602	{
2603	rc = mVirtualBox->i_findHardDiskByLocation(strSrcFilePath, true, &pSourceDisk);
2604	if (FAILED(rc)) throw rc;
2605	}
2606	else//may be CD or DVD
2607	{
2608	rc = mVirtualBox->i_findDVDOrFloppyImage(DeviceType_DVD,
2609	NULL,
2610	strSrcFilePath,
2611	true,
2612	&pSourceDisk);
2613	if (FAILED(rc)) throw rc;
2614	}
2615
2616	Bstr uuidSource;
2617	rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());
2618	if (FAILED(rc)) throw rc;
2619	Guid guidSource(uuidSource);
2620
2621	// output filename
2622	const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
2623
2624	// target path needs to be composed from where the output OVF is
2625	const Utf8Str &strTargetFilePath = strTargetFileNameOnly;
2626
2627	// The exporting requests a lock on the media tree. So leave our lock temporary.
2628	writeLock.release();
2629	try
2630	{
2631	// advance to the next operation
2632	pTask->pProgress->SetNextOperation(BstrFmt(tr("Exporting to disk image '%s'"),
2633	RTPathFilename(strTargetFilePath.c_str())).raw(),
2634	pDiskEntry->ulSizeMB); // operation's weight, as set up
2635	// with the IProgress originally
2636
2637	// create a flat copy of the source disk image
2638	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)
2639	{
2640	/*
2641	* Export a disk image.
2642	*/
2643	/* For compressed VMDK fun, we let i_exportFile produce the image bytes. */
2644	RTVFSIOSTREAM hVfsIosDst;
2645	vrc = RTVfsFsStrmPushFile(hVfsFssDst, strTargetFilePath.c_str(), UINT64_MAX,
2646	NULL /paObjInfo/, 0 /cObjInfo/, RTVFSFSSTRM_PUSH_F_STREAM, &hVfsIosDst);
2647	if (RT_FAILURE(vrc))
2648	throw setErrorVrc(vrc, tr("RTVfsFsStrmPushFile failed for '%s' (%Rrc)"), strTargetFilePath.c_str(), vrc);
2649	hVfsIosDst = i_manifestSetupDigestCalculationForGivenIoStream(hVfsIosDst, strTargetFilePath.c_str(),
2650	false /fRead/);
2651	if (hVfsIosDst == NIL_RTVFSIOSTREAM)
2652	throw setError(E_FAIL, "i_manifestSetupDigestCalculationForGivenIoStream(%s)", strTargetFilePath.c_str());
2653
2654	rc = pSourceDisk->i_exportFile(strTargetFilePath.c_str(),
2655	format,
2656	MediumVariant_VmdkStreamOptimized,
2657	m->m_pSecretKeyStore,
2658	hVfsIosDst,
2659	pTask->pProgress);
2660	RTVfsIoStrmRelease(hVfsIosDst);
2661	}
2662	else
2663	{
2664	/*
2665	* Copy CD/DVD/floppy image.
2666	*/
2667	Assert(pDiskEntry->type == VirtualSystemDescriptionType_CDROM);
2668	rc = pSourceDisk->i_addRawToFss(strTargetFilePath.c_str(), m->m_pSecretKeyStore, hVfsFssDst,
2669	pTask->pProgress, false /fSparse/);
2670	}
2671	if (FAILED(rc)) throw rc;
2672	}
2673	catch (HRESULT rc3)
2674	{
2675	writeLock.acquire();
2676	/// @todo file deletion on error? If not, we can remove that whole try/catch block.
2677	throw rc3;
2678	}
2679	// Finished, lock again (so nobody mess around with the medium tree
2680	// in the meantime)
2681	writeLock.acquire();
2682	}
2683
2684	if (m->fManifest)
2685	{
2686	// Create & write the manifest file
2687	Utf8Str strMfFilePath = Utf8Str(pTask->locInfo.strPath).stripSuffix().append(".mf");
2688	Utf8Str strMfFileName = Utf8Str(strMfFilePath).stripPath();
2689	pTask->pProgress->SetNextOperation(BstrFmt(tr("Creating manifest file '%s'"), strMfFileName.c_str()).raw(),
2690	m->ulWeightForManifestOperation); // operation's weight, as set up
2691	// with the IProgress originally);
2692	/* Create a memory I/O stream and write the manifest to it. */
2693	RTVFSIOSTREAM hVfsIosManifest;
2694	vrc = RTVfsMemIoStrmCreate(NIL_RTVFSIOSTREAM, _1K, &hVfsIosManifest);
2695	if (RT_FAILURE(vrc))
2696	throw setErrorVrc(vrc, tr("RTVfsMemIoStrmCreate failed (%Rrc)"), vrc);
2697	if (m->hOurManifest != NIL_RTMANIFEST) /* In case it's empty. */
2698	vrc = RTManifestWriteStandard(m->hOurManifest, hVfsIosManifest);
2699	if (RT_SUCCESS(vrc))
2700	{
2701	/* Rewind the stream and add it to the output. */
2702	size_t cbIgnored;
2703	vrc = RTVfsIoStrmReadAt(hVfsIosManifest, 0 /offset/, &cbIgnored, 0, true /fBlocking/, &cbIgnored);
2704	if (RT_SUCCESS(vrc))
2705	{
2706	RTVFSOBJ hVfsObjManifest = RTVfsObjFromIoStream(hVfsIosManifest);
2707	vrc = RTVfsFsStrmAdd(hVfsFssDst, strMfFileName.c_str(), hVfsObjManifest, 0 /fFlags/);
2708	if (RT_SUCCESS(vrc))
2709	rc = S_OK;
2710	else
2711	rc = setErrorVrc(vrc, tr("RTVfsFsStrmAdd failed for the manifest (%Rrc)"), vrc);
2712	}
2713	else
2714	rc = setErrorVrc(vrc, tr("RTManifestWriteStandard failed (%Rrc)"), vrc);
2715	}
2716	else
2717	rc = setErrorVrc(vrc, tr("RTManifestWriteStandard failed (%Rrc)"), vrc);
2718	RTVfsIoStrmRelease(hVfsIosManifest);
2719	if (FAILED(rc))
2720	throw rc;
2721	}
2722	}
2723	catch (RTCError &x) // includes all XML exceptions
2724	{
2725	rc = setError(VBOX_E_FILE_ERROR,
2726	x.what());
2727	}
2728	catch (HRESULT aRC)
2729	{
2730	rc = aRC;
2731	}
2732
2733	LogFlowFunc(("rc=%Rhrc\n", rc));
2734	LogFlowFuncLeave();
2735
2736	return rc;
2737	}
2738
2739
2740	/**
2741	* Writes a memory buffer to a file in the output file system stream.
2742	*
2743	* @returns COM status code.
2744	* @param hVfsFssDst The file system stream to add the file to.
2745	* @param pszFilename The file name (w/ path if desired).
2746	* @param pvContent Pointer to buffer containing the file content.
2747	* @param cbContent Size of the content.
2748	*/
2749	HRESULT Appliance::i_writeBufferToFile(RTVFSFSSTREAM hVfsFssDst, const char pszFilename, const void pvContent, size_t cbContent)
2750	{
2751	/*
2752	* Create a VFS file around the memory, converting it to a base VFS object handle.
2753	*/
2754	HRESULT hrc;
2755	RTVFSIOSTREAM hVfsIosSrc;
2756	int vrc = RTVfsIoStrmFromBuffer(RTFILE_O_READ, pvContent, cbContent, &hVfsIosSrc);
2757	if (RT_SUCCESS(vrc))
2758	{
2759	hVfsIosSrc = i_manifestSetupDigestCalculationForGivenIoStream(hVfsIosSrc, pszFilename);
2760	AssertReturn(hVfsIosSrc != NIL_RTVFSIOSTREAM,
2761	setErrorVrc(vrc, "i_manifestSetupDigestCalculationForGivenIoStream"));
2762
2763	RTVFSOBJ hVfsObj = RTVfsObjFromIoStream(hVfsIosSrc);
2764	RTVfsIoStrmRelease(hVfsIosSrc);
2765	AssertReturn(hVfsObj != NIL_RTVFSOBJ, E_FAIL);
2766
2767	/*
2768	* Add it to the stream.
2769	*/
2770	vrc = RTVfsFsStrmAdd(hVfsFssDst, pszFilename, hVfsObj, 0);
2771	RTVfsObjRelease(hVfsObj);
2772	if (RT_SUCCESS(vrc))
2773	hrc = S_OK;
2774	else
2775	hrc = setErrorVrc(vrc, tr("RTVfsFsStrmAdd failed for '%s' (%Rrc)"), pszFilename, vrc);
2776	}
2777	else
2778	hrc = setErrorVrc(vrc, "RTVfsIoStrmFromBuffer");
2779	return hrc;
2780	}
2781

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-server/ApplianceImplExport.cpp@ 79812

Download in other formats: