Changeset 100407 in vbox

Timestamp:

Jul 6, 2023 11:18:29 AM (22 months ago)

Author:

vboxsync

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

158147

Message:

Shared Clipboard: VBoxTray now uses the same way as VBoxClient wrt H->G transfer handling. ​​​bugref:9437

Location:

trunk

Files:

• include/VBox/GuestHost/SharedClipboard-win.h (modified) (1 diff)
• src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp (modified) (7 diffs)
• src/VBox/GuestHost/SharedClipboard/ClipboardDataObjectImpl-win.cpp (modified) (4 diffs)

trunk/include/VBox/GuestHost/SharedClipboard-win.h

@@ -351 +351 @@
     /** Event being triggered when reading the transfer list been completed. */
     RTSEMEVENT                  m_EventListComplete;
-    /** Event being triggered when the transfer status has been changed. */
+    /** Event being triggered when the object status has been changed. */
     RTSEMEVENT                  m_EventStatusChanged;
     /** Registered format for CFSTR_FILEDESCRIPTORA. */

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp

@@ -93 +93 @@
 *********************************************************************************************************************************/
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
-static DECLCALLBACK(void) vbtrShClTransferInitializedCallback(PSHCLTXPROVIDERCTX pCbCtx);
-static DECLCALLBACK(void) vbtrShClTransferStartedCallback(PSHCLTXPROVIDERCTX pCbCtx);
-static DECLCALLBACK(void) vbtrShClTransferErrorCallback(PSHCLTXPROVIDERCTX pCbCtx, int rc);
+static DECLCALLBACK(void) vbtrShClTransferInitializedCallback(PSHCLTRANSFERCALLBACKCTX pCbCtx);
+static DECLCALLBACK(void) vbtrShClTransferStartedCallback(PSHCLTRANSFERCALLBACKCTX pCbCtx);
+static DECLCALLBACK(void) vbtrShClTransferErrorCallback(PSHCLTRANSFERCALLBACKCTX pCbCtx, int rc);
 #endif
 
@@ -195 +195 @@
  * @thread  Clipboard main thread.
  */
-static DECLCALLBACK(void) vbtrShClTransferInitializedCallback(PSHCLTXPROVIDERCTX pCbCtx)
+static DECLCALLBACK(void) vbtrShClTransferInitializedCallback(PSHCLTRANSFERCALLBACKCTX pCbCtx)
 {
     LogFlowFuncEnter();
@@ -209 +209 @@
         {
             AssertPtrBreak(pCtx->Win.pDataObjInFlight);
-            rc = pCtx->Win.pDataObjInFlight->SetStatus(SharedClipboardWinDataObject::Running);
+            rc = pCtx->Win.pDataObjInFlight->SetTransfer(pCbCtx->pTransfer);
+            if (RT_SUCCESS(rc))
+                rc = pCtx->Win.pDataObjInFlight->SetStatus(SharedClipboardWinDataObject::Running);
             break;
         }
@@ -301 +303 @@
     AssertPtr(pTransfer);
 
-    const SHCLTRANSFERDIR enmDir = ShClTransferGetDir(pTransfer);
-
-    LogFlowFunc(("pCtx=%p, idTransfer=%RU32, enmDir=%RU32\n", pCtx, ShClTransferGetID(pTransfer), enmDir));
-
-    int rc;
+    SHCLTRANSFERDIR const enmDir = ShClTransferGetDir(pTransfer);
+
+    int rc = VINF_SUCCESS;
 
     /* The guest wants to transfer data to the host. */
-    if (enmDir == SHCLTRANSFERDIR_TO_REMOTE)
+    if (enmDir == SHCLTRANSFERDIR_TO_REMOTE) /* G->H */
     {
         rc = SharedClipboardWinTransferGetRootsFromClipboard(&pCtx->Win, pTransfer);
     }
-    /* The guest wants to transfer data from the host. */
-    else if (enmDir == SHCLTRANSFERDIR_FROM_REMOTE)
-    {
-        rc = RTCritSectEnter(&pCtx->Win.CritSect);
-        if (RT_SUCCESS(rc))
-        {
-            SharedClipboardWinDataObject *pObj = pCtx->Win.pDataObjInFlight;
-            AssertPtrReturnVoid(pObj);
-            rc = pObj->SetTransfer(pTransfer);
-
-            pCtx->Win.pDataObjInFlight = NULL; /* Hand off to Windows. */
-
-            int rc2 = RTCritSectLeave(&pCtx->Win.CritSect);
-            AssertRC(rc2);
-        }
+    else if (enmDir == SHCLTRANSFERDIR_FROM_REMOTE) /* H->G */
+    {
+        /* Nothing to do here. */
     }
     else
@@ -333 +321 @@
     if (RT_FAILURE(rc))
         LogRel(("Shared Clipboard: Starting transfer failed, rc=%Rrc\n", rc));
-
-    LogFlowFunc(("LEAVE: idTransfer=%RU32, rc=%Rrc\n", ShClTransferGetID(pTransfer), rc));
 }
 
@@ -1093 +1079 @@
     pCtx->CmdCtx.Transfers.Callbacks.cbUser = sizeof(SHCLCONTEXT);
 
+    pCtx->CmdCtx.Transfers.Callbacks.pfnOnInitialized = vbtrShClTransferInitializedCallback;
     pCtx->CmdCtx.Transfers.Callbacks.pfnOnStarted     = vbtrShClTransferStartedCallback;
     pCtx->CmdCtx.Transfers.Callbacks.pfnOnCompleted   = vbtrShClTransferCompletedCallback;
@@ -1113 +1100 @@
         uint32_t idMsg  = 0;
         uint32_t cParms = 0;
-        rc = VbglR3ClipboardMsgPeek(&pCtx->CmdCtx, &idMsg, &cParms, NULL /* pidRestoreCheck */);
+        rc = VbglR3ClipboardMsgPeekWait(&pCtx->CmdCtx, &idMsg, &cParms, NULL /* pidRestoreCheck */);
         if (RT_SUCCESS(rc))
         {

trunk/src/VBox/GuestHost/SharedClipboard/ClipboardDataObjectImpl-win.cpp

@@ -703 +703 @@
                 /* Leave lock while requesting + waiting. */
                 rc2 = RTCritSectLeave(&m_CritSect);
-                AssertRCBreak(rc2);
+                AssertRCBreak(rc);
 
                 /* Start the transfer. */
                 AssertPtrBreak(m_Callbacks.pfnTransferStart);
                 rc = m_Callbacks.pfnTransferStart(&m_CallbackCtx);
-                AssertRCBreak(rc2);
+                AssertRCBreak(rc);
 
                 LogRel2(("Shared Clipboard: Waiting for IDataObject started status ...\n"));
 
-                rc = RTSemEventWait(m_EventStatusChanged, SHCL_TIMEOUT_DEFAULT_MS);
-                AssertRCBreak(rc2);
+                /* Note: Keep the timeout low here (instead of using SHCL_TIMEOUT_DEFAULT_MS), as this will make
+                 *       Windows Explorer unresponsive (i.e. "ghost window") when waiting for too long. */
+                rc = RTSemEventWait(m_EventStatusChanged, RT_MS_10SEC);
+                AssertRCBreak(rc);
 
                 /* Re-acquire lock. */
-                rc2 = RTCritSectEnter(&m_CritSect);
-                AssertRCBreak(rc2);
-
-                if (RT_SUCCESS(rc))
+                rc = RTCritSectEnter(&m_CritSect);
+                AssertRCBreak(rc);
+
+                if (m_enmStatus != Running)
                 {
-                    if (m_enmStatus != Running)
-                    {
-                        LogRel(("Shared Clipboard: Received wrong IDataObject status (%#x)\n", m_enmStatus));
-                        rc = VERR_WRONG_ORDER;
-                        break;
-                    }
-
-                    /* There now must be a transfer assigned. */
-                    AssertPtrBreakStmt(m_pTransfer, rc = VERR_WRONG_ORDER);
+                    LogRel(("Shared Clipboard: Received wrong IDataObject status (%#x)\n", m_enmStatus));
+                    rc = VERR_WRONG_ORDER;
+                    break;
                 }
-                else /* Bail out on failure. */
-                    break;
+
+                /* There now must be a transfer assigned. */
+                AssertPtrBreakStmt(m_pTransfer, rc = VERR_WRONG_ORDER);
 
                 RT_FALL_THROUGH();
@@ -741 +738 @@
                 const bool fUnicode = pFormatEtc->cfFormat == m_cfFileDescriptorW;
 
-                const uint32_t enmTransferStatus = ShClTransferGetStatus(m_pTransfer);
+                SHCLTRANSFERSTATUS const enmTransferStatus = ShClTransferGetStatus(m_pTransfer);
                 RT_NOREF(enmTransferStatus);
 
@@ -750 +747 @@
                 if (!m_fThreadRunning)
                 {
-                    /* Start the transfer asynchronously in a separate thread. */
-                    rc = ShClTransferRun(m_pTransfer, &SharedClipboardWinDataObject::readThread, this /* pvUser */);
+                    /* Start the transfer + run it asynchronously in a separate thread. */
+                    rc = ShClTransferStart(m_pTransfer);
                     if (RT_SUCCESS(rc))
                     {
-                        m_fThreadRunning = true;
-
-                        /* Leave lock while waiting. */
-                        rc2 = RTCritSectLeave(&m_CritSect);
-                        AssertRCReturn(rc2, E_UNEXPECTED);
-
-                        /* Don't block for too long here, as this also will screw other apps running on the OS. */
-                        LogRel2(("Shared Clipboard: Waiting for IDataObject listing to arrive ...\n"));
-                        rc = RTSemEventWait(m_EventListComplete, SHCL_TIMEOUT_DEFAULT_MS);
-
-                        /* Re-acquire lock. */
-                        rc2 = RTCritSectEnter(&m_CritSect);
-                        AssertRCReturn(rc2, E_UNEXPECTED);
+                        rc = ShClTransferRun(m_pTransfer, &SharedClipboardWinDataObject::readThread, this /* pvUser */);
+                        if (RT_SUCCESS(rc))
+                        {
+                            m_fThreadRunning = true;
+
+                            /* Leave lock while waiting. */
+                            rc = RTCritSectLeave(&m_CritSect);
+                            AssertRCReturn(rc, E_UNEXPECTED);
+
+                            /* Don't block for too long here, as this also will screw other apps running on the OS. */
+                            LogRel2(("Shared Clipboard: Waiting for IDataObject listing to arrive ...\n"));
+                            rc = RTSemEventWait(m_EventListComplete, SHCL_TIMEOUT_DEFAULT_MS);
+
+                            /* Re-acquire lock. */
+                            rc = RTCritSectEnter(&m_CritSect);
+                            AssertRCReturn(rc, E_UNEXPECTED);
+                        }
                     }
                 }
@@ -1026 +1027 @@
         if (m_enmStatus == Initialized)
         {
-            AssertMsgReturn(ShClTransferGetStatus(pTransfer) == SHCLTRANSFERSTATUS_STARTED,
-                            ("Cannot set a non-started transfer\n"), VERR_WRONG_ORDER);
-
-            m_pTransfer = pTransfer;
-
-            ShClTransferAcquire(pTransfer);
+            SHCLTRANSFERSTATUS const enmSts = ShClTransferGetStatus(pTransfer);
+            AssertMsgStmt(enmSts == SHCLTRANSFERSTATUS_INITIALIZED, /* Transfer must not be started yet. */
+                          ("Transfer has wrong status (%#x)\n", enmSts), rc = VERR_WRONG_ORDER);
+            if (RT_SUCCESS(rc))
+            {
+                m_pTransfer = pTransfer;
+
+                ShClTransferAcquire(pTransfer);
+            }
         }
         else