Changeset 34714 in vbox

Timestamp:

Dec 3, 2010 10:19:31 PM (14 years ago)

Author:

vboxsync

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

68517

Message:

ExtPackManager: Added API for opening a tarball prior to installation (does not work yet).

Location:

trunk/src/VBox/Main

Files:

• ExtPackManagerImpl.cpp (modified) (5 diffs)
• idl/VirtualBox.xidl (modified) (6 diffs)
• include/ExtPackManagerImpl.h (modified) (3 diffs)
• xpcom/module.cpp (modified) (1 diff)
• xpcom/server.cpp (modified) (1 diff)

trunk/src/VBox/Main/ExtPackManagerImpl.cpp

@@ -64 +64 @@
 *   Structures and Typedefs                                                    *
 *******************************************************************************/
-/**
- * Private extension pack data.
- */
-struct ExtPack::Data
+struct ExtPackBaseData
 {
 public:
@@ -79 +76 @@
     /** Why it is unusable. */
     Utf8Str             strWhyUnusable;
-
+};
+
+/**
+ * Private extension pack data.
+ */
+struct ExtPackFile::Data : public ExtPackBaseData
+{
+public:
+    /** The path to the tarball. */
+    Utf8Str             strExtPackFile;
+    /** The file handle of the extension pack file. */
+    RTFILE              hExtPackFile;
+};
+
+/**
+ * Private extension pack data.
+ */
+struct ExtPack::Data : public ExtPackBaseData
+{
+public:
     /** Where the extension pack is located. */
     Utf8Str             strExtPackPath;
@@ -128 +144 @@
     VBOXEXTPACKCTX      enmContext;
 };
+
+
+DEFINE_EMPTY_CTOR_DTOR(ExtPackFile)
+
+/**
+ * Called by ComObjPtr::createObject when creating the object.
+ *
+ * Just initialize the basic object state, do the rest in initWithDir().
+ *
+ * @returns S_OK.
+ */
+HRESULT ExtPackFile::FinalConstruct()
+{
+    m = NULL;
+    return S_OK;
+}
+
+/**
+ * Initializes the extension pack by reading its file.
+ *
+ * @returns COM status code.
+ * @param   a_pszFile       The path to the extension pack file.
+ */
+HRESULT ExtPackFile::initWithFile(const char *a_pszFile)
+{
+    AutoInitSpan autoInitSpan(this);
+    AssertReturn(autoInitSpan.isOk(), E_FAIL);
+
+    /*
+     * Allocate + initialize our private data.
+     */
+    m = new ExtPackFile::Data;
+    m->Desc.strName                 = NULL;
+    RT_ZERO(m->ObjInfoDesc);
+    m->fUsable                      = false;
+    m->strWhyUnusable               = tr("ExtPack::init failed");
+    m->strExtPackFile               = a_pszFile;
+
+    /*
+     * Probe the extension pack (this code is shared with refresh()).
+     */
+
+    autoInitSpan.setSucceeded();
+    return S_OK;
+}
+
+/**
+ * COM cruft.
+ */
+void ExtPackFile::FinalRelease()
+{
+    uninit();
+}
+
+/**
+ * Do the actual cleanup.
+ */
+void ExtPackFile::uninit()
+{
+    /* Enclose the state transition Ready->InUninit->NotReady */
+    AutoUninitSpan autoUninitSpan(this);
+    if (!autoUninitSpan.uninitDone() && m != NULL)
+    {
+        VBoxExtPackFreeDesc(&m->Desc);
+
+        delete m;
+        m = NULL;
+    }
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(Name)(BSTR *a_pbstrName)
+{
+    CheckComArgOutPointerValid(a_pbstrName);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+    {
+        Bstr str(m->Desc.strName);
+        str.cloneTo(a_pbstrName);
+    }
+    return hrc;
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(Description)(BSTR *a_pbstrDescription)
+{
+    CheckComArgOutPointerValid(a_pbstrDescription);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+    {
+        Bstr str(m->Desc.strDescription);
+        str.cloneTo(a_pbstrDescription);
+    }
+    return hrc;
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(Version)(BSTR *a_pbstrVersion)
+{
+    CheckComArgOutPointerValid(a_pbstrVersion);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+    {
+        Bstr str(m->Desc.strVersion);
+        str.cloneTo(a_pbstrVersion);
+    }
+    return hrc;
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(Revision)(ULONG *a_puRevision)
+{
+    CheckComArgOutPointerValid(a_puRevision);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+        *a_puRevision = m->Desc.uRevision;
+    return hrc;
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(VRDEModule)(BSTR *a_pbstrVrdeModule)
+{
+    CheckComArgOutPointerValid(a_pbstrVrdeModule);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+    {
+        Bstr str(m->Desc.strVrdeModule);
+        str.cloneTo(a_pbstrVrdeModule);
+    }
+    return hrc;
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(PlugIns)(ComSafeArrayOut(IExtPackPlugIn *, a_paPlugIns))
+{
+    /** @todo implement plug-ins. */
+#ifdef VBOX_WITH_XPCOM
+    NOREF(a_paPlugIns);
+    NOREF(a_paPlugInsSize);
+#endif
+    ReturnComNotImplemented();
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(Usable)(BOOL *a_pfUsable)
+{
+    CheckComArgOutPointerValid(a_pfUsable);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+        *a_pfUsable = m->fUsable;
+    return hrc;
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(WhyUnusable)(BSTR *a_pbstrWhy)
+{
+    CheckComArgOutPointerValid(a_pbstrWhy);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+        m->strWhyUnusable.cloneTo(a_pbstrWhy);
+    return hrc;
+}
+
+STDMETHODIMP ExtPackFile::COMGETTER(FilePath)(BSTR *a_pbstrPath)
+{
+    CheckComArgOutPointerValid(a_pbstrPath);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+        m->strExtPackFile.cloneTo(a_pbstrPath);
+    return hrc;
+}
+
+STDMETHODIMP ExtPackFile::Install(void)
+{
+    return E_NOTIMPL;
+}
+
+
+
 
 
@@ -1324 +1527 @@
 }
 
+STDMETHODIMP ExtPackManager::OpenExtPackFile(IN_BSTR a_bstrTarball, IExtPackFile **a_ppExtPackFile)
+{
+    CheckComArgNotNull(a_bstrTarball);
+    CheckComArgOutPointerValid(a_ppExtPackFile);
+    Utf8Str strTarball(a_bstrTarball);
+    AssertReturn(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON, E_UNEXPECTED);
+
+    return E_NOTIMPL;
+}
+
 STDMETHODIMP ExtPackManager::Install(IN_BSTR a_bstrTarball, BSTR *a_pbstrName)
 {
@@ -1329 +1542 @@
     CheckComArgOutPointerValid(a_pbstrName);
     Utf8Str strTarball(a_bstrTarball);
-    Assert(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON);
+    AssertReturn(m->enmContext == VBOXEXTPACKCTX_PER_USER_DAEMON, E_UNEXPECTED);
 
     AutoCaller autoCaller(this);

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

@@ -14334 +14334 @@
 
   <interface
-    name="IExtPack" extends="$unknown"
-    uuid="94564309-5966-419a-81cc-4aec0b6dbd4d"
+    name="IExtPackBase" extends="$unknown"
+    uuid="58304368-f78a-418c-8fec-d9e4e588d797"
     wsmap="suppress"
     >
@@ -14367 +14367 @@
     <attribute name="usable" type="boolean" readonly="yes">
       <desc>
-        Indicates whether the extension pack is usable or not.  An
-        extension pack that is not compatible with the current VirtualBox
-        version will be flagged as not usable.
+        Indicates whether the extension pack is usable or not.
+
+        There are a number of reasons why an extension pack might be unusable,
+        typical examples would be broken installation/file or that it is
+        incompatible with the current VirtualBox version.
       </desc>
     </attribute>
@@ -14378 +14380 @@
       </desc>
     </attribute>
+  </interface>
+
+  <interface
+    name="IExtPack" extends="IExtPackBase"
+    uuid="60f0c30f-c773-4d3e-9580-3ffa47c24e95"
+    wsmap="suppress"
+    >
+    <desc>
+      Interface for querying information about an extension pack as well as
+      accessing COM objects within it.
+    </desc>
     <method name="queryObject">
       <desc>
@@ -14394 +14407 @@
 
   <interface
+    name="IExtPackFile" extends="IExtPackBase"
+    uuid="58509cab-f905-4acb-8087-ba0ab80d8038"
+    wsmap="suppress"
+    >
+    <desc>
+      Extension pack file (aka tarball, .vbox-extpack) representation returned
+      by IExtPackManager::openExtPackFile.  This provides the base extension
+      pack information with the addition of the file name.  It also provides an
+      alternative to IExtPackManager::install.
+    </desc>
+    <attribute name="filePath" type="wstring" readonly="yes">
+      <desc>
+        The path to the extension pack file.
+      </desc>
+    </attribute>
+
+    <method name="install">
+      <desc>
+        Install the extension pack.
+      </desc>
+    </method>
+  </interface>
+
+  <interface
     name="IExtPackManager" extends="$unknown"
-    uuid="bc386406-2637-454b-8d55-021f9e20445a"
+    uuid="8104df65-74d6-4e33-b374-50aa062b4afd"
     wsmap="suppress"
     >
@@ -14427 +14464 @@
     </method>
 
+    <method name="openExtPackFile">
+      <desc>
+        Attempts to open an extension pack file in preparation for
+        installation.
+      </desc>
+      <param name="path" type="wstring" dir="in">
+        <desc>The path of the extension pack tarball.</desc>
+      </param>
+      <param name="file" type="IExtPackFile" dir="return">
+        <desc>The interface of the extension pack file object.</desc>
+      </param>
+    </method>
+
     <method name="install">
+      <desc>
+        Please use openExtPackFile + IExtPackFile::install instead of this
+        interface.   This will be removed later in the beta cycle.
+      </desc>
       <param name="path" type="wstring" dir="in">
         <desc>The path of the extension pack tarball.</desc>
@@ -14463 +14517 @@
         <desc>The name of the frontend or component.</desc>
       </param>
-      <param name="plugInModules" type="wstring" dir="out" safearray="yes">
+      <param name="plugInModules" type="wstring" dir="return" safearray="yes">
         <desc>Array containing the plug-in modules (full paths).</desc>
       </param>

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

@@ -23 +23 @@
 #include <iprt/fs.h>
 
-
 /**
- * An extension pack.
- *
- * This
- */
-class ATL_NO_VTABLE ExtPack :
+ * An extension pack file.
+ */
+class ATL_NO_VTABLE ExtPackFile :
     public VirtualBoxBase,
-    VBOX_SCRIPTABLE_IMPL(IExtPack)
+    VBOX_SCRIPTABLE_IMPL(IExtPackFile)
 {
 public:
     /** @name COM and internal init/term/mapping cruft.
      * @{ */
-    VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(ExtPack, IExtPack)
-    DECLARE_NOT_AGGREGATABLE(ExtPack)
+    VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(ExtPackFile, IExtPackFile)
+    DECLARE_NOT_AGGREGATABLE(ExtPackFile)
     DECLARE_PROTECT_FINAL_CONSTRUCT()
-    BEGIN_COM_MAP(ExtPack)
+    BEGIN_COM_MAP(ExtPackFile)
         COM_INTERFACE_ENTRY(ISupportErrorInfo)
-        COM_INTERFACE_ENTRY(IExtPack)
+        COM_INTERFACE_ENTRY(IExtPackFile)
+        COM_INTERFACE_ENTRY(IExtPackBase)
         COM_INTERFACE_ENTRY(IDispatch)
     END_COM_MAP()
-    DECLARE_EMPTY_CTOR_DTOR(ExtPack)
+    DECLARE_EMPTY_CTOR_DTOR(ExtPackFile)
 
     HRESULT     FinalConstruct();
     void        FinalRelease();
-    HRESULT     initWithDir(VBOXEXTPACKCTX a_enmContext, const char *a_pszName, const char *a_pszDir);
+    HRESULT     initWithFile(const char *a_pszFile);
     void        uninit();
     /** @}  */
 
-    /** @name IExtPack interfaces
+    /** @name IExtPackBase interfaces
      * @{ */
     STDMETHOD(COMGETTER(Name))(BSTR *a_pbstrName);
@@ -62 +60 @@
     STDMETHOD(COMGETTER(Usable))(BOOL *a_pfUsable);
     STDMETHOD(COMGETTER(WhyUnusable))(BSTR *a_pbstrWhy);
+    /** @}  */
+
+    /** @name IExtPackFile interfaces
+     * @{ */
+    STDMETHOD(COMGETTER(FilePath))(BSTR *a_pbstrPath);
+    STDMETHOD(Install)(void);
+    /** @}  */
+
+private:
+    struct Data;
+    /** Pointer to the private instance. */
+    Data *m;
+
+    friend class ExtPackManager;
+};
+
+
+/**
+ * An installed extension pack.
+ */
+class ATL_NO_VTABLE ExtPack :
+    public VirtualBoxBase,
+    VBOX_SCRIPTABLE_IMPL(IExtPack)
+{
+public:
+    /** @name COM and internal init/term/mapping cruft.
+     * @{ */
+    VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(ExtPack, IExtPack)
+    DECLARE_NOT_AGGREGATABLE(ExtPack)
+    DECLARE_PROTECT_FINAL_CONSTRUCT()
+    BEGIN_COM_MAP(ExtPack)
+        COM_INTERFACE_ENTRY(ISupportErrorInfo)
+        COM_INTERFACE_ENTRY(IExtPack)
+        COM_INTERFACE_ENTRY(IExtPackBase)
+        COM_INTERFACE_ENTRY(IDispatch)
+    END_COM_MAP()
+    DECLARE_EMPTY_CTOR_DTOR(ExtPack)
+
+    HRESULT     FinalConstruct();
+    void        FinalRelease();
+    HRESULT     initWithDir(VBOXEXTPACKCTX a_enmContext, const char *a_pszName, const char *a_pszDir);
+    void        uninit();
+    /** @}  */
+
+    /** @name IExtPackBase interfaces
+     * @{ */
+    STDMETHOD(COMGETTER(Name))(BSTR *a_pbstrName);
+    STDMETHOD(COMGETTER(Description))(BSTR *a_pbstrDescription);
+    STDMETHOD(COMGETTER(Version))(BSTR *a_pbstrVersion);
+    STDMETHOD(COMGETTER(Revision))(ULONG *a_puRevision);
+    STDMETHOD(COMGETTER(VRDEModule))(BSTR *a_pbstrVrdeModule);
+    STDMETHOD(COMGETTER(PlugIns))(ComSafeArrayOut(IExtPackPlugIn *, a_paPlugIns));
+    STDMETHOD(COMGETTER(Usable))(BOOL *a_pfUsable);
+    STDMETHOD(COMGETTER(WhyUnusable))(BSTR *a_pbstrWhy);
+    /** @}  */
+
+    /** @name IExtPack interfaces
+     * @{ */
     STDMETHOD(QueryObject)(IN_BSTR a_bstrObjectId, IUnknown **a_ppUnknown);
     /** @}  */
@@ -138 +194 @@
     STDMETHOD(COMGETTER(InstalledExtPacks))(ComSafeArrayOut(IExtPack *, a_paExtPacks));
     STDMETHOD(Find)(IN_BSTR a_bstrName, IExtPack **a_pExtPack);
+    STDMETHOD(OpenExtPackFile)(IN_BSTR a_bstrTarball, IExtPackFile **a_ppExtPackFile);
     STDMETHOD(Install)(IN_BSTR a_bstrTarball, BSTR *a_pbstrName);
     STDMETHOD(Uninstall)(IN_BSTR a_bstrName, BOOL a_fForcedRemoval);

trunk/src/VBox/Main/xpcom/module.cpp

@@ -77 +77 @@
 NS_IMPL_THREADSAFE_ISUPPORTS1_CI(VRDEServerInfo, IVRDEServerInfo)
 #ifdef VBOX_WITH_EXTPACK
+NS_DECL_CLASSINFO(ExtPackFile)
+NS_IMPL_THREADSAFE_ISUPPORTS1_CI(ExtPackFile, IExtPack)
 NS_DECL_CLASSINFO(ExtPack)
 NS_IMPL_THREADSAFE_ISUPPORTS1_CI(ExtPack, IExtPack)

trunk/src/VBox/Main/xpcom/server.cpp

@@ -207 +207 @@
 
 #ifdef VBOX_WITH_EXTPACK
+NS_DECL_CLASSINFO(ExtPackFile)
+NS_IMPL_THREADSAFE_ISUPPORTS1_CI(ExtPackFile, IExtPackFile)
+
 NS_DECL_CLASSINFO(ExtPack)
 NS_IMPL_THREADSAFE_ISUPPORTS1_CI(ExtPack, IExtPack)