Changeset 100655 in vbox for trunk/src/VBox/HostServices

Timestamp:

Jul 19, 2023 4:06:24 PM (17 months ago)

Author:

vboxsync

Message:

Shared Clipboard/VRDE: Integrated the logic of ShClSvcIsBackendActive() in ShClSvcReportFormats(), so that the specific backends don't need to be in charge for that anymore. Renamed VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE -> VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_HOST to emphasize its usage. Added VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_GUEST; see comment for details.

The whole concept of VRDE being a (one and only) service extension nowadays isn't optimal anymore and needs to be replaced with a more generic mechanism, which is out of this scope for this task. So just adapt this as needed and keep the current way.

bugref:9437

Location:

trunk/src/VBox/HostServices/SharedClipboard

Files:

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

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

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

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

@@ -319 +319 @@
 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

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

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

@@ -220 +220 @@
      * there is data in the host clipboard it will automatically be sent to
      * the guest when the clipboard starts up. */
-    if (ShClSvcIsBackendActive())
-        return ShClSvcReportFormats(pClient, VBOX_SHCL_FMT_NONE);
-    return VINF_SUCCESS;
+    return ShClSvcReportFormats(pClient, VBOX_SHCL_FMT_NONE);
 }
 
@@ -369 +367 @@
     AssertPtr(pClient);
 
-    rc = RTCritSectEnter(&pClient->CritSect);
-    if (RT_SUCCESS(rc))
-    {
-        if (ShClSvcIsBackendActive())
-        {
-            /** @todo r=bird: BUGBUG: Revisit this   */
-            if (fFormats != VBOX_SHCL_FMT_NONE) /* No formats to report? */
-            {
-                rc = ShClSvcReportFormats(pCtx->pClient, fFormats);
-            }
-        }
-
-        RTCritSectLeave(&pClient->CritSect);
-    }
+    rc = ShClSvcReportFormats(pCtx->pClient, fFormats);
 
     LogFlowFuncLeaveRC(rc);

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

@@ -1473 +1473 @@
  * Reports 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.
- * @param   fFormats            The formats to report (VBOX_SHCL_FMT_XXX), zero
- *                              is okay (empty the clipboard).
- *
+ * @param   fFormats            The formats to report (VBOX_SHCL_FMT_XXX).
+ *                              VBOX_SHCL_FMT_NONE will empty (clear) the clipboard.
  * @thread  Backend thread.
  */
 int ShClSvcReportFormats(PSHCLCLIENT pClient, SHCLFORMATS fFormats)
 {
-    LogFlowFuncEnter();
+    AssertPtrReturn(pClient, VERR_INVALID_POINTER);
+
+    LogFlowFunc(("fFormats=%#x\n", fFormats));
 
     /*
@@ -1501 +1498 @@
         return VINF_SUCCESS;
 
-    AssertPtrReturn(pClient, VERR_INVALID_POINTER);
-
-    LogFlowFunc(("fFormats=%#x\n", fFormats));
-
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
     bool fSkipTransfers = false;
@@ -1529 +1522 @@
 #endif
 
+    int rc;
+
+    /*
+     * Check if the HGCM callback can handle this first.
+     * This is needed in order to not mess up the clipboard if VRDE is active, for example.
+     */
+    if (g_ExtState.pfnExtension) /* Extension set? */
+    {
+        SHCLEXTPARMS parms;
+        RT_ZERO(parms);
+
+        parms.u.ReportFormats.uFormats = fFormats;
+
+        rc = g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_GUEST, &parms, sizeof(parms));
+        if (rc == VERR_NOT_SUPPORTED)
+        {
+            /* Not handled by the extension, continue below. */
+        }
+        else /* Handled by the extension, bail out. */
+            return rc;
+    }
+
     /*
      * Allocate a message, populate parameters and post it to the client.
      */
-    int rc;
     PSHCLCLIENTMSG pMsg = shClSvcMsgAlloc(pClient, VBOX_SHCL_HOST_MSG_FORMATS_REPORT, 2);
     if (pMsg)
@@ -1539 +1553 @@
         HGCMSvcSetU32(&pMsg->aParms[1], fFormats);
 
-        RTCritSectEnter(&pClient->CritSect);
+        shClSvcClientLock(pClient);
+
         rc = shClSvcMsgAddAndWakeupClient(pClient, pMsg);
-        RTCritSectLeave(&pClient->CritSect);
+
+        shClSvcClientUnlock(pClient);
     }
     else
@@ -1620 +1636 @@
                 parms.u.ReportFormats.uFormats = fFormats;
 
-                rc = g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE, &parms, sizeof(parms));
+                rc = g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_HOST, &parms, sizeof(parms));
             }
             else
@@ -2730 +2746 @@
         switch (u32Function)
         {
-            /* The service extension announces formats to the guest. */
-            case VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE:
+            /* The service extension announces formats to the host. */
+            case VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_HOST:
             {
-                LogFlowFunc(("VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE: g_ExtState.fReadingData=%RTbool\n", g_ExtState.fReadingData));
+                LogFlowFunc(("VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_HOST: g_ExtState.fReadingData=%RTbool\n", g_ExtState.fReadingData));
                 if (!g_ExtState.fReadingData)
                     rc = ShClSvcReportFormats(pClient, u32Format);
@@ -2775 +2791 @@
             }
 
-            /** @todo BUGBUG Why no VBOX_CLIPBOARD_EXT_FN_DATA_WRITE here? */
-
             default:
                 /* Just skip other messages. */