ApplianceImplExport.cpp@ 29945

Last change on this file since 29945 was 29925, checked in by vboxsync, 15 years ago
OVF: respect override of import parameters (setFinalValues) also when vbox:Machine is present, first batch (everything except storage)
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 79.0 KB

Line
1	/* $Id: ApplianceImplExport.cpp 29925 2010-05-31 18:33:15Z vboxsync $ */
2	/** @file
3	*
4	* IAppliance and IVirtualSystem COM class implementations.
5	*/
6
7	/*
8	* Copyright (C) 2008-2010 Oracle Corporation
9	*
10	* This file is part of VirtualBox Open Source Edition (OSE), as
11	* available from http://www.virtualbox.org. This file is free software;
12	* you can redistribute it and/or modify it under the terms of the GNU
13	* General Public License (GPL) as published by the Free Software
14	* Foundation, in version 2 as it comes in the "COPYING" file of the
15	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17	*/
18
19	#include <iprt/path.h>
20	#include <iprt/dir.h>
21	#include <iprt/param.h>
22	#include <iprt/s3.h>
23	#include <iprt/manifest.h>
24
25	#include <VBox/version.h>
26
27	#include "ApplianceImpl.h"
28	#include "VirtualBoxImpl.h"
29
30	#include "ProgressImpl.h"
31	#include "MachineImpl.h"
32
33	#include "AutoCaller.h"
34	#include "Logging.h"
35
36	#include "ApplianceImplPrivate.h"
37
38	using namespace std;
39
40	////////////////////////////////////////////////////////////////////////////////
41	//
42	// IMachine public methods
43	//
44	////////////////////////////////////////////////////////////////////////////////
45
46	// This code is here so we won't have to include the appliance headers in the
47	// IMachine implementation, and we also need to access private appliance data.
48
49	/**
50	* Public method implementation.
51	* @param appliance
52	* @return
53	*/
54
55	STDMETHODIMP Machine::Export(IAppliance aAppliance, IVirtualSystemDescription *aDescription)
56	{
57	HRESULT rc = S_OK;
58
59	if (!aAppliance)
60	return E_POINTER;
61
62	AutoCaller autoCaller(this);
63	if (FAILED(autoCaller.rc())) return autoCaller.rc();
64
65	ComObjPtr<VirtualSystemDescription> pNewDesc;
66
67	try
68	{
69	// create a new virtual system to store in the appliance
70	rc = pNewDesc.createObject();
71	if (FAILED(rc)) throw rc;
72	rc = pNewDesc->init();
73	if (FAILED(rc)) throw rc;
74
75	// store the machine object so we can dump the XML in Appliance::Write()
76	pNewDesc->m->pMachine = this;
77
78	// now fill it with description items
79	Bstr bstrName1;
80	Bstr bstrDescription;
81	Bstr bstrGuestOSType;
82	uint32_t cCPUs;
83	uint32_t ulMemSizeMB;
84	BOOL fUSBEnabled;
85	BOOL fAudioEnabled;
86	AudioControllerType_T audioController;
87
88	ComPtr<IUSBController> pUsbController;
89	ComPtr<IAudioAdapter> pAudioAdapter;
90
91	// first, call the COM methods, as they request locks
92	rc = COMGETTER(USBController)(pUsbController.asOutParam());
93	if (FAILED(rc))
94	fUSBEnabled = false;
95	else
96	rc = pUsbController->COMGETTER(Enabled)(&fUSBEnabled);
97
98	// request the machine lock while acessing internal members
99	AutoReadLock alock1(this COMMA_LOCKVAL_SRC_POS);
100
101	pAudioAdapter = mAudioAdapter;
102	rc = pAudioAdapter->COMGETTER(Enabled)(&fAudioEnabled);
103	if (FAILED(rc)) throw rc;
104	rc = pAudioAdapter->COMGETTER(AudioController)(&audioController);
105	if (FAILED(rc)) throw rc;
106
107	// get name
108	bstrName1 = mUserData->mName;
109	// get description
110	bstrDescription = mUserData->mDescription;
111	// get guest OS
112	bstrGuestOSType = mUserData->mOSTypeId;
113	// CPU count
114	cCPUs = mHWData->mCPUCount;
115	// memory size in MB
116	ulMemSizeMB = mHWData->mMemorySize;
117	// VRAM size?
118	// BIOS settings?
119	// 3D acceleration enabled?
120	// hardware virtualization enabled?
121	// nested paging enabled?
122	// HWVirtExVPIDEnabled?
123	// PAEEnabled?
124	// snapshotFolder?
125	// VRDPServer?
126
127	/* Guest OS type */
128	Utf8Str strOsTypeVBox(bstrGuestOSType);
129	ovf::CIMOSType_T cim = convertVBoxOSType2CIMOSType(strOsTypeVBox.c_str());
130	pNewDesc->addEntry(VirtualSystemDescriptionType_OS,
131	"",
132	Utf8StrFmt("%RI32", cim),
133	strOsTypeVBox);
134
135	/* VM name */
136	Utf8Str strVMName(bstrName1);
137	pNewDesc->addEntry(VirtualSystemDescriptionType_Name,
138	"",
139	strVMName,
140	strVMName);
141
142	// description
143	Utf8Str strDescription(bstrDescription);
144	pNewDesc->addEntry(VirtualSystemDescriptionType_Description,
145	"",
146	strDescription,
147	strDescription);
148
149	/* CPU count*/
150	Utf8Str strCpuCount = Utf8StrFmt("%RI32", cCPUs);
151	pNewDesc->addEntry(VirtualSystemDescriptionType_CPU,
152	"",
153	strCpuCount,
154	strCpuCount);
155
156	/* Memory */
157	Utf8Str strMemory = Utf8StrFmt("%RI64", (uint64_t)ulMemSizeMB * _1M);
158	pNewDesc->addEntry(VirtualSystemDescriptionType_Memory,
159	"",
160	strMemory,
161	strMemory);
162
163	// the one VirtualBox IDE controller has two channels with two ports each, which is
164	// considered two IDE controllers with two ports each by OVF, so export it as two
165	int32_t lIDEControllerPrimaryIndex = 0;
166	int32_t lIDEControllerSecondaryIndex = 0;
167	int32_t lSATAControllerIndex = 0;
168	int32_t lSCSIControllerIndex = 0;
169
170	/* Fetch all available storage controllers */
171	com::SafeIfaceArray<IStorageController> nwControllers;
172	rc = COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(nwControllers));
173	if (FAILED(rc)) throw rc;
174
175	ComPtr<IStorageController> pIDEController;
176	ComPtr<IStorageController> pSATAController;
177	ComPtr<IStorageController> pSCSIController;
178	ComPtr<IStorageController> pSASController;
179	for (size_t j = 0; j < nwControllers.size(); ++j)
180	{
181	StorageBus_T eType;
182	rc = nwControllers[j]->COMGETTER(Bus)(&eType);
183	if (FAILED(rc)) throw rc;
184	if ( eType == StorageBus_IDE
185	&& pIDEController.isNull())
186	pIDEController = nwControllers[j];
187	else if ( eType == StorageBus_SATA
188	&& pSATAController.isNull())
189	pSATAController = nwControllers[j];
190	else if ( eType == StorageBus_SCSI
191	&& pSATAController.isNull())
192	pSCSIController = nwControllers[j];
193	else if ( eType == StorageBus_SAS
194	&& pSASController.isNull())
195	pSASController = nwControllers[j];
196	}
197
198	// <const name="HardDiskControllerIDE" value="6" />
199	if (!pIDEController.isNull())
200	{
201	Utf8Str strVbox;
202	StorageControllerType_T ctlr;
203	rc = pIDEController->COMGETTER(ControllerType)(&ctlr);
204	if (FAILED(rc)) throw rc;
205	switch(ctlr)
206	{
207	case StorageControllerType_PIIX3: strVbox = "PIIX3"; break;
208	case StorageControllerType_PIIX4: strVbox = "PIIX4"; break;
209	case StorageControllerType_ICH6: strVbox = "ICH6"; break;
210	}
211
212	if (strVbox.length())
213	{
214	lIDEControllerPrimaryIndex = (int32_t)pNewDesc->m->llDescriptions.size();
215	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
216	Utf8StrFmt("%d", lIDEControllerPrimaryIndex), // strRef
217	strVbox, // aOvfValue
218	strVbox); // aVboxValue
219	lIDEControllerSecondaryIndex = lIDEControllerPrimaryIndex + 1;
220	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
221	Utf8StrFmt("%d", lIDEControllerSecondaryIndex),
222	strVbox,
223	strVbox);
224	}
225	}
226
227	// <const name="HardDiskControllerSATA" value="7" />
228	if (!pSATAController.isNull())
229	{
230	Utf8Str strVbox = "AHCI";
231	lSATAControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
232	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,
233	Utf8StrFmt("%d", lSATAControllerIndex),
234	strVbox,
235	strVbox);
236	}
237
238	// <const name="HardDiskControllerSCSI" value="8" />
239	if (!pSCSIController.isNull())
240	{
241	StorageControllerType_T ctlr;
242	rc = pSCSIController->COMGETTER(ControllerType)(&ctlr);
243	if (SUCCEEDED(rc))
244	{
245	Utf8Str strVbox = "LsiLogic"; // the default in VBox
246	switch(ctlr)
247	{
248	case StorageControllerType_LsiLogic: strVbox = "LsiLogic"; break;
249	case StorageControllerType_BusLogic: strVbox = "BusLogic"; break;
250	}
251	lSCSIControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
252	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,
253	Utf8StrFmt("%d", lSCSIControllerIndex),
254	strVbox,
255	strVbox);
256	}
257	else
258	throw rc;
259	}
260
261	if (!pSASController.isNull())
262	{
263	// VirtualBox considers the SAS controller a class of its own but in OVF
264	// it should be a SCSI controller
265	Utf8Str strVbox = "LsiLogicSas";
266	lSCSIControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
267	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,
268	Utf8StrFmt("%d", lSCSIControllerIndex),
269	strVbox,
270	strVbox);
271	}
272
273	// <const name="HardDiskImage" value="9" />
274	// <const name="Floppy" value="18" />
275	// <const name="CDROM" value="19" />
276
277	MediaData::AttachmentList::iterator itA;
278	for (itA = mMediaData->mAttachments.begin();
279	itA != mMediaData->mAttachments.end();
280	++itA)
281	{
282	ComObjPtr<MediumAttachment> pHDA = *itA;
283
284	// the attachment's data
285	ComPtr<IMedium> pMedium;
286	ComPtr<IStorageController> ctl;
287	Bstr controllerName;
288
289	rc = pHDA->COMGETTER(Controller)(controllerName.asOutParam());
290	if (FAILED(rc)) throw rc;
291
292	rc = GetStorageControllerByName(controllerName, ctl.asOutParam());
293	if (FAILED(rc)) throw rc;
294
295	StorageBus_T storageBus;
296	DeviceType_T deviceType;
297	LONG lChannel;
298	LONG lDevice;
299
300	rc = ctl->COMGETTER(Bus)(&storageBus);
301	if (FAILED(rc)) throw rc;
302
303	rc = pHDA->COMGETTER(Type)(&deviceType);
304	if (FAILED(rc)) throw rc;
305
306	rc = pHDA->COMGETTER(Medium)(pMedium.asOutParam());
307	if (FAILED(rc)) throw rc;
308
309	rc = pHDA->COMGETTER(Port)(&lChannel);
310	if (FAILED(rc)) throw rc;
311
312	rc = pHDA->COMGETTER(Device)(&lDevice);
313	if (FAILED(rc)) throw rc;
314
315	Utf8Str strTargetVmdkName;
316	Utf8Str strLocation;
317	ULONG64 ullSize = 0;
318
319	if ( deviceType == DeviceType_HardDisk
320	&& pMedium
321	)
322	{
323	Bstr bstrLocation;
324	rc = pMedium->COMGETTER(Location)(bstrLocation.asOutParam());
325	if (FAILED(rc)) throw rc;
326	strLocation = bstrLocation;
327
328	// find the source's base medium for two things:
329	// 1) we'll use its name to determine the name of the target disk, which is readable,
330	// as opposed to the UUID filename of a differencing image, if pMedium is one
331	// 2) we need the size of the base image so we can give it to addEntry(), and later
332	// on export, the progress will be based on that (and not the diff image)
333	ComPtr<IMedium> pBaseMedium;
334	rc = pMedium->COMGETTER(Base)(pBaseMedium.asOutParam());
335	// returns pMedium if there are no diff images
336	if (FAILED(rc)) throw rc;
337
338	Bstr bstrBaseName;
339	rc = pBaseMedium->COMGETTER(Name)(bstrBaseName.asOutParam());
340	if (FAILED(rc)) throw rc;
341
342	strTargetVmdkName = bstrBaseName;
343	strTargetVmdkName.stripExt();
344	strTargetVmdkName.append(".vmdk");
345
346	// force reading state, or else size will be returned as 0
347	MediumState_T ms;
348	rc = pBaseMedium->RefreshState(&ms);
349	if (FAILED(rc)) throw rc;
350
351	rc = pBaseMedium->COMGETTER(Size)(&ullSize);
352	if (FAILED(rc)) throw rc;
353	}
354
355	// and how this translates to the virtual system
356	int32_t lControllerVsys = 0;
357	LONG lChannelVsys;
358
359	switch (storageBus)
360	{
361	case StorageBus_IDE:
362	// this is the exact reverse to what we're doing in Appliance::taskThreadImportMachines,
363	// and it must be updated when that is changed!
364	// Before 3.2 we exported one IDE controller with channel 0-3, but we now maintain
365	// compatibility with what VMware does and export two IDE controllers with two channels each
366
367	if (lChannel == 0 && lDevice == 0) // primary master
368	{
369	lControllerVsys = lIDEControllerPrimaryIndex;
370	lChannelVsys = 0;
371	}
372	else if (lChannel == 0 && lDevice == 1) // primary slave
373	{
374	lControllerVsys = lIDEControllerPrimaryIndex;
375	lChannelVsys = 1;
376	}
377	else if (lChannel == 1 && lDevice == 0) // secondary master; by default this is the CD-ROM but as of VirtualBox 3.1 that can change
378	{
379	lControllerVsys = lIDEControllerSecondaryIndex;
380	lChannelVsys = 0;
381	}
382	else if (lChannel == 1 && lDevice == 1) // secondary slave
383	{
384	lControllerVsys = lIDEControllerSecondaryIndex;
385	lChannelVsys = 1;
386	}
387	else
388	throw setError(VBOX_E_NOT_SUPPORTED,
389	tr("Cannot handle medium attachment: channel is %d, device is %d"), lChannel, lDevice);
390	break;
391
392	case StorageBus_SATA:
393	lChannelVsys = lChannel; // should be between 0 and 29
394	lControllerVsys = lSATAControllerIndex;
395	break;
396
397	case StorageBus_SCSI:
398	case StorageBus_SAS:
399	lChannelVsys = lChannel; // should be between 0 and 15
400	lControllerVsys = lSCSIControllerIndex;
401	break;
402
403	case StorageBus_Floppy:
404	lChannelVsys = 0;
405	lControllerVsys = 0;
406	break;
407
408	default:
409	throw setError(VBOX_E_NOT_SUPPORTED,
410	tr("Cannot handle medium attachment: storageBus is %d, channel is %d, device is %d"), storageBus, lChannel, lDevice);
411	break;
412	}
413
414	Utf8StrFmt strExtra("controller=%RI32;channel=%RI32", lControllerVsys, lChannelVsys);
415	Utf8Str strEmpty;
416
417	switch (deviceType)
418	{
419	case DeviceType_HardDisk:
420	Log(("Adding VirtualSystemDescriptionType_HardDiskImage, disk size: %RI64\n", ullSize));
421	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskImage,
422	strTargetVmdkName, // disk ID: let's use the name
423	strTargetVmdkName, // OVF value:
424	strLocation, // vbox value: media path
425	(uint32_t)(ullSize / _1M),
426	strExtra);
427	break;
428
429	case DeviceType_DVD:
430	pNewDesc->addEntry(VirtualSystemDescriptionType_CDROM,
431	strEmpty, // disk ID
432	strEmpty, // OVF value
433	strEmpty, // vbox value
434	1, // ulSize
435	strExtra);
436	break;
437
438	case DeviceType_Floppy:
439	pNewDesc->addEntry(VirtualSystemDescriptionType_Floppy,
440	strEmpty, // disk ID
441	strEmpty, // OVF value
442	strEmpty, // vbox value
443	1, // ulSize
444	strExtra);
445	break;
446	}
447	}
448
449	// <const name="NetworkAdapter" />
450	size_t a;
451	for (a = 0;
452	a < SchemaDefs::NetworkAdapterCount;
453	++a)
454	{
455	ComPtr<INetworkAdapter> pNetworkAdapter;
456	BOOL fEnabled;
457	NetworkAdapterType_T adapterType;
458	NetworkAttachmentType_T attachmentType;
459
460	rc = GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
461	if (FAILED(rc)) throw rc;
462	/* Enable the network card & set the adapter type */
463	rc = pNetworkAdapter->COMGETTER(Enabled)(&fEnabled);
464	if (FAILED(rc)) throw rc;
465
466	if (fEnabled)
467	{
468	Utf8Str strAttachmentType;
469
470	rc = pNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
471	if (FAILED(rc)) throw rc;
472
473	rc = pNetworkAdapter->COMGETTER(AttachmentType)(&attachmentType);
474	if (FAILED(rc)) throw rc;
475
476	switch (attachmentType)
477	{
478	case NetworkAttachmentType_Null:
479	strAttachmentType = "Null";
480	break;
481
482	case NetworkAttachmentType_NAT:
483	strAttachmentType = "NAT";
484	break;
485
486	case NetworkAttachmentType_Bridged:
487	strAttachmentType = "Bridged";
488	break;
489
490	case NetworkAttachmentType_Internal:
491	strAttachmentType = "Internal";
492	break;
493
494	case NetworkAttachmentType_HostOnly:
495	strAttachmentType = "HostOnly";
496	break;
497	}
498
499	pNewDesc->addEntry(VirtualSystemDescriptionType_NetworkAdapter,
500	"", // ref
501	strAttachmentType, // orig
502	Utf8StrFmt("%RI32", (uint32_t)adapterType), // conf
503	0,
504	Utf8StrFmt("type=%s", strAttachmentType.c_str())); // extra conf
505	}
506	}
507
508	// <const name="USBController" />
509	#ifdef VBOX_WITH_USB
510	if (fUSBEnabled)
511	pNewDesc->addEntry(VirtualSystemDescriptionType_USBController, "", "", "");
512	#endif /* VBOX_WITH_USB */
513
514	// <const name="SoundCard" />
515	if (fAudioEnabled)
516	pNewDesc->addEntry(VirtualSystemDescriptionType_SoundCard,
517	"",
518	"ensoniq1371", // this is what OVFTool writes and VMware supports
519	Utf8StrFmt("%RI32", audioController));
520
521	// finally, add the virtual system to the appliance
522	Appliance pAppliance = static_cast<Appliance>(aAppliance);
523	AutoCaller autoCaller1(pAppliance);
524	if (FAILED(autoCaller1.rc())) return autoCaller1.rc();
525
526	/* We return the new description to the caller */
527	ComPtr<IVirtualSystemDescription> copy(pNewDesc);
528	copy.queryInterfaceTo(aDescription);
529
530	AutoWriteLock alock(pAppliance COMMA_LOCKVAL_SRC_POS);
531
532	pAppliance->m->virtualSystemDescriptions.push_back(pNewDesc);
533	}
534	catch(HRESULT arc)
535	{
536	rc = arc;
537	}
538
539	return rc;
540	}
541
542	////////////////////////////////////////////////////////////////////////////////
543	//
544	// IAppliance public methods
545	//
546	////////////////////////////////////////////////////////////////////////////////
547
548	/**
549	* Public method implementation.
550	* @param format
551	* @param path
552	* @param aProgress
553	* @return
554	*/
555	STDMETHODIMP Appliance::Write(IN_BSTR format, IN_BSTR path, IProgress **aProgress)
556	{
557	if (!path) return E_POINTER;
558	CheckComArgOutPointerValid(aProgress);
559
560	AutoCaller autoCaller(this);
561	if (FAILED(autoCaller.rc())) return autoCaller.rc();
562
563	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
564
565	// do not allow entering this method if the appliance is busy reading or writing
566	if (!isApplianceIdle())
567	return E_ACCESSDENIED;
568
569	// see if we can handle this file; for now we insist it has an ".ovf" extension
570	Utf8Str strPath = path;
571	if (!strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
572	return setError(VBOX_E_FILE_ERROR,
573	tr("Appliance file must have .ovf extension"));
574
575	Utf8Str strFormat(format);
576	OVFFormat ovfF;
577	if (strFormat == "ovf-0.9")
578	ovfF = OVF_0_9;
579	else if (strFormat == "ovf-1.0")
580	ovfF = OVF_1_0;
581	else
582	return setError(VBOX_E_FILE_ERROR,
583	tr("Invalid format \"%s\" specified"), strFormat.c_str());
584
585	ComObjPtr<Progress> progress;
586	HRESULT rc = S_OK;
587	try
588	{
589	/* Parse all necessary info out of the URI */
590	parseURI(strPath, m->locInfo);
591	rc = writeImpl(ovfF, m->locInfo, progress);
592	}
593	catch (HRESULT aRC)
594	{
595	rc = aRC;
596	}
597
598	if (SUCCEEDED(rc))
599	/* Return progress to the caller */
600	progress.queryInterfaceTo(aProgress);
601
602	return rc;
603	}
604
605	////////////////////////////////////////////////////////////////////////////////
606	//
607	// Appliance private methods
608	//
609	////////////////////////////////////////////////////////////////////////////////
610
611	/**
612	* Implementation for writing out the OVF to disk. This starts a new thread which will call
613	* Appliance::taskThreadWriteOVF().
614	*
615	* This is in a separate private method because it is used from two locations:
616	*
617	* 1) from the public Appliance::Write().
618	* 2) from Appliance::writeS3(), which got called from a previous instance of Appliance::taskThreadWriteOVF().
619	*
620	* @param aFormat
621	* @param aLocInfo
622	* @param aProgress
623	* @return
624	*/
625	HRESULT Appliance::writeImpl(OVFFormat aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)
626	{
627	HRESULT rc = S_OK;
628	try
629	{
630	rc = setUpProgress(aProgress,
631	BstrFmt(tr("Export appliance '%s'"), aLocInfo.strPath.c_str()),
632	(aLocInfo.storageType == VFSType_File) ? WriteFile : WriteS3);
633
634	/* Initialize our worker task */
635	std::auto_ptr<TaskOVF> task(new TaskOVF(this, TaskOVF::Write, aLocInfo, aProgress));
636	/* The OVF version to write */
637	task->enFormat = aFormat;
638
639	rc = task->startThread();
640	if (FAILED(rc)) throw rc;
641
642	/* Don't destruct on success */
643	task.release();
644	}
645	catch (HRESULT aRC)
646	{
647	rc = aRC;
648	}
649
650	return rc;
651	}
652
653	/**
654	* Called from Appliance::writeFS() for each virtual system (machine) that needs XML written out.
655	*
656	* @param elmToAddVirtualSystemsTo XML element to append elements to.
657	* @param vsdescThis The IVirtualSystemDescription instance for which to write XML.
658	* @param enFormat OVF format (0.9 or 1.0).
659	* @param stack Structure for temporary private data shared with caller.
660	*/
661	void Appliance::buildXMLForOneVirtualSystem(xml::ElementNode &elmToAddVirtualSystemsTo,
662	std::list<xml::ElementNode> pllElementsWithUuidAttributes,
663	ComObjPtr<VirtualSystemDescription> &vsdescThis,
664	OVFFormat enFormat,
665	XMLStack &stack)
666	{
667	LogFlowFunc(("ENTER appliance %p\n", this));
668
669	xml::ElementNode *pelmVirtualSystem;
670	if (enFormat == OVF_0_9)
671	{
672	// <Section xsi:type="ovf:NetworkSection_Type">
673	pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("Content");
674	pelmVirtualSystem->setAttribute("xsi:type", "ovf:VirtualSystem_Type");
675	}
676	else
677	pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("VirtualSystem");
678
679	/xml::ElementNode pelmVirtualSystemInfo =*/ pelmVirtualSystem->createChild("Info")->addContent("A virtual machine");
680
681	std::list<VirtualSystemDescriptionEntry*> llName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);
682	if (llName.size() != 1)
683	throw setError(VBOX_E_NOT_SUPPORTED,
684	tr("Missing VM name"));
685	Utf8Str &strVMName = llName.front()->strVboxCurrent;
686	pelmVirtualSystem->setAttribute("ovf:id", strVMName);
687
688	// product info
689	std::list<VirtualSystemDescriptionEntry*> llProduct = vsdescThis->findByType(VirtualSystemDescriptionType_Product);
690	std::list<VirtualSystemDescriptionEntry*> llProductUrl = vsdescThis->findByType(VirtualSystemDescriptionType_ProductUrl);
691	std::list<VirtualSystemDescriptionEntry*> llVendor = vsdescThis->findByType(VirtualSystemDescriptionType_Vendor);
692	std::list<VirtualSystemDescriptionEntry*> llVendorUrl = vsdescThis->findByType(VirtualSystemDescriptionType_VendorUrl);
693	std::list<VirtualSystemDescriptionEntry*> llVersion = vsdescThis->findByType(VirtualSystemDescriptionType_Version);
694	bool fProduct = llProduct.size() && !llProduct.front()->strVboxCurrent.isEmpty();
695	bool fProductUrl = llProductUrl.size() && !llProductUrl.front()->strVboxCurrent.isEmpty();
696	bool fVendor = llVendor.size() && !llVendor.front()->strVboxCurrent.isEmpty();
697	bool fVendorUrl = llVendorUrl.size() && !llVendorUrl.front()->strVboxCurrent.isEmpty();
698	bool fVersion = llVersion.size() && !llVersion.front()->strVboxCurrent.isEmpty();
699	if (fProduct \|\|
700	fProductUrl \|\|
701	fVersion \|\|
702	fVendorUrl \|\|
703	fVersion)
704	{
705	/* <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
706	<Info>Meta-information about the installed software</Info>
707	<Product>VAtest</Product>
708	<Vendor>SUN Microsystems</Vendor>
709	<Version>10.0</Version>
710	<ProductUrl>http://blogs.sun.com/VirtualGuru</ProductUrl>
711	<VendorUrl>http://www.sun.com</VendorUrl>
712	</Section> */
713	xml::ElementNode *pelmAnnotationSection;
714	if (enFormat == OVF_0_9)
715	{
716	// <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
717	pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
718	pelmAnnotationSection->setAttribute("xsi:type", "ovf:ProductSection_Type");
719	}
720	else
721	pelmAnnotationSection = pelmVirtualSystem->createChild("ProductSection");
722
723	pelmAnnotationSection->createChild("Info")->addContent("Meta-information about the installed software");
724	if (fProduct)
725	pelmAnnotationSection->createChild("Product")->addContent(llProduct.front()->strVboxCurrent);
726	if (fVendor)
727	pelmAnnotationSection->createChild("Vendor")->addContent(llVendor.front()->strVboxCurrent);
728	if (fVersion)
729	pelmAnnotationSection->createChild("Version")->addContent(llVersion.front()->strVboxCurrent);
730	if (fProductUrl)
731	pelmAnnotationSection->createChild("ProductUrl")->addContent(llProductUrl.front()->strVboxCurrent);
732	if (fVendorUrl)
733	pelmAnnotationSection->createChild("VendorUrl")->addContent(llVendorUrl.front()->strVboxCurrent);
734	}
735
736	// description
737	std::list<VirtualSystemDescriptionEntry*> llDescription = vsdescThis->findByType(VirtualSystemDescriptionType_Description);
738	if (llDescription.size() &&
739	!llDescription.front()->strVboxCurrent.isEmpty())
740	{
741	/* <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
742	<Info>A human-readable annotation</Info>
743	<Annotation>Plan 9</Annotation>
744	</Section> */
745	xml::ElementNode *pelmAnnotationSection;
746	if (enFormat == OVF_0_9)
747	{
748	// <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
749	pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
750	pelmAnnotationSection->setAttribute("xsi:type", "ovf:AnnotationSection_Type");
751	}
752	else
753	pelmAnnotationSection = pelmVirtualSystem->createChild("AnnotationSection");
754
755	pelmAnnotationSection->createChild("Info")->addContent("A human-readable annotation");
756	pelmAnnotationSection->createChild("Annotation")->addContent(llDescription.front()->strVboxCurrent);
757	}
758
759	// license
760	std::list<VirtualSystemDescriptionEntry*> llLicense = vsdescThis->findByType(VirtualSystemDescriptionType_License);
761	if (llLicense.size() &&
762	!llLicense.front()->strVboxCurrent.isEmpty())
763	{
764	/* <EulaSection>
765	<Info ovf:msgid="6">License agreement for the Virtual System.</Info>
766	<License ovf:msgid="1">License terms can go in here.</License>
767	</EulaSection> */
768	xml::ElementNode *pelmEulaSection;
769	if (enFormat == OVF_0_9)
770	{
771	pelmEulaSection = pelmVirtualSystem->createChild("Section");
772	pelmEulaSection->setAttribute("xsi:type", "ovf:EulaSection_Type");
773	}
774	else
775	pelmEulaSection = pelmVirtualSystem->createChild("EulaSection");
776
777	pelmEulaSection->createChild("Info")->addContent("License agreement for the virtual system");
778	pelmEulaSection->createChild("License")->addContent(llLicense.front()->strVboxCurrent);
779	}
780
781	// operating system
782	std::list<VirtualSystemDescriptionEntry*> llOS = vsdescThis->findByType(VirtualSystemDescriptionType_OS);
783	if (llOS.size() != 1)
784	throw setError(VBOX_E_NOT_SUPPORTED,
785	tr("Missing OS type"));
786	/* <OperatingSystemSection ovf:id="82">
787	<Info>Guest Operating System</Info>
788	<Description>Linux 2.6.x</Description>
789	</OperatingSystemSection> */
790	xml::ElementNode *pelmOperatingSystemSection;
791	if (enFormat == OVF_0_9)
792	{
793	pelmOperatingSystemSection = pelmVirtualSystem->createChild("Section");
794	pelmOperatingSystemSection->setAttribute("xsi:type", "ovf:OperatingSystemSection_Type");
795	}
796	else
797	pelmOperatingSystemSection = pelmVirtualSystem->createChild("OperatingSystemSection");
798
799	pelmOperatingSystemSection->setAttribute("ovf:id", llOS.front()->strOvf);
800	pelmOperatingSystemSection->createChild("Info")->addContent("The kind of installed guest operating system");
801	Utf8Str strOSDesc;
802	convertCIMOSType2VBoxOSType(strOSDesc, (ovf::CIMOSType_T)llOS.front()->strOvf.toInt32(), "");
803	pelmOperatingSystemSection->createChild("Description")->addContent(strOSDesc);
804
805	// <VirtualHardwareSection ovf:id="hw1" ovf:transport="iso">
806	xml::ElementNode *pelmVirtualHardwareSection;
807	if (enFormat == OVF_0_9)
808	{
809	// <Section xsi:type="ovf:VirtualHardwareSection_Type">
810	pelmVirtualHardwareSection = pelmVirtualSystem->createChild("Section");
811	pelmVirtualHardwareSection->setAttribute("xsi:type", "ovf:VirtualHardwareSection_Type");
812	}
813	else
814	pelmVirtualHardwareSection = pelmVirtualSystem->createChild("VirtualHardwareSection");
815
816	pelmVirtualHardwareSection->createChild("Info")->addContent("Virtual hardware requirements for a virtual machine");
817
818	/* <System>
819	<vssd:Description>Description of the virtual hardware section.</vssd:Description>
820	<vssd:ElementName>vmware</vssd:ElementName>
821	<vssd:InstanceID>1</vssd:InstanceID>
822	<vssd:VirtualSystemIdentifier>MyLampService</vssd:VirtualSystemIdentifier>
823	<vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
824	</System> */
825	xml::ElementNode *pelmSystem = pelmVirtualHardwareSection->createChild("System");
826
827	pelmSystem->createChild("vssd:ElementName")->addContent("Virtual Hardware Family"); // required OVF 1.0
828
829	// <vssd:InstanceId>0</vssd:InstanceId>
830	if (enFormat == OVF_0_9)
831	pelmSystem->createChild("vssd:InstanceId")->addContent("0");
832	else // capitalization changed...
833	pelmSystem->createChild("vssd:InstanceID")->addContent("0");
834
835	// <vssd:VirtualSystemIdentifier>VAtest</vssd:VirtualSystemIdentifier>
836	pelmSystem->createChild("vssd:VirtualSystemIdentifier")->addContent(strVMName);
837	// <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
838	const char *pcszHardware = "virtualbox-2.2";
839	if (enFormat == OVF_0_9)
840	// pretend to be vmware compatible then
841	pcszHardware = "vmx-6";
842	pelmSystem->createChild("vssd:VirtualSystemType")->addContent(pcszHardware);
843
844	// loop thru all description entries twice; once to write out all
845	// devices _except_ disk images, and a second time to assign the
846	// disk images; this is because disk images need to reference
847	// IDE controllers, and we can't know their instance IDs without
848	// assigning them first
849
850	uint32_t idIDEPrimaryController = 0;
851	int32_t lIDEPrimaryControllerIndex = 0;
852	uint32_t idIDESecondaryController = 0;
853	int32_t lIDESecondaryControllerIndex = 0;
854	uint32_t idSATAController = 0;
855	int32_t lSATAControllerIndex = 0;
856	uint32_t idSCSIController = 0;
857	int32_t lSCSIControllerIndex = 0;
858
859	uint32_t ulInstanceID = 1;
860
861	for (size_t uLoop = 1; uLoop <= 2; ++uLoop)
862	{
863	int32_t lIndexThis = 0;
864	list<VirtualSystemDescriptionEntry>::const_iterator itD;
865	for (itD = vsdescThis->m->llDescriptions.begin();
866	itD != vsdescThis->m->llDescriptions.end();
867	++itD, ++lIndexThis)
868	{
869	const VirtualSystemDescriptionEntry &desc = *itD;
870
871	LogFlowFunc(("Loop %u: handling description entry ulIndex=%u, type=%s, strRef=%s, strOvf=%s, strVbox=%s, strExtraConfig=%s\n",
872	uLoop,
873	desc.ulIndex,
874	( desc.type == VirtualSystemDescriptionType_HardDiskControllerIDE ? "HardDiskControllerIDE"
875	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSATA ? "HardDiskControllerSATA"
876	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSCSI ? "HardDiskControllerSCSI"
877	: desc.type == VirtualSystemDescriptionType_HardDiskImage ? "HardDiskImage"
878	: Utf8StrFmt("%d", desc.type).c_str()),
879	desc.strRef.c_str(),
880	desc.strOvf.c_str(),
881	desc.strVboxCurrent.c_str(),
882	desc.strExtraConfigCurrent.c_str()));
883
884	ovf::ResourceType_T type = (ovf::ResourceType_T)0; // if this becomes != 0 then we do stuff
885	Utf8Str strResourceSubType;
886
887	Utf8Str strDescription; // results in <rasd:Description>...</rasd:Description> block
888	Utf8Str strCaption; // results in <rasd:Caption>...</rasd:Caption> block
889
890	uint32_t ulParent = 0;
891
892	int32_t lVirtualQuantity = -1;
893	Utf8Str strAllocationUnits;
894
895	int32_t lAddress = -1;
896	int32_t lBusNumber = -1;
897	int32_t lAddressOnParent = -1;
898
899	int32_t lAutomaticAllocation = -1; // 0 means "false", 1 means "true"
900	Utf8Str strConnection; // results in <rasd:Connection>...</rasd:Connection> block
901	Utf8Str strHostResource;
902
903	uint64_t uTemp;
904
905	switch (desc.type)
906	{
907	case VirtualSystemDescriptionType_CPU:
908	/* <Item>
909	<rasd:Caption>1 virtual CPU</rasd:Caption>
910	<rasd:Description>Number of virtual CPUs</rasd:Description>
911	<rasd:ElementName>virtual CPU</rasd:ElementName>
912	<rasd:InstanceID>1</rasd:InstanceID>
913	<rasd:ResourceType>3</rasd:ResourceType>
914	<rasd:VirtualQuantity>1</rasd:VirtualQuantity>
915	</Item> */
916	if (uLoop == 1)
917	{
918	strDescription = "Number of virtual CPUs";
919	type = ovf::ResourceType_Processor; // 3
920	desc.strVboxCurrent.toInt(uTemp);
921	lVirtualQuantity = (int32_t)uTemp;
922	strCaption = Utf8StrFmt("%d virtual CPU", lVirtualQuantity); // without this ovftool won't eat the item
923	}
924	break;
925
926	case VirtualSystemDescriptionType_Memory:
927	/* <Item>
928	<rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
929	<rasd:Caption>256 MB of memory</rasd:Caption>
930	<rasd:Description>Memory Size</rasd:Description>
931	<rasd:ElementName>Memory</rasd:ElementName>
932	<rasd:InstanceID>2</rasd:InstanceID>
933	<rasd:ResourceType>4</rasd:ResourceType>
934	<rasd:VirtualQuantity>256</rasd:VirtualQuantity>
935	</Item> */
936	if (uLoop == 1)
937	{
938	strDescription = "Memory Size";
939	type = ovf::ResourceType_Memory; // 4
940	desc.strVboxCurrent.toInt(uTemp);
941	lVirtualQuantity = (int32_t)(uTemp / _1M);
942	strAllocationUnits = "MegaBytes";
943	strCaption = Utf8StrFmt("%d MB of memory", lVirtualQuantity); // without this ovftool won't eat the item
944	}
945	break;
946
947	case VirtualSystemDescriptionType_HardDiskControllerIDE:
948	/* <Item>
949	<rasd:Caption>ideController1</rasd:Caption>
950	<rasd:Description>IDE Controller</rasd:Description>
951	<rasd:InstanceId>5</rasd:InstanceId>
952	<rasd:ResourceType>5</rasd:ResourceType>
953	<rasd:Address>1</rasd:Address>
954	<rasd:BusNumber>1</rasd:BusNumber>
955	</Item> */
956	if (uLoop == 1)
957	{
958	strDescription = "IDE Controller";
959	type = ovf::ResourceType_IDEController; // 5
960	strResourceSubType = desc.strVboxCurrent;
961
962	if (!lIDEPrimaryControllerIndex)
963	{
964	// first IDE controller:
965	strCaption = "ideController0";
966	lAddress = 0;
967	lBusNumber = 0;
968	// remember this ID
969	idIDEPrimaryController = ulInstanceID;
970	lIDEPrimaryControllerIndex = lIndexThis;
971	}
972	else
973	{
974	// second IDE controller:
975	strCaption = "ideController1";
976	lAddress = 1;
977	lBusNumber = 1;
978	// remember this ID
979	idIDESecondaryController = ulInstanceID;
980	lIDESecondaryControllerIndex = lIndexThis;
981	}
982	}
983	break;
984
985	case VirtualSystemDescriptionType_HardDiskControllerSATA:
986	/* <Item>
987	<rasd:Caption>sataController0</rasd:Caption>
988	<rasd:Description>SATA Controller</rasd:Description>
989	<rasd:InstanceId>4</rasd:InstanceId>
990	<rasd:ResourceType>20</rasd:ResourceType>
991	<rasd:ResourceSubType>ahci</rasd:ResourceSubType>
992	<rasd:Address>0</rasd:Address>
993	<rasd:BusNumber>0</rasd:BusNumber>
994	</Item>
995	*/
996	if (uLoop == 1)
997	{
998	strDescription = "SATA Controller";
999	strCaption = "sataController0";
1000	type = ovf::ResourceType_OtherStorageDevice; // 20
1001	// it seems that OVFTool always writes these two, and since we can only
1002	// have one SATA controller, we'll use this as well
1003	lAddress = 0;
1004	lBusNumber = 0;
1005
1006	if ( desc.strVboxCurrent.isEmpty() // AHCI is the default in VirtualBox
1007	\|\| (!desc.strVboxCurrent.compare("ahci", Utf8Str::CaseInsensitive))
1008	)
1009	strResourceSubType = "AHCI";
1010	else
1011	throw setError(VBOX_E_NOT_SUPPORTED,
1012	tr("Invalid config string \"%s\" in SATA controller"), desc.strVboxCurrent.c_str());
1013
1014	// remember this ID
1015	idSATAController = ulInstanceID;
1016	lSATAControllerIndex = lIndexThis;
1017	}
1018	break;
1019
1020	case VirtualSystemDescriptionType_HardDiskControllerSCSI:
1021	/* <Item>
1022	<rasd:Caption>scsiController0</rasd:Caption>
1023	<rasd:Description>SCSI Controller</rasd:Description>
1024	<rasd:InstanceId>4</rasd:InstanceId>
1025	<rasd:ResourceType>6</rasd:ResourceType>
1026	<rasd:ResourceSubType>buslogic</rasd:ResourceSubType>
1027	<rasd:Address>0</rasd:Address>
1028	<rasd:BusNumber>0</rasd:BusNumber>
1029	</Item>
1030	*/
1031	if (uLoop == 1)
1032	{
1033	strDescription = "SCSI Controller";
1034	strCaption = "scsiController0";
1035	type = ovf::ResourceType_ParallelSCSIHBA; // 6
1036	// it seems that OVFTool always writes these two, and since we can only
1037	// have one SATA controller, we'll use this as well
1038	lAddress = 0;
1039	lBusNumber = 0;
1040
1041	if ( desc.strVboxCurrent.isEmpty() // LsiLogic is the default in VirtualBox
1042	\|\| (!desc.strVboxCurrent.compare("lsilogic", Utf8Str::CaseInsensitive))
1043	)
1044	strResourceSubType = "lsilogic";
1045	else if (!desc.strVboxCurrent.compare("buslogic", Utf8Str::CaseInsensitive))
1046	strResourceSubType = "buslogic";
1047	else if (!desc.strVboxCurrent.compare("lsilogicsas", Utf8Str::CaseInsensitive))
1048	strResourceSubType = "lsilogicsas";
1049	else
1050	throw setError(VBOX_E_NOT_SUPPORTED,
1051	tr("Invalid config string \"%s\" in SCSI controller"), desc.strVboxCurrent.c_str());
1052
1053	// remember this ID
1054	idSCSIController = ulInstanceID;
1055	lSCSIControllerIndex = lIndexThis;
1056	}
1057	break;
1058
1059	case VirtualSystemDescriptionType_HardDiskImage:
1060	/* <Item>
1061	<rasd:Caption>disk1</rasd:Caption>
1062	<rasd:InstanceId>8</rasd:InstanceId>
1063	<rasd:ResourceType>17</rasd:ResourceType>
1064	<rasd:HostResource>/disk/vmdisk1</rasd:HostResource>
1065	<rasd:Parent>4</rasd:Parent>
1066	<rasd:AddressOnParent>0</rasd:AddressOnParent>
1067	</Item> */
1068	if (uLoop == 2)
1069	{
1070	uint32_t cDisks = stack.mapDisks.size();
1071	Utf8Str strDiskID = Utf8StrFmt("vmdisk%RI32", ++cDisks);
1072
1073	strDescription = "Disk Image";
1074	strCaption = Utf8StrFmt("disk%RI32", cDisks); // this is not used for anything else
1075	type = ovf::ResourceType_HardDisk; // 17
1076
1077	// the following references the "<Disks>" XML block
1078	strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());
1079
1080	// controller=<index>;channel=<c>
1081	size_t pos1 = desc.strExtraConfigCurrent.find("controller=");
1082	size_t pos2 = desc.strExtraConfigCurrent.find("channel=");
1083	int32_t lControllerIndex = -1;
1084	if (pos1 != Utf8Str::npos)
1085	{
1086	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
1087	if (lControllerIndex == lIDEPrimaryControllerIndex)
1088	ulParent = idIDEPrimaryController;
1089	else if (lControllerIndex == lIDESecondaryControllerIndex)
1090	ulParent = idIDESecondaryController;
1091	else if (lControllerIndex == lSCSIControllerIndex)
1092	ulParent = idSCSIController;
1093	else if (lControllerIndex == lSATAControllerIndex)
1094	ulParent = idSATAController;
1095	}
1096	if (pos2 != Utf8Str::npos)
1097	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
1098
1099	LogFlowFunc(("HardDiskImage details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",
1100	pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex, lIDESecondaryControllerIndex, ulParent, lAddressOnParent));
1101
1102	if ( !ulParent
1103	\|\| lAddressOnParent == -1
1104	)
1105	throw setError(VBOX_E_NOT_SUPPORTED,
1106	tr("Missing or bad extra config string in hard disk image: \"%s\""), desc.strExtraConfigCurrent.c_str());
1107
1108	stack.mapDisks[strDiskID] = &desc;
1109	}
1110	break;
1111
1112	case VirtualSystemDescriptionType_Floppy:
1113	if (uLoop == 1)
1114	{
1115	strDescription = "Floppy Drive";
1116	strCaption = "floppy0"; // this is what OVFTool writes
1117	type = ovf::ResourceType_FloppyDrive; // 14
1118	lAutomaticAllocation = 0;
1119	lAddressOnParent = 0; // this is what OVFTool writes
1120	}
1121	break;
1122
1123	case VirtualSystemDescriptionType_CDROM:
1124	if (uLoop == 2)
1125	{
1126	// we can't have a CD without an IDE controller
1127	if (!idIDESecondaryController)
1128	throw setError(VBOX_E_NOT_SUPPORTED,
1129	tr("Can't have CD-ROM without secondary IDE controller"));
1130
1131	strDescription = "CD-ROM Drive";
1132	strCaption = "cdrom1"; // this is what OVFTool writes
1133	type = ovf::ResourceType_CDDrive; // 15
1134	lAutomaticAllocation = 1;
1135	ulParent = idIDESecondaryController;
1136	lAddressOnParent = 0; // this is what OVFTool writes
1137	}
1138	break;
1139
1140	case VirtualSystemDescriptionType_NetworkAdapter:
1141	/* <Item>
1142	<rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
1143	<rasd:Caption>Ethernet adapter on 'VM Network'</rasd:Caption>
1144	<rasd:Connection>VM Network</rasd:Connection>
1145	<rasd:ElementName>VM network</rasd:ElementName>
1146	<rasd:InstanceID>3</rasd:InstanceID>
1147	<rasd:ResourceType>10</rasd:ResourceType>
1148	</Item> */
1149	if (uLoop == 1)
1150	{
1151	lAutomaticAllocation = 1;
1152	strCaption = Utf8StrFmt("Ethernet adapter on '%s'", desc.strOvf.c_str());
1153	type = ovf::ResourceType_EthernetAdapter; // 10
1154	/* Set the hardware type to something useful.
1155	* To be compatible with vmware & others we set
1156	* PCNet32 for our PCNet types & E1000 for the
1157	* E1000 cards. */
1158	switch (desc.strVboxCurrent.toInt32())
1159	{
1160	case NetworkAdapterType_Am79C970A:
1161	case NetworkAdapterType_Am79C973: strResourceSubType = "PCNet32"; break;
1162	#ifdef VBOX_WITH_E1000
1163	case NetworkAdapterType_I82540EM:
1164	case NetworkAdapterType_I82545EM:
1165	case NetworkAdapterType_I82543GC: strResourceSubType = "E1000"; break;
1166	#endif /* VBOX_WITH_E1000 */
1167	}
1168	strConnection = desc.strOvf;
1169
1170	stack.mapNetworks[desc.strOvf] = true;
1171	}
1172	break;
1173
1174	case VirtualSystemDescriptionType_USBController:
1175	/* <Item ovf:required="false">
1176	<rasd:Caption>usb</rasd:Caption>
1177	<rasd:Description>USB Controller</rasd:Description>
1178	<rasd:InstanceId>3</rasd:InstanceId>
1179	<rasd:ResourceType>23</rasd:ResourceType>
1180	<rasd:Address>0</rasd:Address>
1181	<rasd:BusNumber>0</rasd:BusNumber>
1182	</Item> */
1183	if (uLoop == 1)
1184	{
1185	strDescription = "USB Controller";
1186	strCaption = "usb";
1187	type = ovf::ResourceType_USBController; // 23
1188	lAddress = 0; // this is what OVFTool writes
1189	lBusNumber = 0; // this is what OVFTool writes
1190	}
1191	break;
1192
1193	case VirtualSystemDescriptionType_SoundCard:
1194	/* <Item ovf:required="false">
1195	<rasd:Caption>sound</rasd:Caption>
1196	<rasd:Description>Sound Card</rasd:Description>
1197	<rasd:InstanceId>10</rasd:InstanceId>
1198	<rasd:ResourceType>35</rasd:ResourceType>
1199	<rasd:ResourceSubType>ensoniq1371</rasd:ResourceSubType>
1200	<rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
1201	<rasd:AddressOnParent>3</rasd:AddressOnParent>
1202	</Item> */
1203	if (uLoop == 1)
1204	{
1205	strDescription = "Sound Card";
1206	strCaption = "sound";
1207	type = ovf::ResourceType_SoundCard; // 35
1208	strResourceSubType = desc.strOvf; // e.g. ensoniq1371
1209	lAutomaticAllocation = 0;
1210	lAddressOnParent = 3; // what gives? this is what OVFTool writes
1211	}
1212	break;
1213	}
1214
1215	if (type)
1216	{
1217	xml::ElementNode *pItem;
1218
1219	pItem = pelmVirtualHardwareSection->createChild("Item");
1220
1221	// NOTE: DO NOT CHANGE THE ORDER of these items! The OVF standards prescribes that
1222	// the elements from the rasd: namespace must be sorted by letter, and VMware
1223	// actually requires this as well (see public bug #6612)
1224
1225	if (lAddress != -1)
1226	pItem->createChild("rasd:Address")->addContent(Utf8StrFmt("%d", lAddress));
1227
1228	if (lAddressOnParent != -1)
1229	pItem->createChild("rasd:AddressOnParent")->addContent(Utf8StrFmt("%d", lAddressOnParent));
1230
1231	if (!strAllocationUnits.isEmpty())
1232	pItem->createChild("rasd:AllocationUnits")->addContent(strAllocationUnits);
1233
1234	if (lAutomaticAllocation != -1)
1235	pItem->createChild("rasd:AutomaticAllocation")->addContent( (lAutomaticAllocation) ? "true" : "false" );
1236
1237	if (lBusNumber != -1)
1238	if (enFormat == OVF_0_9) // BusNumber is invalid OVF 1.0 so only write it in 0.9 mode for OVFTool compatibility
1239	pItem->createChild("rasd:BusNumber")->addContent(Utf8StrFmt("%d", lBusNumber));
1240
1241	if (!strCaption.isEmpty())
1242	pItem->createChild("rasd:Caption")->addContent(strCaption);
1243
1244	if (!strConnection.isEmpty())
1245	pItem->createChild("rasd:Connection")->addContent(strConnection);
1246
1247	if (!strDescription.isEmpty())
1248	pItem->createChild("rasd:Description")->addContent(strDescription);
1249
1250	if (!strCaption.isEmpty())
1251	if (enFormat == OVF_1_0)
1252	pItem->createChild("rasd:ElementName")->addContent(strCaption);
1253
1254	if (!strHostResource.isEmpty())
1255	pItem->createChild("rasd:HostResource")->addContent(strHostResource);
1256
1257	// <rasd:InstanceID>1</rasd:InstanceID>
1258	xml::ElementNode *pelmInstanceID;
1259	if (enFormat == OVF_0_9)
1260	pelmInstanceID = pItem->createChild("rasd:InstanceId");
1261	else
1262	pelmInstanceID = pItem->createChild("rasd:InstanceID"); // capitalization changed...
1263	pelmInstanceID->addContent(Utf8StrFmt("%d", ulInstanceID++));
1264
1265	if (ulParent)
1266	pItem->createChild("rasd:Parent")->addContent(Utf8StrFmt("%d", ulParent));
1267
1268	if (!strResourceSubType.isEmpty())
1269	pItem->createChild("rasd:ResourceSubType")->addContent(strResourceSubType);
1270
1271	// <rasd:ResourceType>3</rasd:ResourceType>
1272	pItem->createChild("rasd:ResourceType")->addContent(Utf8StrFmt("%d", type));
1273
1274	// <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
1275	if (lVirtualQuantity != -1)
1276	pItem->createChild("rasd:VirtualQuantity")->addContent(Utf8StrFmt("%d", lVirtualQuantity));
1277	}
1278	}
1279	} // for (size_t uLoop = 1; uLoop <= 2; ++uLoop)
1280
1281	// now that we're done with the official OVF <Item> tags under <VirtualSystem>, write out VirtualBox XML
1282	// under the vbox: namespace
1283	xml::ElementNode *pelmVBoxMachine = pelmVirtualSystem->createChild("vbox:Machine");
1284	// ovf:required="false" tells other OVF parsers that they can ignore this thing
1285	pelmVBoxMachine->setAttribute("ovf:required", "false");
1286	// ovf:Info element is required or VMware will bail out on the vbox:Machine element
1287	pelmVBoxMachine->createChild("ovf:Info")->addContent("Complete VirtualBox machine configuration in VirtualBox format");
1288
1289	// create an empty machine config
1290	settings::MachineConfigFile *pConfig = new settings::MachineConfigFile(NULL);
1291
1292	try
1293	{
1294	AutoWriteLock machineLock(vsdescThis->m->pMachine COMMA_LOCKVAL_SRC_POS);
1295	// fill the machine config
1296	vsdescThis->m->pMachine->copyMachineDataToSettings(*pConfig);
1297	// write the machine config to the vbox:Machine element
1298	pConfig->buildMachineXML(*pelmVBoxMachine,
1299	settings::MachineConfigFile::BuildMachineXML_WriteVboxVersionAttribute
1300	\| settings::MachineConfigFile::BuildMachineXML_SkipRemovableMedia,
1301	// but not BuildMachineXML_IncludeSnapshots
1302	pllElementsWithUuidAttributes);
1303	delete pConfig;
1304	}
1305	catch (...)
1306	{
1307	delete pConfig;
1308	throw;
1309	}
1310	}
1311
1312	/**
1313	* Actual worker code for writing out OVF to disk. This is called from Appliance::taskThreadWriteOVF()
1314	* and therefore runs on the OVF write worker thread. This runs in two contexts:
1315	*
1316	* 1) in a first worker thread; in that case, Appliance::Write() called Appliance::writeImpl();
1317	*
1318	* 2) in a second worker thread; in that case, Appliance::Write() called Appliance::writeImpl(), which
1319	* called Appliance::writeS3(), which called Appliance::writeImpl(), which then called this. In other
1320	* words, to write to the cloud, the first worker thread first starts a second worker thread to create
1321	* temporary files and then uploads them to the S3 cloud server.
1322	*
1323	* @param pTask
1324	* @return
1325	*/
1326	HRESULT Appliance::writeFS(const LocationInfo &locInfo, const OVFFormat enFormat, ComObjPtr<Progress> &pProgress)
1327	{
1328	LogFlowFunc(("ENTER appliance %p\n", this));
1329
1330	AutoCaller autoCaller(this);
1331	if (FAILED(autoCaller.rc())) return autoCaller.rc();
1332
1333	HRESULT rc = S_OK;
1334
1335	try
1336	{
1337	AutoMultiWriteLock2 multiLock(&mVirtualBox->getMediaTreeLockHandle(), this->lockHandle() COMMA_LOCKVAL_SRC_POS);
1338
1339	xml::Document doc;
1340	xml::ElementNode *pelmRoot = doc.createRootElement("Envelope");
1341
1342	pelmRoot->setAttribute("ovf:version", (enFormat == OVF_1_0) ? "1.0" : "0.9");
1343	pelmRoot->setAttribute("xml:lang", "en-US");
1344
1345	Utf8Str strNamespace = (enFormat == OVF_0_9)
1346	? "http://www.vmware.com/schema/ovf/1/envelope" // 0.9
1347	: "http://schemas.dmtf.org/ovf/envelope/1"; // 1.0
1348	pelmRoot->setAttribute("xmlns", strNamespace);
1349	pelmRoot->setAttribute("xmlns:ovf", strNamespace);
1350
1351	// pelmRoot->setAttribute("xmlns:ovfstr", "http://schema.dmtf.org/ovf/strings/1");
1352	pelmRoot->setAttribute("xmlns:rasd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData");
1353	pelmRoot->setAttribute("xmlns:vssd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData");
1354	pelmRoot->setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
1355	pelmRoot->setAttribute("xmlns:vbox", "http://www.virtualbox.org/ovf/machine");
1356	// pelmRoot->setAttribute("xsi:schemaLocation", "http://schemas.dmtf.org/ovf/envelope/1 ../ovf-envelope.xsd");
1357
1358	// <Envelope>/<References>
1359	xml::ElementNode *pelmReferences = pelmRoot->createChild("References"); // 0.9 and 1.0
1360
1361	/* <Envelope>/<DiskSection>:
1362	<DiskSection>
1363	<Info>List of the virtual disks used in the package</Info>
1364	<Disk ovf:capacity="4294967296" ovf:diskId="lamp" ovf:format="..." ovf:populatedSize="1924967692"/>
1365	</DiskSection> */
1366	xml::ElementNode *pelmDiskSection;
1367	if (enFormat == OVF_0_9)
1368	{
1369	// <Section xsi:type="ovf:DiskSection_Type">
1370	pelmDiskSection = pelmRoot->createChild("Section");
1371	pelmDiskSection->setAttribute("xsi:type", "ovf:DiskSection_Type");
1372	}
1373	else
1374	pelmDiskSection = pelmRoot->createChild("DiskSection");
1375
1376	xml::ElementNode *pelmDiskSectionInfo = pelmDiskSection->createChild("Info");
1377	pelmDiskSectionInfo->addContent("List of the virtual disks used in the package");
1378
1379	// the XML stack contains two maps for disks and networks, which allows us to
1380	// a) have a list of unique disk names (to make sure the same disk name is only added once)
1381	// and b) keep a list of all networks
1382	XMLStack stack;
1383
1384	/* <Envelope>/<NetworkSection>:
1385	<NetworkSection>
1386	<Info>Logical networks used in the package</Info>
1387	<Network ovf:name="VM Network">
1388	<Description>The network that the LAMP Service will be available on</Description>
1389	</Network>
1390	</NetworkSection> */
1391	xml::ElementNode *pelmNetworkSection;
1392	if (enFormat == OVF_0_9)
1393	{
1394	// <Section xsi:type="ovf:NetworkSection_Type">
1395	pelmNetworkSection = pelmRoot->createChild("Section");
1396	pelmNetworkSection->setAttribute("xsi:type", "ovf:NetworkSection_Type");
1397	}
1398	else
1399	pelmNetworkSection = pelmRoot->createChild("NetworkSection");
1400
1401	xml::ElementNode *pelmNetworkSectionInfo = pelmNetworkSection->createChild("Info");
1402	pelmNetworkSectionInfo->addContent("Logical networks used in the package");
1403
1404	// and here come the virtual systems:
1405
1406	// This can take a very long time so leave the locks; in particular, we have the media tree
1407	// lock which Medium::CloneTo() will request, and that would deadlock. Instead, protect
1408	// the appliance by resetting its state so we can safely leave the lock
1409	m->state = Data::ApplianceExporting;
1410	multiLock.release();
1411
1412	// write a collection if we have more than one virtual system _and_ we're
1413	// writing OVF 1.0; otherwise fail since ovftool can't import more than
1414	// one machine, it seems
1415	xml::ElementNode *pelmToAddVirtualSystemsTo;
1416	if (m->virtualSystemDescriptions.size() > 1)
1417	{
1418	if (enFormat == OVF_0_9)
1419	throw setError(VBOX_E_FILE_ERROR,
1420	tr("Cannot export more than one virtual system with OVF 0.9, use OVF 1.0"));
1421
1422	pelmToAddVirtualSystemsTo = pelmRoot->createChild("VirtualSystemCollection");
1423	pelmToAddVirtualSystemsTo->setAttribute("ovf:name", "ExportedVirtualBoxMachines"); // whatever
1424	}
1425	else
1426	pelmToAddVirtualSystemsTo = pelmRoot; // add virtual system directly under root element
1427
1428	// this list receives pointers to the XML elements in the machine XML which
1429	// might have UUIDs that need fixing after we know the UUIDs of the exported images
1430	std::list<xml::ElementNode*> llElementsWithUuidAttributes;
1431
1432	list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
1433	/* Iterate throughs all virtual systems of that appliance */
1434	for (it = m->virtualSystemDescriptions.begin();
1435	it != m->virtualSystemDescriptions.end();
1436	++it)
1437	{
1438	ComObjPtr<VirtualSystemDescription> vsdescThis = *it;
1439	buildXMLForOneVirtualSystem(*pelmToAddVirtualSystemsTo,
1440	&llElementsWithUuidAttributes,
1441	vsdescThis,
1442	enFormat,
1443	stack); // disks and networks stack
1444	}
1445
1446	// now, fill in the network section we set up empty above according
1447	// to the networks we found with the hardware items
1448	map<Utf8Str, bool>::const_iterator itN;
1449	for (itN = stack.mapNetworks.begin();
1450	itN != stack.mapNetworks.end();
1451	++itN)
1452	{
1453	const Utf8Str &strNetwork = itN->first;
1454	xml::ElementNode *pelmNetwork = pelmNetworkSection->createChild("Network");
1455	pelmNetwork->setAttribute("ovf:name", strNetwork.c_str());
1456	pelmNetwork->createChild("Description")->addContent("Logical network used by this appliance.");
1457	}
1458
1459	// Finally, write out the disks!
1460
1461	list<Utf8Str> diskList;
1462	map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;
1463	uint32_t ulFile = 1;
1464	for (itS = stack.mapDisks.begin();
1465	itS != stack.mapDisks.end();
1466	++itS)
1467	{
1468	const Utf8Str &strDiskID = itS->first;
1469	const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;
1470
1471	// source path: where the VBox image is
1472	const Utf8Str &strSrcFilePath = pDiskEntry->strVboxCurrent;
1473	Bstr bstrSrcFilePath(strSrcFilePath);
1474	if (!RTPathExists(strSrcFilePath.c_str()))
1475	/* This isn't allowed */
1476	throw setError(VBOX_E_FILE_ERROR,
1477	tr("Source virtual disk image file '%s' doesn't exist"),
1478	strSrcFilePath.c_str());
1479
1480	// clone the disk:
1481	ComPtr<IMedium> pSourceDisk;
1482	ComPtr<IMedium> pTargetDisk;
1483	ComPtr<IProgress> pProgress2;
1484
1485	Log(("Finding source disk \"%ls\"\n", bstrSrcFilePath.raw()));
1486	rc = mVirtualBox->FindHardDisk(bstrSrcFilePath, pSourceDisk.asOutParam());
1487	if (FAILED(rc)) throw rc;
1488
1489	Bstr uuidSource;
1490	rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());
1491	if (FAILED(rc)) throw rc;
1492	Guid guidSource(uuidSource);
1493
1494	// output filename
1495	const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
1496	// target path needs to be composed from where the output OVF is
1497	Utf8Str strTargetFilePath(locInfo.strPath);
1498	strTargetFilePath.stripFilename();
1499	strTargetFilePath.append("/");
1500	strTargetFilePath.append(strTargetFileNameOnly);
1501
1502	// We are always exporting to VMDK stream optimized for now
1503	Bstr bstrSrcFormat = L"VMDK";
1504
1505	// create a new hard disk interface for the destination disk image
1506	Log(("Creating target disk \"%s\"\n", strTargetFilePath.raw()));
1507	rc = mVirtualBox->CreateHardDisk(bstrSrcFormat, Bstr(strTargetFilePath), pTargetDisk.asOutParam());
1508	if (FAILED(rc)) throw rc;
1509
1510	// the target disk is now registered and needs to be removed again,
1511	// both after successful cloning or if anything goes bad!
1512	try
1513	{
1514	// create a flat copy of the source disk image
1515	rc = pSourceDisk->CloneTo(pTargetDisk, MediumVariant_VmdkStreamOptimized, NULL, pProgress2.asOutParam());
1516	if (FAILED(rc)) throw rc;
1517
1518	// advance to the next operation
1519	pProgress->SetNextOperation(BstrFmt(tr("Exporting to disk image '%s'"), strTargetFilePath.c_str()),
1520	pDiskEntry->ulSizeMB); // operation's weight, as set up with the IProgress originally);
1521
1522	// now wait for the background disk operation to complete; this throws HRESULTs on error
1523	waitForAsyncProgress(pProgress, pProgress2);
1524	}
1525	catch (HRESULT rc3)
1526	{
1527	// upon error after registering, close the disk or
1528	// it'll stick in the registry forever
1529	pTargetDisk->Close();
1530	throw rc3;
1531	}
1532	diskList.push_back(strTargetFilePath);
1533
1534	// we need the following for the XML
1535	ULONG64 cbFile = 0; // actual file size
1536	rc = pTargetDisk->COMGETTER(Size)(&cbFile);
1537	if (FAILED(rc)) throw rc;
1538
1539	ULONG64 cbCapacity = 0; // size reported to guest
1540	rc = pTargetDisk->COMGETTER(LogicalSize)(&cbCapacity);
1541	if (FAILED(rc)) throw rc;
1542	// capacity is reported in megabytes, so...
1543	cbCapacity *= _1M;
1544
1545	Bstr uuidTarget;
1546	rc = pTargetDisk->COMGETTER(Id)(uuidTarget.asOutParam());
1547	if (FAILED(rc)) throw rc;
1548	Guid guidTarget(uuidTarget);
1549
1550	// upon success, close the disk as well
1551	rc = pTargetDisk->Close();
1552	if (FAILED(rc)) throw rc;
1553
1554	// now handle the XML for the disk:
1555	Utf8StrFmt strFileRef("file%RI32", ulFile++);
1556	// <File ovf:href="WindowsXpProfessional-disk1.vmdk" ovf:id="file1" ovf:size="1710381056"/>
1557	xml::ElementNode *pelmFile = pelmReferences->createChild("File");
1558	pelmFile->setAttribute("ovf:href", strTargetFileNameOnly);
1559	pelmFile->setAttribute("ovf:id", strFileRef);
1560	pelmFile->setAttribute("ovf:size", Utf8StrFmt("%RI64", cbFile).c_str());
1561
1562	// add disk to XML Disks section
1563	// <Disk ovf:capacity="8589934592" ovf:diskId="vmdisk1" ovf:fileRef="file1" ovf:format="..."/>
1564	xml::ElementNode *pelmDisk = pelmDiskSection->createChild("Disk");
1565	pelmDisk->setAttribute("ovf:capacity", Utf8StrFmt("%RI64", cbCapacity).c_str());
1566	pelmDisk->setAttribute("ovf:diskId", strDiskID);
1567	pelmDisk->setAttribute("ovf:fileRef", strFileRef);
1568	pelmDisk->setAttribute("ovf:format",
1569	(enFormat == OVF_0_9)
1570	? "http://www.vmware.com/specifications/vmdk.html#sparse" // must be sparse or ovftool chokes
1571	: "http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized"
1572	// correct string as communicated to us by VMware (public bug #6612)
1573	);
1574
1575	// add the UUID of the newly created target image to the OVF disk element, but in the
1576	// vbox: namespace since it's not part of the standard
1577	pelmDisk->setAttribute("vbox:uuid", Utf8StrFmt("%RTuuid", guidTarget.raw()).c_str());
1578
1579	// now, we might have other XML elements from vbox:Machine pointing to this image,
1580	// but those would refer to the UUID of the _source_ image (which we created the
1581	// export image from); those UUIDs need to be fixed to the export image
1582	for (std::list<xml::ElementNode*>::iterator eit = llElementsWithUuidAttributes.begin();
1583	eit != llElementsWithUuidAttributes.end();
1584	++eit)
1585	{
1586	xml::ElementNode pelmImage = eit;
1587	// overwrite existing uuid attribute
1588	pelmImage->setAttribute("uuid", guidTarget.toStringCurly());
1589	}
1590	}
1591
1592	// now go write the XML
1593	xml::XmlFileWriter writer(doc);
1594	writer.write(locInfo.strPath.c_str(), false /fSafe/);
1595
1596	// Create & write the manifest file
1597	Utf8Str strMfFile = manifestFileName(locInfo.strPath.c_str());
1598	const char *pcszManifestFileOnly = RTPathFilename(strMfFile.c_str());
1599	pProgress->SetNextOperation(BstrFmt(tr("Creating manifest file '%s'"), pcszManifestFileOnly),
1600	m->ulWeightForManifestOperation); // operation's weight, as set up with the IProgress originally);
1601
1602	const char ppManifestFiles = (const char)RTMemAlloc(sizeof(char)diskList.size() + 1);
1603	ppManifestFiles[0] = locInfo.strPath.c_str();
1604	list<Utf8Str>::const_iterator it1;
1605	size_t i = 1;
1606	for (it1 = diskList.begin();
1607	it1 != diskList.end();
1608	++it1, ++i)
1609	ppManifestFiles[i] = (*it1).c_str();
1610	int vrc = RTManifestWriteFiles(strMfFile.c_str(), ppManifestFiles, diskList.size()+1, NULL, NULL);
1611	RTMemFree(ppManifestFiles);
1612	if (RT_FAILURE(vrc))
1613	throw setError(VBOX_E_FILE_ERROR,
1614	tr("Could not create manifest file '%s' (%Rrc)"),
1615	pcszManifestFileOnly, vrc);
1616	}
1617	catch(xml::Error &x)
1618	{
1619	rc = setError(VBOX_E_FILE_ERROR,
1620	x.what());
1621	}
1622	catch(HRESULT aRC)
1623	{
1624	rc = aRC;
1625	}
1626
1627	AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
1628	// reset the state so others can call methods again
1629	m->state = Data::ApplianceIdle;
1630
1631	LogFlowFunc(("rc=%Rhrc\n", rc));
1632	LogFlowFuncLeave();
1633
1634	return rc;
1635	}
1636
1637	/**
1638	* Worker code for writing out OVF to the cloud. This is called from Appliance::taskThreadWriteOVF()
1639	* in S3 mode and therefore runs on the OVF write worker thread. This then starts a second worker
1640	* thread to create temporary files (see Appliance::writeFS()).
1641	*
1642	* @param pTask
1643	* @return
1644	*/
1645	HRESULT Appliance::writeS3(TaskOVF *pTask)
1646	{
1647	LogFlowFuncEnter();
1648	LogFlowFunc(("Appliance %p\n", this));
1649
1650	AutoCaller autoCaller(this);
1651	if (FAILED(autoCaller.rc())) return autoCaller.rc();
1652
1653	HRESULT rc = S_OK;
1654
1655	AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
1656
1657	int vrc = VINF_SUCCESS;
1658	RTS3 hS3 = NIL_RTS3;
1659	char szOSTmpDir[RTPATH_MAX];
1660	RTPathTemp(szOSTmpDir, sizeof(szOSTmpDir));
1661	/* The template for the temporary directory created below */
1662	char *pszTmpDir;
1663	RTStrAPrintf(&pszTmpDir, "%s"RTPATH_SLASH_STR"vbox-ovf-XXXXXX", szOSTmpDir);
1664	list< pair<Utf8Str, ULONG> > filesList;
1665
1666	// todo:
1667	// - usable error codes
1668	// - seems snapshot filenames are problematic {uuid}.vdi
1669	try
1670	{
1671	/* Extract the bucket */
1672	Utf8Str tmpPath = pTask->locInfo.strPath;
1673	Utf8Str bucket;
1674	parseBucket(tmpPath, bucket);
1675
1676	/* We need a temporary directory which we can put the OVF file & all
1677	* disk images in */
1678	vrc = RTDirCreateTemp(pszTmpDir);
1679	if (RT_FAILURE(vrc))
1680	throw setError(VBOX_E_FILE_ERROR,
1681	tr("Cannot create temporary directory '%s'"), pszTmpDir);
1682
1683	/* The temporary name of the target OVF file */
1684	Utf8StrFmt strTmpOvf("%s/%s", pszTmpDir, RTPathFilename(tmpPath.c_str()));
1685
1686	/* Prepare the temporary writing of the OVF */
1687	ComObjPtr<Progress> progress;
1688	/* Create a temporary file based location info for the sub task */
1689	LocationInfo li;
1690	li.strPath = strTmpOvf;
1691	rc = writeImpl(pTask->enFormat, li, progress);
1692	if (FAILED(rc)) throw rc;
1693
1694	/* Unlock the appliance for the writing thread */
1695	appLock.release();
1696	/* Wait until the writing is done, but report the progress back to the
1697	caller */
1698	ComPtr<IProgress> progressInt(progress);
1699	waitForAsyncProgress(pTask->pProgress, progressInt); /* Any errors will be thrown */
1700
1701	/* Again lock the appliance for the next steps */
1702	appLock.acquire();
1703
1704	vrc = RTPathExists(strTmpOvf.c_str()); /* Paranoid check */
1705	if (RT_FAILURE(vrc))
1706	throw setError(VBOX_E_FILE_ERROR,
1707	tr("Cannot find source file '%s'"), strTmpOvf.c_str());
1708	/* Add the OVF file */
1709	filesList.push_back(pair<Utf8Str, ULONG>(strTmpOvf, m->ulWeightForXmlOperation)); /* Use 1% of the total for the OVF file upload */
1710	Utf8Str strMfFile = manifestFileName(strTmpOvf);
1711	filesList.push_back(pair<Utf8Str, ULONG>(strMfFile , m->ulWeightForXmlOperation)); /* Use 1% of the total for the manifest file upload */
1712
1713	/* Now add every disks of every virtual system */
1714	list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
1715	for (it = m->virtualSystemDescriptions.begin();
1716	it != m->virtualSystemDescriptions.end();
1717	++it)
1718	{
1719	ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
1720	std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
1721	std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
1722	for (itH = avsdeHDs.begin();
1723	itH != avsdeHDs.end();
1724	++itH)
1725	{
1726	const Utf8Str &strTargetFileNameOnly = (*itH)->strOvf;
1727	/* Target path needs to be composed from where the output OVF is */
1728	Utf8Str strTargetFilePath(strTmpOvf);
1729	strTargetFilePath.stripFilename();
1730	strTargetFilePath.append("/");
1731	strTargetFilePath.append(strTargetFileNameOnly);
1732	vrc = RTPathExists(strTargetFilePath.c_str()); /* Paranoid check */
1733	if (RT_FAILURE(vrc))
1734	throw setError(VBOX_E_FILE_ERROR,
1735	tr("Cannot find source file '%s'"), strTargetFilePath.c_str());
1736	filesList.push_back(pair<Utf8Str, ULONG>(strTargetFilePath, (*itH)->ulSizeMB));
1737	}
1738	}
1739	/* Next we have to upload the OVF & all disk images */
1740	vrc = RTS3Create(&hS3, pTask->locInfo.strUsername.c_str(), pTask->locInfo.strPassword.c_str(), pTask->locInfo.strHostname.c_str(), "virtualbox-agent/"VBOX_VERSION_STRING);
1741	if (RT_FAILURE(vrc))
1742	throw setError(VBOX_E_IPRT_ERROR,
1743	tr("Cannot create S3 service handler"));
1744	RTS3SetProgressCallback(hS3, pTask->updateProgress, &pTask);
1745
1746	/* Upload all files */
1747	for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
1748	{
1749	const pair<Utf8Str, ULONG> &s = (*it1);
1750	char *pszFilename = RTPathFilename(s.first.c_str());
1751	/* Advance to the next operation */
1752	pTask->pProgress->SetNextOperation(BstrFmt(tr("Uploading file '%s'"), pszFilename), s.second);
1753	vrc = RTS3PutKey(hS3, bucket.c_str(), pszFilename, s.first.c_str());
1754	if (RT_FAILURE(vrc))
1755	{
1756	if (vrc == VERR_S3_CANCELED)
1757	break;
1758	else if (vrc == VERR_S3_ACCESS_DENIED)
1759	throw setError(E_ACCESSDENIED,
1760	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);
1761	else if (vrc == VERR_S3_NOT_FOUND)
1762	throw setError(VBOX_E_FILE_ERROR,
1763	tr("Cannot upload file '%s' to S3 storage server (File not found)"), pszFilename);
1764	else
1765	throw setError(VBOX_E_IPRT_ERROR,
1766	tr("Cannot upload file '%s' to S3 storage server (%Rrc)"), pszFilename, vrc);
1767	}
1768	}
1769	}
1770	catch(HRESULT aRC)
1771	{
1772	rc = aRC;
1773	}
1774	/* Cleanup */
1775	RTS3Destroy(hS3);
1776	/* Delete all files which where temporary created */
1777	for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
1778	{
1779	const char pszFilePath = (it1).first.c_str();
1780	if (RTPathExists(pszFilePath))
1781	{
1782	vrc = RTFileDelete(pszFilePath);
1783	if (RT_FAILURE(vrc))
1784	rc = setError(VBOX_E_FILE_ERROR,
1785	tr("Cannot delete file '%s' (%Rrc)"), pszFilePath, vrc);
1786	}
1787	}
1788	/* Delete the temporary directory */
1789	if (RTPathExists(pszTmpDir))
1790	{
1791	vrc = RTDirRemove(pszTmpDir);
1792	if (RT_FAILURE(vrc))
1793	rc = setError(VBOX_E_FILE_ERROR,
1794	tr("Cannot delete temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);
1795	}
1796	if (pszTmpDir)
1797	RTStrFree(pszTmpDir);
1798
1799	LogFlowFunc(("rc=%Rhrc\n", rc));
1800	LogFlowFuncLeave();
1801
1802	return rc;
1803	}
1804

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

source: vbox/trunk/src/VBox/Main/ApplianceImplExport.cpp@ 29945

Download in other formats: