#include <iprt/stream.h>

#include <iprt/path.h>

#include <iprt/dir.h>

#include <iprt/file.h>

#include "ApplianceImpl.h"

#include "VirtualBoxImpl.h"

#include "GuestOSTypeImpl.h"

#include "ProgressImpl.h"

#include "Logging.h"

#include "VBox/xml.h"

#include <iostream>

#include <sstream>

using namespace std;

struct DiskImage

{

Utf8Str strDiskId; // value from DiskSection/Disk/@diskId

int64_t iCapacity; // value from DiskSection/Disk/@capacity;

// (maximum size for dynamic images, I guess; we always translate this to bytes)

int64_t iPopulatedSize; // value from DiskSection/Disk/@populatedSize

// (actual used size of disk, always in bytes; can be an estimate of used disk

// space, but cannot be larger than iCapacity)

Utf8Str strFormat; // value from DiskSection/Disk/@format

// typically http://www.vmware.com/specifications/vmdk.html#sparse

// fields from /References/File; the spec says the file reference from disk can be empty,

// so in that case, strFilename will be empty, then a new disk should be created

Utf8Str strHref; // value from /References/File/@href (filename); if empty, then the remaining fields are ignored

int64_t iSize; // value from /References/File/@size (optional according to spec; then we set -1 here)

int64_t iChunkSize; // value from /References/File/@chunkSize (optional, unsupported)

Utf8Str strCompression; // value from /References/File/@compression (optional, can be "gzip" according to spec)

};

struct Network

{

Utf8Str strNetworkName; // value from NetworkSection/Network/@name

// unfortunately the OVF spec is unspecific about how networks should be specified further

};

struct VirtualHardwareItem

{

Utf8Str strDescription;

Utf8Str strCaption;

Utf8Str strElementName;

uint32_t ulInstanceID;

uint32_t ulParent;

OVFResourceType_T resourceType;

Utf8Str strOtherResourceType;

Utf8Str strResourceSubType;

Utf8Str strHostResource; // "Abstractly specifies how a device shall connect to a resource on the deployment platform.

// Not all devices need a backing." Used with disk items, for which this references a virtual

// disk from the Disks section.

bool fAutomaticAllocation;

bool fAutomaticDeallocation;

Utf8Str strConnection; // "All Ethernet adapters that specify the same abstract network connection name within an OVF

// package shall be deployed on the same network. The abstract network connection name shall be

// listed in the NetworkSection at the outermost envelope level."

Utf8Str strAddress; // "Device-specific. For an Ethernet adapter, this specifies the MAC address."

Utf8Str strAddressOnParent; // "For a device, this specifies its location on the controller."

Utf8Str strAllocationUnits; // "Specifies the units of allocation used. For example, “byte * 2^20”."

uint64_t ullVirtualQuantity; // "Specifies the quantity of resources presented. For example, “256”."

uint64_t ullReservation; // "Specifies the minimum quantity of resources guaranteed to be available."

uint64_t ullLimit; // "Specifies the maximum quantity of resources that will be granted."

uint64_t ullWeight; // "Specifies a relative priority for this allocation in relation to other allocations."

Utf8Str strConsumerVisibility;

Utf8Str strMappingBehavior;

Utf8Str strPoolID;

uint32_t ulBusNumber; // seen with IDE controllers, but not listed in OVF spec

uint32_t ulLineNumber; // line number of <Item> element in XML source; cached for error messages

VirtualHardwareItem()

: ulInstanceID(0), fAutomaticAllocation(false), fAutomaticDeallocation(false), ullVirtualQuantity(0), ullReservation(0), ullLimit(0), ullWeight(0), ulBusNumber(0), ulLineNumber(0)

{};

};

typedef map<Utf8Str, DiskImage> DiskImagesMap;

typedef map<Utf8Str, Network> NetworksMap;

struct VirtualSystem;

struct Appliance::Data

{

Bstr bstrPath;

DiskImagesMap mapDisks; // map of DiskImage structs, sorted by DiskImage.strDiskId

NetworksMap mapNetworks; // map of Network structs, sorted by Network.strNetworkName

list<VirtualSystem> llVirtualSystems;

list< ComObjPtr<VirtualSystemDescription> > virtualSystemDescriptions;

};

typedef map<uint32_t, VirtualHardwareItem> HardwareItemsMap;

struct HardDiskController

{

uint32_t idController; // instance ID (Item/InstanceId); this gets referenced from HardDisk

enum ControllerSystemType { IDE, SATA, SCSI };

ControllerSystemType system; // one of IDE, SATA, SCSI

Utf8Str strControllerType; // controller subtype (Item/ResourceSubType); e.g. "LsiLogic"; can be empty (esp. for IDE)

Utf8Str strAddress; // for IDE

uint32_t ulBusNumber; // for IDE

HardDiskController()

: idController(0),

ulBusNumber(0)

{

}

};

typedef map<uint32_t, HardDiskController> ControllersMap;

struct VirtualDisk

{

uint32_t idController; // SCSI (or IDE) controller this disk is connected to;

// points into VirtualSystem.mapControllers

Utf8Str strDiskId; // if the hard disk has an ovf:/disk/<id> reference,

// this receives the <id> component; points to one of the

// references in Appliance::Data.mapDisks

};

typedef map<Utf8Str, VirtualDisk> VirtualDisksMap;

struct VirtualSystem

{

Utf8Str strName; // copy of VirtualSystem/@id

CIMOSType_T cimos;

Utf8Str strVirtualSystemType; // generic hardware description; OVF says this can be something like "vmx-4" or "xen";

// VMware Workstation 6.5 is "vmx-07"

HardwareItemsMap mapHardwareItems; // map of virtual hardware items, sorted by unique instance ID

uint64_t ullMemorySize; // always in bytes, copied from llHardwareItems; default = 0 (unspecified)

uint16_t cCPUs; // no. of CPUs, copied from llHardwareItems; default = 1

list<Utf8Str> llNetworkNames;

// list of strings referring to network names

// (one for each VirtualSystem/Item[@ResourceType=10]/Connection element)

ControllersMap mapControllers;

// list of hard disk controllers

// (one for each VirtualSystem/Item[@ResourceType=6] element with accumulated data from children)

VirtualDisksMap mapVirtualDisks;

// (one for each VirtualSystem/Item[@ResourceType=17] element with accumulated data from children)

bool fHasFloppyDrive; // true if there's a floppy item in mapHardwareItems

bool fHasCdromDrive; // true if there's a CD-ROM item in mapHardwareItems; ISO images are not yet supported by OVFtool

bool fHasUsbController; // true if there's a USB controller item in mapHardwareItems

Utf8Str strSoundCardType; // if not empty, then the system wants a soundcard; this then specifies the hardware;

// VMware Workstation 6.5 uses "ensoniq1371" for example

Utf8Str strLicenceInfo; // license info if any; receives contents of VirtualSystem/EulaSection/Info

Utf8Str strLicenceText; // license info if any; receives contents of VirtualSystem/EulaSection/License

VirtualSystem()

: ullMemorySize(0), cCPUs(1), fHasFloppyDrive(false), fHasCdromDrive(false), fHasUsbController(false)

{

}

};

struct Appliance::Task

{

Task(Appliance *aThat, Progress *aProgress)

: that(aThat)

, progress(aProgress)

, rc(S_OK)

{}

~Task() {}

HRESULT startThread();

Appliance *that;

ComObjPtr<Progress> progress;

HRESULT rc;

};

template <class T>

com::Utf8Str toString(const T& val)

{

// @todo optimize

std::ostringstream ss;

ss << val;

return Utf8Str(ss.str().c_str());

}

static Utf8Str stripFilename(const Utf8Str &strFile)

{

Utf8Str str2(strFile);

RTPathStripFilename(str2.mutableRaw());

return str2;

}

STDMETHODIMP VirtualBox::CreateAppliance(IAppliance** anAppliance)

{

HRESULT rc;

ComObjPtr<Appliance> appliance;

appliance.createObject();

rc = appliance->init(this);

if (SUCCEEDED(rc))

appliance.queryInterfaceTo(anAppliance);

return rc;

}

HRESULT Appliance::Task::startThread()

{

int vrc = RTThreadCreate(NULL, Appliance::taskThread, this,

0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,

"Appliance::Task");

ComAssertMsgRCRet(vrc,

("Could not create Appliance::Task thread (%Rrc)\n", vrc), E_FAIL);

return S_OK;

}

DEFINE_EMPTY_CTOR_DTOR(Appliance)

struct shutup {};

HRESULT Appliance::LoopThruSections(const char *pcszPath,

const xml::Node *pReferencesElem,

const xml::Node *pCurElem)

{

HRESULT rc;

xml::NodesLoop loopChildren(*pCurElem);

const xml::Node *pElem;

while ((pElem = loopChildren.forAllNodes()))

{

const char *pcszElemName = pElem->getName();

const char *pcszTypeAttr = "";

const xml::Node *pTypeAttr;

if ((pTypeAttr = pElem->findAttribute("type")))

pcszTypeAttr = pTypeAttr->getValue();

if ( (!strcmp(pcszElemName, "DiskSection"))

|| ( (!strcmp(pcszElemName, "Section"))

&& (!strcmp(pcszTypeAttr, "ovf:DiskSection_Type"))

)

)

{

if (!(SUCCEEDED((rc = HandleDiskSection(pcszPath, pReferencesElem, pElem)))))

return rc;

}

else if ( (!strcmp(pcszElemName, "NetworkSection"))

|| ( (!strcmp(pcszElemName, "Section"))

&& (!strcmp(pcszTypeAttr, "ovf:NetworkSection_Type"))

)

)

{

if (!(SUCCEEDED((rc = HandleNetworkSection(pcszPath, pElem)))))

return rc;

}

else if ( (!strcmp(pcszElemName, "DeploymentOptionSection>")))

{

// TODO

}

else if ( (!strcmp(pcszElemName, "Info")))

{

// child of VirtualSystemCollection -- TODO

}

else if ( (!strcmp(pcszElemName, "ResourceAllocationSection")))

{

// child of VirtualSystemCollection -- TODO

}

else if ( (!strcmp(pcszElemName, "StartupSection")))

{

// child of VirtualSystemCollection -- TODO

}

else if ( (!strcmp(pcszElemName, "VirtualSystem"))

|| ( (!strcmp(pcszElemName, "Content"))

&& (!strcmp(pcszTypeAttr, "ovf:VirtualSystem_Type"))

)

)

{

if (!(SUCCEEDED((rc = HandleVirtualSystemContent(pcszPath, pElem)))))

return rc;

}

else if ( (!strcmp(pcszElemName, "VirtualSystemCollection"))

|| ( (!strcmp(pcszElemName, "Content"))

&& (!strcmp(pcszTypeAttr, "ovf:VirtualSystemCollection_Type"))

)

)

{

// TODO ResourceAllocationSection

// recurse for this, since it has VirtualSystem elements as children

if (!(SUCCEEDED((rc = LoopThruSections(pcszPath, pReferencesElem, pElem)))))

return rc;

}

}

return S_OK;

}

HRESULT Appliance::HandleDiskSection(const char *pcszPath,

const xml::Node *pReferencesElem,

const xml::Node *pSectionElem)

{

// contains "Disk" child elements

xml::NodesLoop loopDisks(*pSectionElem, "Disk");

const xml::Node *pelmDisk;

while ((pelmDisk = loopDisks.forAllNodes()))

{

DiskImage d;

const char *pcszBad = NULL;

if (!(pelmDisk->getAttributeValue("diskId", d.strDiskId)))

pcszBad = "diskId";

else if (!(pelmDisk->getAttributeValue("format", d.strFormat)))

pcszBad = "format";

else if (!(pelmDisk->getAttributeValue("capacity", d.iCapacity)))

pcszBad = "capacity";

else

{

if (!(pelmDisk->getAttributeValue("populatedSize", d.iPopulatedSize)))

// optional

d.iPopulatedSize = -1;

Utf8Str strFileRef;

if (pelmDisk->getAttributeValue("fileRef", strFileRef)) // optional

{

// look up corresponding /References/File nodes (list built above)

const xml::Node *pFileElem;

if ( pReferencesElem

&& ((pFileElem = pReferencesElem->findChildElementFromId(strFileRef.c_str())))

)

{

// copy remaining values from file node then

const char *pcszBadInFile = NULL;

if (!(pFileElem->getAttributeValue("href", d.strHref)))

pcszBadInFile = "href";

else if (!(pFileElem->getAttributeValue("size", d.iSize)))

d.iSize = -1; // optional

// if (!(pFileElem->getAttributeValue("size", d.iChunkSize))) TODO

d.iChunkSize = -1; // optional

pFileElem->getAttributeValue("compression", d.strCompression);

if (pcszBadInFile)

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": missing or invalid attribute '%s' in 'File' element, line %d"),

pcszPath,

pcszBadInFile,

pFileElem->getLineNumber());

}

else

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": cannot find References/File element for ID '%s' referenced by 'Disk' element, line %d"),

pcszPath,

strFileRef.c_str(),

pelmDisk->getLineNumber());

}

}

if (pcszBad)

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": missing or invalid attribute '%s' in 'DiskSection' element, line %d"),

pcszPath,

pcszBad,

pelmDisk->getLineNumber());

m->mapDisks[d.strDiskId] = d;

}

return S_OK;

}

HRESULT Appliance::HandleNetworkSection(const char *pcszPath,

const xml::Node *pSectionElem)

{

// contains "Disk" child elements

xml::NodesLoop loopNetworks(*pSectionElem, "Network");

const xml::Node *pelmNetwork;

while ((pelmNetwork = loopNetworks.forAllNodes()))

{

Network n;

if (!(pelmNetwork->getAttributeValue("name", n.strNetworkName)))

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": missing 'name' attribute in 'Network', line %d"),

pcszPath,

pelmNetwork->getLineNumber());

m->mapNetworks[n.strNetworkName] = n;

}

return S_OK;

}

HRESULT Appliance::HandleVirtualSystemContent(const char *pcszPath,

const xml::Node *pelmVirtualSystem)

{

VirtualSystem vsys;

const xml::Node *pIdAttr = pelmVirtualSystem->findAttribute("id");

if (pIdAttr)

vsys.strName = pIdAttr->getValue();

xml::NodesLoop loop(*pelmVirtualSystem); // all child elements

const xml::Node *pelmThis;

while ((pelmThis = loop.forAllNodes()))

{

const char *pcszElemName = pelmThis->getName();

const xml::Node *pTypeAttr = pelmThis->findAttribute("type");

const char *pcszTypeAttr = (pTypeAttr) ? pTypeAttr->getValue() : "";

if (!strcmp(pcszElemName, "EulaSection"))

{

/* <EulaSection>

const xml::Node *pelmInfo, *pelmLicense;

if ( ((pelmInfo = pelmThis->findChildElement("Info")))

&& ((pelmLicense = pelmThis->findChildElement("License")))

)

{

vsys.strLicenceInfo = pelmInfo->getValue();

vsys.strLicenceText = pelmLicense->getValue();

}

}

else if ( (!strcmp(pcszElemName, "VirtualHardwareSection"))

|| (!strcmp(pcszTypeAttr, "ovf:VirtualHardwareSection_Type"))

)

{

const xml::Node *pelmSystem, *pelmVirtualSystemType;

if ((pelmSystem = pelmThis->findChildElement("System")))

{

/* <System>

if ((pelmVirtualSystemType = pelmSystem->findChildElement("VirtualSystemType")))

vsys.strVirtualSystemType = pelmVirtualSystemType->getValue();

}

xml::NodesLoop loopVirtualHardwareItems(*pelmThis, "Item"); // all "Item" child elements

const xml::Node *pelmItem;

while ((pelmItem = loopVirtualHardwareItems.forAllNodes()))

{

VirtualHardwareItem i;

i.ulLineNumber = pelmItem->getLineNumber();

xml::NodesLoop loopItemChildren(*pelmItem); // all child elements

const xml::Node *pelmItemChild;

while ((pelmItemChild = loopItemChildren.forAllNodes()))

{

const char *pcszItemChildName = pelmItemChild->getName();

if (!strcmp(pcszItemChildName, "Description"))

i.strDescription = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "Caption"))

i.strCaption = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "ElementName"))

i.strElementName = pelmItemChild->getValue();

else if ( (!strcmp(pcszItemChildName, "InstanceID"))

|| (!strcmp(pcszItemChildName, "InstanceId"))

)

pelmItemChild->copyValue(i.ulInstanceID);

else if (!strcmp(pcszItemChildName, "HostResource"))

i.strHostResource = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "ResourceType"))

{

int32_t iType; /** @todo how to fix correctly? (enum fun.) */

pelmItemChild->copyValue(iType);

i.resourceType = (OVFResourceType_T)iType;

}

else if (!strcmp(pcszItemChildName, "OtherResourceType"))

i.strOtherResourceType = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "ResourceSubType"))

i.strResourceSubType = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "AutomaticAllocation"))

i.fAutomaticAllocation = (!strcmp(pelmItemChild->getValue(), "true")) ? true : false;

else if (!strcmp(pcszItemChildName, "AutomaticDeallocation"))

i.fAutomaticDeallocation = (!strcmp(pelmItemChild->getValue(), "true")) ? true : false;

else if (!strcmp(pcszItemChildName, "Parent"))

pelmItemChild->copyValue(i.ulParent);

else if (!strcmp(pcszItemChildName, "Connection"))

i.strConnection = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "Address"))

i.strAddress = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "AddressOnParent"))

i.strAddressOnParent = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "AllocationUnits"))

i.strAllocationUnits = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "VirtualQuantity"))

pelmItemChild->copyValue(i.ullVirtualQuantity);

else if (!strcmp(pcszItemChildName, "Reservation"))

pelmItemChild->copyValue(i.ullReservation);

else if (!strcmp(pcszItemChildName, "Limit"))

pelmItemChild->copyValue(i.ullLimit);

else if (!strcmp(pcszItemChildName, "Weight"))

pelmItemChild->copyValue(i.ullWeight);

else if (!strcmp(pcszItemChildName, "ConsumerVisibility"))

i.strConsumerVisibility = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "MappingBehavior"))

i.strMappingBehavior = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "PoolID"))

i.strPoolID = pelmItemChild->getValue();

else if (!strcmp(pcszItemChildName, "BusNumber"))

pelmItemChild->copyValue(i.ulBusNumber);

else

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": unknown element \"%s\" under Item element, line %d"),

pcszPath,

pcszItemChildName,

i.ulLineNumber);

}

// store!

vsys.mapHardwareItems[i.ulInstanceID] = i;

}

HardwareItemsMap::const_iterator itH;

for (itH = vsys.mapHardwareItems.begin();

itH != vsys.mapHardwareItems.end();

++itH)

{

const VirtualHardwareItem &i = itH->second;

// do some analysis

switch (i.resourceType)

{

case OVFResourceType_Processor: // 3

/* <rasd:Caption>1 virtual CPU</rasd:Caption>

if (i.ullVirtualQuantity < UINT16_MAX)

vsys.cCPUs = (uint16_t)i.ullVirtualQuantity;

else

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": CPU count %RI64 is larger than %d, line %d"),

pcszPath,

i.ullVirtualQuantity,

UINT16_MAX,

i.ulLineNumber);

break;

case OVFResourceType_Memory: // 4

if ( (i.strAllocationUnits == "MegaBytes") // found in OVF created by OVF toolkit

|| (i.strAllocationUnits == "MB") // found in MS docs

|| (i.strAllocationUnits == "byte * 2^20") // suggested by OVF spec DSP0243 page 21

)

vsys.ullMemorySize = i.ullVirtualQuantity * 1024 * 1024;

else

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": Invalid allocation unit \"%s\" specified with memory size item, line %d"),

pcszPath,

i.strAllocationUnits.c_str(),

i.ulLineNumber);

break;

case OVFResourceType_IdeController: // 5 IdeController

{

/* <Item>

HardDiskController hdc;

hdc.system = HardDiskController::IDE;

hdc.idController = i.ulInstanceID;

hdc.strAddress = i.strAddress;

hdc.ulBusNumber = i.ulBusNumber;

vsys.mapControllers[i.ulInstanceID] = hdc;

}

break;

case OVFResourceType_ParallelScsiHba: // 6 SCSI controller

{

/* <Item>

HardDiskController hdc;

hdc.system = HardDiskController::SCSI;

hdc.idController = i.ulInstanceID;

hdc.strControllerType = i.strResourceSubType;

vsys.mapControllers[i.ulInstanceID] = hdc;

}

break;

case OVFResourceType_EthernetAdapter: // 10

{

/* <Item>

// make sure we have a matching NetworkSection/Network

NetworksMap::iterator it = m->mapNetworks.find(i.strConnection);

if (it == m->mapNetworks.end())

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": Invalid connection \"%s\"; cannot find matching NetworkSection/Network element, line %d"),

pcszPath,

i.strConnection.c_str(),

i.ulLineNumber);

vsys.llNetworkNames.push_back(i.strConnection);

}

break;

case OVFResourceType_FloppyDrive: // 14

vsys.fHasFloppyDrive = true; // we have no additional information

break;

case OVFResourceType_CdDrive: // 15

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

// I tried to see what happens if I set an ISO for the CD-ROM in VMware Workstation,

// but then the ovftool dies with "Device backing not supported". So I guess if

// VMware can't export ISOs, then we don't need to be able to import them right now.

vsys.fHasCdromDrive = true; // we have no additional information

break;

case OVFResourceType_HardDisk: // 17

{

/* <Item>

// look up the hard disk controller element whose InstanceID equals our Parent;

// this is how the connection is specified in OVF

ControllersMap::const_iterator it = vsys.mapControllers.find(i.ulParent);

if (it == vsys.mapControllers.end())

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": Hard disk item with instance ID %d specifies invalid parent %d, line %d"),

pcszPath,

i.ulInstanceID,

i.ulParent,

i.ulLineNumber);

const HardDiskController &hdc = it->second;

VirtualDisk vd;

vd.idController = i.ulParent;

bool fFound = false;

// ovf://disk/lamp

// 12345678901234

if (i.strHostResource.substr(0, 11) == "ovf://disk/")

vd.strDiskId = i.strHostResource.substr(11);

else if (i.strHostResource.substr(0, 6) == "/disk/")

vd.strDiskId = i.strHostResource.substr(6);

if ( !(vd.strDiskId.length())

|| (m->mapDisks.find(vd.strDiskId) == m->mapDisks.end())

)

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": Hard disk item with instance ID %d specifies invalid host resource \"%s\", line %d"),

pcszPath,

i.ulInstanceID,

i.strHostResource.c_str(),

i.ulLineNumber);

vsys.mapVirtualDisks[vd.strDiskId] = vd;

}

break;

case OVFResourceType_UsbController: // 23

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

vsys.fHasUsbController = true; // we have no additional information

break;

case OVFResourceType_SoundCard: // 35

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

vsys.strSoundCardType = i.strResourceSubType;

break;

default:

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": Unknown resource type %d in hardware item, line %d"),

pcszPath,

i.resourceType,

i.ulLineNumber);

}

}

}

else if ( (!strcmp(pcszElemName, "OperatingSystemSection"))

|| (!strcmp(pcszTypeAttr, "ovf:OperatingSystemSection_Type"))

)

{

uint64_t cimos64;

if (!(pelmThis->getAttributeValue("id", cimos64)))

return setError(VBOX_E_FILE_ERROR,

tr("Error reading \"%s\": missing or invalid 'ovf:id' attribute in operating system section element, line %d"),

pcszPath,

pelmThis->getLineNumber());

vsys.cimos = (CIMOSType_T)cimos64;

}

}

// now create the virtual system

m->llVirtualSystems.push_back(vsys);

return S_OK;

}

HRESULT Appliance::init(VirtualBox *aVirtualBox)

{

HRESULT rc;

/* Enclose the state transition NotReady->InInit->Ready */

AutoInitSpan autoInitSpan(this);

AssertReturn(autoInitSpan.isOk(), E_FAIL);

/* Weak reference to a VirtualBox object */

unconst(mVirtualBox) = aVirtualBox;

// initialize data

m = new Data;

/* Confirm a successful initialization */

autoInitSpan.setSucceeded();

return S_OK;

}

void Appliance::uninit()

{

delete m;

m = NULL;

}

STDMETHODIMP Appliance::COMGETTER(Path)(BSTR *aPath)

{

if (!aPath)

return E_POINTER;

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoReadLock alock(this);

m->bstrPath.cloneTo(aPath);

return S_OK;

}

STDMETHODIMP Appliance::COMGETTER(Disks)(ComSafeArrayOut(BSTR, aDisks))

{

CheckComArgOutSafeArrayPointerValid(aDisks);

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoReadLock alock(this);

size_t c = m->mapDisks.size();

com::SafeArray<BSTR> sfaDisks(c);

DiskImagesMap::const_iterator it;

size_t i = 0;

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

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

++it, ++i)

{

// create a string representing this disk

const DiskImage &d = it->second;

char *psz = NULL;

RTStrAPrintf(&psz,

"%s\t"

"%RI64\t"

"%RI64\t"

"%s\t"

"%s\t"

"%RI64\t"

"%RI64\t"

"%s",

d.strDiskId.c_str(),

d.iCapacity,

d.iPopulatedSize,

d.strFormat.c_str(),

d.strHref.c_str(),

d.iSize,

d.iChunkSize,

d.strCompression.c_str());

Utf8Str utf(psz);

Bstr bstr(utf);

// push to safearray

bstr.cloneTo(&sfaDisks[i]);

RTStrFree(psz);

}

sfaDisks.detachTo(ComSafeArrayOutArg(aDisks));

return S_OK;

}

STDMETHODIMP Appliance::COMGETTER(VirtualSystemDescriptions)(ComSafeArrayOut(IVirtualSystemDescription*, aVirtualSystemDescriptions))

{

CheckComArgOutSafeArrayPointerValid(aVirtualSystemDescriptions);

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoReadLock alock(this);

SafeIfaceArray<IVirtualSystemDescription> sfaVSD(m->virtualSystemDescriptions);

sfaVSD.detachTo(ComSafeArrayOutArg(aVirtualSystemDescriptions));

return S_OK;

}

void convertCIMOSType2VBoxOSType(Utf8Str &osTypeVBox, CIMOSType_T c)

{

switch (c)

{

case CIMOSType_CIMOS_Unknown: // 0 - Unknown

osTypeVBox = SchemaDefs_OSTypeId_Other;

break;

case CIMOSType_CIMOS_OS2: // 12 - OS/2

osTypeVBox = SchemaDefs_OSTypeId_OS2;

break;

case CIMOSType_CIMOS_MSDOS: // 14 - MSDOS

osTypeVBox = SchemaDefs_OSTypeId_DOS;

break;

case CIMOSType_CIMOS_WIN3x: // 15 - WIN3x

osTypeVBox = SchemaDefs_OSTypeId_Windows31;

break;

case CIMOSType_CIMOS_WIN95: // 16 - WIN95

osTypeVBox = SchemaDefs_OSTypeId_Windows95;

break;

case CIMOSType_CIMOS_WIN98: // 17 - WIN98

osTypeVBox = SchemaDefs_OSTypeId_Windows98;

break;

case CIMOSType_CIMOS_WINNT: // 18 - WINNT

osTypeVBox = SchemaDefs_OSTypeId_WindowsNT4;

break;

case CIMOSType_CIMOS_NetWare: // 21 - NetWare

case CIMOSType_CIMOS_NovellOES: // 86 - Novell OES

osTypeVBox = SchemaDefs_OSTypeId_Netware;

break;

case CIMOSType_CIMOS_Solaris: // 29 - Solaris

case CIMOSType_CIMOS_SunOS: // 30 - SunOS

osTypeVBox = SchemaDefs_OSTypeId_Solaris;

break;

case CIMOSType_CIMOS_FreeBSD: // 42 - FreeBSD

osTypeVBox = SchemaDefs_OSTypeId_FreeBSD;

break;

case CIMOSType_CIMOS_NetBSD: // 43 - NetBSD

osTypeVBox = SchemaDefs_OSTypeId_NetBSD;

break;

case CIMOSType_CIMOS_QNX: // 48 - QNX

osTypeVBox = SchemaDefs_OSTypeId_QNX;

break;

case CIMOSType_CIMOS_Windows2000: // 58 - Windows 2000

osTypeVBox = SchemaDefs_OSTypeId_Windows2000;

break;

case CIMOSType_CIMOS_WindowsMe: // 63 - Windows (R) Me

osTypeVBox = SchemaDefs_OSTypeId_WindowsMe;

break;

case CIMOSType_CIMOS_OpenBSD: // 65 - OpenBSD

osTypeVBox = SchemaDefs_OSTypeId_OpenBSD;

break;

case CIMOSType_CIMOS_WindowsXP: // 67 - Windows XP

case CIMOSType_CIMOS_WindowsXPEmbedded: // 72 - Windows XP Embedded

case CIMOSType_CIMOS_WindowsEmbeddedforPointofService: // 75 - Windows Embedded for Point of Service

osTypeVBox = SchemaDefs_OSTypeId_WindowsXP;

break;

case CIMOSType_CIMOS_MicrosoftWindowsServer2003: // 69 - Microsoft Windows Server 2003

osTypeVBox = SchemaDefs_OSTypeId_Windows2003;

break;

case CIMOSType_CIMOS_MicrosoftWindowsServer2003_64: // 70 - Microsoft Windows Server 2003 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_Windows2003_64;

break;

case CIMOSType_CIMOS_WindowsXP_64: // 71 - Windows XP 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_WindowsXP_64;

break;

case CIMOSType_CIMOS_WindowsVista: // 73 - Windows Vista

osTypeVBox = SchemaDefs_OSTypeId_WindowsVista;

break;

case CIMOSType_CIMOS_WindowsVista_64: // 74 - Windows Vista 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_WindowsVista_64;

break;

case CIMOSType_CIMOS_MicrosoftWindowsServer2008: // 76 - Microsoft Windows Server 2008

osTypeVBox = SchemaDefs_OSTypeId_Windows2008;

break;

case CIMOSType_CIMOS_MicrosoftWindowsServer2008_64: // 77 - Microsoft Windows Server 2008 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_Windows2008_64;

break;

case CIMOSType_CIMOS_FreeBSD_64: // 78 - FreeBSD 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_FreeBSD_64;

break;

case CIMOSType_CIMOS_RedHatEnterpriseLinux: // 79 - RedHat Enterprise Linux

osTypeVBox = SchemaDefs_OSTypeId_RedHat;

break;

case CIMOSType_CIMOS_RedHatEnterpriseLinux_64: // 80 - RedHat Enterprise Linux 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_RedHat_64;

break;

case CIMOSType_CIMOS_Solaris_64: // 81 - Solaris 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_Solaris_64;

break;

case CIMOSType_CIMOS_SUSE: // 82 - SUSE

case CIMOSType_CIMOS_SLES: // 84 - SLES

case CIMOSType_CIMOS_NovellLinuxDesktop: // 87 - Novell Linux Desktop

osTypeVBox = SchemaDefs_OSTypeId_OpenSUSE;

break;

case CIMOSType_CIMOS_SUSE_64: // 83 - SUSE 64-Bit

case CIMOSType_CIMOS_SLES_64: // 85 - SLES 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_OpenSUSE_64;

break;

case CIMOSType_CIMOS_LINUX: // 36 - LINUX

case CIMOSType_CIMOS_SunJavaDesktopSystem: // 88 - Sun Java Desktop System

case CIMOSType_CIMOS_TurboLinux: // 91 - TurboLinux

osTypeVBox = SchemaDefs_OSTypeId_Linux;

break;

// case CIMOSType_CIMOS_TurboLinux_64: // 92 - TurboLinux 64-Bit

// case CIMOSType_CIMOS_Linux_64: // 101 - Linux 64-Bit

// osTypeVBox = VBOXOSTYPE_Linux_x64;

// break;

case CIMOSType_CIMOS_Mandriva: // 89 - Mandriva

osTypeVBox = SchemaDefs_OSTypeId_Mandriva;

break;

case CIMOSType_CIMOS_Mandriva_64: // 90 - Mandriva 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_Mandriva_64;

break;

case CIMOSType_CIMOS_Ubuntu: // 93 - Ubuntu

osTypeVBox = SchemaDefs_OSTypeId_Ubuntu;

break;

case CIMOSType_CIMOS_Ubuntu_64: // 94 - Ubuntu 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_Ubuntu_64;

break;

case CIMOSType_CIMOS_Debian: // 95 - Debian

osTypeVBox = SchemaDefs_OSTypeId_Debian;

break;

case CIMOSType_CIMOS_Debian_64: // 96 - Debian 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_Debian_64;

break;

case CIMOSType_CIMOS_Linux_2_4_x: // 97 - Linux 2.4.x

osTypeVBox = SchemaDefs_OSTypeId_Linux24;

break;

case CIMOSType_CIMOS_Linux_2_4_x_64: // 98 - Linux 2.4.x 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_Linux24_64;

break;

case CIMOSType_CIMOS_Linux_2_6_x: // 99 - Linux 2.6.x

osTypeVBox = SchemaDefs_OSTypeId_Linux26;

break;

case CIMOSType_CIMOS_Linux_2_6_x_64: // 100 - Linux 2.6.x 64-Bit

osTypeVBox = SchemaDefs_OSTypeId_Linux26_64;

break;

default:

{

/* If we are here we have no clue what OS this should be. Set

osTypeVBox = SchemaDefs_OSTypeId_Other;

}

}

}

STDMETHODIMP Appliance::Read(IN_BSTR path)

{

HRESULT rc = S_OK;

if (!path)

return E_POINTER;

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoWriteLock alock(this);

m->bstrPath = path;

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

Utf8Str utf8Path(path);

const char *pcszLastDot = strrchr(utf8Path, '.');

if ( (!pcszLastDot)

|| ( strcmp(pcszLastDot, ".ovf")

&& strcmp(pcszLastDot, ".OVF")

)

)

return setError(VBOX_E_FILE_ERROR,

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

try

{

xml::XmlFileParser parser;

xml::Document doc;

parser.read(utf8Path.raw(),

doc);

const xml::Node *pRootElem = doc.getRootElement();

if (strcmp(pRootElem->getName(), "Envelope"))

return setError(VBOX_E_FILE_ERROR,

tr("Root element in OVF file must be \"Envelope\"."));

// OVF has the following rough layout:

/*

// get all "File" child elements of "References" section so we can look up files easily;

// first find the "References" sections so we can look up files

xml::NodesList listFileElements; // receives all /Envelope/References/File nodes

const xml::Node *pReferencesElem;

if ((pReferencesElem = pRootElem->findChildElement("References")))

pReferencesElem->getChildElements(listFileElements, "File");

// now go though the sections

if (!(SUCCEEDED(rc = LoopThruSections(utf8Path.raw(), pReferencesElem, pRootElem))))

return rc;

}

catch(xml::Error &x)

{

return setError(VBOX_E_FILE_ERROR,

x.what());

}

return S_OK;

}

STDMETHODIMP Appliance::Interpret()

{

// @todo:

// - don't use COM methods but the methods directly (faster, but needs appropriate locking of that objects itself (s. HardDisk2))

// - Appropriate handle errors like not supported file formats

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoWriteLock(this);

HRESULT rc = S_OK;

/* Clear any previous virtual system descriptions */

// @todo: have the entries deleted also?

m->virtualSystemDescriptions.clear();

/* We need the default path for storing disk images */

ComPtr<ISystemProperties> systemProps;

rc = mVirtualBox->COMGETTER(SystemProperties)(systemProps.asOutParam());

CheckComRCReturnRC(rc);

Bstr bstrDefaultHardDiskLocation;

rc = systemProps->COMGETTER(DefaultHardDiskFolder)(bstrDefaultHardDiskLocation.asOutParam());

CheckComRCReturnRC(rc);

/* Try/catch so we can clean up on error */

try

{

list<VirtualSystem>::const_iterator it;

/* Iterate through all appliances */

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

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

++it)

{

const VirtualSystem &vsysThis = *it;

ComObjPtr<VirtualSystemDescription> pNewDesc;

rc = pNewDesc.createObject();

CheckComRCThrowRC(rc);

rc = pNewDesc->init();

CheckComRCThrowRC(rc);

/* Guest OS type */

Utf8Str strOsTypeVBox,

strCIMOSType = toString<ULONG>(vsysThis.cimos);

convertCIMOSType2VBoxOSType(strOsTypeVBox, vsysThis.cimos);

pNewDesc->addEntry(VirtualSystemDescriptionType_OS,

"",

strCIMOSType,

strOsTypeVBox);

/* VM name */

/* If the there isn't any name specified create a default one out of

Utf8Str nameVBox = vsysThis.strName;

if (nameVBox == "")

nameVBox = strOsTypeVBox;

searchUniqueVMName(nameVBox);

pNewDesc->addEntry(VirtualSystemDescriptionType_Name,

"",

vsysThis.strName,

nameVBox);

/* Now that we know the OS type, get our internal defaults based on that. */

ComPtr<IGuestOSType> pGuestOSType;

rc = mVirtualBox->GetGuestOSType(Bstr(strOsTypeVBox), pGuestOSType.asOutParam());

CheckComRCThrowRC(rc);

/* CPU count */

ULONG cpuCountVBox = vsysThis.cCPUs;

/* Check for the constrains */

if (cpuCountVBox > 1) //SchemaDefs::MaxCPUCount)

{

pNewDesc->addWarning(tr("The virtual system claims support for %u CPU's, but VirtualBox has support for max %u CPU's only."),

cpuCountVBox, 1); //SchemaDefs::MaxCPUCount);

cpuCountVBox = 1; //SchemaDefs::MaxCPUCount;

}

if (vsysThis.cCPUs == 0)

cpuCountVBox = 1;

pNewDesc->addEntry(VirtualSystemDescriptionType_CPU,

"",

toString<ULONG>(vsysThis.cCPUs),

toString<ULONG>(cpuCountVBox));

/* RAM */

uint64_t ullMemSizeVBox = vsysThis.ullMemorySize / _1M;

/* Check for the constrains */

if (ullMemSizeVBox != 0 &&

(ullMemSizeVBox < static_cast<uint64_t>(SchemaDefs::MinGuestRAM) ||

ullMemSizeVBox > static_cast<uint64_t>(SchemaDefs::MaxGuestRAM)))

{

pNewDesc->addWarning(tr("The virtual system claims support for %llu MB RAM size, but VirtualBox has support for min %u & max %u MB RAM size only."),

ullMemSizeVBox, SchemaDefs::MinGuestRAM, SchemaDefs::MaxGuestRAM);

ullMemSizeVBox = RT_MIN(RT_MAX(ullMemSizeVBox, static_cast<uint64_t>(SchemaDefs::MinGuestRAM)), static_cast<uint64_t>(SchemaDefs::MaxGuestRAM));

}

if (vsysThis.ullMemorySize == 0)

{

/* If the RAM of the OVF is zero, use our predefined values */

ULONG memSizeVBox2;

rc = pGuestOSType->COMGETTER(RecommendedRAM)(&memSizeVBox2);

CheckComRCThrowRC(rc);

/* VBox stores that in MByte */

ullMemSizeVBox = (uint64_t)memSizeVBox2;

}

pNewDesc->addEntry(VirtualSystemDescriptionType_Memory,

"",

toString<uint64_t>(vsysThis.ullMemorySize),

toString<uint64_t>(ullMemSizeVBox));

/* Audio */

if (!vsysThis.strSoundCardType.isNull())

/* Currently we set the AC97 always.

pNewDesc->addEntry(VirtualSystemDescriptionType_SoundCard,

"",

vsysThis.strSoundCardType,

toString<ULONG>(AudioControllerType_AC97));

/* USB Controller */

if (vsysThis.fHasUsbController)

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

/* Network Controller */

// @todo: there is no hardware specification in the OVF file; supposedly the

// hardware will then be determined by the VirtualSystemType element (e.g. "vmx-07")

if (vsysThis.llNetworkNames.size() > 0)

{

/* Check for the constrains */

if (vsysThis.llNetworkNames.size() > SchemaDefs::NetworkAdapterCount)

{

pNewDesc->addWarning(tr("The virtual system claims support for %u network adapters, but VirtualBox has support for max %u network adapter only."),

vsysThis.llNetworkNames.size(), SchemaDefs::NetworkAdapterCount);

}

/* Get the default network adapter type for the selected guest OS */

NetworkAdapterType_T nwAdapterVBox = NetworkAdapterType_Am79C970A;

rc = pGuestOSType->COMGETTER(AdapterType)(&nwAdapterVBox);

CheckComRCThrowRC(rc);

list<Utf8Str>::const_iterator nwIt;

/* Iterate through all abstract networks. We support 8 network

size_t a = 0;

for (nwIt = vsysThis.llNetworkNames.begin();

nwIt != vsysThis.llNetworkNames.end() && a < SchemaDefs::NetworkAdapterCount;

++nwIt, ++a)

{

Utf8Str nwController = *nwIt; // @todo: not used yet

pNewDesc->addEntry(VirtualSystemDescriptionType_NetworkAdapter, "", "", toString<ULONG>(nwAdapterVBox));

}

}

/* Floppy Drive */

if (vsysThis.fHasFloppyDrive)

pNewDesc->addEntry(VirtualSystemDescriptionType_Floppy, "", "", "");

/* CD Drive */

/* @todo: I can't disable the CDROM. So nothing to do for now */

/*

/* Hard disk Controller */

uint16_t cIDEused = 0;

uint16_t cSATAused = 0;

uint16_t cSCSIused = 0;

ControllersMap::const_iterator hdcIt;

/* Iterate through all hard disk controllers */

for (hdcIt = vsysThis.mapControllers.begin();

hdcIt != vsysThis.mapControllers.end();

++hdcIt)

{

const HardDiskController &hdc = hdcIt->second;

Utf8Str strControllerID = toString<uint32_t>(hdc.idController);

switch (hdc.system)

{

case HardDiskController::IDE:

{

/* Check for the constrains */

/* @todo: I'm very confused! Are these bits *one* controller or

if (cIDEused < 4)

{

// @todo: figure out the IDE types

/* Use PIIX4 as default */

// IDEControllerType_T hdcController = IDEControllerType_PIIX4;

Utf8Str strType = "PIIX4";

if (!RTStrICmp(hdc.strControllerType.c_str(), "PIIX3"))

strType = "PIIX3";

// else // if (!RTStrICmp(hdc.strControllerType.c_str(), "PIIX4"))

// hdcController = IDEControllerType_PIIX4;

pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,

strControllerID,

hdc.strControllerType,

strType);

}

else

{

/* Warn only once */

if (cIDEused == 1)

pNewDesc->addWarning(tr("The virtual system claims support for more than one IDE controller, but VirtualBox has support for only one."));

}

++cIDEused;

break;

}

#ifdef VBOX_WITH_AHCI

case HardDiskController::SATA:

{

/* Check for the constrains */

if (cSATAused < 1)

{

// @todo: figure out the SATA types

/* We only support a plain AHCI controller, so use them always */

pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,

strControllerID,

hdc.strControllerType,

"AHCI");

}

else

{

/* Warn only once */

if (cSATAused == 1)

pNewDesc->addWarning(tr("The virtual system claims support for more than one SATA controller, but VirtualBox has support for only one."));

}

++cSATAused;

break;

}

#endif /* VBOX_WITH_AHCI */

case HardDiskController::SCSI:

{

/* Check for the constrains */

if (cSCSIused < 1)

{

// @todo: figure out the SCSI types

Utf8Str hdcController = "LsiLogic";

/* if (!RTStrICmp(hdc.strControllerType.c_str(), "LsiLogic"))

if (!RTStrICmp(hdc.strControllerType.c_str(), "BusLogic"))

hdcController = "BusLogic";

pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,

strControllerID,

hdc.strControllerType,

hdcController);

}

else

{

/* Warn only once */

if (cSCSIused == 1)

pNewDesc->addWarning(tr("The virtual system claims support for more than one SCSI controller, but VirtualBox has support for only one."));

}

++cSCSIused;

break;

}

default:

{

/* @todo: should we stop? */

}

}

}

/* Hard disks */

if (vsysThis.mapVirtualDisks.size() > 0)

{

VirtualDisksMap::const_iterator itVD;

/* Iterate through all hard disks ()*/

for (itVD = vsysThis.mapVirtualDisks.begin();

itVD != vsysThis.mapVirtualDisks.end();

++itVD)

{

const VirtualDisk &hd = itVD->second;

/* Get the associated disk image */

const DiskImage &di = m->mapDisks[hd.strDiskId];

// @todo:

// - figure out all possible vmdk formats we also support

// - figure out if there is a url specifier for vhd already

// - we need a url specifier for the vdi format

if ( (!RTStrICmp(di.strFormat.c_str(), "http://www.vmware.com/specifications/vmdk.html#sparse"))

|| (!RTStrICmp(di.strFormat.c_str(), "http://www.vmware.com/specifications/vmdk.html#compressed"))

)

{

/* If the href is empty use the VM name as filename */

Utf8Str strFilename = di.strHref.c_str();

if (di.strHref.c_str()[0] == 0)

strFilename = Utf8StrFmt("%s.vmdk", nameVBox.c_str());

/* Construct a unique target path */

Utf8StrFmt strPath("%ls%c%s",

bstrDefaultHardDiskLocation.raw(),

RTPATH_DELIMITER,

strFilename.c_str());

searchUniqueDiskImageFilePath(strPath);

/* find the description for the hard disk controller

const VirtualSystemDescriptionEntry *pController;

if (!(pController = pNewDesc->findControllerFromID(hd.idController)))

throw setError(E_FAIL,

tr("Internal inconsistency looking up hard disk controller."));

/* controller to attach to @todo bus? */

Utf8StrFmt strExtraConfig("controller=%RI16",

pController->ulIndex);

pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskImage,

hd.strDiskId,

di.strHref,

strPath,

strExtraConfig);

}

else

{

/* @todo: should we stop here? */

pNewDesc->addWarning(tr("The virtual system claims support for the following virtual disk image format which VirtualBox not support: %s"),

di.strFormat.c_str());

}

}

}

m->virtualSystemDescriptions.push_back(pNewDesc);

}

}

catch (HRESULT aRC)

{

/* On error we clear the list & return */

m->virtualSystemDescriptions.clear();

rc = aRC;

}

return rc;

}

STDMETHODIMP Appliance::ImportMachines(IProgress **aProgress)

{

CheckComArgOutPointerValid(aProgress);

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoReadLock(this);

HRESULT rc = S_OK;

ComObjPtr<Progress> progress;

try

{

/* Figure out how many sub operation the import will need */

/* One for the appliance */

int opCount = 1;

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

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

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

++it)

{

/* One for every Virtual System */

++opCount;

ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);

/* One for every hard disk of the Virtual System */

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

opCount += avsdeHDs.size();

}

Bstr progressDesc = BstrFmt(tr("Import appliance '%ls'"),

m->bstrPath.raw());

/* Create the progress object */

progress.createObject();

rc = progress->init(mVirtualBox, static_cast<IAppliance *>(this),

progressDesc,

FALSE /* aCancelable */,

opCount,

progressDesc);

CheckComRCThrowRC(rc);

/* Initialize our worker task */

std::auto_ptr<Task> task(new Task(this, progress));

//AssertComRCThrowRC (task->autoCaller.rc());

rc = task->startThread();

CheckComRCThrowRC(rc);

task.release();

}

catch (HRESULT aRC)

{

rc = aRC;

}

if (SUCCEEDED(rc))

/* Return progress to the caller */

progress.queryInterfaceTo(aProgress);

return rc;

}

HRESULT Appliance::searchUniqueVMName(Utf8Str& aName) const

{

IMachine *machine = NULL;

char *tmpName = RTStrDup(aName.c_str());

int i = 1;

/* @todo: Maybe too cost-intensive; try to find a lighter way */

while (mVirtualBox->FindMachine(Bstr(tmpName), &machine) != VBOX_E_OBJECT_NOT_FOUND)

{

RTStrFree(tmpName);

RTStrAPrintf(&tmpName, "%s_%d", aName.c_str(), i);

++i;

}

aName = tmpName;

RTStrFree(tmpName);

return S_OK;

}

HRESULT Appliance::searchUniqueDiskImageFilePath(Utf8Str& aName) const

{

IHardDisk2 *harddisk = NULL;

char *tmpName = RTStrDup(aName.c_str());

int i = 1;

/* Check if the file exists or if a file with this path is registered

/* @todo: Maybe too cost-intensive; try to find a lighter way */

while (RTPathExists(tmpName) ||

mVirtualBox->FindHardDisk2(Bstr(tmpName), &harddisk) != VBOX_E_OBJECT_NOT_FOUND)

{

RTStrFree(tmpName);

char *tmpDir = RTStrDup(aName.c_str());

RTPathStripFilename(tmpDir);;

char *tmpFile = RTStrDup(RTPathFilename(aName.c_str()));

RTPathStripExt(tmpFile);

const char *tmpExt = RTPathExt(aName.c_str());

RTStrAPrintf(&tmpName, "%s%c%s_%d%s", tmpDir, RTPATH_DELIMITER, tmpFile, i, tmpExt);

RTStrFree(tmpFile);

RTStrFree(tmpDir);

++i;

}

aName = tmpName;

RTStrFree(tmpName);

return S_OK;

}

DECLCALLBACK(int) Appliance::taskThread(RTTHREAD aThread, void *pvUser)

{

std::auto_ptr <Task> task(static_cast<Task *>(pvUser));

AssertReturn(task.get(), VERR_GENERAL_FAILURE);

Appliance *app = task->that;

/// @todo ugly hack, fix ComAssert... (same as in HardDisk2::taskThread)

#define setError app->setError

AutoCaller autoCaller(app);

CheckComRCReturnRC(autoCaller.rc());

AutoWriteLock appLock(app);

HRESULT rc = S_OK;

list<VirtualSystem>::const_iterator it;

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

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

size_t i = 0;

for (it = app->m->llVirtualSystems.begin(),

it1 = app->m->virtualSystemDescriptions.begin();

it != app->m->llVirtualSystems.end();

++it, ++it1, ++i)

{

const VirtualSystem &vsysThis = *it;

ComObjPtr<VirtualSystemDescription> vsdescThis = (*it1);

/* Catch possible errors */

try

{

if (!task->progress.isNull())

{

rc = task->progress->advanceOperation (BstrFmt(tr("Importing Virtual System %d"), i + 1));

CheckComRCThrowRC(rc);

}

/* How many sub notifications are necessary? */

const float opCountMax = 100.0/5;

uint32_t opCount = 0;

/* Guest OS type */

std::list<VirtualSystemDescriptionEntry*> vsdeOS = vsdescThis->findByType(VirtualSystemDescriptionType_OS);

ComAssertMsgThrow(vsdeOS.size() == 1, ("Guest OS Type missing"), E_FAIL);

const Utf8Str &strOsTypeVBox = vsdeOS.front()->strConfig;

/* Now that we know the base system get our internal defaults based on that. */

ComPtr<IGuestOSType> osType;

rc = app->mVirtualBox->GetGuestOSType(Bstr(strOsTypeVBox), osType.asOutParam());

CheckComRCThrowRC(rc);

/* Create the machine */

/* First get the name */

std::list<VirtualSystemDescriptionEntry*> vsdeName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);

ComAssertMsgThrow(vsdeName.size() == 1, ("Guest OS name missing"), E_FAIL);

const Utf8Str &strNameVBox = vsdeName.front()->strConfig;

ComPtr<IMachine> pNewMachine;

rc = app->mVirtualBox->CreateMachine(Bstr(strNameVBox), Bstr(strOsTypeVBox),

Bstr(), Guid(),

pNewMachine.asOutParam());

CheckComRCThrowRC(rc);

if (!task->progress.isNull())

{

rc = task->progress->notifyProgress((uint32_t)(opCountMax * opCount++));

CheckComRCThrowRC(rc);

}

/* CPU count (ignored for now) */

// EntriesList vsdeCPU = vsd->findByType (VirtualSystemDescriptionType_CPU);

/* RAM */

std::list<VirtualSystemDescriptionEntry*> vsdeRAM = vsdescThis->findByType(VirtualSystemDescriptionType_Memory);

ComAssertMsgThrow(vsdeRAM.size() == 1, ("RAM size missing"), E_FAIL);

const Utf8Str &memoryVBox = vsdeRAM.front()->strConfig;

ULONG tt = (ULONG)RTStrToUInt64(memoryVBox.c_str());

rc = pNewMachine->COMSETTER(MemorySize)(tt);

CheckComRCThrowRC(rc);

/* VRAM */

/* Get the recommended VRAM for this guest OS type */

ULONG vramVBox;

rc = osType->COMGETTER(RecommendedVRAM)(&vramVBox);

CheckComRCThrowRC(rc);

/* Set the VRAM */

rc = pNewMachine->COMSETTER(VRAMSize)(vramVBox);

CheckComRCThrowRC(rc);

if (!task->progress.isNull())

{

rc = task->progress->notifyProgress((uint32_t)(opCountMax * opCount++));

CheckComRCThrowRC(rc);

}

/* Audio Adapter */

std::list<VirtualSystemDescriptionEntry*> vsdeAudioAdapter = vsdescThis->findByType(VirtualSystemDescriptionType_SoundCard);

/* @todo: we support one audio adapter only */

if (vsdeAudioAdapter.size() > 0)

{

const Utf8Str& audioAdapterVBox = vsdeAudioAdapter.front()->strConfig;

if (RTStrICmp(audioAdapterVBox, "null") != 0)

{

uint32_t audio = RTStrToUInt32(audioAdapterVBox.c_str());

ComPtr<IAudioAdapter> audioAdapter;

rc = pNewMachine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam());

CheckComRCThrowRC(rc);

rc = audioAdapter->COMSETTER(Enabled)(true);

CheckComRCThrowRC(rc);

rc = audioAdapter->COMSETTER(AudioController)(static_cast<AudioControllerType_T>(audio));

CheckComRCThrowRC(rc);

}

}

/* USB Controller */

std::list<VirtualSystemDescriptionEntry*> vsdeUSBController = vsdescThis->findByType(VirtualSystemDescriptionType_USBController);

// USB support is enabled if there's at least one such entry; to disable USB support,

// the type of the USB item would have been changed to "ignore"

bool fUSBEnabled = vsdeUSBController.size() > 0;

ComPtr<IUSBController> usbController;

rc = pNewMachine->COMGETTER(USBController)(usbController.asOutParam());

CheckComRCThrowRC(rc);

rc = usbController->COMSETTER(Enabled)(fUSBEnabled);

CheckComRCThrowRC(rc);

if (!task->progress.isNull())

{

rc = task->progress->notifyProgress((uint32_t)(opCountMax * opCount++));

CheckComRCThrowRC(rc);

}

/* Change the network adapters */

std::list<VirtualSystemDescriptionEntry*> vsdeNW = vsdescThis->findByType(VirtualSystemDescriptionType_NetworkAdapter);

if (vsdeNW.size() == 0)

{

/* No network adapters, so we have to disable our default one */

ComPtr<INetworkAdapter> nwVBox;

rc = pNewMachine->GetNetworkAdapter(0, nwVBox.asOutParam());

CheckComRCThrowRC(rc);

rc = nwVBox->COMSETTER(Enabled)(false);

CheckComRCThrowRC(rc);

}

else

{

list<VirtualSystemDescriptionEntry*>::const_iterator nwIt;

/* Iterate through all network cards. We support 8 network adapters

size_t a = 0;

for (nwIt = vsdeNW.begin();

(nwIt != vsdeNW.end() && a < SchemaDefs::NetworkAdapterCount);

++nwIt, ++a)

{

const Utf8Str &nwTypeVBox = (*nwIt)->strConfig;

uint32_t tt1 = RTStrToUInt32(nwTypeVBox.c_str());

ComPtr<INetworkAdapter> nwVBox;

rc = pNewMachine->GetNetworkAdapter((ULONG)a, nwVBox.asOutParam());

CheckComRCThrowRC(rc);

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

/* NAT is set as default */

rc = nwVBox->COMSETTER(Enabled)(true);

CheckComRCThrowRC(rc);

rc = nwVBox->COMSETTER(AdapterType)(static_cast<NetworkAdapterType_T>(tt1));

CheckComRCThrowRC(rc);

}

}

/* Floppy drive */

std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsdescThis->findByType(VirtualSystemDescriptionType_Floppy);

// Floppy support is enabled if there's at least one such entry; to disable floppy support,

// the type of the floppy item would have been changed to "ignore"

bool fFloppyEnabled = vsdeFloppy.size() > 0;

ComPtr<IFloppyDrive> floppyDrive;

rc = pNewMachine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam());

CheckComRCThrowRC(rc);

rc = floppyDrive->COMSETTER(Enabled)(fFloppyEnabled);

CheckComRCThrowRC(rc);

if (!task->progress.isNull())

{

rc = task->progress->notifyProgress((uint32_t)(opCountMax * opCount++));

CheckComRCThrowRC(rc);

}

/* CDROM drive */

/* @todo: I can't disable the CDROM. So nothing to do for now */

// std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsd->findByType(VirtualSystemDescriptionType_CDROM);

/* Hard disk controller IDE */

std::list<VirtualSystemDescriptionEntry*> vsdeHDCIDE = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerIDE);

/* @todo: we support one IDE controller only */

if (vsdeHDCIDE.size() > 0)

{

/* Set the appropriate IDE controller in the virtual BIOS of the VM */

ComPtr<IBIOSSettings> biosSettings;

rc = pNewMachine->COMGETTER(BIOSSettings)(biosSettings.asOutParam());

CheckComRCThrowRC(rc);

const char *pcszIDEType = vsdeHDCIDE.front()->strConfig.c_str();

if (!strcmp(pcszIDEType, "PIIX3"))

rc = biosSettings->COMSETTER(IDEControllerType)(IDEControllerType_PIIX3);

else if (!strcmp(pcszIDEType, "PIIX4"))

rc = biosSettings->COMSETTER(IDEControllerType)(IDEControllerType_PIIX4);

else

throw setError(VBOX_E_FILE_ERROR,

tr("Invalid IDE controller type \"%s\""),

pcszIDEType);

CheckComRCThrowRC(rc);

}

#ifdef VBOX_WITH_AHCI

/* Hard disk controller SATA */

std::list<VirtualSystemDescriptionEntry*> vsdeHDCSATA = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSATA);

/* @todo: we support one SATA controller only */

if (vsdeHDCSATA.size() > 0)

{

const Utf8Str &hdcVBox = vsdeHDCIDE.front()->strConfig;

if (hdcVBox == "AHCI")

{

/* For now we have just to enable the AHCI controller. */

ComPtr<ISATAController> hdcSATAVBox;

rc = pNewMachine->COMGETTER(SATAController)(hdcSATAVBox.asOutParam());

CheckComRCThrowRC(rc);

rc = hdcSATAVBox->COMSETTER(Enabled)(true);

CheckComRCThrowRC(rc);

}

else

{

throw setError(VBOX_E_FILE_ERROR,

tr("Invalid SATA controller type \"%s\""),

hdcVBox.c_str());

}

}

#endif /* VBOX_WITH_AHCI */

/* Hard disk controller SCSI */

std::list<VirtualSystemDescriptionEntry*> vsdeHDCSCSI = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSCSI);

/* @todo: do we support more than one SCSI controller? */

if (vsdeHDCSCSI.size() > 0)

{

/* @todo: revisit when Main support for SCSI is ready */

}

/* Now its time to register the machine before we add any hard disks */

rc = app->mVirtualBox->RegisterMachine(pNewMachine);

CheckComRCThrowRC(rc);

if (!task->progress.isNull())

{

rc = task->progress->notifyProgress((uint32_t)(opCountMax * opCount++));

CheckComRCThrowRC(rc);

}

/* Create the hard disks & connect them to the appropriate controllers. */

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

if (avsdeHDs.size() > 0)

{

Guid newMachineId;

rc = pNewMachine->COMGETTER(Id)(newMachineId.asOutParam());

CheckComRCThrowRC(rc);

/* If in the next block an error occur we have to deregister

ComPtr<ISession> session;

ComPtr<IHardDisk2> srcHdVBox;

try

{

/* In order to attach hard disks we need to open a session

rc = session.createInprocObject(CLSID_Session);

CheckComRCThrowRC(rc);

rc = app->mVirtualBox->OpenSession(session, newMachineId);

CheckComRCThrowRC(rc);

int result;

/* The disk image has to be on the same place as the OVF file. So

Utf8Str strSrcDir = stripFilename(Utf8Str(app->m->bstrPath).raw());

/* Iterate over all given disk images */

list<VirtualSystemDescriptionEntry*>::const_iterator itHD;

for (itHD = avsdeHDs.begin();

itHD != avsdeHDs.end();

++itHD)

{

VirtualSystemDescriptionEntry *vsdeHD = *itHD;

const char *pcszDstFilePath = vsdeHD->strConfig.c_str();

/* Check if the destination file exists already or the

if ( !(*pcszDstFilePath)

|| RTPathExists(pcszDstFilePath)

)

/* This isn't allowed */

throw setError(VBOX_E_FILE_ERROR,

tr("Destination file '%s' exists",

pcszDstFilePath));

/* Find the disk from the OVF's disk list */

DiskImagesMap::const_iterator itDiskImage = app->m->mapDisks.find(vsdeHD->strRef);

/* vsdeHD->strRef contains the disk identifier (e.g. "vmdisk1"), which should exist

VirtualDisksMap::const_iterator itVirtualDisk = vsysThis.mapVirtualDisks.find(vsdeHD->strRef);

if ( itDiskImage == app->m->mapDisks.end()

|| itVirtualDisk == vsysThis.mapVirtualDisks.end()

)

throw setError(E_FAIL,

tr("Internal inconsistency looking up disk images."));

const DiskImage &di = itDiskImage->second;

const VirtualDisk &vd = itVirtualDisk->second;

/* Make sure all target directories exists */

rc = VirtualBox::ensureFilePathExists(pcszDstFilePath);

CheckComRCThrowRC(rc);

ComPtr<IHardDisk2> dstHdVBox;

/* If strHref is empty we have to create a new file */

if (di.strHref.c_str()[0] == 0)

{

/* Which format to use? */

Bstr srcFormat = L"VDI";

if ( (!RTStrICmp(di.strFormat.c_str(), "http://www.vmware.com/specifications/vmdk.html#sparse"))

|| (!RTStrICmp(di.strFormat.c_str(), "http://www.vmware.com/specifications/vmdk.html#compressed")))

srcFormat = L"VMDK";

/* Create an empty hard disk */

rc = app->mVirtualBox->CreateHardDisk2(srcFormat, Bstr(pcszDstFilePath), dstHdVBox.asOutParam());

CheckComRCThrowRC(rc);

/* Create a dynamic growing disk image with the given capacity */

ComPtr<IProgress> progress;

dstHdVBox->CreateDynamicStorage(di.iCapacity / _1M, progress.asOutParam());

CheckComRCThrowRC(rc);

/* Advance to the next operation */

if (!task->progress.isNull())

{

rc = task->progress->advanceOperation (BstrFmt(tr("Creating virtual disk image '%s'"), pcszDstFilePath));

CheckComRCThrowRC(rc);

}

/* Manually check the progress to inform the user */

BOOL fCompleted;

LONG currentPercent;

while (SUCCEEDED(progress->COMGETTER(Completed(&fCompleted))))

{

rc = progress->COMGETTER(Percent(&currentPercent));

CheckComRCThrowRC(rc);

if (!task->progress.isNull())

{

rc = task->progress->notifyProgress(currentPercent);

CheckComRCThrowRC(rc);

}

if (fCompleted)

break;

/* Make sure the loop is not too tight */

rc = progress->WaitForCompletion(100);

CheckComRCThrowRC(rc);

}

/* Check the real return code of the asynchrony operation */

HRESULT vrc;

rc = progress->COMGETTER(ResultCode)(&vrc);

CheckComRCThrowRC(rc);

CheckComRCThrowRC(vrc);

}

else

{

/* Construct the source file path */

Utf8StrFmt strSrcFilePath("%s%c%s", strSrcDir.c_str(), RTPATH_DELIMITER, di.strHref.c_str());

/* Check if the source file exists */

if (!RTPathExists(strSrcFilePath.c_str()))

/* This isn't allowed */

throw setError(VBOX_E_FILE_ERROR,

tr("Source virtual disk image file '%s' doesn't exists",

strSrcFilePath.c_str()));

/* Clone the disk image (this is necessary cause the id has

/* First open the existing disk image */

rc = app->mVirtualBox->OpenHardDisk2(Bstr(strSrcFilePath), srcHdVBox.asOutParam());

CheckComRCThrowRC(rc);

/* We need the format description of the source disk image */

Bstr srcFormat;

rc = srcHdVBox->COMGETTER(Format)(srcFormat.asOutParam());

CheckComRCThrowRC(rc);

/* Create a new hard disk interface for the destination disk image */

rc = app->mVirtualBox->CreateHardDisk2(srcFormat, Bstr(pcszDstFilePath), dstHdVBox.asOutParam());

CheckComRCThrowRC(rc);

/* Clone the source disk image */

ComPtr<IProgress> progress;

rc = srcHdVBox->CloneTo(dstHdVBox, progress.asOutParam());

CheckComRCThrowRC(rc);

/* Advance to the next operation */

if (!task->progress.isNull())

{

rc = task->progress->advanceOperation (BstrFmt(tr("Importing virtual disk image '%s'"), strSrcFilePath.c_str()));

CheckComRCThrowRC(rc);

}

/* Manually check the progress to inform the user */

BOOL fCompleted;

LONG currentPercent;

while (SUCCEEDED(progress->COMGETTER(Completed(&fCompleted))))

{

rc = progress->COMGETTER(Percent(&currentPercent));

CheckComRCThrowRC(rc);

if (!task->progress.isNull())

{

rc = task->progress->notifyProgress (currentPercent);

CheckComRCThrowRC(rc);

}

if (fCompleted)

break;

/* Make sure the loop is not too tight */

rc = progress->WaitForCompletion(100);

CheckComRCThrowRC(rc);

}

/* Check the real return code of the asynchrony operation */

HRESULT vrc;

rc = progress->COMGETTER(ResultCode)(&vrc);

CheckComRCThrowRC(rc);

CheckComRCThrowRC(vrc);

/* We *must* close the source disk image in order to deregister it */

rc = srcHdVBox->Close();

CheckComRCThrowRC(rc);

}

/* Now use the new uuid to attach the disk image to our new machine */

ComPtr<IMachine> sMachine;

rc = session->COMGETTER(Machine)(sMachine.asOutParam());

CheckComRCThrowRC(rc);

Guid hdId;

rc = dstHdVBox->COMGETTER(Id)(hdId.asOutParam());;

CheckComRCThrowRC(rc);

/* For now we assume we have one controller of every type only */

HardDiskController hdc = (*vsysThis.mapControllers.find(vd.idController)).second;

StorageBus_T sbt = StorageBus_IDE;

switch (hdc.system)

{

case HardDiskController::IDE: sbt = StorageBus_IDE; break;

case HardDiskController::SATA: sbt = StorageBus_SATA; break;

//case HardDiskController::SCSI: sbt = StorageBus_SCSI; break; // @todo: not available yet

default: break;

}

rc = sMachine->AttachHardDisk2(hdId, sbt, hdc.ulBusNumber, 0);

CheckComRCThrowRC(rc);

rc = sMachine->SaveSettings();

CheckComRCThrowRC(rc);

rc = session->Close();

CheckComRCThrowRC(rc);

}

}

catch(HRESULT aRC)

{

/* @todo: Not sure what to do when there are successfully

if (!srcHdVBox.isNull())

{

/* Close any open src disks */

rc = srcHdVBox->Close();

CheckComRCThrowRC(rc);

}

if (!session.isNull())

{

/* If there is an open session, close them before doing

rc = session->Close();

CheckComRCThrowRC(rc);

}

/* Unregister/Delete the failed machine */

ComPtr<IMachine> failedMachine;

rc = app->mVirtualBox->UnregisterMachine(newMachineId, failedMachine.asOutParam());

CheckComRCThrowRC(rc);

rc = failedMachine->DeleteSettings();

CheckComRCThrowRC(rc);

/* Throw the original error */

throw;

}

}

}

catch(HRESULT aRC)

{

/* @todo: If we are here an error on importing of *one* virtual

rc = aRC;

}

}

task->rc = rc;

if (!task->progress.isNull())

task->progress->notifyComplete (rc);

/// @todo ugly hack, fix ComAssert... (same as in HardDisk2::taskThread)

#undef setError

return VINF_SUCCESS;

}

DEFINE_EMPTY_CTOR_DTOR(VirtualSystemDescription)

struct shutup3 {};

struct VirtualSystemDescription::Data

{

list<VirtualSystemDescriptionEntry> descriptions;

list<Utf8Str> warnings;

};

HRESULT VirtualSystemDescription::init()

{

/* Enclose the state transition NotReady->InInit->Ready */

AutoInitSpan autoInitSpan(this);

AssertReturn(autoInitSpan.isOk(), E_FAIL);

/* Initialize data */

m = new Data();

/* Confirm a successful initialization */

autoInitSpan.setSucceeded();

return S_OK;

}

void VirtualSystemDescription::uninit()

{

delete m;

m = NULL;

}

STDMETHODIMP VirtualSystemDescription::COMGETTER(Count)(ULONG *aCount)

{

if (!aCount)

return E_POINTER;

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoReadLock alock(this);

*aCount = (ULONG)m->descriptions.size();

return S_OK;

}

STDMETHODIMP VirtualSystemDescription::GetDescription(ComSafeArrayOut(VirtualSystemDescriptionType_T, aTypes),

ComSafeArrayOut(BSTR, aRefs),

ComSafeArrayOut(BSTR, aOrigValues),

ComSafeArrayOut(BSTR, aConfigValues),

ComSafeArrayOut(BSTR, aExtraConfigValues))

{

if (ComSafeArrayOutIsNull(aTypes) ||

ComSafeArrayOutIsNull(aRefs) ||

ComSafeArrayOutIsNull(aOrigValues) ||

ComSafeArrayOutIsNull(aConfigValues) ||

ComSafeArrayOutIsNull(aExtraConfigValues))

return E_POINTER;

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoReadLock alock(this);

ULONG c = (ULONG)m->descriptions.size();

com::SafeArray<VirtualSystemDescriptionType_T> sfaTypes(c);

com::SafeArray<BSTR> sfaRefs(c);

com::SafeArray<BSTR> sfaOrigValues(c);

com::SafeArray<BSTR> sfaConfigValues(c);

com::SafeArray<BSTR> sfaExtraConfigValues(c);

list<VirtualSystemDescriptionEntry>::const_iterator it;

size_t i = 0;

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

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

++it, ++i)

{

const VirtualSystemDescriptionEntry &vsde = (*it);

sfaTypes[i] = vsde.type;

Bstr bstr = vsde.strRef;

bstr.cloneTo(&sfaRefs[i]);

bstr = vsde.strOrig;

bstr.cloneTo(&sfaOrigValues[i]);

bstr = vsde.strConfig;

bstr.cloneTo(&sfaConfigValues[i]);

bstr = vsde.strExtraConfig;

bstr.cloneTo(&sfaExtraConfigValues[i]);

}

sfaTypes.detachTo(ComSafeArrayOutArg(aTypes));

sfaRefs.detachTo(ComSafeArrayOutArg(aRefs));

sfaOrigValues.detachTo(ComSafeArrayOutArg(aOrigValues));

sfaConfigValues.detachTo(ComSafeArrayOutArg(aConfigValues));

sfaExtraConfigValues.detachTo(ComSafeArrayOutArg(aExtraConfigValues));

return S_OK;

}

STDMETHODIMP VirtualSystemDescription::SetFinalValues(ComSafeArrayIn(BOOL, aEnabled),

ComSafeArrayIn(IN_BSTR, aFinalValues))

{

CheckComArgSafeArrayNotNull(aFinalValues);

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoWriteLock alock(this);

com::SafeArray <IN_BSTR> values(ComSafeArrayInArg(aFinalValues));

if (values.size() != m->descriptions.size())

return E_INVALIDARG;

list<VirtualSystemDescriptionEntry>::iterator it;

size_t i = 0;

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

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

++it, ++i)

{

VirtualSystemDescriptionEntry& vsde = *it;

if (aEnabled[i])

vsde.strConfig = values[i];

else

vsde.type = VirtualSystemDescriptionType_Ignore;

}

return S_OK;

}

STDMETHODIMP VirtualSystemDescription::GetWarnings(ComSafeArrayOut(BSTR, aWarnings))

{

if (ComSafeArrayOutIsNull(aWarnings))

return E_POINTER;

AutoCaller autoCaller(this);

CheckComRCReturnRC(autoCaller.rc());

AutoReadLock alock(this);

com::SafeArray<BSTR> sfaWarnings(m->warnings.size());

list<Utf8Str>::const_iterator it;

size_t i = 0;

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

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

++it, ++i)

{

Bstr bstr = *it;

bstr.cloneTo(&sfaWarnings[i]);

}

sfaWarnings.detachTo(ComSafeArrayOutArg(aWarnings));

return S_OK;

}

void VirtualSystemDescription::addEntry(VirtualSystemDescriptionType_T aType,

const Utf8Str &strRef,

const Utf8Str &aOrigValue,

const Utf8Str &aAutoValue,

const Utf8Str &strExtraConfig /*= ""*/)

{

VirtualSystemDescriptionEntry vsde;

vsde.ulIndex = m->descriptions.size(); // each entry gets an index so the client side can reference them

vsde.type = aType;

vsde.strRef = strRef;

vsde.strOrig = aOrigValue;

vsde.strConfig = aAutoValue;

vsde.strExtraConfig = strExtraConfig;

m->descriptions.push_back(vsde);

}

void VirtualSystemDescription::addWarning(const char* aWarning, ...)

{

va_list args;

va_start(args, aWarning);

Utf8StrFmtVA str(aWarning, args);

va_end(args);

m->warnings.push_back(str);

}

std::list<VirtualSystemDescriptionEntry*> VirtualSystemDescription::findByType(VirtualSystemDescriptionType_T aType)

{

std::list<VirtualSystemDescriptionEntry*> vsd;

list<VirtualSystemDescriptionEntry>::iterator it;

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

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

++it)

if (it->type == aType)

vsd.push_back(&(*it));

return vsd;

}

const VirtualSystemDescriptionEntry* VirtualSystemDescription::findControllerFromID(uint32_t id)

{

Utf8Str strRef = toString<uint32_t>(id);

list<VirtualSystemDescriptionEntry>::const_iterator it;

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

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

++it)

{

switch (it->type)

{

case VirtualSystemDescriptionType_HardDiskControllerIDE:

case VirtualSystemDescriptionType_HardDiskControllerSATA:

case VirtualSystemDescriptionType_HardDiskControllerSCSI:

if (it->strRef == strRef)

return &(*it);

break;

}

}

return NULL;

}