Changeset 81445 in vbox for trunk/src/VBox/HostServices/SharedClipboard

Timestamp:

Oct 22, 2019 10:23:38 AM (5 years ago)

Author:

vboxsync

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

134163

Message:

Shared Clipboard/Svc: More legacy handling (protocol v0) tweaks needed for VBOX_SHCL_HOST_MSG_READ_DATA. See comments for details.

File:

• trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc.cpp (modified) (5 diffs)

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc.cpp

@@ -427 +427 @@
  * @param   paDstParms  The peek parameter vector.
  * @param   cDstParms   The number of peek parameters (at least two).
- */
-int shclSvcMsgSetGetHostMsgOldReturn(PSHCLCLIENTMSG pMsg, PVBOXHGCMSVCPARM paDstParms, uint32_t cDstParms)
+ * @param   pfRemove    Returns whether the message can be removed from the queue or not.
+ *                      This is needed for certain messages which need to stay around for more than one (guest) call.
+ */
+int shclSvcMsgSetGetHostMsgOldReturn(PSHCLCLIENTMSG pMsg, PVBOXHGCMSVCPARM paDstParms, uint32_t cDstParms,
+                                     bool *pfRemove)
 {
     AssertPtrReturn(pMsg,           VERR_INVALID_POINTER);
     AssertPtrReturn(paDstParms,     VERR_INVALID_POINTER);
     AssertReturn   (cDstParms >= 2, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pfRemove,       VERR_INVALID_POINTER);
 
     int rc = VINF_SUCCESS;
+
+    bool fRemove = true;
+
+    LogFlowFunc(("uMsg=%RU32 (%s), cParms=%RU32\n",
+                 pMsg->uMsg, ShClHostMsgToStr(pMsg->uMsg), pMsg->cParms));
 
     switch (pMsg->uMsg)
@@ -449 +458 @@
             HGCMSvcSetU32(&paDstParms[0], VBOX_SHCL_HOST_MSG_READ_DATA);
             AssertBreakStmt(pMsg->cParms >= 2, rc = VERR_INVALID_PARAMETER); /* Paranoia. */
-            uint32_t uFmt;
-            rc = HGCMSvcGetU32(&pMsg->paParms[1] /* uFormat */, &uFmt);
+            uint32_t uSrcFmt = VBOX_SHCL_FMT_NONE;
+            uint32_t uDstFmt = VBOX_SHCL_FMT_NONE;
+            rc = HGCMSvcGetU32(&pMsg->paParms[1] /* uFormat */, &uSrcFmt);
             if (RT_SUCCESS(rc))
-                HGCMSvcSetU32(&paDstParms[1], uFmt);
+            {
+                if (uSrcFmt & VBOX_SHCL_FMT_UNICODETEXT)
+                    uDstFmt = VBOX_SHCL_FMT_UNICODETEXT;
+                else if (uSrcFmt & VBOX_SHCL_FMT_BITMAP)
+                    uDstFmt = VBOX_SHCL_FMT_BITMAP;
+                else if (uSrcFmt & VBOX_SHCL_FMT_HTML)
+                    uDstFmt = VBOX_SHCL_FMT_HTML;
+                else
+                    AssertStmt(uSrcFmt == VBOX_SHCL_FMT_NONE, uSrcFmt = VBOX_SHCL_FMT_NONE);
+
+                /* Remove format we're going to return from the queued message. */
+                uSrcFmt &= ~uDstFmt;
+                HGCMSvcSetU32(&pMsg->paParms[1], uSrcFmt);
+
+                /* Only report back one format at a time. */
+                HGCMSvcSetU32(&paDstParms[1], uDstFmt);
+
+                /* If no more formats are left, the message can be removed finally. */
+                fRemove = uSrcFmt == VBOX_SHCL_FMT_NONE;
+
+                LogFlowFunc(("uSrcFmt=0x%x, fRemove=%RTbool\n", uSrcFmt, fRemove));
+            }
             break;
         }
@@ -472 +503 @@
             break;
     }
+
+    *pfRemove = fRemove;
 
     LogFlowFuncLeaveRC(rc);
@@ -780 +813 @@
                          pFirstMsg->cParms));
 
-            rc = shclSvcMsgSetGetHostMsgOldReturn(pFirstMsg, paParms, cParms);
+            bool fRemove;
+            rc = shclSvcMsgSetGetHostMsgOldReturn(pFirstMsg, paParms, cParms, &fRemove);
             if (RT_SUCCESS(rc))
             {
                 AssertPtr(g_pHelpers);
                 rc = g_pHelpers->pfnCallComplete(hCall, rc);
-                if (rc != VERR_CANCELLED)
+                if (   rc != VERR_CANCELLED
+                    && fRemove)
                 {
                     pClient->queueMsg.removeFirst();
@@ -975 +1010 @@
                 else if (pClient->Pending.uType == VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD) /* Legacy */
                 {
-                    rc = shclSvcMsgSetGetHostMsgOldReturn(pFirstMsg, pClient->Pending.paParms, pClient->Pending.cParms);
+                    bool fRemove;
+                    rc = shclSvcMsgSetGetHostMsgOldReturn(pFirstMsg, pClient->Pending.paParms, pClient->Pending.cParms,
+                                                          &fRemove);
                     if (RT_SUCCESS(rc))
                     {
-                        /* The old (legacy) protocol gets the message right when returning from peeking, so
-                         * remove the actual message from our queue right now. */
-                        pClient->queueMsg.removeFirst();
-                        shclSvcMsgFree(pFirstMsg);
+                        if (fRemove)
+                        {
+                            /* The old (legacy) protocol gets the message right when returning from peeking, so
+                             * remove the actual message from our queue right now. */
+                            pClient->queueMsg.removeFirst();
+                            shclSvcMsgFree(pFirstMsg);
+                        }
 
                         fDonePending = true;