Changeset 34086 in vbox for trunk/src/VBox/Main

Timestamp:

Nov 15, 2010 5:45:50 PM (14 years ago)

Author:

vboxsync

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

67776

Message:

Main: Pass more IVirtualBox pointers to the extension pack. VRDE registration hook, VirtualBoxReady hook.

Location:

trunk/src/VBox/Main

Files:

• ConsoleImpl.cpp (modified) (1 diff)
• ExtPackManagerImpl.cpp (modified) (22 diffs)
• VirtualBoxImpl.cpp (modified) (2 diffs)
• include/ExtPackManagerImpl.h (modified) (5 diffs)

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -532 +532 @@
 #ifdef VBOX_WITH_EXTPACK
     unconst(mptrExtPackManager).createObject();
-    rc = mptrExtPackManager->init(NULL, false); /* Drop zone handling is VBoxSVC only. */
+    rc = mptrExtPackManager->init(NULL, NULL, false); /* Drop zone handling is VBoxSVC only. */
     AssertComRCReturnRC(rc);
 #endif

trunk/src/VBox/Main/ExtPackManagerImpl.cpp

@@ -42 +42 @@
 #include "AutoCaller.h"
 #include "Global.h"
+#include "SystemPropertiesImpl.h"
+#include "VirtualBoxImpl.h"
 
 
@@ -97 +99 @@
     /** The extension pack registration structure. */
     PCVBOXEXTPACKREG    pReg;
+    /** Pointer to the VirtualBox object (for VRDE registration). */
+    VirtualBox         *pVirtualBox;
 };
 
@@ -117 +121 @@
     /** The list of installed extension packs. */
     ExtPackList llInstalledExtPacks;
+    /** Pointer to the VirtualBox object, our parent. */
+    VirtualBox *pVirtualBox;
 };
 
@@ -139 +145 @@
  *
  * @returns COM status code.
+ * @param   a_pVirtualBox   Pointer to the VirtualBox object (grandparent).
  * @param   a_pszName       The name of the extension pack.  This is also the
  *                          name of the subdirector under @a a_pszParentDir
@@ -144 +151 @@
  * @param   a_pszParentDir  The parent directory.
  */
-HRESULT ExtPack::init(const char *a_pszName, const char *a_pszParentDir)
+HRESULT ExtPack::init(VirtualBox *a_pVirtualBox, const char *a_pszName, const char *a_pszParentDir)
 {
     AutoInitSpan autoInitSpan(this);
@@ -158 +165 @@
         /* pfnFindModule        = */ ExtPack::hlpFindModule,
         /* pfnGetFilePath       = */ ExtPack::hlpGetFilePath,
+        /* pfnRegisterVrde      = */ ExtPack::hlpRegisterVrde,
         /* u32EndMarker         = */ VBOXEXTPACKHLP_VERSION
     };
@@ -183 +191 @@
     m->pThis                        = this;
     m->pReg                         = NULL;
+    m->pVirtualBox                  = a_pVirtualBox;
 
     /*
@@ -229 +238 @@
 /**
  * Calls the installed hook.
+ *
+ * @param   a_pVirtualBox       The VirtualBox interface.
  * @remarks Caller holds the extension manager lock.
  */
-void    ExtPack::callInstalledHook(void)
+void    ExtPack::callInstalledHook(IVirtualBox *a_pVirtualBox)
 {
     if (   m->hMainMod != NIL_RTLDRMOD
         && m->pReg->pfnInstalled)
-        m->pReg->pfnInstalled(m->pReg);
+        m->pReg->pfnInstalled(m->pReg, a_pVirtualBox);
 }
 
@@ -242 +253 @@
  *
  * @returns S_OK or COM error status with error information.
+ * @param   a_pVirtualBox       The VirtualBox interface.
  * @param   a_fForcedRemoval    When set, we'll ignore complaints from the
  *                              uninstall hook.
  * @remarks The caller holds the manager's write lock.
  */
-HRESULT ExtPack::callUninstallHookAndClose(bool a_fForcedRemoval)
+HRESULT ExtPack::callUninstallHookAndClose(IVirtualBox *a_pVirtualBox, bool a_fForcedRemoval)
 {
     HRESULT hrc = S_OK;
@@ -252 +264 @@
     if (m->hMainMod != NIL_RTLDRMOD)
     {
-        if (m->pReg->pfnUninstall)
-        {
-            int vrc = m->pReg->pfnUninstall(m->pReg);
+        if (m->pReg->pfnUninstall && !a_fForcedRemoval)
+        {
+            int vrc = m->pReg->pfnUninstall(m->pReg, a_pVirtualBox);
             if (RT_FAILURE(vrc))
             {
@@ -274 +286 @@
 
 /**
+ * Calls the pfnVirtualBoxReady hook.
+ *
+ * @param   a_pVirtualBox       The VirtualBox interface.
+ * @remarks Caller holds the extension manager lock.
+ */
+void ExtPack::callVirtualBoxReadyHook(IVirtualBox *a_pVirtualBox)
+{
+    if (   m->hMainMod != NIL_RTLDRMOD
+        && m->pReg->pfnVirtualBoxReady)
+        m->pReg->pfnVirtualBoxReady(m->pReg, a_pVirtualBox);
+}
+
+/**
  * Calls the pfnVMCreate hook.
  *
+ * @param   a_pVirtualBox       The VirtualBox interface.
  * @param   a_pMachine          The machine interface of the new VM.
  * @remarks Caller holds the extension manager lock.
  */
-void ExtPack::callVmCreatedHook(IMachine *a_pMachine)
+void ExtPack::callVmCreatedHook(IVirtualBox *a_pVirtualBox, IMachine *a_pMachine)
 {
     if (   m->hMainMod != NIL_RTLDRMOD
         && m->pReg->pfnVMCreated)
-        m->pReg->pfnVMCreated(m->pReg, a_pMachine);
+        m->pReg->pfnVMCreated(m->pReg, a_pVirtualBox, a_pMachine);
 }
 
@@ -530 +556 @@
                 && m->pReg->u32EndMarker == VBOXEXTPACKREG_VERSION)
             {
-                if (   (!m->pReg->pfnInstalled      || RT_VALID_PTR(m->pReg->pfnInstalled))
-                    && (!m->pReg->pfnUninstall      || RT_VALID_PTR(m->pReg->pfnUninstall))
-                    && (!m->pReg->pfnUnload         || RT_VALID_PTR(m->pReg->pfnUnload))
-                    && (!m->pReg->pfnVMCreated      || RT_VALID_PTR(m->pReg->pfnVMCreated))
-                    && (!m->pReg->pfnVMConfigureVMM || RT_VALID_PTR(m->pReg->pfnVMConfigureVMM))
-                    && (!m->pReg->pfnVMPowerOn      || RT_VALID_PTR(m->pReg->pfnVMPowerOn))
-                    && (!m->pReg->pfnVMPowerOff     || RT_VALID_PTR(m->pReg->pfnVMPowerOff))
-                    && (!m->pReg->pfnQueryObject    || RT_VALID_PTR(m->pReg->pfnQueryObject))
+                if (   (!m->pReg->pfnInstalled       || RT_VALID_PTR(m->pReg->pfnInstalled))
+                    && (!m->pReg->pfnUninstall       || RT_VALID_PTR(m->pReg->pfnUninstall))
+                    && (!m->pReg->pfnVirtualBoxReady || RT_VALID_PTR(m->pReg->pfnVirtualBoxReady))
+                    && (!m->pReg->pfnUnload          || RT_VALID_PTR(m->pReg->pfnUnload))
+                    && (!m->pReg->pfnVMCreated       || RT_VALID_PTR(m->pReg->pfnVMCreated))
+                    && (!m->pReg->pfnVMConfigureVMM  || RT_VALID_PTR(m->pReg->pfnVMConfigureVMM))
+                    && (!m->pReg->pfnVMPowerOn       || RT_VALID_PTR(m->pReg->pfnVMPowerOn))
+                    && (!m->pReg->pfnVMPowerOff      || RT_VALID_PTR(m->pReg->pfnVMPowerOff))
+                    && (!m->pReg->pfnQueryObject     || RT_VALID_PTR(m->pReg->pfnQueryObject))
                     )
                 {
@@ -760 +787 @@
 }
 
+/*static*/ DECLCALLBACK(int)
+ExtPack::hlpRegisterVrde(PCVBOXEXTPACKHLP pHlp, const char *pszName, bool fSetDefault)
+{
+    /*
+     * Validate the input and get our bearings.
+     */
+    AssertPtrReturn(pszName, VERR_INVALID_POINTER);
+
+    AssertPtrReturn(pHlp, VERR_INVALID_POINTER);
+    AssertReturn(pHlp->u32Version == VBOXEXTPACKHLP_VERSION, VERR_INVALID_POINTER);
+    ExtPack::Data *m = RT_FROM_CPP_MEMBER(pHlp, Data, Hlp);
+    AssertPtrReturn(m, VERR_INVALID_POINTER);
+    ExtPack *pThis = m->pThis;
+    AssertPtrReturn(pThis, VERR_INVALID_POINTER);
+    AssertPtrReturn(pThis->m->pVirtualBox, VERR_WRONG_ORDER);
+
+    /*
+     * Find the given module and register it (will succeed if it's already
+     * registered).
+     */
+/** @todo Might consider redoing this VRDERegistration interface to be an aspect of the extension
+ * pack manager instead of IVirtualBox.  That would make sure we won't have any broke paths and stuff later on. */
+    int vrc = VERR_MODULE_NOT_FOUND;
+#if 0 /** @todo causing lock order asserts. Should execute the above todo I think. */
+    Utf8Str strFound;
+    if (pThis->findModule(pszName, NULL, &strFound, NULL, NULL))
+    {
+        Bstr bstrFound(strFound);
+        HRESULT hrc = pThis->m->pVirtualBox->VRDERegisterLibrary(bstrFound.raw());
+        if (SUCCEEDED(hrc) && fSetDefault)
+        {
+            /*
+             * Is there a default already?
+             */
+            SystemProperties *pSysProps = pThis->m->pVirtualBox->getSystemProperties();
+            Bstr bstrDefaultLib;
+            hrc = pSysProps->COMGETTER(DefaultVRDELibrary)(bstrDefaultLib.asOutParam());
+            if (SUCCEEDED(hrc) && bstrDefaultLib.isEmpty())
+            {
+                bstrDefaultLib = strFound;
+                hrc = pSysProps->COMSETTER(DefaultVRDELibrary)(bstrDefaultLib.raw());
+            }
+        }
+        vrc = Global::vboxStatusCodeFromCOM(hrc);
+    }
+#endif
+    return vrc;
+}
+
 
 
@@ -896 +972 @@
  *
  * @returns COM status code.
+ * @param   a_pVirtualBox           Pointer to the VirtualBox object.
  * @param   a_pszDropZoneDir        The path to the drop zone directory.
  * @param   a_fCheckDropZone        Whether to check the drop zone for new
@@ -901 +978 @@
  *                                  and then only when wanted.
  */
-HRESULT ExtPackManager::init(const char *a_pszDropZoneDir, bool a_fCheckDropZone)
+HRESULT ExtPackManager::init(VirtualBox *a_pVirtualBox, const char *a_pszDropZoneDir, bool a_fCheckDropZone)
 {
     AutoInitSpan autoInitSpan(this);
@@ -928 +1005 @@
     m->strCertificatDirPath = szCertificatDir;
     m->strDropZoneDir       = a_pszDropZoneDir;
+    m->pVirtualBox          = a_pVirtualBox;
 
     /*
@@ -962 +1040 @@
                 HRESULT hrc2 = NewExtPack.createObject();
                 if (SUCCEEDED(hrc2))
-                    hrc2 = NewExtPack->init(Entry.szName, szBaseDir);
+                    hrc2 = NewExtPack->init(m->pVirtualBox, Entry.szName, szBaseDir);
                 if (SUCCEEDED(hrc2))
                     m->llInstalledExtPacks.push_back(NewExtPack);
@@ -1110 +1188 @@
                                 {
                                     LogRel(("ExtPackManager: Successfully installed extension pack '%s'.\n", pStrName->c_str()));
-                                    pExtPack->callInstalledHook();
+                                    pExtPack->callInstalledHook(m->pVirtualBox);
                                 }
                             }
@@ -1176 +1254 @@
                  * Call the uninstall hook and unload the main dll.
                  */
-                hrc = pExtPack->callUninstallHookAndClose(a_fForcedRemoval != FALSE);
+                hrc = pExtPack->callUninstallHookAndClose(m->pVirtualBox, a_fForcedRemoval != FALSE);
                 if (SUCCEEDED(hrc))
                 {
@@ -1574 +1652 @@
             hrc = NewExtPack.createObject();
             if (SUCCEEDED(hrc))
-                hrc = NewExtPack->init(a_pszName, m->strBaseDir.c_str());
+                hrc = NewExtPack->init(m->pVirtualBox, a_pszName, m->strBaseDir.c_str());
             if (SUCCEEDED(hrc))
             {
@@ -1691 +1769 @@
 
 /**
- * Calls the pfnVMCreated hook for all working extension packs.
- *
- * @param   a_pMachine          The machine interface of the new VM.
- */
-void ExtPackManager::callAllVmCreatedHooks(IMachine *a_pMachine)
+ * Calls the pfnVirtualBoxReady hook for all working extension packs.
+ */
+void ExtPackManager::callAllVirtualBoxReadyHooks(void)
 {
     AutoCaller autoCaller(this);
@@ -1706 +1782 @@
          it != m->llInstalledExtPacks.end();
          it++)
-        (*it)->callVmCreatedHook(a_pMachine);
+        (*it)->callVirtualBoxReadyHook(m->pVirtualBox);
+}
+
+/**
+ * Calls the pfnVMCreated hook for all working extension packs.
+ *
+ * @param   a_pMachine          The machine interface of the new VM.
+ */
+void ExtPackManager::callAllVmCreatedHooks(IMachine *a_pMachine)
+{
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (FAILED(hrc))
+        return;
+    AutoReadLock autoLock(this COMMA_LOCKVAL_SRC_POS);
+
+    for (ExtPackList::iterator it = m->llInstalledExtPacks.begin();
+         it != m->llInstalledExtPacks.end();
+         it++)
+        (*it)->callVmCreatedHook(m->pVirtualBox, a_pMachine);
 }
 

trunk/src/VBox/Main/VirtualBoxImpl.cpp

@@ -504 +504 @@
         if (SUCCEEDED(rc))
             /** @todo Define drop zone location. */
-            rc = m->ptrExtPackManager->init(NULL /*a_pszDropZoneDir*/, false /*a_fCheckDropZone*/);
+            rc = m->ptrExtPackManager->init(this, NULL /*a_pszDropZoneDir*/, false /*a_fCheckDropZone*/);
         if (FAILED(rc))
             throw rc;
@@ -570 +570 @@
     if (SUCCEEDED(rc))
         autoInitSpan.setSucceeded();
+
+#ifdef VBOX_WITH_EXTPACK
+    /* Let the extension packs have a go at things. */
+    if (SUCCEEDED(rc))
+        m->ptrExtPackManager->callAllVirtualBoxReadyHooks();
+#endif
 
     LogFlowThisFunc(("rc=%08X\n", rc));

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

@@ -48 +48 @@
     HRESULT     FinalConstruct();
     void        FinalRelease();
-    HRESULT     init(const char *a_pszName, const char *a_pszParentDir);
+    HRESULT     init(VirtualBox *a_pVirtualBox, const char *a_pszName, const char *a_pszParentDir);
     void        uninit();
     /** @}  */
@@ -66 +66 @@
     /** @name Internal interfaces used by ExtPackManager.
      * @{ */
-    void        callInstalledHook(void);
-    HRESULT     callUninstallHookAndClose(bool a_fForcedRemoval);
-    void        callVmCreatedHook(IMachine *a_pMachine);
+    void        callInstalledHook(IVirtualBox *a_pVirtualBox);
+    HRESULT     callUninstallHookAndClose(IVirtualBox *a_pVirtualBox, bool a_fForcedRemoval);
+    void        callVirtualBoxReadyHook(IVirtualBox *a_pVirtualBox);
+    void        callVmCreatedHook(IVirtualBox *a_pVirtualBox, IMachine *a_pMachine);
     int         callVmConfigureVmmHook(IConsole *a_pConsole, PVM a_pVM);
     int         callVmPowerOnHook(IConsole *a_pConsole, PVM a_pVM);
@@ -89 +90 @@
                                               char *pszFound, size_t cbFound, bool *pfNative);
     static DECLCALLBACK(int)    hlpGetFilePath(PCVBOXEXTPACKHLP pHlp, const char *pszFilename, char *pszPath, size_t cbPath);
+    static DECLCALLBACK(int)    hlpRegisterVrde(PCVBOXEXTPACKHLP pHlp, const char *pszName, bool fSetDefault);
     /** @}  */
 
@@ -121 +123 @@
     HRESULT     FinalConstruct();
     void        FinalRelease();
-    HRESULT     init(const char *a_pszDropZonePath, bool a_fCheckDropZone);
+    HRESULT     init(VirtualBox *a_pVirtualBox, const char *a_pszDropZonePath, bool a_fCheckDropZone);
     void        uninit();
     /** @}  */
@@ -138 +140 @@
      * @{ */
     void        processDropZone(void);
+    void        callAllVirtualBoxReadyHooks(void);
     void        callAllVmCreatedHooks(IMachine *a_pMachine);
     int         callAllVmConfigureVmmHooks(IConsole *a_pConsole, PVM a_pVM);