Changeset 86069 in vbox for trunk/src

Timestamp:

Sep 9, 2020 3:03:23 AM (4 years ago)

Author:

vboxsync

Message:

OCI: Make ICloudProviderRegisteredEvent a non-waitable notification
sent after the fact. Introduce separate ICloudProviderUninstallEvent
sent before unistallation attempt, waitable. Introduce separate
ICloudProviderListChangedEvent that is sent when we are done with all
the extpack providers and the list of providers can be re-read.

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (4 diffs)
• include/VirtualBoxImpl.h (modified) (1 diff)
• src-server/CloudProviderManagerImpl.cpp (modified) (5 diffs)
• src-server/VirtualBoxImpl.cpp (modified) (1 diff)

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

@@ -24467 +24467 @@
   <enum
     name="VBoxEventType"
-    uuid="d5d15e38-808d-11e9-aaac-4bc5d973ca37"
+    uuid="2ab7c196-f232-11ea-a5d2-83b96bc30bcc"
     >
 
@@ -24896 +24896 @@
       </desc>
     </const>
-    <const name="OnCloudProviderRegistered" value="105">
-      <desc>
-        See <link to="ICloudProviderRegisteredEvent">ICloudProviderRegisteredEvent</link>.
-      </desc>
-    </const>
-    <const name="OnCloudProfileRegistered" value="106">
+    <const name="OnCloudProviderListChanged" value="105">
+      <desc>
+        See <link to="ICloudProviderListChangedEvent"/>.
+      </desc>
+    </const>
+    <const name="OnCloudProviderRegistered" value="106">
+      <desc>
+        See <link to="ICloudProviderRegisteredEvent"/>.
+      </desc>
+    </const>
+    <const name="OnCloudProviderUninstall" value="107">
+      <desc>
+        See <link to="ICloudProviderUninstallEvent"/>.
+      </desc>
+    </const>
+    <const name="OnCloudProfileRegistered" value="108">
       <desc>
         See <link to="ICloudProfileRegisteredEvent"/>.
       </desc>
     </const>
-    <const name="OnCloudProfileChanged" value="107">
+    <const name="OnCloudProfileChanged" value="109">
       <desc>
         See <!-- link to="ICloudProfileChangedEvent"/--> ICloudProfileChangedEvent.
@@ -24913 +24923 @@
     <!-- End event marker -->
     <!-- @todo rename to 'End' as it is exclusive (we use 'last' to be inclusive). -->
-    <const name="Last" value="108">
+    <const name="Last" value="110">
       <desc>
         Must be last event, used for iterations and structures relying on numerical event values.
@@ -28253 +28263 @@
   </interface>
 
+  <interface name="ICloudProviderListChangedEvent" extends="IEvent"
+    uuid="a54d9cca-f23f-11ea-9755-efd0f1f792d9"
+    wsmap="managed" autogen="VBoxEvent"
+    id="OnCloudProviderListChanged"
+    >
+    <desc>
+      Each individual provider that is installed or uninstalled is
+      reported as an <link to="ICloudProviderRegisteredEvent"/>.  When
+      the batch is done this event is sent and listerns can get the
+      new list.
+    </desc>
+    <attribute name="registered" type="boolean" readonly="yes"/>
+  </interface>
+
   <interface name="ICloudProviderRegisteredEvent" extends="IEvent"
-    uuid="3d515696-eb98-11ea-96ac-8b4794b20214"
+    uuid="e28e227a-f231-11ea-9641-9b500c6d5365"
     wsmap="managed" autogen="VBoxEvent"
-    id="OnCloudProviderRegistered" waitable="yes"
-    >
+    id="OnCloudProviderRegistered"
+    >
+    <desc>
+      A cloud provider was installed or uninstalled.
+      See also <link to="ICloudProviderListChangedEvent"/>.
+    </desc>
     <attribute name="id" type="uuid" mod="string" readonly="yes"/>
     <attribute name="registered" type="boolean" readonly="yes"/>
+  </interface>
+
+  <interface name="ICloudProviderUninstallEvent" extends="IEvent"
+    uuid="f01f1066-f231-11ea-8eee-33bb2afb0b6e"
+    wsmap="managed" autogen="VBoxEvent"
+    id="OnCloudProviderCanUninstall" waitable="yes"
+    >
+    <desc>
+      A cloud provider is about to be uninstalled.
+      Unlike <link to="ICloudProviderRegisteredEvent"/> this one is
+      waitable and is sent <i>before</i> an attempt is made to
+      uninstall a provider.  Listerns should release references to the
+      provider and related objects if they have any, or the
+      uninstallation of the provider is going to fail because it's
+      still in use.
+    </desc>
+    <attribute name="id" type="uuid" mod="string" readonly="yes"/>
   </interface>
 

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

@@ -209 +209 @@
     int i_natNetworkRefDec(const Utf8Str &aNetworkName);
 
-    void i_onCloudProviderRegistered(const Utf8Str &aId, BOOL aRegistered);
+    void i_onCloudProviderListChanged(BOOL aRegistered);
+    void i_onCloudProviderRegistered(const Utf8Str &aProviderId, BOOL aRegistered);
+    void i_onCloudProviderUninstall(const Utf8Str &aProviderId);
 
 #ifdef VBOX_WITH_CLOUD_NET

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

@@ -136 +136 @@
             {
                 /* 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.
+                hrc = pTmpProvider->COMGETTER(Id)(bstrProviderId.asOutParam());
+
+                /*
+                 * We send this event @em before we 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.
                  */
-                m_pVirtualBox->i_onCloudProviderRegistered(bstrProviderId, FALSE);
+                if (bstrProviderId.isNotEmpty())
+                    m_pVirtualBox->i_onCloudProviderUninstall(bstrProviderId);
 
                 hrc = pTmpProvider->PrepareUninstall();
@@ -159 +157 @@
                 m_astrExtPackNames.erase(m_astrExtPackNames.begin() + (ssize_t)i);
                 m_apCloudProviders.erase(m_apCloudProviders.begin() + (ssize_t)i);
+
+                if (bstrProviderId.isNotEmpty())
+                    m_pVirtualBox->i_onCloudProviderRegistered(bstrProviderId, FALSE);
+
                 /* NB: not advancing loop index */
             }
@@ -172 +174 @@
         if (fRes)
             m_mapCloudProviderManagers.erase(it);
+
+        /**
+         * Tell listeners we are done and they can re-read the new
+         * list of providers.
+         */
+        m_pVirtualBox->i_onCloudProviderListChanged(FALSE);
     }
 
@@ -208 +216 @@
     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++)
     {
@@ -228 +232 @@
                 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);
-    }
+                if (bstrProviderId.isNotEmpty())
+                    m_pVirtualBox->i_onCloudProviderRegistered(bstrProviderId, TRUE);
+            }
+        }
+    }
+
+    /**
+     * Tell listeners we are done and they can re-read the new list of
+     * providers.
+     */
+    m_pVirtualBox->i_onCloudProviderListChanged(TRUE);
 }
 

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

@@ -3819 +3819 @@
 
 
-void VirtualBox::i_onCloudProviderRegistered(const Utf8Str &aId, BOOL aRegistered)
+void VirtualBox::i_onCloudProviderListChanged(BOOL aRegistered)
+{
+    ::FireCloudProviderListChangedEvent(m->pEventSource, aRegistered);
+}
+
+
+void VirtualBox::i_onCloudProviderRegistered(const Utf8Str &aProviderId, BOOL aRegistered)
+{
+    ::FireCloudProviderRegisteredEvent(m->pEventSource, aProviderId, aRegistered);
+}
+
+
+void VirtualBox::i_onCloudProviderUninstall(const Utf8Str &aProviderId)
 {
     HRESULT hrc;
 
     ComPtr<IEvent> pEvent;
-    hrc = CreateCloudProviderRegisteredEvent(pEvent.asOutParam(), m->pEventSource,
-                                             aId, aRegistered);
+    hrc = CreateCloudProviderUninstallEvent(pEvent.asOutParam(),
+                                            m->pEventSource, aProviderId);
     if (FAILED(hrc))
         return;
 
     BOOL fDelivered = FALSE;
-    hrc = m->pEventSource->FireEvent(pEvent, 10000, &fDelivered); // XXX: timeout
+    hrc = m->pEventSource->FireEvent(pEvent, /* :timeout */ 10000, &fDelivered);
     if (FAILED(hrc))
         return;