Changeset 49038 in vbox for trunk/src/VBox

Timestamp:

Oct 10, 2013 6:21:26 PM (11 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

89815

Message:

Main/Appliance: change API of IAppliance::write, allowing easy handling of multiple options, needed for making the DVD image export optional
Frontends/VirtualBox+VBoxManage: corresponding adaptions
doc/SDKRef: mention incompatible API change

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxManageAppliance.cpp (modified) (1 diff)
• Frontends/VirtualBox/src/wizards/exportappliance/UIWizardExportApp.cpp (modified) (2 diffs)
• Main/idl/VirtualBox.xidl (modified) (2 diffs)
• Main/include/ApplianceImpl.h (modified) (2 diffs)
• Main/include/ApplianceImplPrivate.h (modified) (2 diffs)
• Main/src-server/ApplianceImplExport.cpp (modified) (4 diffs)
• Main/src-server/ApplianceImplImport.cpp (modified) (2 diffs)

trunk/src/VBox/Frontends/VBoxManage/VBoxManageAppliance.cpp

@@ -1051 +1051 @@
             break;
 
+        com::SafeArray<ExportOptions_T> options;
+        if (fManifest)
+            options.push_back(ExportOptions_CreateManifest);
+
         ComPtr<IProgress> progress;
         CHECK_ERROR_BREAK(pAppliance, Write(Bstr(strOvfFormat).raw(),
-                                            fManifest,
+                                            ComSafeArrayAsInParam(options),
                                             Bstr(pszAbsFilePath).raw(),
                                             progress.asOutParam()));

trunk/src/VBox/Frontends/VirtualBox/src/wizards/exportappliance/UIWizardExportApp.cpp

@@ -7 +7 @@
 
 /*
- * Copyright (C) 2009-2012 Oracle Corporation
+ * Copyright (C) 2009-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -139 +139 @@
 {
     /* Write the appliance: */
-    CProgress progress = appliance.Write(field("format").toString(), field("manifestSelected").toBool() /* fManifest */, uri());
+    QVector<KExportOptions> options;
+    if (field("manifestSelected").toBool())
+        options.append(KExportOptions_CreateManifest);
+    CProgress progress = appliance.Write(field("format").toString(), options, uri());
     bool fResult = appliance.isOk();
     if (fResult)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -2797 +2797 @@
   </enum>
 
+  <enum
+    name="ExportOptions"
+    uuid="8f45eb08-fd34-41ee-af95-a880bdee5554"
+    >
+
+    <desc>
+    Export options, used with <link to="IAppliance::write" />.
+    </desc>
+
+    <const name="CreateManifest"    value="1">
+      <desc>Write the optional manifest file (.mf) which is used for integrity
+      checks prior import.</desc>
+    </const>
+    <const name="ExportDVDImages"   value="2">
+      <desc>Export DVD images. Default is not to export them as it is rarely
+      needed for typical VMs.</desc>
+    </const>
+
+  </enum>
+
 
   <!--
@@ -3039 +3059 @@
         </desc>
       </param>
-      <param name="manifest" type="boolean" dir="in">
-        <desc>
-            Indicate if the optional manifest file (.mf) should be written. The manifest file
-            is used for integrity checks prior import.
-        </desc>
+      <param name="options" type="ExportOptions" dir="in" safearray="yes">
+        <desc>Options for the exporting operation.</desc>
       </param>
       <param name="path" type="wstring" dir="in">

trunk/src/VBox/Main/include/ApplianceImpl.h

@@ -7 +7 @@
 
 /*
- * Copyright (C) 2006-2012 Oracle Corporation
+ * Copyright (C) 2006-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -104 +104 @@
     /* Export methods */
     STDMETHOD(CreateVFSExplorer)(IN_BSTR aURI, IVFSExplorer **aExplorer);
-    STDMETHOD(Write)(IN_BSTR format, BOOL fManifest, IN_BSTR path, IProgress **aProgress);
+    STDMETHOD(Write)(IN_BSTR format, ComSafeArrayIn(ExportOptions_T, options), IN_BSTR path, IProgress **aProgress);
 
     STDMETHOD(GetWarnings)(ComSafeArrayOut(BSTR, aWarnings));

trunk/src/VBox/Main/include/ApplianceImplPrivate.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2012 Oracle Corporation
+ * Copyright (C) 2006-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -79 +79 @@
     Utf8Str             strOVFSHADigest;//SHA digest of OVf file. It is stored here after reading OVF file (before import)
 
-    RTCList<ImportOptions_T> optList;
+    RTCList<ImportOptions_T> optListImport;
+    RTCList<ExportOptions_T> optListExport;
 
     ovf::OVFReader      *pReader;

trunk/src/VBox/Main/src-server/ApplianceImplExport.cpp

@@ -579 +579 @@
  * Public method implementation.
  * @param format
+ * @param options
  * @param path
  * @param aProgress
  * @return
  */
-STDMETHODIMP Appliance::Write(IN_BSTR format, BOOL fManifest, IN_BSTR path, IProgress **aProgress)
+STDMETHODIMP Appliance::Write(IN_BSTR format, ComSafeArrayIn(ImportOptions_T, options), IN_BSTR path, IProgress **aProgress)
 {
     if (!path) return E_POINTER;
@@ -592 +593 @@
 
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    if (options != NULL)
+        m->optListExport = com::SafeArray<ExportOptions_T>(ComSafeArrayInArg(options)).toList();
+
+    AssertReturn(!(m->optListExport.contains(ExportOptions_CreateManifest) && m->optListExport.contains(ExportOptions_ExportDVDImages)), E_INVALIDARG);
 
     // do not allow entering this method if the appliance is busy reading or writing
@@ -604 +610 @@
                         tr("Appliance file must have .ovf or .ova extension"));
 
-    m->fManifest = !!fManifest;
+    m->fManifest = m->optListExport.contains(ExportOptions_CreateManifest);
     Utf8Str strFormat(format);
 
@@ -886 +892 @@
         {
             rc = mVirtualBox->OpenMedium(bstrSrcFilePath.raw(),
-                                                 DeviceType_HardDisk,
-                                                 AccessMode_ReadWrite,
-                                                 FALSE /* fForceNewUuid */,
-                                                 pSourceDisk.asOutParam());
+                                         DeviceType_HardDisk,
+                                         AccessMode_ReadWrite,
+                                         FALSE /* fForceNewUuid */,
+                                         pSourceDisk.asOutParam());
             if (FAILED(rc))
                 throw rc;

trunk/src/VBox/Main/src-server/ApplianceImplImport.cpp

@@ -770 +770 @@
     if (FAILED(autoCaller.rc())) return autoCaller.rc();
 
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
     if (options != NULL)
-        m->optList = com::SafeArray<ImportOptions_T>(ComSafeArrayInArg(options)).toList();
-
-    AssertReturn(!(m->optList.contains(ImportOptions_KeepAllMACs) && m->optList.contains(ImportOptions_KeepNATMACs)), E_INVALIDARG);
-
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+        m->optListImport = com::SafeArray<ImportOptions_T>(ComSafeArrayInArg(options)).toList();
+
+    AssertReturn(!(m->optListImport.contains(ImportOptions_KeepAllMACs) && m->optListImport.contains(ImportOptions_KeepNATMACs)), E_INVALIDARG);
 
     // do not allow entering this method if the appliance is busy reading or writing
@@ -3340 +3340 @@
     /* First disable all network cards, they will be enabled below again. */
     settings::NetworkAdaptersList::iterator it1;
-    bool fKeepAllMACs = m->optList.contains(ImportOptions_KeepAllMACs);
-    bool fKeepNATMACs = m->optList.contains(ImportOptions_KeepNATMACs);
+    bool fKeepAllMACs = m->optListImport.contains(ImportOptions_KeepAllMACs);
+    bool fKeepNATMACs = m->optListImport.contains(ImportOptions_KeepNATMACs);
     for (it1 = llNetworkAdapters.begin(); it1 != llNetworkAdapters.end(); ++it1)
     {