ApplianceImplExport.cpp@ 59090

Last change on this file since 59090 was 58005, checked in by vboxsync, 9 years ago
pr7179. Part related to Appliance class and TaskOVF tasks like import, export, reading.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 112.1 KB

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

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

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

Download in other formats: