Changeset 97783 in vbox for trunk/src/VBox/Main/src-client

Timestamp:

Dec 12, 2022 5:26:43 PM (2 years ago)

Author:

vboxsync

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

154854

Message:

DnD/Main: Added ability to report back the guest-side rc when waiting for a guest response + the guest source / target implementations now make use of the COM object error setting functions provided by GuestDnDBase. How (and if at all) those errors will be reported will depend on the client using those APIs.

Location:

trunk/src/VBox/Main/src-client

Files:

• GuestDnDPrivate.cpp (modified) (5 diffs)
• GuestDnDSourceImpl.cpp (modified) (4 diffs)
• GuestDnDTargetImpl.cpp (modified) (13 diffs)

trunk/src/VBox/Main/src-client/GuestDnDPrivate.cpp ¶

@@ -304 +304 @@
     , m_fGuestFeatures0(VBOX_DND_GF_NONE)
     , m_EventSem(NIL_RTSEMEVENT)
+    , m_rcGuest(VERR_IPE_UNINITIALIZED_STATUS)
     , m_dndActionDefault(0)
     , m_dndLstActionsAllowed(0)
@@ -323 +324 @@
 /**
  * Notifies the waiting side about a guest notification response.
- */
-int GuestDnDState::notifyAboutGuestResponse(void) const
-{
+ *
+ * @returns VBox status code.
+ * @param   rcGuest             Guest rc to set for the response.
+ *                              Defaults to VINF_SUCCESS (for success).
+ */
+int GuestDnDState::notifyAboutGuestResponse(int rcGuest /* = VINF_SUCCESS */)
+{
+    m_rcGuest = rcGuest;
     return RTSemEventSignal(m_EventSem);
 }
@@ -340 +346 @@
 
     m_lstFormats.clear();
+
+    m_rcGuest = VERR_IPE_UNINITIALIZED_STATUS;
 }
 
@@ -619 +627 @@
             rc = setProgress(pCBData->uPercentage, pCBData->uStatus, pCBData->rc);
             if (RT_SUCCESS(rc))
-                rc = notifyAboutGuestResponse();
+                rc = notifyAboutGuestResponse(pCBData->rc);
             break;
         }
@@ -699 +707 @@
 
 /**
+ * Waits for a guest response to happen, extended version.
+ *
+ * @returns VBox status code.
+ * @retval  VERR_TIMEOUT when waiting has timed out.
+ * @retval  VERR_DND_GUEST_ERROR on an error reported back from the guest.
+ * @param   msTimeout           Timeout (in ms) for waiting. Optional, waits 3000 ms if not specified.
+ * @param   prcGuest            Where to return the guest error when VERR_DND_GUEST_ERROR is returned. Optional.
+ */
+int GuestDnDState::waitForGuestResponseEx(RTMSINTERVAL msTimeout /* = 3000 */, int *prcGuest /* = NULL */)
+{
+    int vrc = RTSemEventWait(m_EventSem, msTimeout);
+    if (RT_SUCCESS(vrc))
+    {
+        if (RT_FAILURE(m_rcGuest))
+            vrc = VERR_DND_GUEST_ERROR;
+        if (prcGuest)
+            *prcGuest = m_rcGuest;
+    }
+    return vrc;
+}
+
+/**
  * Waits for a guest response to happen.
  *
  * @returns VBox status code.
- * @param   msTimeout           Timeout (in ms) for waiting. Optional, waits 3000 ms if not specified.
- */
-int GuestDnDState::waitForGuestResponse(RTMSINTERVAL msTimeout /*= 3000 */) const
-{
-    int rc = RTSemEventWait(m_EventSem, msTimeout);
-#ifdef DEBUG_andy
-    LogFlowFunc(("msTimeout=%RU32, rc=%Rrc\n", msTimeout, rc));
-#endif
-    return rc;
+ * @retval  VERR_TIMEOUT when waiting has timed out.
+ * @retval  VERR_DND_GUEST_ERROR on an error reported back from the guest.
+ * @param   prcGuest            Where to return the guest error when VERR_DND_GUEST_ERROR is returned. Optional.
+ *
+ * @note    Uses the default timeout of 3000 ms.
+ */
+int GuestDnDState::waitForGuestResponse(int *prcGuest /* = NULL */)
+{
+    return waitForGuestResponseEx(3000 /* ms */, prcGuest);
 }
 

trunk/src/VBox/Main/src-client/GuestDnDSourceImpl.cpp ¶

@@ -285 +285 @@
         *aDefaultAction = DnDAction_Ignore;
 
-    HRESULT hr = S_OK;
+    GuestDnDState *pState = GuestDnDInst()->getState();
+    AssertPtrReturn(pState, E_POINTER);
+
+    HRESULT hrc = S_OK;
 
     GuestDnDMsg Msg;
@@ -293 +296 @@
     Msg.appendUInt32(uScreenId);
 
-    int rc = GuestDnDInst()->hostCall(Msg.getType(), Msg.getCount(), Msg.getParms());
-    if (RT_SUCCESS(rc))
-    {
-        GuestDnDState *pState = GuestDnDInst()->getState();
-        AssertPtr(pState);
-
-        bool fFetchResult = true;
-
-        rc = pState->waitForGuestResponse(100 /* Timeout in ms */);
-        if (RT_FAILURE(rc))
-            fFetchResult = false;
-
-        if (   fFetchResult
-            && isDnDIgnoreAction(pState->getActionDefault()))
-            fFetchResult = false;
-
-        /* Fetch the default action to use. */
-        if (fFetchResult)
-        {
-            /*
-             * In the GuestDnDSource case the source formats are from the guest,
-             * as GuestDnDSource acts as a target for the guest. The host always
-             * dictates what's supported and what's not, so filter out all formats
-             * which are not supported by the host.
-             */
-            GuestDnDMIMEList lstFiltered  = GuestDnD::toFilteredFormatList(m_lstFmtSupported, pState->formats());
-            if (lstFiltered.size())
+    int vrc = GuestDnDInst()->hostCall(Msg.getType(), Msg.getCount(), Msg.getParms());
+    if (RT_SUCCESS(vrc))
+    {
+        int vrcGuest;
+        vrc = pState->waitForGuestResponseEx(100 /* Timeout in ms */, &vrcGuest);
+        if (RT_SUCCESS(vrc))
+        {
+            if (!isDnDIgnoreAction(pState->getActionDefault()))
             {
-                LogRel3(("DnD: Host offered the following formats:\n"));
-                for (size_t i = 0; i < lstFiltered.size(); i++)
-                    LogRel3(("DnD:\tFormat #%zu: %s\n", i, lstFiltered.at(i).c_str()));
-
-                aFormats            = lstFiltered;
-                aAllowedActions     = GuestDnD::toMainActions(pState->getActionsAllowed());
-                if (aDefaultAction)
-                    *aDefaultAction = GuestDnD::toMainAction(pState->getActionDefault());
-
-                /* Apply the (filtered) formats list. */
-                m_lstFmtOffered     = lstFiltered;
+                /*
+                 * In the GuestDnDSource case the source formats are from the guest,
+                 * as GuestDnDSource acts as a target for the guest. The host always
+                 * dictates what's supported and what's not, so filter out all formats
+                 * which are not supported by the host.
+                 */
+                GuestDnDMIMEList lstFiltered  = GuestDnD::toFilteredFormatList(m_lstFmtSupported, pState->formats());
+                if (lstFiltered.size())
+                {
+                    LogRel2(("DnD: Host offered the following formats:\n"));
+                    for (size_t i = 0; i < lstFiltered.size(); i++)
+                        LogRel2(("DnD:\tFormat #%zu: %s\n", i, lstFiltered.at(i).c_str()));
+
+                    aFormats            = lstFiltered;
+                    aAllowedActions     = GuestDnD::toMainActions(pState->getActionsAllowed());
+                    if (aDefaultAction)
+                        *aDefaultAction = GuestDnD::toMainAction(pState->getActionDefault());
+
+                    /* Apply the (filtered) formats list. */
+                    m_lstFmtOffered     = lstFiltered;
+                }
+                else
+                    hrc = i_setErrorAndReset(tr("Negotiation of formats between guest and host failed!\n\nHost offers: %s\n\nGuest offers: %s"),
+                                             GuestDnD::toFormatString(m_lstFmtSupported , ",").c_str(),
+                                             GuestDnD::toFormatString(pState->formats() , ",").c_str());
             }
-            else
-                LogRel2(("DnD: Negotiation of formats between guest and host failed, drag and drop to host not possible\n"));
-        }
-
-        LogFlowFunc(("fFetchResult=%RTbool, lstActionsAllowed=0x%x\n", fFetchResult, pState->getActionsAllowed()));
-    }
-
-    LogFlowFunc(("hr=%Rhrc\n", hr));
-    return hr;
+            /* Note: Don't report an error here when the action is "ignore" -- that only means that the current window on the guest
+                     simply doesn't support the format or drag and drop at all. */
+        }
+        else
+            hrc = i_setErrorAndReset(vrc == VERR_DND_GUEST_ERROR ? vrcGuest : vrc, tr("Requesting pending data from guest failed"));
+    }
+    else
+        hrc = i_setErrorAndReset(vrc, tr("Sending drag pending event to guest failed"));
+
+    LogFlowFunc(("hr=%Rhrc\n", hrc));
+    return hrc;
 #endif /* VBOX_WITH_DRAG_AND_DROP */
 }
@@ -419 +419 @@
     catch (std::bad_alloc &)
     {
-        hr = setError(E_OUTOFMEMORY);
+        hr = E_OUTOFMEMORY;
     }
     catch (...)
@@ -437 +437 @@
     }
     else
-        hr = setError(hr, tr("Starting thread for GuestDnDSource failed (%Rhrc)"), hr);
+        hr = i_setErrorAndReset(tr("Starting thread for GuestDnDSource failed (%Rhrc)"), hr);
 
     LogFlowFunc(("Returning hr=%Rhrc\n", hr));

trunk/src/VBox/Main/src-client/GuestDnDTargetImpl.cpp ¶

@@ -300 +300 @@
     if (isDnDIgnoreAction(dndActionDefault))
         return S_OK;
+
+    GuestDnDState *pState = GuestDnDInst()->getState();
+    AssertPtrReturn(pState, E_POINTER);
 
     /*
@@ -340 +343 @@
         if (RT_SUCCESS(vrc))
         {
-            GuestDnDState *pState = GuestDnDInst()->getState();
-            if (pState && RT_SUCCESS(vrc = pState->waitForGuestResponse()))
+            int vrcGuest;
+            if (RT_SUCCESS(vrc = pState->waitForGuestResponse(&vrcGuest)))
             {
                 resAction = GuestDnD::toMainAction(m_pState->getActionDefault());
@@ -349 +352 @@
             }
             else
-                hrc = setErrorBoth(VBOX_E_DND_ERROR, vrc, tr("Waiting for response of enter event failed (%Rrc)"), vrc);
+                hrc = i_setErrorAndReset(vrc == VERR_DND_GUEST_ERROR ? vrcGuest : vrc, tr("Entering VM window failed"));
         }
         else
-            hrc = setErrorBoth(VBOX_E_DND_ERROR, vrc, tr("Sending enter event to guest failed (%Rrc)"), vrc);
+        {
+            switch (vrc)
+            {
+                case VERR_ACCESS_DENIED:
+                {
+                    hrc = i_setErrorAndReset(tr("Drag and drop to guest not allowed. Select the right mode first"));
+                    break;
+                }
+
+                case VERR_NOT_SUPPORTED:
+                {
+                    hrc = i_setErrorAndReset(tr("Drag and drop to guest not possible -- either the guest OS does not support this, "
+                                                "or the Guest Additions are not installed"));
+                    break;
+                }
+
+                default:
+                    hrc = i_setErrorAndReset(vrc, tr("Entering VM window failed"));
+                    break;
+            }
+        }
     }
 
@@ -393 +416 @@
     if (isDnDIgnoreAction(dndActionDefault))
         return S_OK;
+
+    GuestDnDState *pState = GuestDnDInst()->getState();
+    AssertPtrReturn(pState, E_POINTER);
 
     /*
@@ -422 +448 @@
         if (RT_SUCCESS(vrc))
         {
-            GuestDnDState *pState = GuestDnDInst()->getState();
-            if (pState && RT_SUCCESS(vrc = pState->waitForGuestResponse()))
+            int vrcGuest;
+            if (RT_SUCCESS(vrc = pState->waitForGuestResponse(&vrcGuest)))
             {
                 resAction = GuestDnD::toMainAction(pState->getActionDefault());
@@ -431 +457 @@
             }
             else
-                hrc = setErrorBoth(VBOX_E_DND_ERROR, vrc, tr("Waiting for response of move event failed (%Rrc)"), vrc);
+                hrc = i_setErrorAndReset(vrc == VERR_DND_GUEST_ERROR ? vrcGuest : vrc,
+                                         tr("Moving to %RU32,%RU32 (screen %u) failed"), aX, aY, aScreenId);
         }
         else
-            hrc = setErrorBoth(VBOX_E_DND_ERROR, vrc, tr("Sending move event to guest failed (%Rrc)"), vrc);
+        {
+            switch (vrc)
+            {
+                case VERR_ACCESS_DENIED:
+                {
+                    hrc = i_setErrorAndReset(tr("Moving in guest not allowed. Select the right mode first"));
+                    break;
+                }
+
+                case VERR_NOT_SUPPORTED:
+                {
+                    hrc = i_setErrorAndReset(tr("Moving in guest not possible -- either the guest OS does not support this, "
+                                                "or the Guest Additions are not installed"));
+                    break;
+                }
+
+                default:
+                    hrc = i_setErrorAndReset(vrc, tr("Moving in VM window failed"));
+                    break;
+            }
+        }
     }
     else
-        hrc = setError(hrc, tr("Retrieving move coordinates failed"));
+        hrc = i_setErrorAndReset(tr("Retrieving move coordinates failed"));
 
     if (SUCCEEDED(hrc))
@@ -460 +507 @@
     if (autoCaller.isNotOk()) return autoCaller.rc();
 
+    GuestDnDState *pState = GuestDnDInst()->getState();
+    AssertPtrReturn(pState, E_POINTER);
+
     HRESULT hrc = S_OK;
 
@@ -472 +522 @@
     if (RT_SUCCESS(vrc))
     {
-        GuestDnDState *pState = GuestDnDInst()->getState();
-        if (pState && RT_SUCCESS(vrc = pState->waitForGuestResponse()))
+        int vrcGuest;
+        if (RT_SUCCESS(vrc = pState->waitForGuestResponse(&vrcGuest)))
         {
             /* Nothing to do here. */
         }
         else
-            hrc = setErrorBoth(VBOX_E_DND_ERROR, vrc, tr("Waiting for response of leave event failed (%Rrc)"), vrc);
+            hrc = i_setErrorAndReset(vrc == VERR_DND_GUEST_ERROR ? vrcGuest : vrc, tr("Leaving VM window failed"));
     }
     else
-        hrc = setErrorBoth(VBOX_E_DND_ERROR, vrc, tr("Sending leave event to guest failed (%Rrc)"), vrc);
+    {
+        switch (vrc)
+        {
+            case VERR_ACCESS_DENIED:
+            {
+                hrc = i_setErrorAndReset(tr("Leaving guest not allowed. Select the right mode first"));
+                break;
+            }
+
+            case VERR_NOT_SUPPORTED:
+            {
+                hrc = i_setErrorAndReset(tr("Leaving guest not possible -- either the guest OS does not support this, "
+                                            "or the Guest Additions are not installed"));
+                break;
+            }
+
+            default:
+                hrc = i_setErrorAndReset(vrc, tr("Leaving VM window failed"));
+                break;
+        }
+    }
 
     LogFlowFunc(("hrc=%Rhrc\n", hrc));
@@ -528 +598 @@
         return S_OK;
     }
+
+    GuestDnDState *pState = GuestDnDInst()->getState();
+    AssertPtrReturn(pState, E_POINTER);
 
     /*
@@ -561 +634 @@
         if (RT_SUCCESS(vrc))
         {
-            GuestDnDState *pState = GuestDnDInst()->getState();
-            if (pState && RT_SUCCESS(pState->waitForGuestResponse()))
+            int vrcGuest;
+            if (RT_SUCCESS(vrc = pState->waitForGuestResponse(&vrcGuest)))
             {
                 resAct = GuestDnD::toMainAction(pState->getActionDefault());
@@ -575 +648 @@
                     {
                         if (lstFormats.size() == 0)
-                            hrc = setError(VBOX_E_DND_ERROR, tr("Guest accepted drop, but did not specify the format"));
+                            hrc = i_setErrorAndReset(VERR_DND_GUEST_ERROR, tr("Guest accepted drop, but did not specify the format"));
                         else
-                            hrc = setError(VBOX_E_DND_ERROR, tr("Guest accepted drop, but returned more than one drop format (%zu formats)"),
-                                          lstFormats.size());
+                            hrc = i_setErrorAndReset(VERR_DND_GUEST_ERROR, tr("Guest accepted drop, but returned more than one drop format (%zu formats)"),
+                                                     lstFormats.size());
                     }
-
-                    LogRel2(("DnD: Guest accepted drop in format '%s' (action %#x, %zu format(s))\n",
-                             resFmt.c_str(), resAct, lstFormats.size()));
                 }
             }
             else
-                hrc = setErrorBoth(VBOX_E_DND_ERROR, vrc, tr("Waiting for response of dropped event failed (%Rrc)"), vrc);
+                hrc = i_setErrorAndReset(vrc == VERR_DND_GUEST_ERROR ? vrcGuest : vrc, tr("Dropping into VM failed"));
         }
         else
-            hrc = setErrorBoth(VBOX_E_DND_ERROR, vrc, tr("Sending dropped event to guest failed (%Rrc)"), vrc);
+            hrc = i_setErrorAndReset(vrc, tr("Sending dropped event to guest failed"));
     }
     else
-        hrc = setError(hrc, tr("Retrieving drop coordinates failed"));
+        hrc = i_setErrorAndReset(hrc, tr("Retrieving drop coordinates failed"));
 
     if (SUCCEEDED(hrc))
@@ -682 +752 @@
     catch (std::bad_alloc &)
     {
-        hr = setError(E_OUTOFMEMORY);
+        hr = E_OUTOFMEMORY;
     }
     catch (...)
@@ -700 +770 @@
     }
     else
-        hr = setError(hr, tr("Starting thread for GuestDnDTarget failed (%Rhrc)"), hr);
+        hr = i_setErrorAndReset(tr("Starting thread for GuestDnDTarget failed (%Rhrc)"), hr);
 
     LogFlowFunc(("Returning hr=%Rhrc\n", hr));