ApplianceImplExport.cpp@ 51498

Last change on this file since 51498 was 51498, checked in by vboxsync, 11 years ago
6813 - MachineImpl use of server side wrappers + misc mods on other classes
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 109.6 KB

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

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

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

Download in other formats: