#include <iprt/path.h>

#include <iprt/dir.h>

#include <iprt/param.h>

#include <iprt/s3.h>

#include <iprt/manifest.h>

#include <iprt/tar.h>

#include <iprt/stream.h>

#include <VBox/version.h>

#include "ApplianceImpl.h"

#include "VirtualBoxImpl.h"

#include "ProgressImpl.h"

#include "MachineImpl.h"

#include "MediumImpl.h"

#include "MediumFormatImpl.h"

#include "Global.h"

#include "SystemPropertiesImpl.h"

#include "AutoCaller.h"

#include "Logging.h"

#include "ApplianceImplPrivate.h"

using namespace std;

STDMETHODIMP Machine::ExportTo(IAppliance *aAppliance, IN_BSTR location, IVirtualSystemDescription **aDescription)

{

HRESULT rc = S_OK;

if (!aAppliance)

return E_POINTER;

AutoCaller autoCaller(this);

if (FAILED(autoCaller.rc())) return autoCaller.rc();

ComObjPtr<VirtualSystemDescription> pNewDesc;

try

{

Appliance *pAppliance = static_cast<Appliance*>(aAppliance);

AutoCaller autoCaller1(pAppliance);

if (FAILED(autoCaller1.rc())) return autoCaller1.rc();

LocationInfo locInfo;

i_parseURI(location, locInfo);

// create a new virtual system to store in the appliance

rc = pNewDesc.createObject();

if (FAILED(rc)) throw rc;

rc = pNewDesc->init();

if (FAILED(rc)) throw rc;

// store the machine object so we can dump the XML in Appliance::Write()

pNewDesc->m->pMachine = this;

// first, call the COM methods, as they request locks

BOOL fUSBEnabled = FALSE;

com::SafeIfaceArray<IUSBController> usbControllers;

rc = COMGETTER(USBControllers)(ComSafeArrayAsOutParam(usbControllers));

if (SUCCEEDED(rc))

{

for (unsigned i = 0; i < usbControllers.size(); i++)

{

USBControllerType_T enmType;

rc = usbControllers[i]->COMGETTER(Type)(&enmType);

if (FAILED(rc)) throw rc;

if (enmType == USBControllerType_OHCI)

fUSBEnabled = TRUE;

}

}

// request the machine lock while accessing internal members

AutoReadLock alock1(this COMMA_LOCKVAL_SRC_POS);

ComPtr<IAudioAdapter> pAudioAdapter = mAudioAdapter;

BOOL fAudioEnabled;

rc = pAudioAdapter->COMGETTER(Enabled)(&fAudioEnabled);

if (FAILED(rc)) throw rc;

AudioControllerType_T audioController;

rc = pAudioAdapter->COMGETTER(AudioController)(&audioController);

if (FAILED(rc)) throw rc;

// get name

Utf8Str strVMName = mUserData->s.strName;

// get description

Utf8Str strDescription = mUserData->s.strDescription;

// get guest OS

Utf8Str strOsTypeVBox = mUserData->s.strOsType;

// CPU count

uint32_t cCPUs = mHWData->mCPUCount;

// memory size in MB

uint32_t ulMemSizeMB = mHWData->mMemorySize;

// VRAM size?

// BIOS settings?

// 3D acceleration enabled?

// hardware virtualization enabled?

// nested paging enabled?

// HWVirtExVPIDEnabled?

// PAEEnabled?

// Long mode enabled?

BOOL fLongMode;

rc = GetCPUProperty(CPUPropertyType_LongMode, &fLongMode);

if (FAILED(rc)) throw rc;

// snapshotFolder?

// VRDPServer?

/* Guest OS type */

ovf::CIMOSType_T cim = convertVBoxOSType2CIMOSType(strOsTypeVBox.c_str(), fLongMode);

pNewDesc->i_addEntry(VirtualSystemDescriptionType_OS,

"",

Utf8StrFmt("%RI32", cim),

strOsTypeVBox);

/* VM name */

pNewDesc->i_addEntry(VirtualSystemDescriptionType_Name,

"",

strVMName,

strVMName);

// description

pNewDesc->i_addEntry(VirtualSystemDescriptionType_Description,

"",

strDescription,

strDescription);

/* CPU count*/

Utf8Str strCpuCount = Utf8StrFmt("%RI32", cCPUs);

pNewDesc->i_addEntry(VirtualSystemDescriptionType_CPU,

"",

strCpuCount,

strCpuCount);

/* Memory */

Utf8Str strMemory = Utf8StrFmt("%RI64", (uint64_t)ulMemSizeMB * _1M);

pNewDesc->i_addEntry(VirtualSystemDescriptionType_Memory,

"",

strMemory,

strMemory);

// the one VirtualBox IDE controller has two channels with two ports each, which is

// considered two IDE controllers with two ports each by OVF, so export it as two

int32_t lIDEControllerPrimaryIndex = 0;

int32_t lIDEControllerSecondaryIndex = 0;

int32_t lSATAControllerIndex = 0;

int32_t lSCSIControllerIndex = 0;

/* Fetch all available storage controllers */

com::SafeIfaceArray<IStorageController> nwControllers;

rc = COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(nwControllers));

if (FAILED(rc)) throw rc;

ComPtr<IStorageController> pIDEController;

ComPtr<IStorageController> pSATAController;

ComPtr<IStorageController> pSCSIController;

ComPtr<IStorageController> pSASController;

for (size_t j = 0; j < nwControllers.size(); ++j)

{

StorageBus_T eType;

rc = nwControllers[j]->COMGETTER(Bus)(&eType);

if (FAILED(rc)) throw rc;

if ( eType == StorageBus_IDE

&& pIDEController.isNull())

pIDEController = nwControllers[j];

else if ( eType == StorageBus_SATA

&& pSATAController.isNull())

pSATAController = nwControllers[j];

else if ( eType == StorageBus_SCSI

&& pSATAController.isNull())

pSCSIController = nwControllers[j];

else if ( eType == StorageBus_SAS

&& pSASController.isNull())

pSASController = nwControllers[j];

}

if (!pIDEController.isNull())

{

Utf8Str strVBox;

StorageControllerType_T ctlr;

rc = pIDEController->COMGETTER(ControllerType)(&ctlr);

if (FAILED(rc)) throw rc;

switch(ctlr)

{

case StorageControllerType_PIIX3: strVBox = "PIIX3"; break;

case StorageControllerType_PIIX4: strVBox = "PIIX4"; break;

case StorageControllerType_ICH6: strVBox = "ICH6"; break;

}

if (strVBox.length())

{

lIDEControllerPrimaryIndex = (int32_t)pNewDesc->m->maDescriptions.size();

pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,

Utf8StrFmt("%d", lIDEControllerPrimaryIndex), // strRef

strVBox, // aOvfValue

strVBox); // aVBoxValue

lIDEControllerSecondaryIndex = lIDEControllerPrimaryIndex + 1;

pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,

Utf8StrFmt("%d", lIDEControllerSecondaryIndex),

strVBox,

strVBox);

}

}

if (!pSATAController.isNull())

{

Utf8Str strVBox = "AHCI";

lSATAControllerIndex = (int32_t)pNewDesc->m->maDescriptions.size();

pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,

Utf8StrFmt("%d", lSATAControllerIndex),

strVBox,

strVBox);

}

if (!pSCSIController.isNull())

{

StorageControllerType_T ctlr;

rc = pSCSIController->COMGETTER(ControllerType)(&ctlr);

if (SUCCEEDED(rc))

{

Utf8Str strVBox = "LsiLogic"; // the default in VBox

switch(ctlr)

{

case StorageControllerType_LsiLogic: strVBox = "LsiLogic"; break;

case StorageControllerType_BusLogic: strVBox = "BusLogic"; break;

}

lSCSIControllerIndex = (int32_t)pNewDesc->m->maDescriptions.size();

pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,

Utf8StrFmt("%d", lSCSIControllerIndex),

strVBox,

strVBox);

}

else

throw rc;

}

if (!pSASController.isNull())

{

// VirtualBox considers the SAS controller a class of its own but in OVF

// it should be a SCSI controller

Utf8Str strVBox = "LsiLogicSas";

lSCSIControllerIndex = (int32_t)pNewDesc->m->maDescriptions.size();

pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskControllerSAS,

Utf8StrFmt("%d", lSCSIControllerIndex),

strVBox,

strVBox);

}

MediaData::AttachmentList::iterator itA;

for (itA = mMediaData->mAttachments.begin();

itA != mMediaData->mAttachments.end();

++itA)

{

ComObjPtr<MediumAttachment> pHDA = *itA;

// the attachment's data

ComPtr<IMedium> pMedium;

ComPtr<IStorageController> ctl;

Bstr controllerName;

rc = pHDA->COMGETTER(Controller)(controllerName.asOutParam());

if (FAILED(rc)) throw rc;

rc = GetStorageControllerByName(controllerName.raw(), ctl.asOutParam());

if (FAILED(rc)) throw rc;

StorageBus_T storageBus;

DeviceType_T deviceType;

LONG lChannel;

LONG lDevice;

rc = ctl->COMGETTER(Bus)(&storageBus);

if (FAILED(rc)) throw rc;

rc = pHDA->COMGETTER(Type)(&deviceType);

if (FAILED(rc)) throw rc;

rc = pHDA->COMGETTER(Medium)(pMedium.asOutParam());

if (FAILED(rc)) throw rc;

rc = pHDA->COMGETTER(Port)(&lChannel);

if (FAILED(rc)) throw rc;

rc = pHDA->COMGETTER(Device)(&lDevice);

if (FAILED(rc)) throw rc;

Utf8Str strTargetImageName;

Utf8Str strLocation;

LONG64 llSize = 0;

if ( deviceType == DeviceType_HardDisk

&& pMedium)

{

Bstr bstrLocation;

rc = pMedium->COMGETTER(Location)(bstrLocation.asOutParam());

if (FAILED(rc)) throw rc;

strLocation = bstrLocation;

// find the source's base medium for two things:

// 1) we'll use its name to determine the name of the target disk, which is readable,

// as opposed to the UUID filename of a differencing image, if pMedium is one

// 2) we need the size of the base image so we can give it to addEntry(), and later

// on export, the progress will be based on that (and not the diff image)

ComPtr<IMedium> pBaseMedium;

rc = pMedium->COMGETTER(Base)(pBaseMedium.asOutParam());

// returns pMedium if there are no diff images

if (FAILED(rc)) throw rc;

Utf8Str strName = Utf8Str(locInfo.strPath).stripPath().stripSuffix();

strTargetImageName = Utf8StrFmt("%s-disk%d.vmdk", strName.c_str(), ++pAppliance->m->cDisks);

if (strTargetImageName.length() > RTTAR_NAME_MAX)

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Cannot attach disk '%s' -- file name too long"), strTargetImageName.c_str());

// force reading state, or else size will be returned as 0

MediumState_T ms;

rc = pBaseMedium->RefreshState(&ms);

if (FAILED(rc)) throw rc;

rc = pBaseMedium->COMGETTER(Size)(&llSize);

if (FAILED(rc)) throw rc;

}

else if ( deviceType == DeviceType_DVD

&& pMedium)

{

/*

//1. no host drive CD/DVD image

BOOL fHostDrive = false;

rc = pMedium->COMGETTER(HostDrive)(&fHostDrive);

if (FAILED(rc)) throw rc;

if(fHostDrive)

continue;

//2. the image must be accessible and readable

MediumState_T ms;

rc = pMedium->RefreshState(&ms);

if (FAILED(rc)) throw rc;

if (ms != MediumState_Created)

continue;

//3. only ISO image is exported

Bstr bstrLocation;

rc = pMedium->COMGETTER(Location)(bstrLocation.asOutParam());

if (FAILED(rc)) throw rc;

strLocation = bstrLocation;

Utf8Str ext = strLocation;

ext.assignEx(RTPathSuffix(ext.c_str()));//returns extension with dot (".iso")

int eq = ext.compare(".iso", Utf8Str::CaseInsensitive);

if (eq != 0)

continue;

Utf8Str strName = Utf8Str(locInfo.strPath).stripPath().stripSuffix();

strTargetImageName = Utf8StrFmt("%s-disk%d.iso", strName.c_str(), ++pAppliance->m->cDisks);

if (strTargetImageName.length() > RTTAR_NAME_MAX)

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Cannot attach image '%s' -- file name too long"), strTargetImageName.c_str());

rc = pMedium->COMGETTER(Size)(&llSize);

if (FAILED(rc)) throw rc;

}

// and how this translates to the virtual system

int32_t lControllerVsys = 0;

LONG lChannelVsys;

switch (storageBus)

{

case StorageBus_IDE:

// this is the exact reverse to what we're doing in Appliance::taskThreadImportMachines,

// and it must be updated when that is changed!

// Before 3.2 we exported one IDE controller with channel 0-3, but we now maintain

// compatibility with what VMware does and export two IDE controllers with two channels each

if (lChannel == 0 && lDevice == 0) // primary master

{

lControllerVsys = lIDEControllerPrimaryIndex;

lChannelVsys = 0;

}

else if (lChannel == 0 && lDevice == 1) // primary slave

{

lControllerVsys = lIDEControllerPrimaryIndex;

lChannelVsys = 1;

}

else if (lChannel == 1 && lDevice == 0) // secondary master; by default this is the CD-ROM but as of VirtualBox 3.1 that can change

{

lControllerVsys = lIDEControllerSecondaryIndex;

lChannelVsys = 0;

}

else if (lChannel == 1 && lDevice == 1) // secondary slave

{

lControllerVsys = lIDEControllerSecondaryIndex;

lChannelVsys = 1;

}

else

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Cannot handle medium attachment: channel is %d, device is %d"), lChannel, lDevice);

break;

case StorageBus_SATA:

lChannelVsys = lChannel; // should be between 0 and 29

lControllerVsys = lSATAControllerIndex;

break;

case StorageBus_SCSI:

case StorageBus_SAS:

lChannelVsys = lChannel; // should be between 0 and 15

lControllerVsys = lSCSIControllerIndex;

break;

case StorageBus_Floppy:

lChannelVsys = 0;

lControllerVsys = 0;

break;

default:

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Cannot handle medium attachment: storageBus is %d, channel is %d, device is %d"), storageBus, lChannel, lDevice);

break;

}

Utf8StrFmt strExtra("controller=%RI32;channel=%RI32", lControllerVsys, lChannelVsys);

Utf8Str strEmpty;

switch (deviceType)

{

case DeviceType_HardDisk:

Log(("Adding VirtualSystemDescriptionType_HardDiskImage, disk size: %RI64\n", llSize));

pNewDesc->i_addEntry(VirtualSystemDescriptionType_HardDiskImage,

strTargetImageName, // disk ID: let's use the name

strTargetImageName, // OVF value:

strLocation, // vbox value: media path

(uint32_t)(llSize / _1M),

strExtra);

break;

case DeviceType_DVD:

Log(("Adding VirtualSystemDescriptionType_CDROM, disk size: %RI64\n", llSize));

pNewDesc->i_addEntry(VirtualSystemDescriptionType_CDROM,

strTargetImageName, // disk ID

strTargetImageName, // OVF value

strLocation, // vbox value

(uint32_t)(llSize / _1M),// ulSize

strExtra);

break;

case DeviceType_Floppy:

pNewDesc->i_addEntry(VirtualSystemDescriptionType_Floppy,

strEmpty, // disk ID

strEmpty, // OVF value

strEmpty, // vbox value

1, // ulSize

strExtra);

break;

}

}

uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(getChipsetType());

size_t a;

for (a = 0; a < maxNetworkAdapters; ++a)

{

ComPtr<INetworkAdapter> pNetworkAdapter;

BOOL fEnabled;

NetworkAdapterType_T adapterType;

NetworkAttachmentType_T attachmentType;

rc = GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());

if (FAILED(rc)) throw rc;

/* Enable the network card & set the adapter type */

rc = pNetworkAdapter->COMGETTER(Enabled)(&fEnabled);

if (FAILED(rc)) throw rc;

if (fEnabled)

{

rc = pNetworkAdapter->COMGETTER(AdapterType)(&adapterType);

if (FAILED(rc)) throw rc;

rc = pNetworkAdapter->COMGETTER(AttachmentType)(&attachmentType);

if (FAILED(rc)) throw rc;

Utf8Str strAttachmentType = convertNetworkAttachmentTypeToString(attachmentType);

pNewDesc->i_addEntry(VirtualSystemDescriptionType_NetworkAdapter,

"", // ref

strAttachmentType, // orig

Utf8StrFmt("%RI32", (uint32_t)adapterType), // conf

0,

Utf8StrFmt("type=%s", strAttachmentType.c_str())); // extra conf

}

}

#ifdef VBOX_WITH_USB

if (fUSBEnabled)

pNewDesc->i_addEntry(VirtualSystemDescriptionType_USBController, "", "", "");

#endif /* VBOX_WITH_USB */

if (fAudioEnabled)

pNewDesc->i_addEntry(VirtualSystemDescriptionType_SoundCard,

"",

"ensoniq1371", // this is what OVFTool writes and VMware supports

Utf8StrFmt("%RI32", audioController));

/* We return the new description to the caller */

ComPtr<IVirtualSystemDescription> copy(pNewDesc);

copy.queryInterfaceTo(aDescription);

AutoWriteLock alock(pAppliance COMMA_LOCKVAL_SRC_POS);

// finally, add the virtual system to the appliance

pAppliance->m->virtualSystemDescriptions.push_back(pNewDesc);

}

catch(HRESULT arc)

{

rc = arc;

}

return rc;

}

HRESULT Appliance::write(const com::Utf8Str &aFormat,

const std::vector<ExportOptions_T> &aOptions,

const com::Utf8Str &aPath,

ComPtr<IProgress> &aProgress)

{

AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);

m->optListExport.clear();

if (aOptions.size())

{

for (size_t i = 0; i < aOptions.size(); ++i)

{

m->optListExport.insert(i, aOptions[i]);

}

}

m->fExportISOImages = m->optListExport.contains(ExportOptions_ExportDVDImages);

if (!m->fExportISOImages)/* remove all ISO images from VirtualSystemDescription */

{

list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;

for (it = m->virtualSystemDescriptions.begin();

it != m->virtualSystemDescriptions.end();

++it)

{

ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);

std::list<VirtualSystemDescriptionEntry*> skipped = vsdescThis->i_findByType(VirtualSystemDescriptionType_CDROM);

std::list<VirtualSystemDescriptionEntry*>:: iterator pItSkipped = skipped.begin();

while (pItSkipped != skipped.end())

{

(*pItSkipped)->skipIt = true;

++pItSkipped;

}

}

}

// do not allow entering this method if the appliance is busy reading or writing

if (!i_isApplianceIdle())

return E_ACCESSDENIED;

// see if we can handle this file; for now we insist it has an ".ovf" extension

if (!( aPath.endsWith(".ovf", Utf8Str::CaseInsensitive)

|| aPath.endsWith(".ova", Utf8Str::CaseInsensitive)))

return setError(VBOX_E_FILE_ERROR,

tr("Appliance file must have .ovf or .ova extension"));

m->fManifest = m->optListExport.contains(ExportOptions_CreateManifest);

ovf::OVFVersion_T ovfF;

if (aFormat == "ovf-0.9")

{

ovfF = ovf::OVFVersion_0_9;

}

else if (aFormat == "ovf-1.0")

{

ovfF = ovf::OVFVersion_1_0;

}

else if (aFormat == "ovf-2.0")

{

ovfF = ovf::OVFVersion_2_0;

}

else

return setError(VBOX_E_FILE_ERROR,

tr("Invalid format \"%s\" specified"), aFormat.c_str());

/* as of OVF 2.0 we have to use SHA256 */

m->fSha256 = ovfF >= ovf::OVFVersion_2_0;

ComObjPtr<Progress> progress;

HRESULT rc = S_OK;

try

{

/* Parse all necessary info out of the URI */

i_parseURI(aPath, m->locInfo);

rc = i_writeImpl(ovfF, m->locInfo, progress);

}

catch (HRESULT aRC)

{

rc = aRC;

}

if (SUCCEEDED(rc))

/* Return progress to the caller */

progress.queryInterfaceTo(aProgress.asOutParam());

return rc;

}

HRESULT Appliance::i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)

{

HRESULT rc = S_OK;

try

{

rc = i_setUpProgress(aProgress,

BstrFmt(tr("Export appliance '%s'"), aLocInfo.strPath.c_str()),

(aLocInfo.storageType == VFSType_File) ? WriteFile : WriteS3);

/* Initialize our worker task */

std::auto_ptr<TaskOVF> task(new TaskOVF(this, TaskOVF::Write, aLocInfo, aProgress));

/* The OVF version to write */

task->enFormat = aFormat;

rc = task->startThread();

if (FAILED(rc)) throw rc;

/* Don't destruct on success */

task.release();

}

catch (HRESULT aRC)

{

rc = aRC;

}

return rc;

}

void Appliance::i_buildXML(AutoWriteLockBase& writeLock,

xml::Document &doc,

XMLStack &stack,

const Utf8Str &strPath,

ovf::OVFVersion_T enFormat)

{

xml::ElementNode *pelmRoot = doc.createRootElement("Envelope");

pelmRoot->setAttribute("ovf:version", enFormat == ovf::OVFVersion_2_0 ? "2.0"

: enFormat == ovf::OVFVersion_1_0 ? "1.0"

: "0.9");

pelmRoot->setAttribute("xml:lang", "en-US");

Utf8Str strNamespace;

if (enFormat == ovf::OVFVersion_0_9)

{

strNamespace = ovf::OVF09_URI_string;

}

else if (enFormat == ovf::OVFVersion_1_0)

{

strNamespace = ovf::OVF10_URI_string;

}

else

{

strNamespace = ovf::OVF20_URI_string;

}

pelmRoot->setAttribute("xmlns", strNamespace);

pelmRoot->setAttribute("xmlns:ovf", strNamespace);

// pelmRoot->setAttribute("xmlns:ovfstr", "http://schema.dmtf.org/ovf/strings/1");

pelmRoot->setAttribute("xmlns:rasd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData");

pelmRoot->setAttribute("xmlns:vssd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData");

pelmRoot->setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");

pelmRoot->setAttribute("xmlns:vbox", "http://www.virtualbox.org/ovf/machine");

// pelmRoot->setAttribute("xsi:schemaLocation", "http://schemas.dmtf.org/ovf/envelope/1 ../ovf-envelope.xsd");

if (enFormat == ovf::OVFVersion_2_0)

{

pelmRoot->setAttribute("xmlns:epasd",

"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_EthernetPortAllocationSettingData.xsd");

pelmRoot->setAttribute("xmlns:sasd",

"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_StorageAllocationSettingData.xsd");

}

// <Envelope>/<References>

xml::ElementNode *pelmReferences = pelmRoot->createChild("References"); // 0.9 and 1.0

/* <Envelope>/<DiskSection>:

xml::ElementNode *pelmDiskSection;

if (enFormat == ovf::OVFVersion_0_9)

{

// <Section xsi:type="ovf:DiskSection_Type">

pelmDiskSection = pelmRoot->createChild("Section");

pelmDiskSection->setAttribute("xsi:type", "ovf:DiskSection_Type");

}

else

pelmDiskSection = pelmRoot->createChild("DiskSection");

xml::ElementNode *pelmDiskSectionInfo = pelmDiskSection->createChild("Info");

pelmDiskSectionInfo->addContent("List of the virtual disks used in the package");

/* <Envelope>/<NetworkSection>:

xml::ElementNode *pelmNetworkSection;

if (enFormat == ovf::OVFVersion_0_9)

{

// <Section xsi:type="ovf:NetworkSection_Type">

pelmNetworkSection = pelmRoot->createChild("Section");

pelmNetworkSection->setAttribute("xsi:type", "ovf:NetworkSection_Type");

}

else

pelmNetworkSection = pelmRoot->createChild("NetworkSection");

xml::ElementNode *pelmNetworkSectionInfo = pelmNetworkSection->createChild("Info");

pelmNetworkSectionInfo->addContent("Logical networks used in the package");

// and here come the virtual systems:

// write a collection if we have more than one virtual system _and_ we're

// writing OVF 1.0; otherwise fail since ovftool can't import more than

// one machine, it seems

xml::ElementNode *pelmToAddVirtualSystemsTo;

if (m->virtualSystemDescriptions.size() > 1)

{

if (enFormat == ovf::OVFVersion_0_9)

throw setError(VBOX_E_FILE_ERROR,

tr("Cannot export more than one virtual system with OVF 0.9, use OVF 1.0"));

pelmToAddVirtualSystemsTo = pelmRoot->createChild("VirtualSystemCollection");

pelmToAddVirtualSystemsTo->setAttribute("ovf:name", "ExportedVirtualBoxMachines"); // whatever

}

else

pelmToAddVirtualSystemsTo = pelmRoot; // add virtual system directly under root element

// this list receives pointers to the XML elements in the machine XML which

// might have UUIDs that need fixing after we know the UUIDs of the exported images

std::list<xml::ElementNode*> llElementsWithUuidAttributes;

list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;

/* Iterate through all virtual systems of that appliance */

for (it = m->virtualSystemDescriptions.begin();

it != m->virtualSystemDescriptions.end();

++it)

{

ComObjPtr<VirtualSystemDescription> vsdescThis = *it;

i_buildXMLForOneVirtualSystem(writeLock,

*pelmToAddVirtualSystemsTo,

&llElementsWithUuidAttributes,

vsdescThis,

enFormat,

stack); // disks and networks stack

}

// now, fill in the network section we set up empty above according

// to the networks we found with the hardware items

map<Utf8Str, bool>::const_iterator itN;

for (itN = stack.mapNetworks.begin();

itN != stack.mapNetworks.end();

++itN)

{

const Utf8Str &strNetwork = itN->first;

xml::ElementNode *pelmNetwork = pelmNetworkSection->createChild("Network");

pelmNetwork->setAttribute("ovf:name", strNetwork.c_str());

pelmNetwork->createChild("Description")->addContent("Logical network used by this appliance.");

}

// Finally, write out the disk info

list<Utf8Str> diskList;

map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;

uint32_t ulFile = 1;

for (itS = stack.mapDisks.begin();

itS != stack.mapDisks.end();

++itS)

{

const Utf8Str &strDiskID = itS->first;

const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;

// source path: where the VBox image is

const Utf8Str &strSrcFilePath = pDiskEntry->strVBoxCurrent;

Bstr bstrSrcFilePath(strSrcFilePath);

//skip empty Medium. There are no information to add into section <References> or <DiskSection>

if (strSrcFilePath.isEmpty() ||

pDiskEntry->skipIt == true)

continue;

// Do NOT check here whether the file exists. FindMedium will figure

// that out, and filesystem-based tests are simply wrong in the

// general case (think of iSCSI).

// We need some info from the source disks

ComPtr<IMedium> pSourceDisk;

//DeviceType_T deviceType = DeviceType_HardDisk;// by default

Log(("Finding source disk \"%ls\"\n", bstrSrcFilePath.raw()));

HRESULT rc;

if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)

{

rc = mVirtualBox->OpenMedium(bstrSrcFilePath.raw(),

DeviceType_HardDisk,

AccessMode_ReadWrite,

FALSE /* fForceNewUuid */,

pSourceDisk.asOutParam());

if (FAILED(rc))

throw rc;

}

else if (pDiskEntry->type == VirtualSystemDescriptionType_CDROM)//may be, this is CD/DVD

{

rc = mVirtualBox->OpenMedium(bstrSrcFilePath.raw(),

DeviceType_DVD,

AccessMode_ReadOnly,

FALSE,

pSourceDisk.asOutParam());

if (FAILED(rc))

throw rc;

}

Bstr uuidSource;

rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());

if (FAILED(rc)) throw rc;

Guid guidSource(uuidSource);

// output filename

const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;

// target path needs to be composed from where the output OVF is

Utf8Str strTargetFilePath(strPath);

strTargetFilePath.stripFilename();

strTargetFilePath.append("/");

strTargetFilePath.append(strTargetFileNameOnly);

// We are always exporting to VMDK stream optimized for now

//Bstr bstrSrcFormat = L"VMDK";//not used

diskList.push_back(strTargetFilePath);

LONG64 cbCapacity = 0; // size reported to guest

rc = pSourceDisk->COMGETTER(LogicalSize)(&cbCapacity);

if (FAILED(rc)) throw rc;

// Todo r=poetzsch: wrong it is reported in bytes ...

// capacity is reported in megabytes, so...

//cbCapacity *= _1M;

Guid guidTarget; /* Creates a new uniq number for the target disk. */

guidTarget.create();

// now handle the XML for the disk:

Utf8StrFmt strFileRef("file%RI32", ulFile++);

// <File ovf:href="WindowsXpProfessional-disk1.vmdk" ovf:id="file1" ovf:size="1710381056"/>

xml::ElementNode *pelmFile = pelmReferences->createChild("File");

pelmFile->setAttribute("ovf:href", strTargetFileNameOnly);

pelmFile->setAttribute("ovf:id", strFileRef);

// Todo: the actual size is not available at this point of time,

// cause the disk will be compressed. The 1.0 standard says this is

// optional! 1.1 isn't fully clear if the "gzip" format is used.

// Need to be checked. */

// pelmFile->setAttribute("ovf:size", Utf8StrFmt("%RI64", cbFile).c_str());

// add disk to XML Disks section

// <Disk ovf:capacity="8589934592" ovf:diskId="vmdisk1" ovf:fileRef="file1" ovf:format="..."/>

xml::ElementNode *pelmDisk = pelmDiskSection->createChild("Disk");

pelmDisk->setAttribute("ovf:capacity", Utf8StrFmt("%RI64", cbCapacity).c_str());

pelmDisk->setAttribute("ovf:diskId", strDiskID);

pelmDisk->setAttribute("ovf:fileRef", strFileRef);

if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)//deviceType == DeviceType_HardDisk

{

pelmDisk->setAttribute("ovf:format",

(enFormat == ovf::OVFVersion_0_9)

? "http://www.vmware.com/specifications/vmdk.html#sparse" // must be sparse or ovftool ch

: "http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized"

// correct string as communicated to us by VMware (public bug #6612)

);

}

else //pDiskEntry->type == VirtualSystemDescriptionType_CDROM, deviceType == DeviceType_DVD

{

pelmDisk->setAttribute("ovf:format",

"http://www.ecma-international.org/publications/standards/Ecma-119.htm"

);

}

// add the UUID of the newly target image to the OVF disk element, but in the

// vbox: namespace since it's not part of the standard

pelmDisk->setAttribute("vbox:uuid", Utf8StrFmt("%RTuuid", guidTarget.raw()).c_str());

// now, we might have other XML elements from vbox:Machine pointing to this image,

// but those would refer to the UUID of the _source_ image (which we created the

// export image from); those UUIDs need to be fixed to the export image

Utf8Str strGuidSourceCurly = guidSource.toStringCurly();

for (std::list<xml::ElementNode*>::iterator eit = llElementsWithUuidAttributes.begin();

eit != llElementsWithUuidAttributes.end();

++eit)

{

xml::ElementNode *pelmImage = *eit;

Utf8Str strUUID;

pelmImage->getAttributeValue("uuid", strUUID);

if (strUUID == strGuidSourceCurly)

// overwrite existing uuid attribute

pelmImage->setAttribute("uuid", guidTarget.toStringCurly());

}

}

}

void Appliance::i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,

xml::ElementNode &elmToAddVirtualSystemsTo,

std::list<xml::ElementNode*> *pllElementsWithUuidAttributes,

ComObjPtr<VirtualSystemDescription> &vsdescThis,

ovf::OVFVersion_T enFormat,

XMLStack &stack)

{

LogFlowFunc(("ENTER appliance %p\n", this));

xml::ElementNode *pelmVirtualSystem;

if (enFormat == ovf::OVFVersion_0_9)

{

// <Section xsi:type="ovf:NetworkSection_Type">

pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("Content");

pelmVirtualSystem->setAttribute("xsi:type", "ovf:VirtualSystem_Type");

}

else

pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("VirtualSystem");

/*xml::ElementNode *pelmVirtualSystemInfo =*/ pelmVirtualSystem->createChild("Info")->addContent("A virtual machine");

std::list<VirtualSystemDescriptionEntry*> llName = vsdescThis->i_findByType(VirtualSystemDescriptionType_Name);

if (!llName.size())

throw setError(VBOX_E_NOT_SUPPORTED, tr("Missing VM name"));

Utf8Str &strVMName = llName.back()->strVBoxCurrent;

pelmVirtualSystem->setAttribute("ovf:id", strVMName);

// product info

std::list<VirtualSystemDescriptionEntry*> llProduct = vsdescThis->i_findByType(VirtualSystemDescriptionType_Product);

std::list<VirtualSystemDescriptionEntry*> llProductUrl = vsdescThis->i_findByType(VirtualSystemDescriptionType_ProductUrl);

std::list<VirtualSystemDescriptionEntry*> llVendor = vsdescThis->i_findByType(VirtualSystemDescriptionType_Vendor);

std::list<VirtualSystemDescriptionEntry*> llVendorUrl = vsdescThis->i_findByType(VirtualSystemDescriptionType_VendorUrl);

std::list<VirtualSystemDescriptionEntry*> llVersion = vsdescThis->i_findByType(VirtualSystemDescriptionType_Version);

bool fProduct = llProduct.size() && !llProduct.back()->strVBoxCurrent.isEmpty();

bool fProductUrl = llProductUrl.size() && !llProductUrl.back()->strVBoxCurrent.isEmpty();

bool fVendor = llVendor.size() && !llVendor.back()->strVBoxCurrent.isEmpty();

bool fVendorUrl = llVendorUrl.size() && !llVendorUrl.back()->strVBoxCurrent.isEmpty();

bool fVersion = llVersion.size() && !llVersion.back()->strVBoxCurrent.isEmpty();

if (fProduct ||

fProductUrl ||

fVersion ||

fVendorUrl ||

fVersion)

{

/* <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">

xml::ElementNode *pelmAnnotationSection;

if (enFormat == ovf::OVFVersion_0_9)

{

// <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">

pelmAnnotationSection = pelmVirtualSystem->createChild("Section");

pelmAnnotationSection->setAttribute("xsi:type", "ovf:ProductSection_Type");

}

else

pelmAnnotationSection = pelmVirtualSystem->createChild("ProductSection");

pelmAnnotationSection->createChild("Info")->addContent("Meta-information about the installed software");

if (fProduct)

pelmAnnotationSection->createChild("Product")->addContent(llProduct.back()->strVBoxCurrent);

if (fVendor)

pelmAnnotationSection->createChild("Vendor")->addContent(llVendor.back()->strVBoxCurrent);

if (fVersion)

pelmAnnotationSection->createChild("Version")->addContent(llVersion.back()->strVBoxCurrent);

if (fProductUrl)

pelmAnnotationSection->createChild("ProductUrl")->addContent(llProductUrl.back()->strVBoxCurrent);

if (fVendorUrl)

pelmAnnotationSection->createChild("VendorUrl")->addContent(llVendorUrl.back()->strVBoxCurrent);

}

// description

std::list<VirtualSystemDescriptionEntry*> llDescription = vsdescThis->i_findByType(VirtualSystemDescriptionType_Description);

if (llDescription.size() &&

!llDescription.back()->strVBoxCurrent.isEmpty())

{

/* <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">

xml::ElementNode *pelmAnnotationSection;

if (enFormat == ovf::OVFVersion_0_9)

{

// <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">

pelmAnnotationSection = pelmVirtualSystem->createChild("Section");

pelmAnnotationSection->setAttribute("xsi:type", "ovf:AnnotationSection_Type");

}

else

pelmAnnotationSection = pelmVirtualSystem->createChild("AnnotationSection");

pelmAnnotationSection->createChild("Info")->addContent("A human-readable annotation");

pelmAnnotationSection->createChild("Annotation")->addContent(llDescription.back()->strVBoxCurrent);

}

// license

std::list<VirtualSystemDescriptionEntry*> llLicense = vsdescThis->i_findByType(VirtualSystemDescriptionType_License);

if (llLicense.size() &&

!llLicense.back()->strVBoxCurrent.isEmpty())

{

/* <EulaSection>

xml::ElementNode *pelmEulaSection;

if (enFormat == ovf::OVFVersion_0_9)

{

pelmEulaSection = pelmVirtualSystem->createChild("Section");

pelmEulaSection->setAttribute("xsi:type", "ovf:EulaSection_Type");

}

else

pelmEulaSection = pelmVirtualSystem->createChild("EulaSection");

pelmEulaSection->createChild("Info")->addContent("License agreement for the virtual system");

pelmEulaSection->createChild("License")->addContent(llLicense.back()->strVBoxCurrent);

}

// operating system

std::list<VirtualSystemDescriptionEntry*> llOS = vsdescThis->i_findByType(VirtualSystemDescriptionType_OS);

if (!llOS.size())

throw setError(VBOX_E_NOT_SUPPORTED, tr("Missing OS type"));

/* <OperatingSystemSection ovf:id="82">

VirtualSystemDescriptionEntry *pvsdeOS = llOS.back();

xml::ElementNode *pelmOperatingSystemSection;

if (enFormat == ovf::OVFVersion_0_9)

{

pelmOperatingSystemSection = pelmVirtualSystem->createChild("Section");

pelmOperatingSystemSection->setAttribute("xsi:type", "ovf:OperatingSystemSection_Type");

}

else

pelmOperatingSystemSection = pelmVirtualSystem->createChild("OperatingSystemSection");

pelmOperatingSystemSection->setAttribute("ovf:id", pvsdeOS->strOvf);

pelmOperatingSystemSection->createChild("Info")->addContent("The kind of installed guest operating system");

Utf8Str strOSDesc;

convertCIMOSType2VBoxOSType(strOSDesc, (ovf::CIMOSType_T)pvsdeOS->strOvf.toInt32(), "");

pelmOperatingSystemSection->createChild("Description")->addContent(strOSDesc);

// add the VirtualBox ostype in a custom tag in a different namespace

xml::ElementNode *pelmVBoxOSType = pelmOperatingSystemSection->createChild("vbox:OSType");

pelmVBoxOSType->setAttribute("ovf:required", "false");

pelmVBoxOSType->addContent(pvsdeOS->strVBoxCurrent);

// <VirtualHardwareSection ovf:id="hw1" ovf:transport="iso">

xml::ElementNode *pelmVirtualHardwareSection;

if (enFormat == ovf::OVFVersion_0_9)

{

// <Section xsi:type="ovf:VirtualHardwareSection_Type">

pelmVirtualHardwareSection = pelmVirtualSystem->createChild("Section");

pelmVirtualHardwareSection->setAttribute("xsi:type", "ovf:VirtualHardwareSection_Type");

}

else

pelmVirtualHardwareSection = pelmVirtualSystem->createChild("VirtualHardwareSection");

pelmVirtualHardwareSection->createChild("Info")->addContent("Virtual hardware requirements for a virtual machine");

/* <System>

xml::ElementNode *pelmSystem = pelmVirtualHardwareSection->createChild("System");

pelmSystem->createChild("vssd:ElementName")->addContent("Virtual Hardware Family"); // required OVF 1.0

// <vssd:InstanceId>0</vssd:InstanceId>

if (enFormat == ovf::OVFVersion_0_9)

pelmSystem->createChild("vssd:InstanceId")->addContent("0");

else // capitalization changed...

pelmSystem->createChild("vssd:InstanceID")->addContent("0");

// <vssd:VirtualSystemIdentifier>VAtest</vssd:VirtualSystemIdentifier>

pelmSystem->createChild("vssd:VirtualSystemIdentifier")->addContent(strVMName);

// <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>

const char *pcszHardware = "virtualbox-2.2";

if (enFormat == ovf::OVFVersion_0_9)

// pretend to be vmware compatible then

pcszHardware = "vmx-6";

pelmSystem->createChild("vssd:VirtualSystemType")->addContent(pcszHardware);

// loop thru all description entries twice; once to write out all

// devices _except_ disk images, and a second time to assign the

// disk images; this is because disk images need to reference

// IDE controllers, and we can't know their instance IDs without

// assigning them first

uint32_t idIDEPrimaryController = 0;

int32_t lIDEPrimaryControllerIndex = 0;

uint32_t idIDESecondaryController = 0;

int32_t lIDESecondaryControllerIndex = 0;

uint32_t idSATAController = 0;

int32_t lSATAControllerIndex = 0;

uint32_t idSCSIController = 0;

int32_t lSCSIControllerIndex = 0;

uint32_t ulInstanceID = 1;

uint32_t cDVDs = 0;

for (size_t uLoop = 1; uLoop <= 2; ++uLoop)

{

int32_t lIndexThis = 0;

vector<VirtualSystemDescriptionEntry>::const_iterator itD;

for (itD = vsdescThis->m->maDescriptions.begin();

itD != vsdescThis->m->maDescriptions.end();

++itD, ++lIndexThis)

{

const VirtualSystemDescriptionEntry &desc = *itD;

LogFlowFunc(("Loop %u: handling description entry ulIndex=%u, type=%s, strRef=%s, strOvf=%s, strVBox=%s, strExtraConfig=%s\n",

uLoop,

desc.ulIndex,

( desc.type == VirtualSystemDescriptionType_HardDiskControllerIDE ? "HardDiskControllerIDE"

: desc.type == VirtualSystemDescriptionType_HardDiskControllerSATA ? "HardDiskControllerSATA"

: desc.type == VirtualSystemDescriptionType_HardDiskControllerSCSI ? "HardDiskControllerSCSI"

: desc.type == VirtualSystemDescriptionType_HardDiskControllerSAS ? "HardDiskControllerSAS"

: desc.type == VirtualSystemDescriptionType_HardDiskImage ? "HardDiskImage"

: Utf8StrFmt("%d", desc.type).c_str()),

desc.strRef.c_str(),

desc.strOvf.c_str(),

desc.strVBoxCurrent.c_str(),

desc.strExtraConfigCurrent.c_str()));

ovf::ResourceType_T type = (ovf::ResourceType_T)0; // if this becomes != 0 then we do stuff

Utf8Str strResourceSubType;

Utf8Str strDescription; // results in <rasd:Description>...</rasd:Description> block

Utf8Str strCaption; // results in <rasd:Caption>...</rasd:Caption> block

uint32_t ulParent = 0;

int32_t lVirtualQuantity = -1;

Utf8Str strAllocationUnits;

int32_t lAddress = -1;

int32_t lBusNumber = -1;

int32_t lAddressOnParent = -1;

int32_t lAutomaticAllocation = -1; // 0 means "false", 1 means "true"

Utf8Str strConnection; // results in <rasd:Connection>...</rasd:Connection> block

Utf8Str strHostResource;

uint64_t uTemp;

ovf::VirtualHardwareItem vhi;

ovf::StorageItem si;

ovf::EthernetPortItem epi;

switch (desc.type)

{

case VirtualSystemDescriptionType_CPU:

/* <Item>

if (uLoop == 1)

{

strDescription = "Number of virtual CPUs";

type = ovf::ResourceType_Processor; // 3

desc.strVBoxCurrent.toInt(uTemp);

lVirtualQuantity = (int32_t)uTemp;

strCaption = Utf8StrFmt("%d virtual CPU", lVirtualQuantity); // without this ovftool won't eat the item

}

break;

case VirtualSystemDescriptionType_Memory:

/* <Item>

if (uLoop == 1)

{

strDescription = "Memory Size";

type = ovf::ResourceType_Memory; // 4

desc.strVBoxCurrent.toInt(uTemp);

lVirtualQuantity = (int32_t)(uTemp / _1M);

strAllocationUnits = "MegaBytes";

strCaption = Utf8StrFmt("%d MB of memory", lVirtualQuantity); // without this ovftool won't eat the item

}

break;

case VirtualSystemDescriptionType_HardDiskControllerIDE:

/* <Item>

if (uLoop == 1)

{

strDescription = "IDE Controller";

type = ovf::ResourceType_IDEController; // 5

strResourceSubType = desc.strVBoxCurrent;

if (!lIDEPrimaryControllerIndex)

{

// first IDE controller:

strCaption = "ideController0";

lAddress = 0;

lBusNumber = 0;

// remember this ID

idIDEPrimaryController = ulInstanceID;

lIDEPrimaryControllerIndex = lIndexThis;

}

else

{

// second IDE controller:

strCaption = "ideController1";

lAddress = 1;

lBusNumber = 1;

// remember this ID

idIDESecondaryController = ulInstanceID;

lIDESecondaryControllerIndex = lIndexThis;

}

}

break;

case VirtualSystemDescriptionType_HardDiskControllerSATA:

/* <Item>

if (uLoop == 1)

{

strDescription = "SATA Controller";

strCaption = "sataController0";

type = ovf::ResourceType_OtherStorageDevice; // 20

// it seems that OVFTool always writes these two, and since we can only

// have one SATA controller, we'll use this as well

lAddress = 0;

lBusNumber = 0;

if ( desc.strVBoxCurrent.isEmpty() // AHCI is the default in VirtualBox

|| (!desc.strVBoxCurrent.compare("ahci", Utf8Str::CaseInsensitive))

)

strResourceSubType = "AHCI";

else

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Invalid config string \"%s\" in SATA controller"), desc.strVBoxCurrent.c_str());

// remember this ID

idSATAController = ulInstanceID;

lSATAControllerIndex = lIndexThis;

}

break;

case VirtualSystemDescriptionType_HardDiskControllerSCSI:

case VirtualSystemDescriptionType_HardDiskControllerSAS:

/* <Item>

if (uLoop == 1)

{

strDescription = "SCSI Controller";

strCaption = "scsiController0";

type = ovf::ResourceType_ParallelSCSIHBA; // 6

// it seems that OVFTool always writes these two, and since we can only

// have one SATA controller, we'll use this as well

lAddress = 0;

lBusNumber = 0;

if ( desc.strVBoxCurrent.isEmpty() // LsiLogic is the default in VirtualBox

|| (!desc.strVBoxCurrent.compare("lsilogic", Utf8Str::CaseInsensitive))

)

strResourceSubType = "lsilogic";

else if (!desc.strVBoxCurrent.compare("buslogic", Utf8Str::CaseInsensitive))

strResourceSubType = "buslogic";

else if (!desc.strVBoxCurrent.compare("lsilogicsas", Utf8Str::CaseInsensitive))

strResourceSubType = "lsilogicsas";

else

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Invalid config string \"%s\" in SCSI/SAS controller"), desc.strVBoxCurrent.c_str());

// remember this ID

idSCSIController = ulInstanceID;

lSCSIControllerIndex = lIndexThis;

}

break;

case VirtualSystemDescriptionType_HardDiskImage:

/* <Item>

if (uLoop == 2)

{

uint32_t cDisks = (uint32_t)stack.mapDisks.size();

Utf8Str strDiskID = Utf8StrFmt("vmdisk%RI32", ++cDisks);

strDescription = "Disk Image";

strCaption = Utf8StrFmt("disk%RI32", cDisks); // this is not used for anything else

type = ovf::ResourceType_HardDisk; // 17

// the following references the "<Disks>" XML block

strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());

// controller=<index>;channel=<c>

size_t pos1 = desc.strExtraConfigCurrent.find("controller=");

size_t pos2 = desc.strExtraConfigCurrent.find("channel=");

int32_t lControllerIndex = -1;

if (pos1 != Utf8Str::npos)

{

RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);

if (lControllerIndex == lIDEPrimaryControllerIndex)

ulParent = idIDEPrimaryController;

else if (lControllerIndex == lIDESecondaryControllerIndex)

ulParent = idIDESecondaryController;

else if (lControllerIndex == lSCSIControllerIndex)

ulParent = idSCSIController;

else if (lControllerIndex == lSATAControllerIndex)

ulParent = idSATAController;

}

if (pos2 != Utf8Str::npos)

RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);

LogFlowFunc(("HardDiskImage details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",

pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex, lIDESecondaryControllerIndex, ulParent, lAddressOnParent));

if ( !ulParent

|| lAddressOnParent == -1

)

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Missing or bad extra config string in hard disk image: \"%s\""), desc.strExtraConfigCurrent.c_str());

stack.mapDisks[strDiskID] = &desc;

}

break;

case VirtualSystemDescriptionType_Floppy:

if (uLoop == 1)

{

strDescription = "Floppy Drive";

strCaption = "floppy0"; // this is what OVFTool writes

type = ovf::ResourceType_FloppyDrive; // 14

lAutomaticAllocation = 0;

lAddressOnParent = 0; // this is what OVFTool writes

}

break;

case VirtualSystemDescriptionType_CDROM:

/* <Item>

if (uLoop == 2)

{

//uint32_t cDisks = stack.mapDisks.size();

Utf8Str strDiskID = Utf8StrFmt("iso%RI32", ++cDVDs);

strDescription = "CD-ROM Drive";

strCaption = Utf8StrFmt("cdrom%RI32", cDVDs); // OVFTool starts with 1

type = ovf::ResourceType_CDDrive; // 15

lAutomaticAllocation = 1;

//skip empty Medium. There are no information to add into section <References> or <DiskSection>

if (desc.strVBoxCurrent.isNotEmpty() &&

desc.skipIt == false)

{

// the following references the "<Disks>" XML block

strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());

}

// controller=<index>;channel=<c>

size_t pos1 = desc.strExtraConfigCurrent.find("controller=");

size_t pos2 = desc.strExtraConfigCurrent.find("channel=");

int32_t lControllerIndex = -1;

if (pos1 != Utf8Str::npos)

{

RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);

if (lControllerIndex == lIDEPrimaryControllerIndex)

ulParent = idIDEPrimaryController;

else if (lControllerIndex == lIDESecondaryControllerIndex)

ulParent = idIDESecondaryController;

else if (lControllerIndex == lSCSIControllerIndex)

ulParent = idSCSIController;

else if (lControllerIndex == lSATAControllerIndex)

ulParent = idSATAController;

}

if (pos2 != Utf8Str::npos)

RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);

LogFlowFunc(("DVD drive details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",

pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex, lIDESecondaryControllerIndex, ulParent, lAddressOnParent));

if ( !ulParent

|| lAddressOnParent == -1

)

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Missing or bad extra config string in DVD drive medium: \"%s\""), desc.strExtraConfigCurrent.c_str());

stack.mapDisks[strDiskID] = &desc;

// there is no DVD drive map to update because it is

// handled completely with this entry.

}

break;

case VirtualSystemDescriptionType_NetworkAdapter:

/* <Item>

if (uLoop == 2)

{

lAutomaticAllocation = 1;

strCaption = Utf8StrFmt("Ethernet adapter on '%s'", desc.strOvf.c_str());

type = ovf::ResourceType_EthernetAdapter; // 10

/* Set the hardware type to something useful.

switch (desc.strVBoxCurrent.toInt32())

{

case NetworkAdapterType_Am79C970A:

case NetworkAdapterType_Am79C973: strResourceSubType = "PCNet32"; break;

#ifdef VBOX_WITH_E1000

case NetworkAdapterType_I82540EM:

case NetworkAdapterType_I82545EM:

case NetworkAdapterType_I82543GC: strResourceSubType = "E1000"; break;

#endif /* VBOX_WITH_E1000 */

}

strConnection = desc.strOvf;

stack.mapNetworks[desc.strOvf] = true;

}

break;

case VirtualSystemDescriptionType_USBController:

/* <Item ovf:required="false">

if (uLoop == 1)

{

strDescription = "USB Controller";

strCaption = "usb";

type = ovf::ResourceType_USBController; // 23

lAddress = 0; // this is what OVFTool writes

lBusNumber = 0; // this is what OVFTool writes

}

break;

case VirtualSystemDescriptionType_SoundCard:

/* <Item ovf:required="false">

if (uLoop == 1)

{

strDescription = "Sound Card";

strCaption = "sound";

type = ovf::ResourceType_SoundCard; // 35

strResourceSubType = desc.strOvf; // e.g. ensoniq1371

lAutomaticAllocation = 0;

lAddressOnParent = 3; // what gives? this is what OVFTool writes

}

break;

}

if (type)

{

xml::ElementNode *pItem;

xml::ElementNode *pItemHelper;

RTCString itemElement;

RTCString itemElementHelper;

if (enFormat == ovf::OVFVersion_2_0)

{

if(uLoop == 2)

{

if (desc.type == VirtualSystemDescriptionType_NetworkAdapter)

{

itemElement = "epasd:";

pItem = pelmVirtualHardwareSection->createChild("EthernetPortItem");

}

else if (desc.type == VirtualSystemDescriptionType_CDROM ||

desc.type == VirtualSystemDescriptionType_HardDiskImage)

{

itemElement = "sasd:";

pItem = pelmVirtualHardwareSection->createChild("StorageItem");

}

else

pItem = NULL;

}

else

{

itemElement = "rasd:";

pItem = pelmVirtualHardwareSection->createChild("Item");

}

}

else

{

itemElement = "rasd:";

pItem = pelmVirtualHardwareSection->createChild("Item");

}

// NOTE: DO NOT CHANGE THE ORDER of these items! The OVF standards prescribes that

// the elements from the rasd: namespace must be sorted by letter, and VMware

// actually requires this as well (see public bug #6612)

if (lAddress != -1)

{

//pItem->createChild("rasd:Address")->addContent(Utf8StrFmt("%d", lAddress));

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("Address").c_str());

pItemHelper->addContent(Utf8StrFmt("%d", lAddress));

}

if (lAddressOnParent != -1)

{

//pItem->createChild("rasd:AddressOnParent")->addContent(Utf8StrFmt("%d", lAddressOnParent));

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("AddressOnParent").c_str());

pItemHelper->addContent(Utf8StrFmt("%d", lAddressOnParent));

}

if (!strAllocationUnits.isEmpty())

{

//pItem->createChild("rasd:AllocationUnits")->addContent(strAllocationUnits);

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("AllocationUnits").c_str());

pItemHelper->addContent(strAllocationUnits);

}

if (lAutomaticAllocation != -1)

{

//pItem->createChild("rasd:AutomaticAllocation")->addContent( (lAutomaticAllocation) ? "true" : "false" );

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("AutomaticAllocation").c_str());

pItemHelper->addContent((lAutomaticAllocation) ? "true" : "false" );

}

if (lBusNumber != -1)

{

if (enFormat == ovf::OVFVersion_0_9)

{

// BusNumber is invalid OVF 1.0 so only write it in 0.9 mode for OVFTool

//pItem->createChild("rasd:BusNumber")->addContent(Utf8StrFmt("%d", lBusNumber));

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("BusNumber").c_str());

pItemHelper->addContent(Utf8StrFmt("%d", lBusNumber));

}

}

if (!strCaption.isEmpty())

{

//pItem->createChild("rasd:Caption")->addContent(strCaption);

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("Caption").c_str());

pItemHelper->addContent(strCaption);

}

if (!strConnection.isEmpty())

{

//pItem->createChild("rasd:Connection")->addContent(strConnection);

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("Connection").c_str());

pItemHelper->addContent(strConnection);

}

if (!strDescription.isEmpty())

{

//pItem->createChild("rasd:Description")->addContent(strDescription);

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("Description").c_str());

pItemHelper->addContent(strDescription);

}

if (!strCaption.isEmpty())

{

if (enFormat == ovf::OVFVersion_1_0)

{

//pItem->createChild("rasd:ElementName")->addContent(strCaption);

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("ElementName").c_str());

pItemHelper->addContent(strCaption);

}

}

if (!strHostResource.isEmpty())

{

//pItem->createChild("rasd:HostResource")->addContent(strHostResource);

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("HostResource").c_str());

pItemHelper->addContent(strHostResource);

}

{

// <rasd:InstanceID>1</rasd:InstanceID>

itemElementHelper = itemElement;

if (enFormat == ovf::OVFVersion_0_9)

//pelmInstanceID = pItem->createChild("rasd:InstanceId");

pItemHelper = pItem->createChild(itemElementHelper.append("InstanceId").c_str());

else

//pelmInstanceID = pItem->createChild("rasd:InstanceID"); // capitalization changed...

pItemHelper = pItem->createChild(itemElementHelper.append("InstanceID").c_str());

pItemHelper->addContent(Utf8StrFmt("%d", ulInstanceID++));

}

if (ulParent)

{

//pItem->createChild("rasd:Parent")->addContent(Utf8StrFmt("%d", ulParent));

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("Parent").c_str());

pItemHelper->addContent(Utf8StrFmt("%d", ulParent));

}

if (!strResourceSubType.isEmpty())

{

//pItem->createChild("rasd:ResourceSubType")->addContent(strResourceSubType);

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("ResourceSubType").c_str());

pItemHelper->addContent(strResourceSubType);

}

{

// <rasd:ResourceType>3</rasd:ResourceType>

//pItem->createChild("rasd:ResourceType")->addContent(Utf8StrFmt("%d", type));

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("ResourceType").c_str());

pItemHelper->addContent(Utf8StrFmt("%d", type));

}

// <rasd:VirtualQuantity>1</rasd:VirtualQuantity>

if (lVirtualQuantity != -1)

{

//pItem->createChild("rasd:VirtualQuantity")->addContent(Utf8StrFmt("%d", lVirtualQuantity));

itemElementHelper = itemElement;

pItemHelper = pItem->createChild(itemElementHelper.append("VirtualQuantity").c_str());

pItemHelper->addContent(Utf8StrFmt("%d", lVirtualQuantity));

}

}

}

} // for (size_t uLoop = 1; uLoop <= 2; ++uLoop)

// now that we're done with the official OVF <Item> tags under <VirtualSystem>, write out VirtualBox XML

// under the vbox: namespace

xml::ElementNode *pelmVBoxMachine = pelmVirtualSystem->createChild("vbox:Machine");

// ovf:required="false" tells other OVF parsers that they can ignore this thing

pelmVBoxMachine->setAttribute("ovf:required", "false");

// ovf:Info element is required or VMware will bail out on the vbox:Machine element

pelmVBoxMachine->createChild("ovf:Info")->addContent("Complete VirtualBox machine configuration in VirtualBox format");

// create an empty machine config

settings::MachineConfigFile *pConfig = new settings::MachineConfigFile(NULL);

writeLock.release();

try

{

AutoWriteLock machineLock(vsdescThis->m->pMachine COMMA_LOCKVAL_SRC_POS);

// fill the machine config

vsdescThis->m->pMachine->copyMachineDataToSettings(*pConfig);

// Apply export tweaks to machine settings

bool fStripAllMACs = m->optListExport.contains(ExportOptions_StripAllMACs);

bool fStripAllNonNATMACs = m->optListExport.contains(ExportOptions_StripAllNonNATMACs);

if (fStripAllMACs || fStripAllNonNATMACs)

{

for (settings::NetworkAdaptersList::iterator it = pConfig->hardwareMachine.llNetworkAdapters.begin();

it != pConfig->hardwareMachine.llNetworkAdapters.end();

++it)

{

settings::NetworkAdapter &nic = *it;

if (fStripAllMACs || (fStripAllNonNATMACs && nic.mode != NetworkAttachmentType_NAT))

nic.strMACAddress.setNull();

}

}

// write the machine config to the vbox:Machine element

pConfig->buildMachineXML(*pelmVBoxMachine,

settings::MachineConfigFile::BuildMachineXML_WriteVBoxVersionAttribute

/*| settings::MachineConfigFile::BuildMachineXML_SkipRemovableMedia*/

| settings::MachineConfigFile::BuildMachineXML_SuppressSavedState,

// but not BuildMachineXML_IncludeSnapshots nor BuildMachineXML_MediaRegistry

pllElementsWithUuidAttributes);

delete pConfig;

}

catch (...)

{

writeLock.acquire();

delete pConfig;

throw;

}

writeLock.acquire();

}

HRESULT Appliance::i_writeFS(TaskOVF *pTask)

{

LogFlowFuncEnter();

LogFlowFunc(("ENTER appliance %p\n", this));

AutoCaller autoCaller(this);

if (FAILED(autoCaller.rc())) return autoCaller.rc();

HRESULT rc = S_OK;

// Lock the media tree early to make sure nobody else tries to make changes

// to the tree. Also lock the IAppliance object for writing.

AutoMultiWriteLock2 multiLock(&mVirtualBox->i_getMediaTreeLockHandle(), this->lockHandle() COMMA_LOCKVAL_SRC_POS);

// Additional protect the IAppliance object, cause we leave the lock

// when starting the disk export and we don't won't block other

// callers on this lengthy operations.

m->state = Data::ApplianceExporting;

if (pTask->locInfo.strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))

rc = i_writeFSOVF(pTask, multiLock);

else

rc = i_writeFSOVA(pTask, multiLock);

// reset the state so others can call methods again

m->state = Data::ApplianceIdle;

LogFlowFunc(("rc=%Rhrc\n", rc));

LogFlowFuncLeave();

return rc;

}

HRESULT Appliance::i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock)

{

LogFlowFuncEnter();

HRESULT rc = S_OK;

PVDINTERFACEIO pShaIo = 0;

PVDINTERFACEIO pFileIo = 0;

do

{

pShaIo = ShaCreateInterface();

if (!pShaIo)

{

rc = E_OUTOFMEMORY;

break;

}

pFileIo = FileCreateInterface();

if (!pFileIo)

{

rc = E_OUTOFMEMORY;

break;

}

SHASTORAGE storage;

RT_ZERO(storage);

storage.fCreateDigest = m->fManifest;

storage.fSha256 = m->fSha256;

Utf8Str name = i_applianceIOName(applianceIOFile);

int vrc = VDInterfaceAdd(&pFileIo->Core, name.c_str(),

VDINTERFACETYPE_IO, 0, sizeof(VDINTERFACEIO),

&storage.pVDImageIfaces);

if (RT_FAILURE(vrc))

{

rc = E_FAIL;

break;

}

rc = i_writeFSImpl(pTask, writeLock, pShaIo, &storage);

} while (0);

/* Cleanup */

if (pShaIo)

RTMemFree(pShaIo);

if (pFileIo)

RTMemFree(pFileIo);

LogFlowFuncLeave();

return rc;

}

HRESULT Appliance::i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock)

{

LogFlowFuncEnter();

RTTAR tar;

int vrc = RTTarOpen(&tar, pTask->locInfo.strPath.c_str(), RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_ALL);

if (RT_FAILURE(vrc))

return setError(VBOX_E_FILE_ERROR,

tr("Could not create OVA file '%s' (%Rrc)"),

pTask->locInfo.strPath.c_str(), vrc);

HRESULT rc = S_OK;

PVDINTERFACEIO pShaIo = 0;

PVDINTERFACEIO pTarIo = 0;

do

{

pShaIo = ShaCreateInterface();

if (!pShaIo)

{

rc = E_OUTOFMEMORY;

break;

}

pTarIo = tarWriterCreateInterface();

if (!pTarIo)

{

rc = E_OUTOFMEMORY;

break;

}

SHASTORAGE storage;

RT_ZERO(storage);

storage.fCreateDigest = m->fManifest;

storage.fSha256 = m->fSha256;

Utf8Str name = i_applianceIOName(applianceIOTar);

vrc = VDInterfaceAdd(&pTarIo->Core, name.c_str(),

VDINTERFACETYPE_IO, tar, sizeof(VDINTERFACEIO),

&storage.pVDImageIfaces);

if (RT_FAILURE(vrc))

{

rc = E_FAIL;

break;

}

rc = i_writeFSImpl(pTask, writeLock, pShaIo, &storage);

} while (0);

RTTarClose(tar);

/* Cleanup */

if (pShaIo)

RTMemFree(pShaIo);

if (pTarIo)

RTMemFree(pTarIo);

/* Delete ova file on error */

if (FAILED(rc))

RTFileDelete(pTask->locInfo.strPath.c_str());

LogFlowFuncLeave();

return rc;

}

HRESULT Appliance::i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase& writeLock, PVDINTERFACEIO pIfIo, PSHASTORAGE pStorage)

{

LogFlowFuncEnter();

HRESULT rc = S_OK;

list<STRPAIR> fileList;

try

{

int vrc;

// the XML stack contains two maps for disks and networks, which allows us to

// a) have a list of unique disk names (to make sure the same disk name is only added once)

// and b) keep a list of all networks

XMLStack stack;

// Scope this to free the memory as soon as this is finished

{

// Create a xml document

xml::Document doc;

// Now fully build a valid ovf document in memory

i_buildXML(writeLock, doc, stack, pTask->locInfo.strPath, pTask->enFormat);

/* Extract the OVA file name */

Utf8Str strOvaFile = pTask->locInfo.strPath;

/* Extract the path */

Utf8Str strOvfFile = strOvaFile.stripSuffix().append(".ovf");

// Create a memory buffer containing the XML. */

void *pvBuf = 0;

size_t cbSize;

xml::XmlMemWriter writer;

writer.write(doc, &pvBuf, &cbSize);

if (RT_UNLIKELY(!pvBuf))

throw setError(VBOX_E_FILE_ERROR,

tr("Could not create OVF file '%s'"),

strOvfFile.c_str());

/* Write the ovf file to disk. */

vrc = writeBufferToFile(strOvfFile.c_str(), pvBuf, cbSize, pIfIo, pStorage);

if (RT_FAILURE(vrc))

throw setError(VBOX_E_FILE_ERROR,

tr("Could not create OVF file '%s' (%Rrc)"),

strOvfFile.c_str(), vrc);

fileList.push_back(STRPAIR(strOvfFile, pStorage->strDigest));

}

// We need a proper format description

ComObjPtr<MediumFormat> formatTemp;

ComObjPtr<MediumFormat> format;

// Scope for the AutoReadLock

{

SystemProperties *pSysProps = mVirtualBox->i_getSystemProperties();

AutoReadLock propsLock(pSysProps COMMA_LOCKVAL_SRC_POS);

// We are always exporting to VMDK stream optimized for now

formatTemp = pSysProps->i_mediumFormatFromExtension("iso");

format = pSysProps->i_mediumFormat("VMDK");

if (format.isNull())

throw setError(VBOX_E_NOT_SUPPORTED,

tr("Invalid medium storage format"));

}

// Finally, write out the disks!

map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;

for (itS = stack.mapDisks.begin();

itS != stack.mapDisks.end();

++itS)

{

const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;

// source path: where the VBox image is

const Utf8Str &strSrcFilePath = pDiskEntry->strVBoxCurrent;

//skip empty Medium. In common, It's may be empty CD/DVD

if (strSrcFilePath.isEmpty() ||

pDiskEntry->skipIt == true)

continue;

// Do NOT check here whether the file exists. findHardDisk will

// figure that out, and filesystem-based tests are simply wrong

// in the general case (think of iSCSI).

// clone the disk:

ComObjPtr<Medium> pSourceDisk;

Log(("Finding source disk \"%s\"\n", strSrcFilePath.c_str()));

if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)

{

rc = mVirtualBox->i_findHardDiskByLocation(strSrcFilePath, true, &pSourceDisk);

if (FAILED(rc)) throw rc;

}

else//may be CD or DVD

{

rc = mVirtualBox->i_findDVDOrFloppyImage(DeviceType_DVD,

NULL,

strSrcFilePath,

true,

&pSourceDisk);

if (FAILED(rc)) throw rc;

}

Bstr uuidSource;

rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());

if (FAILED(rc)) throw rc;

Guid guidSource(uuidSource);

// output filename

const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;

// target path needs to be composed from where the output OVF is

Utf8Str strTargetFilePath(pTask->locInfo.strPath);

strTargetFilePath.stripFilename()

.append("/")

.append(strTargetFileNameOnly);

// The exporting requests a lock on the media tree. So leave our lock temporary.

writeLock.release();

try

{

// advance to the next operation

pTask->pProgress->SetNextOperation(BstrFmt(tr("Exporting to disk image '%s'"),

RTPathFilename(strTargetFilePath.c_str())).raw(),

pDiskEntry->ulSizeMB); // operation's weight, as set up with the IProgress originally

// create a flat copy of the source disk image

if (pDiskEntry->type == VirtualSystemDescriptionType_HardDiskImage)

{

ComObjPtr<Progress> pProgress2;

pProgress2.createObject();

rc = pProgress2->init(mVirtualBox, static_cast<IAppliance*>(this), BstrFmt(tr("Creating medium '%s'"),

strTargetFilePath.c_str()).raw(), TRUE);

if (FAILED(rc)) throw rc;

rc = pSourceDisk->i_exportFile(strTargetFilePath.c_str(),

format,

MediumVariant_VmdkStreamOptimized,

pIfIo,

pStorage,

pProgress2);

if (FAILED(rc)) throw rc;

ComPtr<IProgress> pProgress3(pProgress2);

// now wait for the background disk operation to complete; this throws HRESULTs on error

i_waitForAsyncProgress(pTask->pProgress, pProgress3);

}

else

{

//copy/clone CD/DVD image

Assert(pDiskEntry->type == VirtualSystemDescriptionType_CDROM);

/* Read the ISO file and add one to OVA/OVF package */

{

void *pvStorage;

RTFILE pFile = NULL;

void *pvUser = pStorage;

vrc = pIfIo->pfnOpen(pvUser, strTargetFilePath.c_str(),

RTFILE_O_OPEN_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_NONE,

0,

&pvStorage);

if (RT_FAILURE(vrc))

throw setError(VBOX_E_FILE_ERROR,

tr("Could not create or open file '%s' (%Rrc)"),

strTargetFilePath.c_str(), vrc);

vrc = RTFileOpen(&pFile,

strSrcFilePath.c_str(),

RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE);

if (RT_FAILURE(vrc) || pFile == NULL)

{

pIfIo->pfnClose(pvUser, pvStorage);

throw setError(VBOX_E_FILE_ERROR,

tr("Could not create or open file '%s' (%Rrc)"),

strSrcFilePath.c_str(), vrc);

}

uint64_t cbFile = 0;

vrc = RTFileGetSize(pFile, &cbFile);

if (RT_SUCCESS(vrc))

{

size_t const cbTmpSize = _1M;

void *pvTmpBuf = RTMemAlloc(cbTmpSize);

if (pvTmpBuf)

{

/* The copy loop. */

uint64_t offDstFile = 0;

for (;;)

{

size_t cbChunk = 0;

vrc = RTFileRead(pFile, pvTmpBuf, cbTmpSize, &cbChunk);

if (RT_FAILURE(vrc) || cbChunk == 0)

break;

size_t cbWritten = 0;

vrc = pIfIo->pfnWriteSync(pvUser,

pvStorage,

offDstFile,

pvTmpBuf,

cbChunk,

&cbWritten);

if (RT_FAILURE(vrc))

break;

Assert(cbWritten == cbChunk);

offDstFile += cbWritten;

}

RTMemFree(pvTmpBuf);

}

else

vrc = VERR_NO_MEMORY;

}

pIfIo->pfnClose(pvUser, pvStorage);

RTFileClose(pFile);

if (RT_FAILURE(vrc))

{

if (vrc == VERR_EOF)

vrc = VINF_SUCCESS;

else

throw setError(VBOX_E_FILE_ERROR,

tr("Error during copy CD/DVD image '%s' (%Rrc)"),

strSrcFilePath.c_str(), vrc);

}

}

}

}

catch (HRESULT rc3)

{

writeLock.acquire();

// Todo: file deletion on error? If not, we can remove that whole try/catch block.

throw rc3;

}

// Finished, lock again (so nobody mess around with the medium tree

// in the meantime)

writeLock.acquire();

fileList.push_back(STRPAIR(strTargetFilePath, pStorage->strDigest));

}

if (m->fManifest)

{

// Create & write the manifest file

Utf8Str strMfFilePath = Utf8Str(pTask->locInfo.strPath).stripSuffix().append(".mf");

Utf8Str strMfFileName = Utf8Str(strMfFilePath).stripPath();

pTask->pProgress->SetNextOperation(BstrFmt(tr("Creating manifest file '%s'"), strMfFileName.c_str()).raw(),

m->ulWeightForManifestOperation); // operation's weight, as set up with the IProgress originally);

PRTMANIFESTTEST paManifestFiles = (PRTMANIFESTTEST)RTMemAlloc(sizeof(RTMANIFESTTEST) * fileList.size());

size_t i = 0;

list<STRPAIR>::const_iterator it1;

for (it1 = fileList.begin();

it1 != fileList.end();

++it1, ++i)

{

paManifestFiles[i].pszTestFile = (*it1).first.c_str();

paManifestFiles[i].pszTestDigest = (*it1).second.c_str();

}

void *pvBuf;

size_t cbSize;

vrc = RTManifestWriteFilesBuf(&pvBuf, &cbSize, m->fSha256 ? RTDIGESTTYPE_SHA256 : RTDIGESTTYPE_SHA1,

paManifestFiles, fileList.size());

RTMemFree(paManifestFiles);

if (RT_FAILURE(vrc))

throw setError(VBOX_E_FILE_ERROR,

tr("Could not create manifest file '%s' (%Rrc)"),

strMfFileName.c_str(), vrc);

/* Disable digest creation for the manifest file. */

pStorage->fCreateDigest = false;

/* Write the manifest file to disk. */

vrc = writeBufferToFile(strMfFilePath.c_str(), pvBuf, cbSize, pIfIo, pStorage);

RTMemFree(pvBuf);

if (RT_FAILURE(vrc))

throw setError(VBOX_E_FILE_ERROR,

tr("Could not create manifest file '%s' (%Rrc)"),

strMfFilePath.c_str(), vrc);

}

}

catch (RTCError &x) // includes all XML exceptions

{

rc = setError(VBOX_E_FILE_ERROR,

x.what());

}

catch (HRESULT aRC)

{

rc = aRC;

}

/* Cleanup on error */

if (FAILED(rc))

{

list<STRPAIR>::const_iterator it1;

for (it1 = fileList.begin();

it1 != fileList.end();

++it1)

pIfIo->pfnDelete(pStorage, (*it1).first.c_str());

}

LogFlowFunc(("rc=%Rhrc\n", rc));

LogFlowFuncLeave();

return rc;

}

#ifdef VBOX_WITH_S3

HRESULT Appliance::i_writeS3(TaskOVF *pTask)

{

LogFlowFuncEnter();

LogFlowFunc(("Appliance %p\n", this));

AutoCaller autoCaller(this);

if (FAILED(autoCaller.rc())) return autoCaller.rc();

HRESULT rc = S_OK;

AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);

int vrc = VINF_SUCCESS;

RTS3 hS3 = NIL_RTS3;

char szOSTmpDir[RTPATH_MAX];

RTPathTemp(szOSTmpDir, sizeof(szOSTmpDir));

/* The template for the temporary directory created below */

char *pszTmpDir = RTPathJoinA(szOSTmpDir, "vbox-ovf-XXXXXX");

list< pair<Utf8Str, ULONG> > filesList;

// todo:

// - usable error codes

// - seems snapshot filenames are problematic {uuid}.vdi

try

{

/* Extract the bucket */

Utf8Str tmpPath = pTask->locInfo.strPath;

Utf8Str bucket;

i_parseBucket(tmpPath, bucket);

/* We need a temporary directory which we can put the OVF file & all

vrc = RTDirCreateTemp(pszTmpDir, 0700);

if (RT_FAILURE(vrc))

throw setError(VBOX_E_FILE_ERROR,

tr("Cannot create temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);

/* The temporary name of the target OVF file */

Utf8StrFmt strTmpOvf("%s/%s", pszTmpDir, RTPathFilename(tmpPath.c_str()));

/* Prepare the temporary writing of the OVF */

ComObjPtr<Progress> progress;

/* Create a temporary file based location info for the sub task */

LocationInfo li;

li.strPath = strTmpOvf;

rc = i_writeImpl(pTask->enFormat, li, progress);

if (FAILED(rc)) throw rc;

/* Unlock the appliance for the writing thread */

appLock.release();

/* Wait until the writing is done, but report the progress back to the

ComPtr<IProgress> progressInt(progress);

i_waitForAsyncProgress(pTask->pProgress, progressInt); /* Any errors will be thrown */

/* Again lock the appliance for the next steps */

appLock.acquire();

vrc = RTPathExists(strTmpOvf.c_str()); /* Paranoid check */

if (RT_FAILURE(vrc))

throw setError(VBOX_E_FILE_ERROR,

tr("Cannot find source file '%s' (%Rrc)"), strTmpOvf.c_str(), vrc);

/* Add the OVF file */

filesList.push_back(pair<Utf8Str, ULONG>(strTmpOvf, m->ulWeightForXmlOperation)); /* Use 1% of the total for the OVF file upload */

/* Add the manifest file */

if (m->fManifest)

{

Utf8Str strMfFile = Utf8Str(strTmpOvf).stripSuffix().append(".mf");

filesList.push_back(pair<Utf8Str, ULONG>(strMfFile , m->ulWeightForXmlOperation)); /* Use 1% of the total for the manifest file upload */

}

/* Now add every disks of every virtual system */

list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;

for (it = m->virtualSystemDescriptions.begin();

it != m->virtualSystemDescriptions.end();

++it)

{

ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);

std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->i_findByType(VirtualSystemDescriptionType_HardDiskImage);

std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;

for (itH = avsdeHDs.begin();

itH != avsdeHDs.end();

++itH)

{

const Utf8Str &strTargetFileNameOnly = (*itH)->strOvf;

/* Target path needs to be composed from where the output OVF is */

Utf8Str strTargetFilePath(strTmpOvf);

strTargetFilePath.stripFilename();

strTargetFilePath.append("/");

strTargetFilePath.append(strTargetFileNameOnly);

vrc = RTPathExists(strTargetFilePath.c_str()); /* Paranoid check */

if (RT_FAILURE(vrc))

throw setError(VBOX_E_FILE_ERROR,

tr("Cannot find source file '%s' (%Rrc)"), strTargetFilePath.c_str(), vrc);

filesList.push_back(pair<Utf8Str, ULONG>(strTargetFilePath, (*itH)->ulSizeMB));

}

}

/* Next we have to upload the OVF & all disk images */

vrc = RTS3Create(&hS3, pTask->locInfo.strUsername.c_str(), pTask->locInfo.strPassword.c_str(), pTask->locInfo.strHostname.c_str(), "virtualbox-agent/" VBOX_VERSION_STRING);

if (RT_FAILURE(vrc))

throw setError(VBOX_E_IPRT_ERROR,

tr("Cannot create S3 service handler"));

RTS3SetProgressCallback(hS3, pTask->updateProgress, &pTask);

/* Upload all files */

for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)

{

const pair<Utf8Str, ULONG> &s = (*it1);

char *pszFilename = RTPathFilename(s.first.c_str());

/* Advance to the next operation */

pTask->pProgress->SetNextOperation(BstrFmt(tr("Uploading file '%s'"), pszFilename).raw(), s.second);

vrc = RTS3PutKey(hS3, bucket.c_str(), pszFilename, s.first.c_str());

if (RT_FAILURE(vrc))

{

if (vrc == VERR_S3_CANCELED)

break;

else if (vrc == VERR_S3_ACCESS_DENIED)

throw setError(E_ACCESSDENIED,

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);

else if (vrc == VERR_S3_NOT_FOUND)

throw setError(VBOX_E_FILE_ERROR,

tr("Cannot upload file '%s' to S3 storage server (File not found)"), pszFilename);

else

throw setError(VBOX_E_IPRT_ERROR,

tr("Cannot upload file '%s' to S3 storage server (%Rrc)"), pszFilename, vrc);

}

}

}

catch(HRESULT aRC)

{

rc = aRC;

}

/* Cleanup */

RTS3Destroy(hS3);

/* Delete all files which where temporary created */

for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)

{

const char *pszFilePath = (*it1).first.c_str();

if (RTPathExists(pszFilePath))

{

vrc = RTFileDelete(pszFilePath);

if (RT_FAILURE(vrc))

rc = setError(VBOX_E_FILE_ERROR,

tr("Cannot delete file '%s' (%Rrc)"), pszFilePath, vrc);

}

}

/* Delete the temporary directory */

if (RTPathExists(pszTmpDir))

{

vrc = RTDirRemove(pszTmpDir);

if (RT_FAILURE(vrc))

rc = setError(VBOX_E_FILE_ERROR,

tr("Cannot delete temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);

}

if (pszTmpDir)

RTStrFree(pszTmpDir);

LogFlowFunc(("rc=%Rhrc\n", rc));

LogFlowFuncLeave();

return rc;

}

#endif /* VBOX_WITH_S3 */