Changeset 91749 in vbox

Timestamp:

Oct 14, 2021 9:02:32 PM (3 years ago)

Author:

vboxsync

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

147507

Message:

VRDP: Shared Clipboard: delegate clipboard processing to VRDP service when remote RDP clients are connected, bugref:10117.

Location:

trunk/src/VBox/HostServices/SharedClipboard

Files:

• VBoxSharedClipboardSvc-darwin.cpp (modified) (1 diff)
• VBoxSharedClipboardSvc-internal.h (modified) (2 diffs)
• VBoxSharedClipboardSvc-win.cpp (modified) (1 diff)
• VBoxSharedClipboardSvc-x11.cpp (modified) (2 diffs)
• VBoxSharedClipboardSvc.cpp (modified) (10 diffs)

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

@@ -84 +84 @@
                                        &fFormats, &fChanged);
     if (   RT_SUCCESS(rc)
-        && fChanged)
+        && fChanged
+        && ShClSvcIsBackendActive())
         rc = ShClSvcHostReportFormats(pCtx->pClient, fFormats);
 

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h

@@ -259 +259 @@
 } SHCLEXTSTATE, *PSHCLEXTSTATE;
 
+extern SHCLEXTSTATE g_ExtState;
+
 int shClSvcSetSource(PSHCLCLIENT pClient, SHCLSOURCE enmSource);
 
@@ -298 +300 @@
 bool ShClSvcLock(void);
 void ShClSvcUnlock(void);
+
+/**
+ * Checks if the backend is active (@c true), or if VRDE is in control of
+ * the host side.
+ */
+DECLINLINE(bool) ShClSvcIsBackendActive(void)
+{
+    return g_ExtState.pfnExtension == NULL;
+}
 /** @} */
 

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

@@ -590 +590 @@
         rc = SharedClipboardWinGetFormats(&pCtx->Win, &fFormats);
         if (   RT_SUCCESS(rc)
-            && fFormats != VBOX_SHCL_FMT_NONE) /** @todo r=bird: BUGBUG: revisit this. */
+            && fFormats != VBOX_SHCL_FMT_NONE /** @todo r=bird: BUGBUG: revisit this. */
+            && ShClSvcIsBackendActive())
             rc = ShClSvcHostReportFormats(pCtx->pClient, fFormats);
     }

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

@@ -140 +140 @@
      * there is data in the host clipboard it will automatically be sent to
      * the guest when the clipboard starts up. */
-    return ShClSvcHostReportFormats(pClient, VBOX_SHCL_FMT_NONE);
+    if (ShClSvcIsBackendActive())
+        return ShClSvcHostReportFormats(pClient, VBOX_SHCL_FMT_NONE);
+    return VINF_SUCCESS;
 }
 
@@ -290 +292 @@
     if (RT_SUCCESS(rc))
     {
-        /** @todo r=bird: BUGBUG: Revisit this   */
-        if (fFormats != VBOX_SHCL_FMT_NONE) /* No formats to report? */
-        {
-            rc = ShClSvcHostReportFormats(pCtx->pClient, fFormats);
+        if (ShClSvcIsBackendActive())
+        {
+            /** @todo r=bird: BUGBUG: Revisit this   */
+            if (fFormats != VBOX_SHCL_FMT_NONE) /* No formats to report? */
+            {
+                rc = ShClSvcHostReportFormats(pCtx->pClient, fFormats);
+            }
         }
 

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

@@ -1400 +1400 @@
  * Reports available VBox clipboard formats to the guest.
  *
+ * @note    Host backend callers must check if it's active (use
+ *          ShClSvcIsBackendActive) before calling to prevent mixing up the
+ *          VRDE clipboard.
+ *
  * @returns VBox status code.
  * @param   pClient             Client to report clipboard formats to.
@@ -1545 +1549 @@
         if (RT_SUCCESS(rc))
         {
-            if (g_ExtState.pfnExtension)
+            rc = RTCritSectEnter(&g_CritSect);
+            if (RT_SUCCESS(rc))
             {
-                SHCLEXTPARMS parms;
-                RT_ZERO(parms);
-                parms.uFormat = fFormats;
-
-                g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE, &parms, sizeof(parms));
+                if (g_ExtState.pfnExtension)
+                {
+                    SHCLEXTPARMS parms;
+                    RT_ZERO(parms);
+                    parms.uFormat = fFormats;
+
+                    g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE, &parms, sizeof(parms));
+                }
+                else
+                {
+#ifdef LOG_ENABLED
+                    char *pszFmts = ShClFormatsToStrA(fFormats);
+                    if (pszFmts)
+                    {
+                        LogRel2(("Shared Clipboard: Guest reported formats '%s' to host\n", pszFmts));
+                        RTStrFree(pszFmts);
+                    }
+#endif
+                    rc = ShClBackendFormatAnnounce(pClient, fFormats);
+                    if (RT_FAILURE(rc))
+                        LogRel(("Shared Clipboard: Reporting guest clipboard formats to the host failed with %Rrc\n", rc));
+                }
+
+                RTCritSectLeave(&g_CritSect);
             }
             else
-            {
-#ifdef LOG_ENABLED
-                char *pszFmts = ShClFormatsToStrA(fFormats);
-                AssertPtrReturn(pszFmts, VERR_NO_MEMORY);
-                LogRel2(("Shared Clipboard: Guest reported formats '%s' to host\n", pszFmts));
-                RTStrFree(pszFmts);
-#endif
-                rc = ShClBackendFormatAnnounce(pClient, fFormats);
-                if (RT_FAILURE(rc))
-                    LogRel(("Shared Clipboard: Reporting guest clipboard formats to the host failed with %Rrc\n", rc));
-            }
+                LogRel2(("Shared Clipboard: Unable to take internal lock while receiving guest clipboard announcement: %Rrc\n", rc));
         }
     }
@@ -1669 +1683 @@
      * Do the reading.
      */
-    int rc;
     uint32_t cbActual = 0;
+
+    int rc = RTCritSectEnter(&g_CritSect);
+    AssertRCReturn(rc, rc);
 
     /* If there is a service extension active, try reading data from it first. */
@@ -1727 +1743 @@
             rc = VINF_BUFFER_OVERFLOW;
     }
+
+    RTCritSectLeave(&g_CritSect);
 
     LogFlowFuncLeaveRC(rc);
@@ -1854 +1872 @@
 #ifdef LOG_ENABLED
     char *pszFmt = ShClFormatsToStrA(uFormat);
-    AssertPtrReturn(pszFmt, VERR_NO_MEMORY);
-    LogRel2(("Shared Clipboard: Guest writes %RU32 bytes clipboard data in format '%s' to host\n", cbData, pszFmt));
-    RTStrFree(pszFmt);
+    if (pszFmt)
+    {
+        LogRel2(("Shared Clipboard: Guest writes %RU32 bytes clipboard data in format '%s' to host\n", cbData, pszFmt));
+        RTStrFree(pszFmt);
+    }
 #endif
 
@@ -1862 +1882 @@
      * Write the data to the active host side clipboard.
      */
-    int rc;
+    int rc = RTCritSectEnter(&g_CritSect);
+    AssertRCReturn(rc, rc);
+
     if (g_ExtState.pfnExtension)
     {
@@ -1887 +1909 @@
         AssertRC(rc2);
     }
+
+    RTCritSectLeave(&g_CritSect);
 
     LogFlowFuncLeaveRC(rc);
@@ -2695 +2719 @@
     RT_ZERO(parms);
 
+    /*
+     * Reference counting for service extension registration is done a few
+     * layers up (in ConsoleVRDPServer::ClipboardCreate()).
+     */
+
+    int rc = RTCritSectEnter(&g_CritSect);
+    AssertLogRelRCReturn(rc, rc);
+
     if (pfnExtension)
     {
@@ -2702 +2734 @@
 
         parms.u.pfnCallback = extCallback;
-
         g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_SET_CALLBACK, &parms, sizeof(parms));
+
+        LogRel2(("Shared Clipboard: registered service extension\n"));
     }
     else
@@ -2711 +2744 @@
 
         /* Uninstall extension. */
+        g_ExtState.pvExtension  = NULL;
         g_ExtState.pfnExtension = NULL;
-        g_ExtState.pvExtension = NULL;
-    }
+
+        LogRel2(("Shared Clipboard: de-registered service extension\n"));
+    }
+
+    RTCritSectLeave(&g_CritSect);
 
     return VINF_SUCCESS;