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

Timestamp:

Aug 9, 2024 8:59:25 AM (9 months ago)

Author:

vboxsync

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

164323

Message:

Shared Clipboard/Transfers: Be a bit more informative in the release log why file transfers do not work when reporting formats to the guest + host. bugref:9437

File:

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

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

@@ -1498 +1498 @@
 
 /**
- * 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).
- *
- * @thread  Backend thread.
- */
-int ShClSvcReportFormats(PSHCLCLIENT pClient, SHCLFORMATS fFormats)
-{
-    AssertPtrReturn(pClient, VERR_INVALID_POINTER);
-
-    LogFlowFunc(("fFormats=%#x\n", fFormats));
-
-    /*
-     * Check if the service mode allows this operation and whether the guest is
-     * supposed to be reading from the host. Otherwise, silently ignore reporting
-     * formats and return VINF_SUCCESS in order to do not trigger client
-     * termination in svcConnect().
-     */
-    uint32_t uMode = ShClSvcGetMode();
-    if (   uMode == VBOX_SHCL_MODE_BIDIRECTIONAL
-        || uMode == VBOX_SHCL_MODE_HOST_TO_GUEST)
-    { /* likely */ }
-    else
-        return VINF_SUCCESS;
-
+ * Handles clipboard formats.
+ *
+ * @returns The new Shared Clipboard formats.
+ * @param   fHostToGuest        Reporting direction.
+ *                              \c true from host -> guest.
+ *                              \c false from guest -> host.
+ * @param   pClient             Pointer to client instance.
+ * @param   fFormats            Reported clipboard formats.
+ */
+static SHCLFORMATS shClSvcHandleFormats(bool fHostToGuest, PSHCLCLIENT pClient, SHCLFORMATS fFormats)
+{
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
     bool fSkipTransfers = false;
@@ -1539 +1518 @@
             if (s_uTransfersBitchedNotEnabled++ < 32)
             {
-                LogRel(("Shared Clipboard: File transfers are disabled, skipping reporting those to the guest\n"));
+                LogRel(("Shared Clipboard: File transfers are disabled on host, skipping reporting those to the guest\n"));
                 fSkipTransfers = true;
             }
@@ -1558 +1537 @@
             fFormats &= ~VBOX_SHCL_FMT_URI_LIST;
     }
-#endif
-
-#ifdef LOG_ENABLED
+#else
+    RT_NOREF(pClient);
+#endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
+
     char *pszFmts = ShClFormatsToStrA(fFormats);
-    AssertPtrReturn(pszFmts, VERR_NO_MEMORY);
-    LogRel2(("Shared Clipboard: Reporting formats '%s' to guest\n", pszFmts));
-    RTStrFree(pszFmts);
-#endif
+    if (pszFmts)
+    {
+        LogRel2(("Shared Clipboard: %s reported formats '%s' to %s\n",
+                 fHostToGuest ? "Host" : "Guest",
+                 pszFmts,
+                 fHostToGuest ? "guest" : "host"));
+        RTStrFree(pszFmts);
+    }
+
+    return fFormats;
+}
+
+/**
+ * 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).
+ *
+ * @thread  Backend thread.
+ */
+int ShClSvcReportFormats(PSHCLCLIENT pClient, SHCLFORMATS fFormats)
+{
+    AssertPtrReturn(pClient, VERR_INVALID_POINTER);
+
+    LogFlowFunc(("fFormats=%#x\n", fFormats));
+
+    /*
+     * Check if the service mode allows this operation and whether the guest is
+     * supposed to be reading from the host. Otherwise, silently ignore reporting
+     * formats and return VINF_SUCCESS in order to do not trigger client
+     * termination in svcConnect().
+     */
+    uint32_t uMode = ShClSvcGetMode();
+    if (   uMode == VBOX_SHCL_MODE_BIDIRECTIONAL
+        || uMode == VBOX_SHCL_MODE_HOST_TO_GUEST)
+    { /* likely */ }
+    else
+        return VINF_SUCCESS;
+
+    fFormats = shClSvcHandleFormats(true /* fHostToGuest */, pClient, fFormats);
 
     int rc;
@@ -1652 +1674 @@
     }
     ASSERT_GUEST_RETURN(paParms[iParm].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
-    uint32_t const fFormats = paParms[iParm].u.uint32;
+    uint32_t fFormats = paParms[iParm].u.uint32;
     iParm++;
     if (cParms == VBOX_SHCL_CPARMS_REPORT_FORMATS_61B)
@@ -1676 +1698 @@
     else
     {
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
+        fFormats = shClSvcHandleFormats(false /* fHostToGuest */, pClient, fFormats);
+#endif
         rc = RTCritSectEnter(&g_CritSect);
         if (RT_SUCCESS(rc))
@@ -1694 +1719 @@
             if (rc == VERR_NOT_SUPPORTED)
             {
-#ifdef LOG_ENABLED
-                char *pszFmts = ShClFormatsToStrA(fFormats);
-                if (pszFmts)
-                {
-                    LogRel2(("Shared Clipboard: Guest reported formats '%s' to host\n", pszFmts));
-                    RTStrFree(pszFmts);
-                }
-#endif
                 rc = ShClBackendReportFormats(&g_ShClBackend, pClient, fFormats);
                 if (RT_FAILURE(rc))