Changeset 86012 in vbox for trunk

Timestamp:

Sep 3, 2020 12:08:56 AM (5 years ago)

Author:

vboxsync

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

140208

Message:

OCI: Send events when a cloud provider is registered or is about to be
unregistered.

Location:

trunk

Files:

• include/VBox/log.h (modified) (2 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)
• src/VBox/Main/include/CloudProviderManagerImpl.h (modified) (3 diffs)
• src/VBox/Main/include/VirtualBoxImpl.h (modified) (1 diff)
• src/VBox/Main/src-server/CloudProviderManagerImpl.cpp (modified) (8 diffs)
• src/VBox/Main/src-server/VirtualBoxImpl.cpp (modified) (2 diffs)

trunk/include/VBox/log.h

@@ -379 +379 @@
     /** Main group, ICloudProviderManager. */
     LOG_GROUP_MAIN_CLOUDPROVIDERMANAGER,
+    /** Main group, ICloudProviderRegisteredEvent. */
+    LOG_GROUP_MAIN_CLOUDPROVIDERREGISTEREDEVENT,
     /** Main group, IConsole. */
     LOG_GROUP_MAIN_CONSOLE,
@@ -938 +940 @@
     "MAIN_CLOUDPROVIDER", \
     "MAIN_CLOUDPROVIDERMANAGER", \
+    "MAIN_CLOUDPROVIDERREGISTEREDEVENT", \
     "MAIN_CONSOLE", \
     "MAIN_CPUPROFILE", \

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

@@ -24896 +24896 @@
       </desc>
     </const>
+    <const name="OnCloudProviderRegistered" value="105">
+      <desc>
+        See <link to="ICloudProviderRegisteredEvent">ICloudProviderRegisteredEvent</link>.
+      </desc>
+    </const>
     <!-- End event marker -->
     <!-- @todo rename to 'End' as it is exclusive (we use 'last' to be inclusive). -->
-    <const name="Last" value="105">
+    <const name="Last" value="106">
       <desc>
         Must be last event, used for iterations and structures relying on numerical event values.
@@ -28236 +28241 @@
     </method>
 
+  </interface>
+
+  <interface name="ICloudProviderRegisteredEvent" extends="IEvent"
+    uuid="3d515696-eb98-11ea-96ac-8b4794b20214"
+    wsmap="managed" autogen="VBoxEvent"
+    id="OnCloudProviderRegistered" waitable="yes"
+    >
+    <!-- should be in ICloudProviderEvent if we ever have one -->
+    <attribute name="id" type="uuid" mod="string" readonly="yes"/>
+
+    <attribute name="registered" type="boolean" readonly="yes"/>
   </interface>
 

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

@@ -24 +24 @@
 #include "CloudProviderManagerWrap.h"
 
-
 class ATL_NO_VTABLE CloudProviderManager
     : public CloudProviderManagerWrap
 {
 public:
-    DECLARE_EMPTY_CTOR_DTOR(CloudProviderManager)
+    CloudProviderManager();
+    virtual ~CloudProviderManager();
 
     HRESULT FinalConstruct();
     void FinalRelease();
 
-    HRESULT init();
+    HRESULT init(VirtualBox *aVirtualBox);
     void uninit();
 
@@ -57 +57 @@
     typedef std::map<com::Utf8Str, ComPtr<ICloudProviderManager> > ExtPackNameCloudProviderManagerMap;
     ExtPackNameCloudProviderManagerMap m_mapCloudProviderManagers;
+
     typedef std::vector<com::Utf8Str> ExtPackNameVec;
     ExtPackNameVec m_astrExtPackNames;
@@ -63 +64 @@
     typedef std::vector<ComPtr<ICloudProvider> > CloudProviderVec;
     CloudProviderVec m_apCloudProviders;
+
+    VirtualBox * const m_pVirtualBox;
 };
 

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

@@ -208 +208 @@
     int i_natNetworkRefInc(const Utf8Str &aNetworkName);
     int i_natNetworkRefDec(const Utf8Str &aNetworkName);
+
+    void i_onCloudProviderRegistered(const Utf8Str &aId, BOOL aRegistered);
 
 #ifdef VBOX_WITH_CLOUD_NET

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

@@ -18 +18 @@
 
 #define LOG_GROUP LOG_GROUP_MAIN_CLOUDPROVIDERMANAGER
+#include <iprt/cpp/utils.h>
 #include <VBox/com/array.h>
 
@@ -33 +34 @@
 // ////////////////////////////////////////////////////////////////////////////////
 CloudProviderManager::CloudProviderManager()
+  : m_pVirtualBox(NULL)
 {
 }
@@ -53 +55 @@
 }
 
-HRESULT CloudProviderManager::init()
+HRESULT CloudProviderManager::init(VirtualBox *aVirtualBox)
 {
     // Enclose the state transition NotReady->InInit->Ready.
@@ -60 +62 @@
 
     m_apCloudProviders.clear();
+    unconst(m_pVirtualBox) = aVirtualBox;
 
     autoInitSpan.setSucceeded();
@@ -71 +74 @@
     if (autoUninitSpan.uninitDone())
         return;
-}
+
+    m_mapCloudProviderManagers.clear();
+    m_apCloudProviders.clear();
+
+    unconst(m_pVirtualBox) = NULL; // not a ComPtr, but be pedantic
+}
+
 
 #ifdef VBOX_WITH_EXTPACK
@@ -88 +97 @@
 
     bool fRes = true;
-    Bstr bstrName;
-    aExtPack->COMGETTER(Name)(bstrName.asOutParam());
-    Utf8Str strName(bstrName);
-    ExtPackNameCloudProviderManagerMap::iterator it = m_mapCloudProviderManagers.find(strName);
+
+    Bstr bstrExtPackName;
+    aExtPack->COMGETTER(Name)(bstrExtPackName.asOutParam());
+    Utf8Str strExtPackName(bstrExtPackName);
+
+    /* is there a cloud provider in this extpack? */
+    ExtPackNameCloudProviderManagerMap::iterator it
+        = m_mapCloudProviderManagers.find(strExtPackName);
     if (it != m_mapCloudProviderManagers.end())
     {
-        ComPtr<ICloudProviderManager> pTmp(it->second);
-
+        // const ComPtr<ICloudProviderManager> pManager(it->second); /* unused */
+
+        /* loop over all providers checking for those from the aExtPack */
         Assert(m_astrExtPackNames.size() == m_apCloudProviders.size());
         for (size_t i = 0; i < m_astrExtPackNames.size(); )
         {
-            if (m_astrExtPackNames[i] != strName)
+            /* the horse it rode in on? */
+            if (m_astrExtPackNames[i] != strExtPackName)
             {
                 i++;
-                continue;
-            }
-
-            // pTmpProvider will point to an object with refcount > 0 until
-            // the ComPtr is removed from m_apCloudProviders.
+                continue;     /* not the extpack we are looking for */
+            }
+
+            /* note the id of this provider to send an event later */
+            Bstr bstrProviderId;
+
+            /*
+             * pTmpProvider will point to an object with refcount > 0
+             * until the ComPtr is removed from m_apCloudProviders.
+             * PrepareUninstall checks that that is the only reference
+             */
             HRESULT hrc = S_OK;
             ULONG uRefCnt = 1;
@@ -112 +133 @@
             if (pTmpProvider)
             {
+                /* do this before the provider goes over the rainbow bridge */
+                pTmpProvider->COMGETTER(Id)(bstrProviderId.asOutParam());
+
+                /**
+                 * @todo r=uwe We send the event @em before we even
+                 * try to uninstall the provider.  The GUI can get the
+                 * event and get rid of any references to the objects
+                 * related to this provider that it still has.  The
+                 * current uninstall attempt might fail, but the GUI
+                 * can then retry once and likely succeed.  Needs more
+                 * thought and feeback from dsen.
+                 */
+                m_pVirtualBox->i_onCloudProviderRegistered(bstrProviderId, FALSE);
+
                 hrc = pTmpProvider->PrepareUninstall();
-                // Sanity check the refcount, it should be 1 at this point.
                 pTmpProvider->AddRef();
                 uRefCnt = pTmpProvider->Release();
-                Assert(uRefCnt == 1);
-            }
+            }
+
+            /* has PrepareUninstall uninited the provider? */
             if (SUCCEEDED(hrc) && uRefCnt == 1)
             {
                 m_astrExtPackNames.erase(m_astrExtPackNames.begin() + (ssize_t)i);
                 m_apCloudProviders.erase(m_apCloudProviders.begin() + (ssize_t)i);
+                /* NB: not advancing loop index */
             }
             else
             {
-                LogRel(("CloudProviderManager: provider '%s' blocks extpack uninstall, result=%Rhrc, refcount=%u\n", strName.c_str(), hrc, uRefCnt));
+                LogRel(("CloudProviderManager: provider '%s' blocks extpack uninstall, result=%Rhrc, refcount=%u\n",
+                        strExtPackName.c_str(), hrc, uRefCnt));
                 fRes = false;
                 i++;
@@ -140 +177 @@
 void CloudProviderManager::i_addExtPack(IExtPack *aExtPack)
 {
+    HRESULT hrc;
+
     AssertReturnVoid(aExtPack);
-
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    Bstr bstrName;
-    aExtPack->COMGETTER(Name)(bstrName.asOutParam());
-    Utf8Str strName(bstrName);
+    Bstr bstrExtPackName;
+    aExtPack->COMGETTER(Name)(bstrExtPackName.asOutParam());
+    Utf8Str strExtPackName(bstrExtPackName);
+
+    /* get the extpack's cloud provider manager object if present */
     ComPtr<IUnknown> pObj;
-    std::vector<com::Utf8Str> astrExtPackNames;
     com::Guid idObj(COM_IIDOF(ICloudProviderManager));
-    HRESULT hrc = aExtPack->QueryObject(Bstr(idObj.toString()).raw(), pObj.asOutParam());
+    hrc = aExtPack->QueryObject(Bstr(idObj.toString()).raw(), pObj.asOutParam());
     if (FAILED(hrc))
         return;
-
-    ComPtr<ICloudProviderManager> pTmp(pObj);
-    if (pTmp.isNull())
-        return;
-
+    const ComPtr<ICloudProviderManager> pManager(pObj);
+    if (pManager.isNull())
+        return;
+
+    /* get the list of cloud providers */
     SafeIfaceArray<ICloudProvider> apProvidersFromCurrExtPack;
-    hrc = pTmp->COMGETTER(Providers)(ComSafeArrayAsOutParam(apProvidersFromCurrExtPack));
+    hrc = pManager->COMGETTER(Providers)(ComSafeArrayAsOutParam(apProvidersFromCurrExtPack));
     if (FAILED(hrc))
         return;
-
-    m_mapCloudProviderManagers[strName] = pTmp;
+    if (apProvidersFromCurrExtPack.size() == 0)
+        return;
+
+    m_mapCloudProviderManagers[strExtPackName] = pManager;
+
+    /* collect provider ids for bulk-sending the events */
+    std::vector<Utf8Str> aProviderIds;
+    aProviderIds.reserve(apProvidersFromCurrExtPack.size());
+
     for (unsigned i = 0; i < apProvidersFromCurrExtPack.size(); i++)
     {
-        // Sanity check each cloud provider by forcing a QueryInterface call,
-        // making sure that it implements the right interface.
-        ComPtr<ICloudProvider> pTmpCP1(apProvidersFromCurrExtPack[i]);
-        if (!pTmpCP1.isNull())
-        {
-            ComPtr<ICloudProvider> pTmpCP2;
-            pTmpCP1.queryInterfaceTo(pTmpCP2.asOutParam());
-            if (!pTmpCP2.isNull())
-            {
+        const ComPtr<ICloudProvider> pProvider(apProvidersFromCurrExtPack[i]);
+        if (!pProvider.isNull())
+        {
+            // Sanity check each cloud provider by forcing a QueryInterface call,
+            // making sure that it implements the right interface.
+            ComPtr<ICloudProvider> pProviderCheck;
+            pProvider.queryInterfaceTo(pProviderCheck.asOutParam());
+            if (!pProviderCheck.isNull()) /* ok, seems legit */
+            {
+                /* save the provider and the name of the extpack it came from */
                 Assert(m_astrExtPackNames.size() == m_apCloudProviders.size());
-                m_astrExtPackNames.push_back(strName);
-                m_apCloudProviders.push_back(apProvidersFromCurrExtPack[i]);
-            }
-        }
+                m_astrExtPackNames.push_back(strExtPackName);
+                m_apCloudProviders.push_back(pProvider);
+
+                /* note the id of this provider to send an event later */
+                Bstr bstrProviderId;
+                pProvider->COMGETTER(Id)(bstrProviderId.asOutParam());
+                aProviderIds.push_back(bstrProviderId);
+            }
+        }
+    }
+
+    /* bulk-send ICloudProviderRegisteredEvent's */
+    for (size_t i = 0; i < aProviderIds.size(); ++i)
+    {
+        m_pVirtualBox->i_onCloudProviderRegistered(aProviderIds[i], TRUE);
     }
 }

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

@@ -762 +762 @@
         rc = unconst(m->pCloudProviderManager).createObject();
         if (SUCCEEDED(rc))
-            rc = m->pCloudProviderManager->init();
+            rc = m->pCloudProviderManager->init(this);
         ComAssertComRCThrowRC(rc);
         if (FAILED(rc)) throw rc;
@@ -3819 +3819 @@
 
 
+void VirtualBox::i_onCloudProviderRegistered(const Utf8Str &aId, BOOL aRegistered)
+{
+    HRESULT hrc;
+
+    ComPtr<IEvent> pEvent;
+    hrc = CreateCloudProviderRegisteredEvent(pEvent.asOutParam(), m->pEventSource,
+                                             aId, aRegistered);
+    if (FAILED(hrc))
+        return;
+
+    BOOL fDelivered = FALSE;
+    hrc = m->pEventSource->FireEvent(pEvent, 10000, &fDelivered); // XXX: timeout
+    if (FAILED(hrc))
+        return;
+}
+
+
 /**
  *  @note Locks the list of other objects for reading.