Changeset 86795 in vbox

Timestamp:

Nov 3, 2020 12:29:09 PM (4 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:9653: VirtualBox Manager: Chooser pane: Now that's the heavy one, switching cloud profile update logic from UITask to UIProgressTask; That's more flexible since we are able to control the IProgress interface directly in such case.

Location:

trunk/src/VBox/Frontends/VirtualBox

Files:

• Makefile.kmk (modified) (2 diffs)
• src/manager/UIProgressTaskReadCloudMachineList.cpp (moved) (moved from trunk/src/VBox/Frontends/VirtualBox/src/manager/UITaskCloudListMachines.cpp ) (2 diffs)
• src/manager/UIProgressTaskReadCloudMachineList.h (moved) (moved from trunk/src/VBox/Frontends/VirtualBox/src/manager/UITaskCloudListMachines.h ) (3 diffs)
• src/manager/chooser/UIChooserAbstractModel.cpp (modified) (12 diffs)
• src/manager/chooser/UIChooserAbstractModel.h (modified) (3 diffs)
• src/manager/chooser/UIChooserModel.cpp (modified) (5 diffs)
• src/manager/chooser/UIChooserModel.h (modified) (1 diff)

trunk/src/VBox/Frontends/VirtualBox/Makefile.kmk

@@ -580 +580 @@
         src/hostnetwork/UIHostNetworkManager.h \
         src/manager/UIErrorPane.h \
+        src/manager/UIProgressTaskReadCloudMachineList.h \
         src/manager/UITaskCloudGetSettingsForm.h \
-        src/manager/UITaskCloudListMachines.h \
         src/manager/UIToolPaneGlobal.h \
         src/manager/UIToolPaneMachine.h \
@@ -1060 +1060 @@
         src/manager/UICloudEntityKey.cpp \
         src/manager/UIErrorPane.cpp \
+        src/manager/UIProgressTaskReadCloudMachineList.cpp \
         src/manager/UITaskCloudGetSettingsForm.cpp \
-        src/manager/UITaskCloudListMachines.cpp \
         src/manager/UIToolPaneGlobal.cpp \
         src/manager/UIToolPaneMachine.cpp \

trunk/src/VBox/Frontends/VirtualBox/src/manager/UIProgressTaskReadCloudMachineList.cpp

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * VBox Qt GUI - UITaskCloudListMachines class implementation.
+ * VBox Qt GUI - UIProgressTaskReadCloudMachineList class implementation.
  */
 
@@ -18 +18 @@
 /* GUI includes: */
 #include "UICloudNetworkingStuff.h"
-#include "UITaskCloudListMachines.h"
-
-/* COM includes: */
-#include "CCloudClient.h"
+#include "UIMessageCenter.h"
+#include "UIProgressTaskReadCloudMachineList.h"
 
 
-UITaskCloudListMachines::UITaskCloudListMachines(const QString &strProviderShortName,
-                                                 const QString &strProfileName,
-                                                 bool fWithRefresh)
-    : UITask(Type_CloudListMachines)
-    , m_strProviderShortName(strProviderShortName)
-    , m_strProfileName(strProfileName)
+UIProgressTaskReadCloudMachineList::UIProgressTaskReadCloudMachineList(QObject *pParent,
+                                                                       const UICloudEntityKey &guiCloudProfileKey,
+                                                                       bool fWithRefresh)
+    : UIProgressTask(pParent)
+    , m_guiCloudProfileKey(guiCloudProfileKey)
     , m_fWithRefresh(fWithRefresh)
 {
 }
 
-QVector<CCloudMachine> UITaskCloudListMachines::result() const
+UICloudEntityKey UIProgressTaskReadCloudMachineList::cloudProfileKey() const
 {
-    m_mutex.lock();
-    const QVector<CCloudMachine> resultVector = m_result;
-    m_mutex.unlock();
-    return resultVector;
+    return m_guiCloudProfileKey;
 }
 
-QString UITaskCloudListMachines::errorInfo() const
+QVector<CCloudMachine> UIProgressTaskReadCloudMachineList::machines() const
 {
-    m_mutex.lock();
-    QString strErrorInfo = m_strErrorInfo;
-    m_mutex.unlock();
-    return strErrorInfo;
+    return m_machines;
 }
 
-void UITaskCloudListMachines::run()
+CProgress UIProgressTaskReadCloudMachineList::createProgress()
 {
-    m_mutex.lock();
-    CCloudClient comCloudClient = cloudClientByName(m_strProviderShortName, m_strProfileName, m_strErrorInfo);
-    if (m_strErrorInfo.isNull())
-        m_result = m_fWithRefresh
-                 ? listCloudMachines(comCloudClient, m_strErrorInfo)
-                 : listCloudMachineStubs(comCloudClient, m_strErrorInfo);
-    m_mutex.unlock();
+    /* Create cloud client: */
+    m_comCloudClient = cloudClientByName(m_guiCloudProfileKey.m_strProviderShortName,
+                                         m_guiCloudProfileKey.m_strProfileName);
+
+    /* Prepare resulting progress-wrapper: */
+    CProgress comResult;
+
+    /* Initialize actual progress-wrapper: */
+    if (m_fWithRefresh)
+    {
+        CProgress comProgress = m_comCloudClient.ReadCloudMachineList();
+        if (!m_comCloudClient.isOk())
+            msgCenter().cannotAcquireCloudClientParameter(m_comCloudClient);
+        else
+            comResult = comProgress;
+    }
+    else
+    {
+        CProgress comProgress = m_comCloudClient.ReadCloudMachineStubList();
+        if (!m_comCloudClient.isOk())
+            msgCenter().cannotAcquireCloudClientParameter(m_comCloudClient);
+        else
+            comResult = comProgress;
+    }
+
+    /* Return progress-wrapper in any case: */
+    return comResult;
 }
+
+void UIProgressTaskReadCloudMachineList::handleProgressFinished(CProgress &comProgress)
+{
+    /* Handle progress-wrapper errors: */
+    if (!comProgress.GetCanceled() && (!comProgress.isOk() || comProgress.GetResultCode() != 0))
+        msgCenter().cannotAcquireCloudClientParameter(comProgress);
+    {
+        /* Fill the result: */
+        m_machines = m_fWithRefresh ? m_comCloudClient.GetCloudMachineList() : m_comCloudClient.GetCloudMachineStubList();
+        if (!m_comCloudClient.isOk())
+            msgCenter().cannotAcquireCloudClientParameter(m_comCloudClient);
+    }
+}

trunk/src/VBox/Frontends/VirtualBox/src/manager/UIProgressTaskReadCloudMachineList.h

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * VBox Qt GUI - UITaskCloudListMachines class declaration.
+ * VBox Qt GUI - UIProgressTaskReadCloudMachineList class declaration.
  */
 
@@ -16 +16 @@
  */
 
-#ifndef FEQT_INCLUDED_SRC_manager_UITaskCloudListMachines_h
-#define FEQT_INCLUDED_SRC_manager_UITaskCloudListMachines_h
+#ifndef FEQT_INCLUDED_SRC_manager_UIProgressTaskReadCloudMachineList_h
+#define FEQT_INCLUDED_SRC_manager_UIProgressTaskReadCloudMachineList_h
 #ifndef RT_WITHOUT_PRAGMA_ONCE
 # pragma once
 #endif
 
-/* Qt includes: */
-#include <QMutex>
-
 /* GUI includes: */
-#include "UITask.h"
+#include "UICloudEntityKey.h"
+#include "UIProgressTask.h"
 
 /* COM includes: */
 #include "COMEnums.h"
+#include "CCloudClient.h"
 #include "CCloudMachine.h"
 
-/** UITask extension used to list cloud machines. */
-class UITaskCloudListMachines : public UITask
+/** UIProgressTask extension performing read cloud machine list task. */
+class UIProgressTaskReadCloudMachineList : public UIProgressTask
 {
     Q_OBJECT;
@@ -39 +38 @@
 public:
 
-    /** Constructs task taking @a strProviderShortName and @a strProfileName as data.
-      * @param  strProviderShortName  Brings the provider short name.
-      * @param  strProfileName        Brings the profile name.
-      * @param  fWithRefresh          Brings whether the task includes refresh. */
-    UITaskCloudListMachines(const QString &strProviderShortName,
-                            const QString &strProfileName,
-                            bool fWithRefresh);
+    /** Constructs read cloud machine list task passing @a pParent to the base-class.
+      * @param  guiCloudProfileKey  Brings cloud profile description key.
+      * @param  fWithRefresh        Brings whether cloud machine should be refreshed as well. */
+    UIProgressTaskReadCloudMachineList(QObject *pParent, const UICloudEntityKey &guiCloudProfileKey, bool fWithRefresh);
 
-    /** Returns provider short name. */
-    QString providerShortName() const { return m_strProviderShortName; }
-    /** Returns profile name. */
-    QString profileName() const { return m_strProfileName; }
-    /** Returns whether the task includes refresh. */
-    bool withRefresh() const { return m_fWithRefresh; }
+    /** Returns cloud profile description key. */
+    UICloudEntityKey cloudProfileKey() const;
 
-    /** Returns error info. */
-    QString errorInfo() const;
-
-    /** Returns the task result. */
-    QVector<CCloudMachine> result() const;
+    /** Returns resulting cloud machine-wrapper vector. */
+    QVector<CCloudMachine> machines() const;
 
 protected:
 
-    /** Contains the task body. */
-    virtual void run() /* override */;
+    /** Creates and returns started progress-wrapper required to init UIProgressObject. */
+    virtual CProgress createProgress() /* override */;
+    /** Handles finished @a comProgress wrapper. */
+    virtual void handleProgressFinished(CProgress &comProgress) /* override */;
 
 private:
 
-    /** Holds the mutex to access result. */
-    mutable QMutex  m_mutex;
+    /** Holds the cloud profile description key. */
+    UICloudEntityKey  m_guiCloudProfileKey;
+    /** Holds whether cloud machine should be refreshed as well. */
+    bool              m_fWithRefresh;
 
-    /** Holds the provider short name. */
-    const QString  m_strProviderShortName;
-    /** Holds the profile name. */
-    const QString  m_strProfileName;
-    /** Holds whether the task includes refresh. */
-    const bool     m_fWithRefresh;
-
-    /** Holds the error info. */
-    QString  m_strErrorInfo;
-
-    /** Holds the task result. */
-    QVector<CCloudMachine>  m_result;
+    /** Holds the cloud client-wrapper. */
+    CCloudClient            m_comCloudClient;
+    /** Holds the resulting cloud machine-wrapper vector. */
+    QVector<CCloudMachine>  m_machines;
 };
 
-#endif /* !FEQT_INCLUDED_SRC_manager_UITaskCloudListMachines_h */
+#endif /* !FEQT_INCLUDED_SRC_manager_UIProgressTaskReadCloudMachineList_h */

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserAbstractModel.cpp

@@ -30 +30 @@
 #include "UIExtraDataManager.h"
 #include "UIMessageCenter.h"
-#include "UITaskCloudListMachines.h"
-#include "UIThreadPool.h"
+#include "UIProgressTaskReadCloudMachineList.h"
 #include "UIVirtualBoxEventHandler.h"
 #include "UIVirtualMachineItemCloud.h"
@@ -590 +589 @@
 void UIChooserAbstractModel::insertCloudEntityKey(const UICloudEntityKey &key)
 {
-//    printf("Cloud entity with key %s being updated..\n", key.toString().toUtf8().constData());
+    printf("Cloud entity with key %s being updated..\n", key.toString().toUtf8().constData());
     m_cloudEntityKeysBeingUpdated.insert(key);
     emit sigCloudUpdateStateChanged();
@@ -597 +596 @@
 void UIChooserAbstractModel::removeCloudEntityKey(const UICloudEntityKey &key)
 {
-//    printf("Cloud entity with key %s is updated!\n", key.toString().toUtf8().constData());
+    printf("Cloud entity with key %s is updated!\n", key.toString().toUtf8().constData());
     m_cloudEntityKeysBeingUpdated.remove(key);
     emit sigCloudUpdateStateChanged();
@@ -848 +847 @@
 }
 
-void UIChooserAbstractModel::sltHandleCloudListMachinesTaskComplete(UITask *pTask)
-{
-    /* Skip unrelated tasks: */
-    AssertPtrReturnVoid(pTask);
-    if (pTask->type() != UITask::Type_CloudListMachines)
+void UIChooserAbstractModel::sltHandleReadCloudMachineListTaskComplete()
+{
+    /* Parse task result: */
+    UIProgressTaskReadCloudMachineList *pSender = qobject_cast<UIProgressTaskReadCloudMachineList*>(sender());
+    AssertPtrReturnVoid(pSender);
+    const UICloudEntityKey guiCloudProfileKey = pSender->cloudProfileKey();
+    const QVector<CCloudMachine> machines = pSender->machines();
+
+    /* Delete task: */
+    delete pSender;
+
+    /* Check whether this task was expected: */
+    if (!containsCloudEntityKey(guiCloudProfileKey))
         return;
-    UITaskCloudListMachines *pAcquiringTask = qobject_cast<UITaskCloudListMachines*>(pTask);
-    AssertPtrReturnVoid(pAcquiringTask);
-    const QString strProviderShortName = pAcquiringTask->providerShortName();
-    const QString strProfileName = pAcquiringTask->profileName();
 
     /* Search for profile node: */
-    UIChooserNode *pProfileNode = searchProfileNode(strProviderShortName, strProfileName);
+    UIChooserNode *pProfileNode = searchProfileNode(guiCloudProfileKey.m_strProviderShortName,
+                                                    guiCloudProfileKey.m_strProfileName);
     if (!pProfileNode)
         return;
@@ -878 +882 @@
     QSet<QUuid> newIDs;
     QMap<QUuid, CCloudMachine> newMachines;
-    foreach (const CCloudMachine &comMachine, pAcquiringTask->result())
+    foreach (const CCloudMachine &comMachine, machines)
     {
         QUuid uId;
@@ -895 +899 @@
     /* Remove unregistered cloud VM nodes: */
     if (!unregisteredIDs.isEmpty())
-        sltCloudMachinesUnregistered(strProviderShortName, strProfileName, unregisteredIDs.toList());
+        sltCloudMachinesUnregistered(guiCloudProfileKey.m_strProviderShortName,
+                                     guiCloudProfileKey.m_strProfileName,
+                                     unregisteredIDs.toList());
     /* Add registered cloud VM nodes: */
     if (!registeredMachines.isEmpty())
-        sltCloudMachinesRegistered(strProviderShortName, strProfileName, registeredMachines);
+        sltCloudMachinesRegistered(guiCloudProfileKey.m_strProviderShortName,
+                                   guiCloudProfileKey.m_strProfileName,
+                                   registeredMachines);
     /* If we changed nothing and have nothing currently: */
     if (unregisteredIDs.isEmpty() && newIDs.isEmpty())
@@ -910 +918 @@
 
     /* Remove cloud entity key from the list of keys currently being updated: */
-    const UICloudEntityKey guiCloudEntityKey = UICloudEntityKey(strProviderShortName, strProfileName);
-    removeCloudEntityKey(guiCloudEntityKey);
+    removeCloudEntityKey(guiCloudProfileKey);
 }
 
@@ -922 +929 @@
 void UIChooserAbstractModel::createReadCloudMachineListTask(const UICloudEntityKey &guiCloudProfileKey, bool fWithRefresh)
 {
-    /* Create list cloud machines task: */
-    UITaskCloudListMachines *pTask = new UITaskCloudListMachines(guiCloudProfileKey.m_strProviderShortName,
-                                                                 guiCloudProfileKey.m_strProfileName,
-                                                                 fWithRefresh);
-    AssertPtrReturnVoid(pTask);
-    uiCommon().threadPoolCloud()->enqueueTask(pTask);
+    /* Do not create task if already registered: */
+    if (containsCloudEntityKey(guiCloudProfileKey))
+        return;
+
+    /* Create task: */
+    UIProgressTaskReadCloudMachineList *pTask = new UIProgressTaskReadCloudMachineList(this,
+                                                                                       guiCloudProfileKey,
+                                                                                       fWithRefresh);
+    if (pTask)
+    {
+        /* Insert cloud profile key into a list of keys currently being updated: */
+        insertCloudEntityKey(guiCloudProfileKey);
+
+        /* Connect and start it finally: */
+        connect(pTask, &UIProgressTaskReadCloudMachineList::sigProgressFinished,
+                this, &UIChooserAbstractModel::sltHandleReadCloudMachineListTaskComplete);
+        pTask->start();
+    }
 }
 
@@ -943 +962 @@
 void UIChooserAbstractModel::prepareConnections()
 {
-    /* Cloud thread-pool connections: */
-    connect(uiCommon().threadPoolCloud(), &UIThreadPool::sigTaskComplete,
-            this, &UIChooserAbstractModel::sltHandleCloudListMachinesTaskComplete);
-
     /* Cloud VM registration connections: */
     connect(&uiCommon(), &UICommon::sigCloudMachineUnregistered,
@@ -989 +1004 @@
 }
 
+void UIChooserAbstractModel::cleanupTasks()
+{
+    foreach (UIProgressTaskReadCloudMachineList *pTask, findChildren<UIProgressTaskReadCloudMachineList*>())
+        delete pTask;
+}
+
 void UIChooserAbstractModel::cleanupConnections()
 {
-    /* Cloud thread-pool connections: */
-    disconnect(uiCommon().threadPoolCloud(), &UIThreadPool::sigTaskComplete,
-               this, &UIChooserAbstractModel::sltHandleCloudListMachinesTaskComplete);
-
     /* Cloud VM registration connections: */
     disconnect(&uiCommon(), &UICommon::sigCloudMachineUnregistered,
@@ -1038 +1055 @@
 void UIChooserAbstractModel::cleanup()
 {
+    cleanupTasks();
     cleanupConnections();
 }
@@ -1178 +1196 @@
             createCloudMachineNode(pProfileNode, UIFakeCloudVirtualMachineItemState_Loading);
 
-            /* Insert cloud profile key into a list of keys currently being updated: */
+            /* Create read cloud machine list task: */
             const UICloudEntityKey guiCloudProfileKey = UICloudEntityKey(strProviderShortName, strProfileName);
-            insertCloudEntityKey(guiCloudProfileKey);
-
-            /* Create list cloud machines task: */
             createReadCloudMachineListTask(guiCloudProfileKey, true /* with refresh? */);
         }

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserAbstractModel.h

@@ -37 +37 @@
 class UIChooser;
 class UIChooserNode;
-class UITask;
 class CCloudMachine;
 class CMachine;
@@ -217 +216 @@
                                                 const QVector<CCloudMachine> &machines);
 
-        /** Handles list cloud machines task complete signal. */
-        virtual void sltHandleCloudListMachinesTaskComplete(UITask *pTask);
+        /** Handles read cloud machine list task complete signal. */
+        virtual void sltHandleReadCloudMachineListTaskComplete();
 
         /** Handles Cloud Profile Manager cumulative change. */
@@ -250 +249 @@
         void prepareConnections();
 
+        /** Cleanups tasks. */
+        void cleanupTasks();
         /** Cleanups connections. */
         void cleanupConnections();

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserModel.cpp

@@ -44 +44 @@
 #include "UIMessageCenter.h"
 #include "UIModalWindowManager.h"
-#include "UITaskCloudListMachines.h"
-#include "UIThreadPool.h"
 #include "UIVirtualBoxManagerWidget.h"
 #include "UIVirtualMachineItemCloud.h"
@@ -940 +938 @@
                 AssertPtrReturnVoid(pParentOfParent);
 
-                /* Insert cloud profile key into a list of keys currently being updated: */
+                /* Create read cloud machine list task: */
                 const UICloudEntityKey guiCloudProfileKey = UICloudEntityKey(pParentOfParent->name(), pParent->name());
-                insertCloudEntityKey(guiCloudProfileKey);
-
-                /* Create list cloud machines task: */
                 createReadCloudMachineListTask(guiCloudProfileKey, true /* with refresh? */);
 
@@ -1219 +1214 @@
 }
 
-void UIChooserModel::sltHandleCloudListMachinesTaskComplete(UITask *pTask)
-{
-    /* Skip unrelated tasks: */
-    if (!pTask || pTask->type() != UITask::Type_CloudListMachines)
-        return;
-
+void UIChooserModel::sltHandleReadCloudMachineListTaskComplete()
+{
     /* Call to base-class: */
-    UIChooserAbstractModel::sltHandleCloudListMachinesTaskComplete(pTask);
+    UIChooserAbstractModel::sltHandleReadCloudMachineListTaskComplete();
 
     /* Restart cloud profile update timer: */
@@ -1357 +1348 @@
     /* Restart List Cloud Machines task for selected profile keys: */
     foreach (const UICloudEntityKey &guiCloudProfileKey, selectedCloudProfileKeys)
-    {
-        /* Skip cloud profile keys already being updated: */
-        if (containsCloudEntityKey(guiCloudProfileKey))
-            continue;
-        insertCloudEntityKey(guiCloudProfileKey);
-
-        /* Create a task for particular cloud entity key: */
         createReadCloudMachineListTask(guiCloudProfileKey, false /* with refresh? */);
-    }
 }
 
@@ -1952 +1935 @@
     /* Restart List Cloud Machines task for required profile keys: */
     foreach (const UICloudEntityKey &guiCloudProfileKey, changedCloudEntityKeys)
-    {
-        /* Skip cloud profile keys already being updated: */
-        if (containsCloudEntityKey(guiCloudProfileKey))
-            continue;
-        insertCloudEntityKey(guiCloudProfileKey);
-
-        /* Create a task for particular cloud entity key: */
         createReadCloudMachineListTask(guiCloudProfileKey, false /* with refresh? */);
-    }
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserModel.h

@@ -304 +304 @@
                                                 const QVector<CCloudMachine> &machines) /* override */;
 
-        /** Handles list cloud machines task complete signal. */
-        virtual void sltHandleCloudListMachinesTaskComplete(UITask *pTask) /* override */;
+        /** Handles read cloud machine list task complete signal. */
+        virtual void sltHandleReadCloudMachineListTaskComplete() /* override */;
 
         /** Handles Cloud Profile Manager cumulative changes. */