ApplianceImplExport.cpp@ 61644

Last change on this file since 61644 was 59578, checked in by vboxsync, 9 years ago
Main: Removed the VBOX_WITH_S3 code because we haven't maintained it properly for years.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 104.1 KB

Line
1	/* $Id: ApplianceImplExport.cpp 59578 2016-02-04 14:19:58Z 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	* @param aFormat
739	* @param aLocInfo
740	* @param aProgress
741	* @return
742	*/
743	HRESULT Appliance::i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)
744	{
745	HRESULT rc = S_OK;
746	try
747	{
748	rc = i_setUpProgress(aProgress,
749	BstrFmt(tr("Export appliance '%s'"), aLocInfo.strPath.c_str()),
750	(aLocInfo.storageType == VFSType_File) ? WriteFile : WriteS3);
751
752	/* Initialize our worker task */
753	TaskOVF* task = NULL;
754	try
755	{
756	task = new TaskOVF(this, TaskOVF::Write, aLocInfo, aProgress);
757	}
758	catch(...)
759	{
760	delete task;
761	throw rc = setError(VBOX_E_OBJECT_NOT_FOUND,
762	tr("Could not create TaskOVF object for for writing out the OVF to disk"));
763	}
764
765	/* The OVF version to write */
766	task->enFormat = aFormat;
767
768	rc = task->createThread();
769	if (FAILED(rc)) throw rc;
770
771	}
772	catch (HRESULT aRC)
773	{
774	rc = aRC;
775	}
776
777	return rc;
778	}
779
780	/**
781	* Called from Appliance::i_writeFS() for creating a XML document for this
782	* Appliance.
783	*
784	* @param writeLock The current write lock.
785	* @param doc The xml document to fill.
786	* @param stack Structure for temporary private
787	* data shared with caller.
788	* @param strPath Path to the target OVF.
789	* instance for which to write XML.
790	* @param enFormat OVF format (0.9 or 1.0).
791	*/
792	void Appliance::i_buildXML(AutoWriteLockBase& writeLock,
793	xml::Document &doc,
794	XMLStack &stack,
795	const Utf8Str &strPath,
796	ovf::OVFVersion_T enFormat)
797	{
798	xml::ElementNode *pelmRoot = doc.createRootElement("Envelope");
799
800	pelmRoot->setAttribute("ovf:version", enFormat == ovf::OVFVersion_2_0 ? "2.0"
801	: enFormat == ovf::OVFVersion_1_0 ? "1.0"
802	: "0.9");
803	pelmRoot->setAttribute("xml:lang", "en-US");
804
805	Utf8Str strNamespace;
806
807	if (enFormat == ovf::OVFVersion_0_9)
808	{
809	strNamespace = ovf::OVF09_URI_string;
810	}
811	else if (enFormat == ovf::OVFVersion_1_0)
812	{
813	strNamespace = ovf::OVF10_URI_string;
814	}
815	else
816	{
817	strNamespace = ovf::OVF20_URI_string;
818	}
819
820	pelmRoot->setAttribute("xmlns", strNamespace);
821	pelmRoot->setAttribute("xmlns:ovf", strNamespace);
822
823	// pelmRoot->setAttribute("xmlns:ovfstr", "http://schema.dmtf.org/ovf/strings/1");
824	pelmRoot->setAttribute("xmlns:rasd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData");
825	pelmRoot->setAttribute("xmlns:vssd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData");
826	pelmRoot->setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
827	pelmRoot->setAttribute("xmlns:vbox", "http://www.virtualbox.org/ovf/machine");
828	// pelmRoot->setAttribute("xsi:schemaLocation", "http://schemas.dmtf.org/ovf/envelope/1 ../ovf-envelope.xsd");
829
830	if (enFormat == ovf::OVFVersion_2_0)
831	{
832	pelmRoot->setAttribute("xmlns:epasd",
833	"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_EthernetPortAllocationSettingData.xsd");
834	pelmRoot->setAttribute("xmlns:sasd",
835	"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_StorageAllocationSettingData.xsd");
836	}
837
838	// <Envelope>/<References>
839	xml::ElementNode *pelmReferences = pelmRoot->createChild("References"); // 0.9 and 1.0
840
841	/* <Envelope>/<DiskSection>:
842	<DiskSection>
843	<Info>List of the virtual disks used in the package</Info>
844	<Disk ovf:capacity="4294967296" ovf:diskId="lamp" ovf:format="..." ovf:populatedSize="1924967692"/>
845	</DiskSection> */
846	xml::ElementNode *pelmDiskSection;
847	if (enFormat == ovf::OVFVersion_0_9)
848	{
849	// <Section xsi:type="ovf:DiskSection_Type">
850	pelmDiskSection = pelmRoot->createChild("Section");
851	pelmDiskSection->setAttribute("xsi:type", "ovf:DiskSection_Type");
852	}
853	else
854	pelmDiskSection = pelmRoot->createChild("DiskSection");
855
856	xml::ElementNode *pelmDiskSectionInfo = pelmDiskSection->createChild("Info");
857	pelmDiskSectionInfo->addContent("List of the virtual disks used in the package");
858
859	/* <Envelope>/<NetworkSection>:
860	<NetworkSection>
861	<Info>Logical networks used in the package</Info>
862	<Network ovf:name="VM Network">
863	<Description>The network that the LAMP Service will be available on</Description>
864	</Network>
865	</NetworkSection> */
866	xml::ElementNode *pelmNetworkSection;
867	if (enFormat == ovf::OVFVersion_0_9)
868	{
869	// <Section xsi:type="ovf:NetworkSection_Type">
870	pelmNetworkSection = pelmRoot->createChild("Section");
871	pelmNetworkSection->setAttribute("xsi:type", "ovf:NetworkSection_Type");
872	}
873	else
874	pelmNetworkSection = pelmRoot->createChild("NetworkSection");
875
876	xml::ElementNode *pelmNetworkSectionInfo = pelmNetworkSection->createChild("Info");
877	pelmNetworkSectionInfo->addContent("Logical networks used in the package");
878
879	// and here come the virtual systems:
880
881	// write a collection if we have more than one virtual system _and_ we're
882	// writing OVF 1.0; otherwise fail since ovftool can't import more than
883	// one machine, it seems
884	xml::ElementNode *pelmToAddVirtualSystemsTo;
885	if (m->virtualSystemDescriptions.size() > 1)
886	{
887	if (enFormat == ovf::OVFVersion_0_9)
888	throw setError(VBOX_E_FILE_ERROR,
889	tr("Cannot export more than one virtual system with OVF 0.9, use OVF 1.0"));
890
891	pelmToAddVirtualSystemsTo = pelmRoot->createChild("VirtualSystemCollection");
892	pelmToAddVirtualSystemsTo->setAttribute("ovf:name", "ExportedVirtualBoxMachines"); // whatever
893	}
894	else
895	pelmToAddVirtualSystemsTo = pelmRoot; // add virtual system directly under root element
896
897	// this list receives pointers to the XML elements in the machine XML which
898	// might have UUIDs that need fixing after we know the UUIDs of the exported images
899	std::list<xml::ElementNode*> llElementsWithUuidAttributes;
900
901	list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
902	/* Iterate through all virtual systems of that appliance */
903	for (it = m->virtualSystemDescriptions.begin();
904	it != m->virtualSystemDescriptions.end();
905	++it)
906	{
907	ComObjPtr<VirtualSystemDescription> vsdescThis = *it;
908	i_buildXMLForOneVirtualSystem(writeLock,
909	*pelmToAddVirtualSystemsTo,
910	&llElementsWithUuidAttributes,
911	vsdescThis,
912	enFormat,
913	stack); // disks and networks stack
914	}
915
916	// now, fill in the network section we set up empty above according
917	// to the networks we found with the hardware items
918	map<Utf8Str, bool>::const_iterator itN;
919	for (itN = stack.mapNetworks.begin();
920	itN != stack.mapNetworks.end();
921	++itN)
922	{
923	const Utf8Str &strNetwork = itN->first;
924	xml::ElementNode *pelmNetwork = pelmNetworkSection->createChild("Network");
925	pelmNetwork->setAttribute("ovf:name", strNetwork.c_str());
926	pelmNetwork->createChild("Description")->addContent("Logical network used by this appliance.");
927	}
928
929	// Finally, write out the disk info
930	list<Utf8Str> diskList;
931	map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;
932	uint32_t ulFile = 1;
933	for (itS = stack.mapDisks.begin();
934	itS != stack.mapDisks.end();
935	++itS)
936	{
937	const Utf8Str &strDiskID = itS->first;
938	const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;
939
940	// source path: where the VBox image is
941	const Utf8Str &strSrcFilePath = pDiskEntry->strVBoxCurrent;
942	Bstr bstrSrcFilePath(strSrcFilePath);
943
944	//skip empty Medium. There are no information to add into section <References> or <DiskSection>
945	if (strSrcFilePath.isEmpty() \|\|
946	pDiskEntry->skipIt == true)
947	continue;
948
949	// Do NOT check here whether the file exists. FindMedium will figure
950	// that out, and filesystem-based tests are simply wrong in the
951	// general case (think of iSCSI).
952
953	// We need some info from the source disks
954	ComPtr<IMedium> pSourceDisk;
955	//DeviceType_T deviceType = DeviceType_HardDisk;// by default
956
957	Log(("Finding source disk \"%ls\"\n", bstrSrcFilePath.raw()));
958
959	HRESULT rc;
960
961	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)
962	{
963	rc = mVirtualBox->OpenMedium(bstrSrcFilePath.raw(),
964	DeviceType_HardDisk,
965	AccessMode_ReadWrite,
966	FALSE /* fForceNewUuid */,
967	pSourceDisk.asOutParam());
968	if (FAILED(rc))
969	throw rc;
970	}
971	else if (pDiskEntry->type == VirtualSystemDescriptionType_CDROM)//may be, this is CD/DVD
972	{
973	rc = mVirtualBox->OpenMedium(bstrSrcFilePath.raw(),
974	DeviceType_DVD,
975	AccessMode_ReadOnly,
976	FALSE,
977	pSourceDisk.asOutParam());
978	if (FAILED(rc))
979	throw rc;
980	}
981
982	Bstr uuidSource;
983	rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());
984	if (FAILED(rc)) throw rc;
985	Guid guidSource(uuidSource);
986
987	// output filename
988	const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
989	// target path needs to be composed from where the output OVF is
990	Utf8Str strTargetFilePath(strPath);
991	strTargetFilePath.stripFilename();
992	strTargetFilePath.append("/");
993	strTargetFilePath.append(strTargetFileNameOnly);
994
995	// We are always exporting to VMDK stream optimized for now
996	//Bstr bstrSrcFormat = L"VMDK";//not used
997
998	diskList.push_back(strTargetFilePath);
999
1000	LONG64 cbCapacity = 0; // size reported to guest
1001	rc = pSourceDisk->COMGETTER(LogicalSize)(&cbCapacity);
1002	if (FAILED(rc)) throw rc;
1003	// Todo r=poetzsch: wrong it is reported in bytes ...
1004	// capacity is reported in megabytes, so...
1005	//cbCapacity *= _1M;
1006
1007	Guid guidTarget; /* Creates a new uniq number for the target disk. */
1008	guidTarget.create();
1009
1010	// now handle the XML for the disk:
1011	Utf8StrFmt strFileRef("file%RI32", ulFile++);
1012	// <File ovf:href="WindowsXpProfessional-disk1.vmdk" ovf:id="file1" ovf:size="1710381056"/>
1013	xml::ElementNode *pelmFile = pelmReferences->createChild("File");
1014	pelmFile->setAttribute("ovf:href", strTargetFileNameOnly);
1015	pelmFile->setAttribute("ovf:id", strFileRef);
1016	// Todo: the actual size is not available at this point of time,
1017	// cause the disk will be compressed. The 1.0 standard says this is
1018	// optional! 1.1 isn't fully clear if the "gzip" format is used.
1019	// Need to be checked. */
1020	// pelmFile->setAttribute("ovf:size", Utf8StrFmt("%RI64", cbFile).c_str());
1021
1022	// add disk to XML Disks section
1023	// <Disk ovf:capacity="8589934592" ovf:diskId="vmdisk1" ovf:fileRef="file1" ovf:format="..."/>
1024	xml::ElementNode *pelmDisk = pelmDiskSection->createChild("Disk");
1025	pelmDisk->setAttribute("ovf:capacity", Utf8StrFmt("%RI64", cbCapacity).c_str());
1026	pelmDisk->setAttribute("ovf:diskId", strDiskID);
1027	pelmDisk->setAttribute("ovf:fileRef", strFileRef);
1028
1029	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)//deviceType == DeviceType_HardDisk
1030	{
1031	pelmDisk->setAttribute("ovf:format",
1032	(enFormat == ovf::OVFVersion_0_9)
1033	? "http://www.vmware.com/specifications/vmdk.html#sparse" // must be sparse or ovftool ch
1034	: "http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized"
1035	// correct string as communicated to us by VMware (public bug #6612)
1036	);
1037	}
1038	else //pDiskEntry->type == VirtualSystemDescriptionType_CDROM, deviceType == DeviceType_DVD
1039	{
1040	pelmDisk->setAttribute("ovf:format",
1041	"http://www.ecma-international.org/publications/standards/Ecma-119.htm"
1042	);
1043	}
1044
1045	// add the UUID of the newly target image to the OVF disk element, but in the
1046	// vbox: namespace since it's not part of the standard
1047	pelmDisk->setAttribute("vbox:uuid", Utf8StrFmt("%RTuuid", guidTarget.raw()).c_str());
1048
1049	// now, we might have other XML elements from vbox:Machine pointing to this image,
1050	// but those would refer to the UUID of the _source_ image (which we created the
1051	// export image from); those UUIDs need to be fixed to the export image
1052	Utf8Str strGuidSourceCurly = guidSource.toStringCurly();
1053	for (std::list<xml::ElementNode*>::iterator eit = llElementsWithUuidAttributes.begin();
1054	eit != llElementsWithUuidAttributes.end();
1055	++eit)
1056	{
1057	xml::ElementNode pelmImage = eit;
1058	Utf8Str strUUID;
1059	pelmImage->getAttributeValue("uuid", strUUID);
1060	if (strUUID == strGuidSourceCurly)
1061	// overwrite existing uuid attribute
1062	pelmImage->setAttribute("uuid", guidTarget.toStringCurly());
1063	}
1064	}
1065	}
1066
1067	/**
1068	* Called from Appliance::i_buildXML() for each virtual system (machine) that
1069	* needs XML written out.
1070	*
1071	* @param writeLock The current write lock.
1072	* @param elmToAddVirtualSystemsTo XML element to append elements to.
1073	* @param pllElementsWithUuidAttributes out: list of XML elements produced here
1074	* with UUID attributes for quick
1075	* fixing by caller later
1076	* @param vsdescThis The IVirtualSystemDescription
1077	* instance for which to write XML.
1078	* @param enFormat OVF format (0.9 or 1.0).
1079	* @param stack Structure for temporary private
1080	* data shared with caller.
1081	*/
1082	void Appliance::i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
1083	xml::ElementNode &elmToAddVirtualSystemsTo,
1084	std::list<xml::ElementNode> pllElementsWithUuidAttributes,
1085	ComObjPtr<VirtualSystemDescription> &vsdescThis,
1086	ovf::OVFVersion_T enFormat,
1087	XMLStack &stack)
1088	{
1089	LogFlowFunc(("ENTER appliance %p\n", this));
1090
1091	xml::ElementNode *pelmVirtualSystem;
1092	if (enFormat == ovf::OVFVersion_0_9)
1093	{
1094	// <Section xsi:type="ovf:NetworkSection_Type">
1095	pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("Content");
1096	pelmVirtualSystem->setAttribute("xsi:type", "ovf:VirtualSystem_Type");
1097	}
1098	else
1099	pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("VirtualSystem");
1100
1101	/xml::ElementNode pelmVirtualSystemInfo =*/ pelmVirtualSystem->createChild("Info")->addContent("A virtual machine");
1102
1103	std::list<VirtualSystemDescriptionEntry*> llName = vsdescThis->i_findByType(VirtualSystemDescriptionType_Name);
1104	if (llName.empty())
1105	throw setError(VBOX_E_NOT_SUPPORTED, tr("Missing VM name"));
1106	Utf8Str &strVMName = llName.back()->strVBoxCurrent;
1107	pelmVirtualSystem->setAttribute("ovf:id", strVMName);
1108
1109	// product info
1110	std::list<VirtualSystemDescriptionEntry*> llProduct = vsdescThis->i_findByType(VirtualSystemDescriptionType_Product);
1111	std::list<VirtualSystemDescriptionEntry*> llProductUrl = vsdescThis->i_findByType(VirtualSystemDescriptionType_ProductUrl);
1112	std::list<VirtualSystemDescriptionEntry*> llVendor = vsdescThis->i_findByType(VirtualSystemDescriptionType_Vendor);
1113	std::list<VirtualSystemDescriptionEntry*> llVendorUrl = vsdescThis->i_findByType(VirtualSystemDescriptionType_VendorUrl);
1114	std::list<VirtualSystemDescriptionEntry*> llVersion = vsdescThis->i_findByType(VirtualSystemDescriptionType_Version);
1115	bool fProduct = llProduct.size() && !llProduct.back()->strVBoxCurrent.isEmpty();
1116	bool fProductUrl = llProductUrl.size() && !llProductUrl.back()->strVBoxCurrent.isEmpty();
1117	bool fVendor = llVendor.size() && !llVendor.back()->strVBoxCurrent.isEmpty();
1118	bool fVendorUrl = llVendorUrl.size() && !llVendorUrl.back()->strVBoxCurrent.isEmpty();
1119	bool fVersion = llVersion.size() && !llVersion.back()->strVBoxCurrent.isEmpty();
1120	if (fProduct \|\| fProductUrl \|\| fVendor \|\| fVendorUrl \|\| fVersion)
1121	{
1122	/* <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
1123	<Info>Meta-information about the installed software</Info>
1124	<Product>VAtest</Product>
1125	<Vendor>SUN Microsystems</Vendor>
1126	<Version>10.0</Version>
1127	<ProductUrl>http://blogs.sun.com/VirtualGuru</ProductUrl>
1128	<VendorUrl>http://www.sun.com</VendorUrl>
1129	</Section> */
1130	xml::ElementNode *pelmAnnotationSection;
1131	if (enFormat == ovf::OVFVersion_0_9)
1132	{
1133	// <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
1134	pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
1135	pelmAnnotationSection->setAttribute("xsi:type", "ovf:ProductSection_Type");
1136	}
1137	else
1138	pelmAnnotationSection = pelmVirtualSystem->createChild("ProductSection");
1139
1140	pelmAnnotationSection->createChild("Info")->addContent("Meta-information about the installed software");
1141	if (fProduct)
1142	pelmAnnotationSection->createChild("Product")->addContent(llProduct.back()->strVBoxCurrent);
1143	if (fVendor)
1144	pelmAnnotationSection->createChild("Vendor")->addContent(llVendor.back()->strVBoxCurrent);
1145	if (fVersion)
1146	pelmAnnotationSection->createChild("Version")->addContent(llVersion.back()->strVBoxCurrent);
1147	if (fProductUrl)
1148	pelmAnnotationSection->createChild("ProductUrl")->addContent(llProductUrl.back()->strVBoxCurrent);
1149	if (fVendorUrl)
1150	pelmAnnotationSection->createChild("VendorUrl")->addContent(llVendorUrl.back()->strVBoxCurrent);
1151	}
1152
1153	// description
1154	std::list<VirtualSystemDescriptionEntry*> llDescription = vsdescThis->i_findByType(VirtualSystemDescriptionType_Description);
1155	if (llDescription.size() &&
1156	!llDescription.back()->strVBoxCurrent.isEmpty())
1157	{
1158	/* <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
1159	<Info>A human-readable annotation</Info>
1160	<Annotation>Plan 9</Annotation>
1161	</Section> */
1162	xml::ElementNode *pelmAnnotationSection;
1163	if (enFormat == ovf::OVFVersion_0_9)
1164	{
1165	// <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
1166	pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
1167	pelmAnnotationSection->setAttribute("xsi:type", "ovf:AnnotationSection_Type");
1168	}
1169	else
1170	pelmAnnotationSection = pelmVirtualSystem->createChild("AnnotationSection");
1171
1172	pelmAnnotationSection->createChild("Info")->addContent("A human-readable annotation");
1173	pelmAnnotationSection->createChild("Annotation")->addContent(llDescription.back()->strVBoxCurrent);
1174	}
1175
1176	// license
1177	std::list<VirtualSystemDescriptionEntry*> llLicense = vsdescThis->i_findByType(VirtualSystemDescriptionType_License);
1178	if (llLicense.size() &&
1179	!llLicense.back()->strVBoxCurrent.isEmpty())
1180	{
1181	/* <EulaSection>
1182	<Info ovf:msgid="6">License agreement for the Virtual System.</Info>
1183	<License ovf:msgid="1">License terms can go in here.</License>
1184	</EulaSection> */
1185	xml::ElementNode *pelmEulaSection;
1186	if (enFormat == ovf::OVFVersion_0_9)
1187	{
1188	pelmEulaSection = pelmVirtualSystem->createChild("Section");
1189	pelmEulaSection->setAttribute("xsi:type", "ovf:EulaSection_Type");
1190	}
1191	else
1192	pelmEulaSection = pelmVirtualSystem->createChild("EulaSection");
1193
1194	pelmEulaSection->createChild("Info")->addContent("License agreement for the virtual system");
1195	pelmEulaSection->createChild("License")->addContent(llLicense.back()->strVBoxCurrent);
1196	}
1197
1198	// operating system
1199	std::list<VirtualSystemDescriptionEntry*> llOS = vsdescThis->i_findByType(VirtualSystemDescriptionType_OS);
1200	if (llOS.empty())
1201	throw setError(VBOX_E_NOT_SUPPORTED, tr("Missing OS type"));
1202	/* <OperatingSystemSection ovf:id="82">
1203	<Info>Guest Operating System</Info>
1204	<Description>Linux 2.6.x</Description>
1205	</OperatingSystemSection> */
1206	VirtualSystemDescriptionEntry *pvsdeOS = llOS.back();
1207	xml::ElementNode *pelmOperatingSystemSection;
1208	if (enFormat == ovf::OVFVersion_0_9)
1209	{
1210	pelmOperatingSystemSection = pelmVirtualSystem->createChild("Section");
1211	pelmOperatingSystemSection->setAttribute("xsi:type", "ovf:OperatingSystemSection_Type");
1212	}
1213	else
1214	pelmOperatingSystemSection = pelmVirtualSystem->createChild("OperatingSystemSection");
1215
1216	pelmOperatingSystemSection->setAttribute("ovf:id", pvsdeOS->strOvf);
1217	pelmOperatingSystemSection->createChild("Info")->addContent("The kind of installed guest operating system");
1218	Utf8Str strOSDesc;
1219	convertCIMOSType2VBoxOSType(strOSDesc, (ovf::CIMOSType_T)pvsdeOS->strOvf.toInt32(), "");
1220	pelmOperatingSystemSection->createChild("Description")->addContent(strOSDesc);
1221	// add the VirtualBox ostype in a custom tag in a different namespace
1222	xml::ElementNode *pelmVBoxOSType = pelmOperatingSystemSection->createChild("vbox:OSType");
1223	pelmVBoxOSType->setAttribute("ovf:required", "false");
1224	pelmVBoxOSType->addContent(pvsdeOS->strVBoxCurrent);
1225
1226	// <VirtualHardwareSection ovf:id="hw1" ovf:transport="iso">
1227	xml::ElementNode *pelmVirtualHardwareSection;
1228	if (enFormat == ovf::OVFVersion_0_9)
1229	{
1230	// <Section xsi:type="ovf:VirtualHardwareSection_Type">
1231	pelmVirtualHardwareSection = pelmVirtualSystem->createChild("Section");
1232	pelmVirtualHardwareSection->setAttribute("xsi:type", "ovf:VirtualHardwareSection_Type");
1233	}
1234	else
1235	pelmVirtualHardwareSection = pelmVirtualSystem->createChild("VirtualHardwareSection");
1236
1237	pelmVirtualHardwareSection->createChild("Info")->addContent("Virtual hardware requirements for a virtual machine");
1238
1239	/* <System>
1240	<vssd:Description>Description of the virtual hardware section.</vssd:Description>
1241	<vssd:ElementName>vmware</vssd:ElementName>
1242	<vssd:InstanceID>1</vssd:InstanceID>
1243	<vssd:VirtualSystemIdentifier>MyLampService</vssd:VirtualSystemIdentifier>
1244	<vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
1245	</System> */
1246	xml::ElementNode *pelmSystem = pelmVirtualHardwareSection->createChild("System");
1247
1248	pelmSystem->createChild("vssd:ElementName")->addContent("Virtual Hardware Family"); // required OVF 1.0
1249
1250	// <vssd:InstanceId>0</vssd:InstanceId>
1251	if (enFormat == ovf::OVFVersion_0_9)
1252	pelmSystem->createChild("vssd:InstanceId")->addContent("0");
1253	else // capitalization changed...
1254	pelmSystem->createChild("vssd:InstanceID")->addContent("0");
1255
1256	// <vssd:VirtualSystemIdentifier>VAtest</vssd:VirtualSystemIdentifier>
1257	pelmSystem->createChild("vssd:VirtualSystemIdentifier")->addContent(strVMName);
1258	// <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
1259	const char *pcszHardware = "virtualbox-2.2";
1260	if (enFormat == ovf::OVFVersion_0_9)
1261	// pretend to be vmware compatible then
1262	pcszHardware = "vmx-6";
1263	pelmSystem->createChild("vssd:VirtualSystemType")->addContent(pcszHardware);
1264
1265	// loop thru all description entries twice; once to write out all
1266	// devices _except_ disk images, and a second time to assign the
1267	// disk images; this is because disk images need to reference
1268	// IDE controllers, and we can't know their instance IDs without
1269	// assigning them first
1270
1271	uint32_t idIDEPrimaryController = 0;
1272	int32_t lIDEPrimaryControllerIndex = 0;
1273	uint32_t idIDESecondaryController = 0;
1274	int32_t lIDESecondaryControllerIndex = 0;
1275	uint32_t idSATAController = 0;
1276	int32_t lSATAControllerIndex = 0;
1277	uint32_t idSCSIController = 0;
1278	int32_t lSCSIControllerIndex = 0;
1279
1280	uint32_t ulInstanceID = 1;
1281
1282	uint32_t cDVDs = 0;
1283
1284	for (size_t uLoop = 1; uLoop <= 2; ++uLoop)
1285	{
1286	int32_t lIndexThis = 0;
1287	vector<VirtualSystemDescriptionEntry>::const_iterator itD;
1288	for (itD = vsdescThis->m->maDescriptions.begin();
1289	itD != vsdescThis->m->maDescriptions.end();
1290	++itD, ++lIndexThis)
1291	{
1292	const VirtualSystemDescriptionEntry &desc = *itD;
1293
1294	LogFlowFunc(("Loop %u: handling description entry ulIndex=%u, type=%s, strRef=%s, strOvf=%s, strVBox=%s, strExtraConfig=%s\n",
1295	uLoop,
1296	desc.ulIndex,
1297	( desc.type == VirtualSystemDescriptionType_HardDiskControllerIDE ? "HardDiskControllerIDE"
1298	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSATA ? "HardDiskControllerSATA"
1299	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSCSI ? "HardDiskControllerSCSI"
1300	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSAS ? "HardDiskControllerSAS"
1301	: desc.type == VirtualSystemDescriptionType_HardDiskImage ? "HardDiskImage"
1302	: Utf8StrFmt("%d", desc.type).c_str()),
1303	desc.strRef.c_str(),
1304	desc.strOvf.c_str(),
1305	desc.strVBoxCurrent.c_str(),
1306	desc.strExtraConfigCurrent.c_str()));
1307
1308	ovf::ResourceType_T type = (ovf::ResourceType_T)0; // if this becomes != 0 then we do stuff
1309	Utf8Str strResourceSubType;
1310
1311	Utf8Str strDescription; // results in <rasd:Description>...</rasd:Description> block
1312	Utf8Str strCaption; // results in <rasd:Caption>...</rasd:Caption> block
1313
1314	uint32_t ulParent = 0;
1315
1316	int32_t lVirtualQuantity = -1;
1317	Utf8Str strAllocationUnits;
1318
1319	int32_t lAddress = -1;
1320	int32_t lBusNumber = -1;
1321	int32_t lAddressOnParent = -1;
1322
1323	int32_t lAutomaticAllocation = -1; // 0 means "false", 1 means "true"
1324	Utf8Str strConnection; // results in <rasd:Connection>...</rasd:Connection> block
1325	Utf8Str strHostResource;
1326
1327	uint64_t uTemp;
1328
1329	ovf::VirtualHardwareItem vhi;
1330	ovf::StorageItem si;
1331	ovf::EthernetPortItem epi;
1332
1333	switch (desc.type)
1334	{
1335	case VirtualSystemDescriptionType_CPU:
1336	/* <Item>
1337	<rasd:Caption>1 virtual CPU</rasd:Caption>
1338	<rasd:Description>Number of virtual CPUs</rasd:Description>
1339	<rasd:ElementName>virtual CPU</rasd:ElementName>
1340	<rasd:InstanceID>1</rasd:InstanceID>
1341	<rasd:ResourceType>3</rasd:ResourceType>
1342	<rasd:VirtualQuantity>1</rasd:VirtualQuantity>
1343	</Item> */
1344	if (uLoop == 1)
1345	{
1346	strDescription = "Number of virtual CPUs";
1347	type = ovf::ResourceType_Processor; // 3
1348	desc.strVBoxCurrent.toInt(uTemp);
1349	lVirtualQuantity = (int32_t)uTemp;
1350	strCaption = Utf8StrFmt("%d virtual CPU", lVirtualQuantity); // without this ovftool
1351	// won't eat the item
1352	}
1353	break;
1354
1355	case VirtualSystemDescriptionType_Memory:
1356	/* <Item>
1357	<rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
1358	<rasd:Caption>256 MB of memory</rasd:Caption>
1359	<rasd:Description>Memory Size</rasd:Description>
1360	<rasd:ElementName>Memory</rasd:ElementName>
1361	<rasd:InstanceID>2</rasd:InstanceID>
1362	<rasd:ResourceType>4</rasd:ResourceType>
1363	<rasd:VirtualQuantity>256</rasd:VirtualQuantity>
1364	</Item> */
1365	if (uLoop == 1)
1366	{
1367	strDescription = "Memory Size";
1368	type = ovf::ResourceType_Memory; // 4
1369	desc.strVBoxCurrent.toInt(uTemp);
1370	lVirtualQuantity = (int32_t)(uTemp / _1M);
1371	strAllocationUnits = "MegaBytes";
1372	strCaption = Utf8StrFmt("%d MB of memory", lVirtualQuantity); // without this ovftool
1373	// won't eat the item
1374	}
1375	break;
1376
1377	case VirtualSystemDescriptionType_HardDiskControllerIDE:
1378	/* <Item>
1379	<rasd:Caption>ideController1</rasd:Caption>
1380	<rasd:Description>IDE Controller</rasd:Description>
1381	<rasd:InstanceId>5</rasd:InstanceId>
1382	<rasd:ResourceType>5</rasd:ResourceType>
1383	<rasd:Address>1</rasd:Address>
1384	<rasd:BusNumber>1</rasd:BusNumber>
1385	</Item> */
1386	if (uLoop == 1)
1387	{
1388	strDescription = "IDE Controller";
1389	type = ovf::ResourceType_IDEController; // 5
1390	strResourceSubType = desc.strVBoxCurrent;
1391
1392	if (!lIDEPrimaryControllerIndex)
1393	{
1394	// first IDE controller:
1395	strCaption = "ideController0";
1396	lAddress = 0;
1397	lBusNumber = 0;
1398	// remember this ID
1399	idIDEPrimaryController = ulInstanceID;
1400	lIDEPrimaryControllerIndex = lIndexThis;
1401	}
1402	else
1403	{
1404	// second IDE controller:
1405	strCaption = "ideController1";
1406	lAddress = 1;
1407	lBusNumber = 1;
1408	// remember this ID
1409	idIDESecondaryController = ulInstanceID;
1410	lIDESecondaryControllerIndex = lIndexThis;
1411	}
1412	}
1413	break;
1414
1415	case VirtualSystemDescriptionType_HardDiskControllerSATA:
1416	/* <Item>
1417	<rasd:Caption>sataController0</rasd:Caption>
1418	<rasd:Description>SATA Controller</rasd:Description>
1419	<rasd:InstanceId>4</rasd:InstanceId>
1420	<rasd:ResourceType>20</rasd:ResourceType>
1421	<rasd:ResourceSubType>ahci</rasd:ResourceSubType>
1422	<rasd:Address>0</rasd:Address>
1423	<rasd:BusNumber>0</rasd:BusNumber>
1424	</Item>
1425	*/
1426	if (uLoop == 1)
1427	{
1428	strDescription = "SATA Controller";
1429	strCaption = "sataController0";
1430	type = ovf::ResourceType_OtherStorageDevice; // 20
1431	// it seems that OVFTool always writes these two, and since we can only
1432	// have one SATA controller, we'll use this as well
1433	lAddress = 0;
1434	lBusNumber = 0;
1435
1436	if ( desc.strVBoxCurrent.isEmpty() // AHCI is the default in VirtualBox
1437	\|\| (!desc.strVBoxCurrent.compare("ahci", Utf8Str::CaseInsensitive))
1438	)
1439	strResourceSubType = "AHCI";
1440	else
1441	throw setError(VBOX_E_NOT_SUPPORTED,
1442	tr("Invalid config string \"%s\" in SATA controller"), desc.strVBoxCurrent.c_str());
1443
1444	// remember this ID
1445	idSATAController = ulInstanceID;
1446	lSATAControllerIndex = lIndexThis;
1447	}
1448	break;
1449
1450	case VirtualSystemDescriptionType_HardDiskControllerSCSI:
1451	case VirtualSystemDescriptionType_HardDiskControllerSAS:
1452	/* <Item>
1453	<rasd:Caption>scsiController0</rasd:Caption>
1454	<rasd:Description>SCSI Controller</rasd:Description>
1455	<rasd:InstanceId>4</rasd:InstanceId>
1456	<rasd:ResourceType>6</rasd:ResourceType>
1457	<rasd:ResourceSubType>buslogic</rasd:ResourceSubType>
1458	<rasd:Address>0</rasd:Address>
1459	<rasd:BusNumber>0</rasd:BusNumber>
1460	</Item>
1461	*/
1462	if (uLoop == 1)
1463	{
1464	strDescription = "SCSI Controller";
1465	strCaption = "scsiController0";
1466	type = ovf::ResourceType_ParallelSCSIHBA; // 6
1467	// it seems that OVFTool always writes these two, and since we can only
1468	// have one SATA controller, we'll use this as well
1469	lAddress = 0;
1470	lBusNumber = 0;
1471
1472	if ( desc.strVBoxCurrent.isEmpty() // LsiLogic is the default in VirtualBox
1473	\|\| (!desc.strVBoxCurrent.compare("lsilogic", Utf8Str::CaseInsensitive))
1474	)
1475	strResourceSubType = "lsilogic";
1476	else if (!desc.strVBoxCurrent.compare("buslogic", Utf8Str::CaseInsensitive))
1477	strResourceSubType = "buslogic";
1478	else if (!desc.strVBoxCurrent.compare("lsilogicsas", Utf8Str::CaseInsensitive))
1479	strResourceSubType = "lsilogicsas";
1480	else
1481	throw setError(VBOX_E_NOT_SUPPORTED,
1482	tr("Invalid config string \"%s\" in SCSI/SAS controller"),
1483	desc.strVBoxCurrent.c_str());
1484
1485	// remember this ID
1486	idSCSIController = ulInstanceID;
1487	lSCSIControllerIndex = lIndexThis;
1488	}
1489	break;
1490
1491	case VirtualSystemDescriptionType_HardDiskImage:
1492	/* <Item>
1493	<rasd:Caption>disk1</rasd:Caption>
1494	<rasd:InstanceId>8</rasd:InstanceId>
1495	<rasd:ResourceType>17</rasd:ResourceType>
1496	<rasd:HostResource>/disk/vmdisk1</rasd:HostResource>
1497	<rasd:Parent>4</rasd:Parent>
1498	<rasd:AddressOnParent>0</rasd:AddressOnParent>
1499	</Item> */
1500	if (uLoop == 2)
1501	{
1502	uint32_t cDisks = (uint32_t)stack.mapDisks.size();
1503	Utf8Str strDiskID = Utf8StrFmt("vmdisk%RI32", ++cDisks);
1504
1505	strDescription = "Disk Image";
1506	strCaption = Utf8StrFmt("disk%RI32", cDisks); // this is not used for anything else
1507	type = ovf::ResourceType_HardDisk; // 17
1508
1509	// the following references the "<Disks>" XML block
1510	strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());
1511
1512	// controller=<index>;channel=<c>
1513	size_t pos1 = desc.strExtraConfigCurrent.find("controller=");
1514	size_t pos2 = desc.strExtraConfigCurrent.find("channel=");
1515	int32_t lControllerIndex = -1;
1516	if (pos1 != Utf8Str::npos)
1517	{
1518	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
1519	if (lControllerIndex == lIDEPrimaryControllerIndex)
1520	ulParent = idIDEPrimaryController;
1521	else if (lControllerIndex == lIDESecondaryControllerIndex)
1522	ulParent = idIDESecondaryController;
1523	else if (lControllerIndex == lSCSIControllerIndex)
1524	ulParent = idSCSIController;
1525	else if (lControllerIndex == lSATAControllerIndex)
1526	ulParent = idSATAController;
1527	}
1528	if (pos2 != Utf8Str::npos)
1529	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
1530
1531	LogFlowFunc(("HardDiskImage details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",
1532	pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex, lIDESecondaryControllerIndex,
1533	ulParent, lAddressOnParent));
1534
1535	if ( !ulParent
1536	\|\| lAddressOnParent == -1
1537	)
1538	throw setError(VBOX_E_NOT_SUPPORTED,
1539	tr("Missing or bad extra config string in hard disk image: \"%s\""),
1540	desc.strExtraConfigCurrent.c_str());
1541
1542	stack.mapDisks[strDiskID] = &desc;
1543	}
1544	break;
1545
1546	case VirtualSystemDescriptionType_Floppy:
1547	if (uLoop == 1)
1548	{
1549	strDescription = "Floppy Drive";
1550	strCaption = "floppy0"; // this is what OVFTool writes
1551	type = ovf::ResourceType_FloppyDrive; // 14
1552	lAutomaticAllocation = 0;
1553	lAddressOnParent = 0; // this is what OVFTool writes
1554	}
1555	break;
1556
1557	case VirtualSystemDescriptionType_CDROM:
1558	/* <Item>
1559	<rasd:Caption>cdrom1</rasd:Caption>
1560	<rasd:InstanceId>8</rasd:InstanceId>
1561	<rasd:ResourceType>15</rasd:ResourceType>
1562	<rasd:HostResource>/disk/cdrom1</rasd:HostResource>
1563	<rasd:Parent>4</rasd:Parent>
1564	<rasd:AddressOnParent>0</rasd:AddressOnParent>
1565	</Item> */
1566	if (uLoop == 2)
1567	{
1568	//uint32_t cDisks = stack.mapDisks.size();
1569	Utf8Str strDiskID = Utf8StrFmt("iso%RI32", ++cDVDs);
1570
1571	strDescription = "CD-ROM Drive";
1572	strCaption = Utf8StrFmt("cdrom%RI32", cDVDs); // OVFTool starts with 1
1573	type = ovf::ResourceType_CDDrive; // 15
1574	lAutomaticAllocation = 1;
1575
1576	//skip empty Medium. There are no information to add into section <References> or <DiskSection>
1577	if (desc.strVBoxCurrent.isNotEmpty() &&
1578	desc.skipIt == false)
1579	{
1580	// the following references the "<Disks>" XML block
1581	strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());
1582	}
1583
1584	// controller=<index>;channel=<c>
1585	size_t pos1 = desc.strExtraConfigCurrent.find("controller=");
1586	size_t pos2 = desc.strExtraConfigCurrent.find("channel=");
1587	int32_t lControllerIndex = -1;
1588	if (pos1 != Utf8Str::npos)
1589	{
1590	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
1591	if (lControllerIndex == lIDEPrimaryControllerIndex)
1592	ulParent = idIDEPrimaryController;
1593	else if (lControllerIndex == lIDESecondaryControllerIndex)
1594	ulParent = idIDESecondaryController;
1595	else if (lControllerIndex == lSCSIControllerIndex)
1596	ulParent = idSCSIController;
1597	else if (lControllerIndex == lSATAControllerIndex)
1598	ulParent = idSATAController;
1599	}
1600	if (pos2 != Utf8Str::npos)
1601	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
1602
1603	LogFlowFunc(("DVD drive details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",
1604	pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex,
1605	lIDESecondaryControllerIndex, ulParent, lAddressOnParent));
1606
1607	if ( !ulParent
1608	\|\| lAddressOnParent == -1
1609	)
1610	throw setError(VBOX_E_NOT_SUPPORTED,
1611	tr("Missing or bad extra config string in DVD drive medium: \"%s\""),
1612	desc.strExtraConfigCurrent.c_str());
1613
1614	stack.mapDisks[strDiskID] = &desc;
1615	// there is no DVD drive map to update because it is
1616	// handled completely with this entry.
1617	}
1618	break;
1619
1620	case VirtualSystemDescriptionType_NetworkAdapter:
1621	/* <Item>
1622	<rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
1623	<rasd:Caption>Ethernet adapter on 'VM Network'</rasd:Caption>
1624	<rasd:Connection>VM Network</rasd:Connection>
1625	<rasd:ElementName>VM network</rasd:ElementName>
1626	<rasd:InstanceID>3</rasd:InstanceID>
1627	<rasd:ResourceType>10</rasd:ResourceType>
1628	</Item> */
1629	if (uLoop == 2)
1630	{
1631	lAutomaticAllocation = 1;
1632	strCaption = Utf8StrFmt("Ethernet adapter on '%s'", desc.strOvf.c_str());
1633	type = ovf::ResourceType_EthernetAdapter; // 10
1634	/* Set the hardware type to something useful.
1635	* To be compatible with vmware & others we set
1636	* PCNet32 for our PCNet types & E1000 for the
1637	* E1000 cards. */
1638	switch (desc.strVBoxCurrent.toInt32())
1639	{
1640	case NetworkAdapterType_Am79C970A:
1641	case NetworkAdapterType_Am79C973: strResourceSubType = "PCNet32"; break;
1642	#ifdef VBOX_WITH_E1000
1643	case NetworkAdapterType_I82540EM:
1644	case NetworkAdapterType_I82545EM:
1645	case NetworkAdapterType_I82543GC: strResourceSubType = "E1000"; break;
1646	#endif /* VBOX_WITH_E1000 */
1647	}
1648	strConnection = desc.strOvf;
1649
1650	stack.mapNetworks[desc.strOvf] = true;
1651	}
1652	break;
1653
1654	case VirtualSystemDescriptionType_USBController:
1655	/* <Item ovf:required="false">
1656	<rasd:Caption>usb</rasd:Caption>
1657	<rasd:Description>USB Controller</rasd:Description>
1658	<rasd:InstanceId>3</rasd:InstanceId>
1659	<rasd:ResourceType>23</rasd:ResourceType>
1660	<rasd:Address>0</rasd:Address>
1661	<rasd:BusNumber>0</rasd:BusNumber>
1662	</Item> */
1663	if (uLoop == 1)
1664	{
1665	strDescription = "USB Controller";
1666	strCaption = "usb";
1667	type = ovf::ResourceType_USBController; // 23
1668	lAddress = 0; // this is what OVFTool writes
1669	lBusNumber = 0; // this is what OVFTool writes
1670	}
1671	break;
1672
1673	case VirtualSystemDescriptionType_SoundCard:
1674	/* <Item ovf:required="false">
1675	<rasd:Caption>sound</rasd:Caption>
1676	<rasd:Description>Sound Card</rasd:Description>
1677	<rasd:InstanceId>10</rasd:InstanceId>
1678	<rasd:ResourceType>35</rasd:ResourceType>
1679	<rasd:ResourceSubType>ensoniq1371</rasd:ResourceSubType>
1680	<rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
1681	<rasd:AddressOnParent>3</rasd:AddressOnParent>
1682	</Item> */
1683	if (uLoop == 1)
1684	{
1685	strDescription = "Sound Card";
1686	strCaption = "sound";
1687	type = ovf::ResourceType_SoundCard; // 35
1688	strResourceSubType = desc.strOvf; // e.g. ensoniq1371
1689	lAutomaticAllocation = 0;
1690	lAddressOnParent = 3; // what gives? this is what OVFTool writes
1691	}
1692	break;
1693	}
1694
1695	if (type)
1696	{
1697	xml::ElementNode *pItem;
1698	xml::ElementNode *pItemHelper;
1699	RTCString itemElement;
1700	RTCString itemElementHelper;
1701
1702	if (enFormat == ovf::OVFVersion_2_0)
1703	{
1704	if(uLoop == 2)
1705	{
1706	if (desc.type == VirtualSystemDescriptionType_NetworkAdapter)
1707	{
1708	itemElement = "epasd:";
1709	pItem = pelmVirtualHardwareSection->createChild("EthernetPortItem");
1710	}
1711	else if (desc.type == VirtualSystemDescriptionType_CDROM \|\|
1712	desc.type == VirtualSystemDescriptionType_HardDiskImage)
1713	{
1714	itemElement = "sasd:";
1715	pItem = pelmVirtualHardwareSection->createChild("StorageItem");
1716	}
1717	else
1718	pItem = NULL;
1719	}
1720	else
1721	{
1722	itemElement = "rasd:";
1723	pItem = pelmVirtualHardwareSection->createChild("Item");
1724	}
1725	}
1726	else
1727	{
1728	itemElement = "rasd:";
1729	pItem = pelmVirtualHardwareSection->createChild("Item");
1730	}
1731
1732	// NOTE: DO NOT CHANGE THE ORDER of these items! The OVF standards prescribes that
1733	// the elements from the rasd: namespace must be sorted by letter, and VMware
1734	// actually requires this as well (see public bug #6612)
1735
1736	if (lAddress != -1)
1737	{
1738	//pItem->createChild("rasd:Address")->addContent(Utf8StrFmt("%d", lAddress));
1739	itemElementHelper = itemElement;
1740	pItemHelper = pItem->createChild(itemElementHelper.append("Address").c_str());
1741	pItemHelper->addContent(Utf8StrFmt("%d", lAddress));
1742	}
1743
1744	if (lAddressOnParent != -1)
1745	{
1746	//pItem->createChild("rasd:AddressOnParent")->addContent(Utf8StrFmt("%d", lAddressOnParent));
1747	itemElementHelper = itemElement;
1748	pItemHelper = pItem->createChild(itemElementHelper.append("AddressOnParent").c_str());
1749	pItemHelper->addContent(Utf8StrFmt("%d", lAddressOnParent));
1750	}
1751
1752	if (!strAllocationUnits.isEmpty())
1753	{
1754	//pItem->createChild("rasd:AllocationUnits")->addContent(strAllocationUnits);
1755	itemElementHelper = itemElement;
1756	pItemHelper = pItem->createChild(itemElementHelper.append("AllocationUnits").c_str());
1757	pItemHelper->addContent(strAllocationUnits);
1758	}
1759
1760	if (lAutomaticAllocation != -1)
1761	{
1762	//pItem->createChild("rasd:AutomaticAllocation")->addContent( (lAutomaticAllocation) ? "true" : "false" );
1763	itemElementHelper = itemElement;
1764	pItemHelper = pItem->createChild(itemElementHelper.append("AutomaticAllocation").c_str());
1765	pItemHelper->addContent((lAutomaticAllocation) ? "true" : "false" );
1766	}
1767
1768	if (lBusNumber != -1)
1769	{
1770	if (enFormat == ovf::OVFVersion_0_9)
1771	{
1772	// BusNumber is invalid OVF 1.0 so only write it in 0.9 mode for OVFTool
1773	//pItem->createChild("rasd:BusNumber")->addContent(Utf8StrFmt("%d", lBusNumber));
1774	itemElementHelper = itemElement;
1775	pItemHelper = pItem->createChild(itemElementHelper.append("BusNumber").c_str());
1776	pItemHelper->addContent(Utf8StrFmt("%d", lBusNumber));
1777	}
1778	}
1779
1780	if (!strCaption.isEmpty())
1781	{
1782	//pItem->createChild("rasd:Caption")->addContent(strCaption);
1783	itemElementHelper = itemElement;
1784	pItemHelper = pItem->createChild(itemElementHelper.append("Caption").c_str());
1785	pItemHelper->addContent(strCaption);
1786	}
1787
1788	if (!strConnection.isEmpty())
1789	{
1790	//pItem->createChild("rasd:Connection")->addContent(strConnection);
1791	itemElementHelper = itemElement;
1792	pItemHelper = pItem->createChild(itemElementHelper.append("Connection").c_str());
1793	pItemHelper->addContent(strConnection);
1794	}
1795
1796	if (!strDescription.isEmpty())
1797	{
1798	//pItem->createChild("rasd:Description")->addContent(strDescription);
1799	itemElementHelper = itemElement;
1800	pItemHelper = pItem->createChild(itemElementHelper.append("Description").c_str());
1801	pItemHelper->addContent(strDescription);
1802	}
1803
1804	if (!strCaption.isEmpty())
1805	{
1806	if (enFormat == ovf::OVFVersion_1_0)
1807	{
1808	//pItem->createChild("rasd:ElementName")->addContent(strCaption);
1809	itemElementHelper = itemElement;
1810	pItemHelper = pItem->createChild(itemElementHelper.append("ElementName").c_str());
1811	pItemHelper->addContent(strCaption);
1812	}
1813	}
1814
1815	if (!strHostResource.isEmpty())
1816	{
1817	//pItem->createChild("rasd:HostResource")->addContent(strHostResource);
1818	itemElementHelper = itemElement;
1819	pItemHelper = pItem->createChild(itemElementHelper.append("HostResource").c_str());
1820	pItemHelper->addContent(strHostResource);
1821	}
1822
1823	{
1824	// <rasd:InstanceID>1</rasd:InstanceID>
1825	itemElementHelper = itemElement;
1826	if (enFormat == ovf::OVFVersion_0_9)
1827	//pelmInstanceID = pItem->createChild("rasd:InstanceId");
1828	pItemHelper = pItem->createChild(itemElementHelper.append("InstanceId").c_str());
1829	else
1830	//pelmInstanceID = pItem->createChild("rasd:InstanceID"); // capitalization changed...
1831	pItemHelper = pItem->createChild(itemElementHelper.append("InstanceID").c_str());
1832
1833	pItemHelper->addContent(Utf8StrFmt("%d", ulInstanceID++));
1834	}
1835
1836	if (ulParent)
1837	{
1838	//pItem->createChild("rasd:Parent")->addContent(Utf8StrFmt("%d", ulParent));
1839	itemElementHelper = itemElement;
1840	pItemHelper = pItem->createChild(itemElementHelper.append("Parent").c_str());
1841	pItemHelper->addContent(Utf8StrFmt("%d", ulParent));
1842	}
1843
1844	if (!strResourceSubType.isEmpty())
1845	{
1846	//pItem->createChild("rasd:ResourceSubType")->addContent(strResourceSubType);
1847	itemElementHelper = itemElement;
1848	pItemHelper = pItem->createChild(itemElementHelper.append("ResourceSubType").c_str());
1849	pItemHelper->addContent(strResourceSubType);
1850	}
1851
1852	{
1853	// <rasd:ResourceType>3</rasd:ResourceType>
1854	//pItem->createChild("rasd:ResourceType")->addContent(Utf8StrFmt("%d", type));
1855	itemElementHelper = itemElement;
1856	pItemHelper = pItem->createChild(itemElementHelper.append("ResourceType").c_str());
1857	pItemHelper->addContent(Utf8StrFmt("%d", type));
1858	}
1859
1860	// <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
1861	if (lVirtualQuantity != -1)
1862	{
1863	//pItem->createChild("rasd:VirtualQuantity")->addContent(Utf8StrFmt("%d", lVirtualQuantity));
1864	itemElementHelper = itemElement;
1865	pItemHelper = pItem->createChild(itemElementHelper.append("VirtualQuantity").c_str());
1866	pItemHelper->addContent(Utf8StrFmt("%d", lVirtualQuantity));
1867	}
1868	}
1869	}
1870	} // for (size_t uLoop = 1; uLoop <= 2; ++uLoop)
1871
1872	// now that we're done with the official OVF <Item> tags under <VirtualSystem>, write out VirtualBox XML
1873	// under the vbox: namespace
1874	xml::ElementNode *pelmVBoxMachine = pelmVirtualSystem->createChild("vbox:Machine");
1875	// ovf:required="false" tells other OVF parsers that they can ignore this thing
1876	pelmVBoxMachine->setAttribute("ovf:required", "false");
1877	// ovf:Info element is required or VMware will bail out on the vbox:Machine element
1878	pelmVBoxMachine->createChild("ovf:Info")->addContent("Complete VirtualBox machine configuration in VirtualBox format");
1879
1880	// create an empty machine config
1881	// use the same settings version as the current VM settings file
1882	settings::MachineConfigFile *pConfig = new settings::MachineConfigFile(&vsdescThis->m->pMachine->i_getSettingsFileFull());
1883
1884	writeLock.release();
1885	try
1886	{
1887	AutoWriteLock machineLock(vsdescThis->m->pMachine COMMA_LOCKVAL_SRC_POS);
1888	// fill the machine config
1889	vsdescThis->m->pMachine->i_copyMachineDataToSettings(*pConfig);
1890
1891	// Apply export tweaks to machine settings
1892	bool fStripAllMACs = m->optListExport.contains(ExportOptions_StripAllMACs);
1893	bool fStripAllNonNATMACs = m->optListExport.contains(ExportOptions_StripAllNonNATMACs);
1894	if (fStripAllMACs \|\| fStripAllNonNATMACs)
1895	{
1896	for (settings::NetworkAdaptersList::iterator it = pConfig->hardwareMachine.llNetworkAdapters.begin();
1897	it != pConfig->hardwareMachine.llNetworkAdapters.end();
1898	++it)
1899	{
1900	settings::NetworkAdapter &nic = *it;
1901	if (fStripAllMACs \|\| (fStripAllNonNATMACs && nic.mode != NetworkAttachmentType_NAT))
1902	nic.strMACAddress.setNull();
1903	}
1904	}
1905
1906	// write the machine config to the vbox:Machine element
1907	pConfig->buildMachineXML(*pelmVBoxMachine,
1908	settings::MachineConfigFile::BuildMachineXML_WriteVBoxVersionAttribute
1909	/\| settings::MachineConfigFile::BuildMachineXML_SkipRemovableMedia/
1910	\| settings::MachineConfigFile::BuildMachineXML_SuppressSavedState,
1911	// but not BuildMachineXML_IncludeSnapshots nor BuildMachineXML_MediaRegistry
1912	pllElementsWithUuidAttributes);
1913	delete pConfig;
1914	}
1915	catch (...)
1916	{
1917	writeLock.acquire();
1918	delete pConfig;
1919	throw;
1920	}
1921	writeLock.acquire();
1922	}
1923
1924	/**
1925	* Actual worker code for writing out OVF/OVA to disk. This is called from Appliance::taskThreadWriteOVF()
1926	* and therefore runs on the OVF/OVA write worker thread.
1927	*
1928	* This runs in one context:
1929	*
1930	* 1) in a first worker thread; in that case, Appliance::Write() called Appliance::i_writeImpl();
1931	*
1932	* @param pTask
1933	* @return
1934	*/
1935	HRESULT Appliance::i_writeFS(TaskOVF *pTask)
1936	{
1937	LogFlowFuncEnter();
1938	LogFlowFunc(("ENTER appliance %p\n", this));
1939
1940	AutoCaller autoCaller(this);
1941	if (FAILED(autoCaller.rc())) return autoCaller.rc();
1942
1943	HRESULT rc = S_OK;
1944
1945	// Lock the media tree early to make sure nobody else tries to make changes
1946	// to the tree. Also lock the IAppliance object for writing.
1947	AutoMultiWriteLock2 multiLock(&mVirtualBox->i_getMediaTreeLockHandle(), this->lockHandle() COMMA_LOCKVAL_SRC_POS);
1948	// Additional protect the IAppliance object, cause we leave the lock
1949	// when starting the disk export and we don't won't block other
1950	// callers on this lengthy operations.
1951	m->state = Data::ApplianceExporting;
1952
1953	if (pTask->locInfo.strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
1954	rc = i_writeFSOVF(pTask, multiLock);
1955	else
1956	rc = i_writeFSOVA(pTask, multiLock);
1957
1958	// reset the state so others can call methods again
1959	m->state = Data::ApplianceIdle;
1960
1961	LogFlowFunc(("rc=%Rhrc\n", rc));
1962	LogFlowFuncLeave();
1963	return rc;
1964	}
1965
1966	HRESULT Appliance::i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock)
1967	{
1968	LogFlowFuncEnter();
1969
1970	HRESULT rc = S_OK;
1971
1972	PVDINTERFACEIO pShaIo = 0;
1973	PVDINTERFACEIO pFileIo = 0;
1974	do
1975	{
1976	pShaIo = ShaCreateInterface();
1977	if (!pShaIo)
1978	{
1979	rc = E_OUTOFMEMORY;
1980	break;
1981	}
1982	pFileIo = FileCreateInterface();
1983	if (!pFileIo)
1984	{
1985	rc = E_OUTOFMEMORY;
1986	break;
1987	}
1988
1989	SHASTORAGE storage;
1990	RT_ZERO(storage);
1991	storage.fCreateDigest = m->fManifest;
1992	storage.fSha256 = m->fSha256;
1993
1994
1995	Utf8Str name = i_applianceIOName(applianceIOFile);
1996
1997	int vrc = VDInterfaceAdd(&pFileIo->Core, name.c_str(),
1998	VDINTERFACETYPE_IO, 0, sizeof(VDINTERFACEIO),
1999	&storage.pVDImageIfaces);
2000	if (RT_FAILURE(vrc))
2001	{
2002	rc = E_FAIL;
2003	break;
2004	}
2005	rc = i_writeFSImpl(pTask, writeLock, pShaIo, &storage);
2006	} while (0);
2007
2008	/* Cleanup */
2009	if (pShaIo)
2010	RTMemFree(pShaIo);
2011	if (pFileIo)
2012	RTMemFree(pFileIo);
2013
2014	LogFlowFuncLeave();
2015	return rc;
2016	}
2017
2018	HRESULT Appliance::i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock)
2019	{
2020	LogFlowFuncEnter();
2021
2022	RTTAR tar;
2023	int vrc = RTTarOpen(&tar, pTask->locInfo.strPath.c_str(), RTFILE_O_CREATE \| RTFILE_O_WRITE \| RTFILE_O_DENY_ALL);
2024	if (RT_FAILURE(vrc))
2025	return setError(VBOX_E_FILE_ERROR,
2026	tr("Could not create OVA file '%s' (%Rrc)"),
2027	pTask->locInfo.strPath.c_str(), vrc);
2028
2029	HRESULT rc = S_OK;
2030
2031	PVDINTERFACEIO pShaIo = 0;
2032	PVDINTERFACEIO pTarIo = 0;
2033	do
2034	{
2035	pShaIo = ShaCreateInterface();
2036	if (!pShaIo)
2037	{
2038	rc = E_OUTOFMEMORY;
2039	break;
2040	}
2041	pTarIo = tarWriterCreateInterface();
2042	if (!pTarIo)
2043	{
2044	rc = E_OUTOFMEMORY;
2045	break;
2046	}
2047	SHASTORAGE storage;
2048	RT_ZERO(storage);
2049	storage.fCreateDigest = m->fManifest;
2050	storage.fSha256 = m->fSha256;
2051
2052	Utf8Str name = i_applianceIOName(applianceIOTar);
2053
2054	vrc = VDInterfaceAdd(&pTarIo->Core, name.c_str(),
2055	VDINTERFACETYPE_IO, tar, sizeof(VDINTERFACEIO),
2056	&storage.pVDImageIfaces);
2057
2058	if (RT_FAILURE(vrc))
2059	{
2060	rc = E_FAIL;
2061	break;
2062	}
2063	rc = i_writeFSImpl(pTask, writeLock, pShaIo, &storage);
2064	} while (0);
2065
2066	RTTarClose(tar);
2067
2068	/* Cleanup */
2069	if (pShaIo)
2070	RTMemFree(pShaIo);
2071	if (pTarIo)
2072	RTMemFree(pTarIo);
2073
2074	/* Delete ova file on error */
2075	if (FAILED(rc))
2076	RTFileDelete(pTask->locInfo.strPath.c_str());
2077
2078	LogFlowFuncLeave();
2079	return rc;
2080	}
2081
2082	HRESULT Appliance::i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase& writeLock, PVDINTERFACEIO pIfIo, PSHASTORAGE pStorage)
2083	{
2084	LogFlowFuncEnter();
2085
2086	HRESULT rc = S_OK;
2087
2088	list<STRPAIR> fileList;
2089	try
2090	{
2091	int vrc;
2092	// the XML stack contains two maps for disks and networks, which allows us to
2093	// a) have a list of unique disk names (to make sure the same disk name is only added once)
2094	// and b) keep a list of all networks
2095	XMLStack stack;
2096	// Scope this to free the memory as soon as this is finished
2097	{
2098	// Create a xml document
2099	xml::Document doc;
2100	// Now fully build a valid ovf document in memory
2101	i_buildXML(writeLock, doc, stack, pTask->locInfo.strPath, pTask->enFormat);
2102	/* Extract the OVA file name */
2103	Utf8Str strOvaFile = pTask->locInfo.strPath;
2104	/* Extract the path */
2105	Utf8Str strOvfFile = strOvaFile.stripSuffix().append(".ovf");
2106	// Create a memory buffer containing the XML. */
2107	void *pvBuf = 0;
2108	size_t cbSize;
2109	xml::XmlMemWriter writer;
2110	writer.write(doc, &pvBuf, &cbSize);
2111	if (RT_UNLIKELY(!pvBuf))
2112	throw setError(VBOX_E_FILE_ERROR,
2113	tr("Could not create OVF file '%s'"),
2114	strOvfFile.c_str());
2115	/* Write the ovf file to disk. */
2116	vrc = writeBufferToFile(strOvfFile.c_str(), pvBuf, cbSize, pIfIo, pStorage);
2117	if (RT_FAILURE(vrc))
2118	throw setError(VBOX_E_FILE_ERROR,
2119	tr("Could not create OVF file '%s' (%Rrc)"),
2120	strOvfFile.c_str(), vrc);
2121	fileList.push_back(STRPAIR(strOvfFile, pStorage->strDigest));
2122	}
2123
2124	// We need a proper format description
2125	ComObjPtr<MediumFormat> formatTemp;
2126
2127	ComObjPtr<MediumFormat> format;
2128	// Scope for the AutoReadLock
2129	{
2130	SystemProperties *pSysProps = mVirtualBox->i_getSystemProperties();
2131	AutoReadLock propsLock(pSysProps COMMA_LOCKVAL_SRC_POS);
2132	// We are always exporting to VMDK stream optimized for now
2133	formatTemp = pSysProps->i_mediumFormatFromExtension("iso");
2134
2135	format = pSysProps->i_mediumFormat("VMDK");
2136	if (format.isNull())
2137	throw setError(VBOX_E_NOT_SUPPORTED,
2138	tr("Invalid medium storage format"));
2139	}
2140
2141	// Finally, write out the disks!
2142	map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;
2143	for (itS = stack.mapDisks.begin();
2144	itS != stack.mapDisks.end();
2145	++itS)
2146	{
2147	const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;
2148
2149	// source path: where the VBox image is
2150	const Utf8Str &strSrcFilePath = pDiskEntry->strVBoxCurrent;
2151
2152	//skip empty Medium. In common, It's may be empty CD/DVD
2153	if (strSrcFilePath.isEmpty() \|\|
2154	pDiskEntry->skipIt == true)
2155	continue;
2156
2157	// Do NOT check here whether the file exists. findHardDisk will
2158	// figure that out, and filesystem-based tests are simply wrong
2159	// in the general case (think of iSCSI).
2160
2161	// clone the disk:
2162	ComObjPtr<Medium> pSourceDisk;
2163
2164	Log(("Finding source disk \"%s\"\n", strSrcFilePath.c_str()));
2165
2166	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)
2167	{
2168	rc = mVirtualBox->i_findHardDiskByLocation(strSrcFilePath, true, &pSourceDisk);
2169	if (FAILED(rc)) throw rc;
2170	}
2171	else//may be CD or DVD
2172	{
2173	rc = mVirtualBox->i_findDVDOrFloppyImage(DeviceType_DVD,
2174	NULL,
2175	strSrcFilePath,
2176	true,
2177	&pSourceDisk);
2178	if (FAILED(rc)) throw rc;
2179	}
2180
2181	Bstr uuidSource;
2182	rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());
2183	if (FAILED(rc)) throw rc;
2184	Guid guidSource(uuidSource);
2185
2186	// output filename
2187	const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
2188	// target path needs to be composed from where the output OVF is
2189	Utf8Str strTargetFilePath(pTask->locInfo.strPath);
2190	strTargetFilePath.stripFilename()
2191	.append("/")
2192	.append(strTargetFileNameOnly);
2193
2194	// The exporting requests a lock on the media tree. So leave our lock temporary.
2195	writeLock.release();
2196	try
2197	{
2198	// advance to the next operation
2199	pTask->pProgress->SetNextOperation(BstrFmt(tr("Exporting to disk image '%s'"),
2200	RTPathFilename(strTargetFilePath.c_str())).raw(),
2201	pDiskEntry->ulSizeMB); // operation's weight, as set up
2202	// with the IProgress originally
2203
2204	// create a flat copy of the source disk image
2205	if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)
2206	{
2207	ComObjPtr<Progress> pProgress2;
2208	pProgress2.createObject();
2209	rc = pProgress2->init(mVirtualBox, static_cast<IAppliance*>(this),
2210	BstrFmt(tr("Creating medium '%s'"),
2211	strTargetFilePath.c_str()).raw(), TRUE);
2212	if (FAILED(rc)) throw rc;
2213
2214	rc = pSourceDisk->i_exportFile(strTargetFilePath.c_str(),
2215	format,
2216	MediumVariant_VmdkStreamOptimized,
2217	m->m_pSecretKeyStore,
2218	pIfIo,
2219	pStorage,
2220	pProgress2);
2221	if (FAILED(rc)) throw rc;
2222
2223	ComPtr<IProgress> pProgress3(pProgress2);
2224	// now wait for the background disk operation to complete; this throws HRESULTs on error
2225	i_waitForAsyncProgress(pTask->pProgress, pProgress3);
2226	}
2227	else
2228	{
2229	//copy/clone CD/DVD image
2230	Assert(pDiskEntry->type == VirtualSystemDescriptionType_CDROM);
2231
2232	/* Read the ISO file and add one to OVA/OVF package */
2233	{
2234	void *pvStorage;
2235	RTFILE pFile = NULL;
2236	void *pvUser = pStorage;
2237
2238	vrc = pIfIo->pfnOpen(pvUser, strTargetFilePath.c_str(),
2239	RTFILE_O_OPEN_CREATE \| RTFILE_O_WRITE \| RTFILE_O_DENY_NONE,
2240	0,
2241	&pvStorage);
2242	if (RT_FAILURE(vrc))
2243	throw setError(VBOX_E_FILE_ERROR,
2244	tr("Could not create or open file '%s' (%Rrc)"),
2245	strTargetFilePath.c_str(), vrc);
2246
2247	vrc = RTFileOpen(&pFile,
2248	strSrcFilePath.c_str(),
2249	RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE);
2250
2251	if (RT_FAILURE(vrc) \|\| pFile == NULL)
2252	{
2253	pIfIo->pfnClose(pvUser, pvStorage);
2254	throw setError(VBOX_E_FILE_ERROR,
2255	tr("Could not create or open file '%s' (%Rrc)"),
2256	strSrcFilePath.c_str(), vrc);
2257	}
2258
2259	uint64_t cbFile = 0;
2260	vrc = RTFileGetSize(pFile, &cbFile);
2261	if (RT_SUCCESS(vrc))
2262	{
2263	size_t const cbTmpSize = _1M;
2264	void *pvTmpBuf = RTMemAlloc(cbTmpSize);
2265	if (pvTmpBuf)
2266	{
2267	/* The copy loop. */
2268	uint64_t offDstFile = 0;
2269	for (;;)
2270	{
2271	size_t cbChunk = 0;
2272	vrc = RTFileRead(pFile, pvTmpBuf, cbTmpSize, &cbChunk);
2273	if (RT_FAILURE(vrc) \|\| cbChunk == 0)
2274	break;
2275
2276	size_t cbWritten = 0;
2277	vrc = pIfIo->pfnWriteSync(pvUser,
2278	pvStorage,
2279	offDstFile,
2280	pvTmpBuf,
2281	cbChunk,
2282	&cbWritten);
2283	if (RT_FAILURE(vrc))
2284	break;
2285	Assert(cbWritten == cbChunk);
2286
2287	offDstFile += cbWritten;
2288	}
2289
2290	RTMemFree(pvTmpBuf);
2291	}
2292	else
2293	vrc = VERR_NO_MEMORY;
2294	}
2295
2296	pIfIo->pfnClose(pvUser, pvStorage);
2297	RTFileClose(pFile);
2298
2299	if (RT_FAILURE(vrc))
2300	{
2301	if (vrc == VERR_EOF)
2302	vrc = VINF_SUCCESS;
2303	else
2304	throw setError(VBOX_E_FILE_ERROR,
2305	tr("Error during copy CD/DVD image '%s' (%Rrc)"),
2306	strSrcFilePath.c_str(), vrc);
2307	}
2308	}
2309	}
2310	}
2311	catch (HRESULT rc3)
2312	{
2313	writeLock.acquire();
2314	// Todo: file deletion on error? If not, we can remove that whole try/catch block.
2315	throw rc3;
2316	}
2317	// Finished, lock again (so nobody mess around with the medium tree
2318	// in the meantime)
2319	writeLock.acquire();
2320	fileList.push_back(STRPAIR(strTargetFilePath, pStorage->strDigest));
2321	}
2322
2323	if (m->fManifest)
2324	{
2325	// Create & write the manifest file
2326	Utf8Str strMfFilePath = Utf8Str(pTask->locInfo.strPath).stripSuffix().append(".mf");
2327	Utf8Str strMfFileName = Utf8Str(strMfFilePath).stripPath();
2328	pTask->pProgress->SetNextOperation(BstrFmt(tr("Creating manifest file '%s'"), strMfFileName.c_str()).raw(),
2329	m->ulWeightForManifestOperation); // operation's weight, as set up
2330	// with the IProgress originally);
2331	PRTMANIFESTTEST paManifestFiles = (PRTMANIFESTTEST)RTMemAlloc(sizeof(RTMANIFESTTEST) * fileList.size());
2332	size_t i = 0;
2333	list<STRPAIR>::const_iterator it1;
2334	for (it1 = fileList.begin();
2335	it1 != fileList.end();
2336	++it1, ++i)
2337	{
2338	paManifestFiles[i].pszTestFile = (*it1).first.c_str();
2339	paManifestFiles[i].pszTestDigest = (*it1).second.c_str();
2340	}
2341	void *pvBuf;
2342	size_t cbSize;
2343	vrc = RTManifestWriteFilesBuf(&pvBuf, &cbSize, m->fSha256 ? RTDIGESTTYPE_SHA256 : RTDIGESTTYPE_SHA1,
2344	paManifestFiles, fileList.size());
2345	RTMemFree(paManifestFiles);
2346	if (RT_FAILURE(vrc))
2347	throw setError(VBOX_E_FILE_ERROR,
2348	tr("Could not create manifest file '%s' (%Rrc)"),
2349	strMfFileName.c_str(), vrc);
2350	/* Disable digest creation for the manifest file. */
2351	pStorage->fCreateDigest = false;
2352	/* Write the manifest file to disk. */
2353	vrc = writeBufferToFile(strMfFilePath.c_str(), pvBuf, cbSize, pIfIo, pStorage);
2354	RTMemFree(pvBuf);
2355	if (RT_FAILURE(vrc))
2356	throw setError(VBOX_E_FILE_ERROR,
2357	tr("Could not create manifest file '%s' (%Rrc)"),
2358	strMfFilePath.c_str(), vrc);
2359	}
2360	}
2361	catch (RTCError &x) // includes all XML exceptions
2362	{
2363	rc = setError(VBOX_E_FILE_ERROR,
2364	x.what());
2365	}
2366	catch (HRESULT aRC)
2367	{
2368	rc = aRC;
2369	}
2370
2371	/* Cleanup on error */
2372	if (FAILED(rc))
2373	{
2374	list<STRPAIR>::const_iterator it1;
2375	for (it1 = fileList.begin();
2376	it1 != fileList.end();
2377	++it1)
2378	pIfIo->pfnDelete(pStorage, (*it1).first.c_str());
2379	}
2380
2381	LogFlowFunc(("rc=%Rhrc\n", rc));
2382	LogFlowFuncLeave();
2383
2384	return rc;
2385	}
2386

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

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

Download in other formats: