Changeset 103480 in vbox

Timestamp:

Feb 20, 2024 3:21:35 PM (9 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Added a ShClTransferTransformPath() function to make the paths more uniform. bugref:9437

Location:

trunk

Files:

• include/VBox/GuestHost/SharedClipboard-transfers.h (modified) (3 diffs)
• include/VBox/HostServices/VBoxClipboardSvc.h (modified) (2 diffs)
• src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibClipboard.cpp (modified) (4 diffs)
• src/VBox/GuestHost/SharedClipboard/ClipboardStreamImpl-win.cpp (modified) (2 diffs)
• src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp (modified) (1 diff)
• src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-transfers.cpp (modified) (3 diffs)

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

@@ -345 +345 @@
 typedef struct _SHCLOBJOPENCREATEPARMS
 {
-    /** Path to object to open / create. */
+    /** Path to object to open / create.
+     *  Always stored as UNIX-style paths ('/').
+     *  Backslashes ('\') can be part of a UNIX path though. */
     char                       *pszPath;
     /** Size (in bytes) of path to to object. */
@@ -421 +423 @@
     /** Size (in bytes) of the listing path. */
     uint32_t cbPath;
-    /** Listing path (absolute). If empty or NULL the listing's root path will be opened. */
+    /** Listing path (absolute). If empty or NULL the listing's root path will be opened.
+     *  We always use UNIX-style paths. */
     char    *pszPath;
 } SHCLLISTOPENPARMS;
@@ -1266 +1269 @@
 int ShClPathSanitize(char *pszPath, size_t cbPath);
 const char *ShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus);
+int ShClTransferTransformPath(char *pszPath, size_t cbPath);
 int ShClTransferValidatePath(const char *pcszPath, bool fMustExist);
 int ShClTransferResolvePathAbs(PSHCLTRANSFER pTransfer, const char *pszPath, uint32_t fFlags, char **ppszResolved);

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

@@ -990 +990 @@
     /** pointer, in: Filter string. */
     HGCMFunctionParameter pvFilter;
-    /** pointer, in: Listing poth. If empty or NULL the listing's root path will be opened. */
+    /** pointer, in: Listing path. If empty or NULL the listing's root path will be opened.
+     *  We always use UNIX-style paths. */
     HGCMFunctionParameter pvPath;
     /** uint64_t, out: List handle. */
@@ -1110 +1111 @@
     /** uint64_t, out: Object handle. */
     HGCMFunctionParameter uHandle;
-    /** pointer, in: Absoulte path of object to open/create. */
+    /** pointer, in: Absoulte path of object to open/create.
+     *  We always use UNIX-style paths. */
     HGCMFunctionParameter szPath;
     /** uint32_t in: Open / Create flags of type SHCL_OBJ_CF_. */

trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibClipboard.cpp

@@ -1196 +1196 @@
     AssertPtrReturn(phList,     VERR_INVALID_POINTER);
 
+    int rc = ShClTransferTransformPath(pOpenParms->pszPath, pOpenParms->cbPath);
+    AssertRCReturn(rc, rc);
+
     VBoxShClListOpenMsg Msg;
     VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->idClient,
@@ -1206 +1209 @@
     Msg.uHandle.SetUInt64(0);
 
-    int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
-    if (RT_SUCCESS(rc))
-    {
+    rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
+    if (RT_SUCCESS(rc))
         rc = Msg.uHandle.GetUInt64(phList); AssertRC(rc);
-    }
 
     LogFlowFuncLeaveRC(rc);
@@ -1701 +1702 @@
     AssertPtrReturn(phObj,        VERR_INVALID_POINTER);
 
+    int rc = ShClTransferTransformPath(pCreateParms->pszPath, pCreateParms->cbPath);
+    AssertRCReturn(rc, rc);
+
     VBoxShClObjOpenMsg Msg;
     VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->idClient,
@@ -1710 +1714 @@
     Msg.fCreate.SetUInt32(pCreateParms->fCreate);
 
-    int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
-    if (RT_SUCCESS(rc))
-    {
+    rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
+    if (RT_SUCCESS(rc))
         Msg.uHandle.GetUInt64(phObj);
-    }
 
     LogFlowFuncLeaveRC(rc);

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

@@ -38 +38 @@
 
 #include <VBox/GuestHost/SharedClipboard.h>
+#include <VBox/GuestHost/SharedClipboard-transfers.h>
 #include <VBox/GuestHost/SharedClipboard-win.h>
 
@@ -211 +212 @@
             rc = RTStrCopy(openParms.pszPath, openParms.cbPath, m_strPath.c_str());
             if (RT_SUCCESS(rc))
-                rc = ShClTransferObjOpen(m_pTransfer, &openParms, &m_hObj);
+            {
+                rc = ShClTransferTransformPath(openParms.pszPath, openParms.cbPath);
+                if (RT_SUCCESS(rc))
+                    rc = ShClTransferObjOpen(m_pTransfer, &openParms, &m_hObj);
+            }
 
             ShClTransferObjOpenParmsDestroy(&openParms);

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp

@@ -3368 +3368 @@
     }
     return "Unknown";
+}
+
+/**
+ * Transforms a path so that it can be sent over to the other party.
+ *
+ * @returns VBox status code.
+ * @param   pszPath             Path to transform. Will be modified in place.
+ * @param   cbPath              Size (in bytes) of \a pszPath.
+ *
+ * @note    Shared Clipboard file paths always are sent over as UNIX-style paths.
+ *          Sending over back slashes ('\') could happen on non-Windows OSes as part of a path or file name.
+ */
+int ShClTransferTransformPath(char *pszPath, size_t cbPath)
+{
+#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
+    RT_NOREF(cbPath);
+    RTPathChangeToUnixSlashes(pszPath, true /* fForce */);
+#else
+    RT_NOREF(pszPath, cbPath);
+#endif
+    return VINF_SUCCESS;
 }
 

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

@@ -43 +43 @@
 #include <iprt/file.h>
 #include <iprt/path.h>
+
+#include <VBox/GuestHost/SharedClipboard-transfers.h>
 
 #include "VBoxSharedClipboardSvc-internal.h"
@@ -326 +328 @@
                                                    pEvent->idEvent);
 
-            rc = shClSvcTransferSetListOpen(pMsg->cParms, pMsg->aParms, pMsg->idCtx, pOpenParms);
+            rc = ShClTransferTransformPath(pOpenParms->pszPath, pOpenParms->cbPath);
+            if (RT_SUCCESS(rc))
+                rc = shClSvcTransferSetListOpen(pMsg->cParms, pMsg->aParms, pMsg->idCtx, pOpenParms);
             if (RT_SUCCESS(rc))
             {
@@ -604 +608 @@
             LogFlowFunc(("pszPath=%s, fCreate=0x%x\n", pCreateParms->pszPath, pCreateParms->fCreate));
 
-            const uint32_t cbPath = (uint32_t)strlen(pCreateParms->pszPath) + 1; /* Include terminating zero */
-
-            HGCMSvcSetU64(&pMsg->aParms[0], VBOX_SHCL_CONTEXTID_MAKE(pClient->State.uSessionID,
-                                                                     pCtx->pTransfer->State.uID, pEvent->idEvent));
-            HGCMSvcSetU64(&pMsg->aParms[1], 0); /* uHandle */
-            HGCMSvcSetPv (&pMsg->aParms[2], pCreateParms->pszPath, cbPath);
-            HGCMSvcSetU32(&pMsg->aParms[3], pCreateParms->fCreate);
-
-            shClSvcClientLock(pClient);
-
-            shClSvcMsgAdd(pClient, pMsg, true /* fAppend */);
-            rc = shClSvcClientWakeup(pClient);
-
-            shClSvcClientUnlock(pClient);
-
+            rc = ShClTransferTransformPath(pCreateParms->pszPath, pCreateParms->cbPath);
             if (RT_SUCCESS(rc))
             {
-                int               rcEvent;
-                PSHCLEVENTPAYLOAD pPayload;
-                rc = ShClEventWaitEx(pEvent, pCtx->pTransfer->uTimeoutMs, &rcEvent, &pPayload);
+                const uint32_t cbPath = (uint32_t)strlen(pCreateParms->pszPath) + 1; /* Include terminating zero */
+
+                HGCMSvcSetU64(&pMsg->aParms[0], VBOX_SHCL_CONTEXTID_MAKE(pClient->State.uSessionID,
+                                                                         pCtx->pTransfer->State.uID, pEvent->idEvent));
+                HGCMSvcSetU64(&pMsg->aParms[1], 0); /* uHandle */
+                HGCMSvcSetPv (&pMsg->aParms[2], pCreateParms->pszPath, cbPath);
+                HGCMSvcSetU32(&pMsg->aParms[3], pCreateParms->fCreate);
+
+                shClSvcClientLock(pClient);
+
+                shClSvcMsgAdd(pClient, pMsg, true /* fAppend */);
+                rc = shClSvcClientWakeup(pClient);
+
+                shClSvcClientUnlock(pClient);
+
                 if (RT_SUCCESS(rc))
                 {
-                    Assert(pPayload->cbData == sizeof(SHCLREPLY));
-
-                    PSHCLREPLY pReply = (PSHCLREPLY)pPayload->pvData;
-                    AssertPtr(pReply);
-
-                    Assert(pReply->uType == VBOX_SHCL_TX_REPLYMSGTYPE_OBJ_OPEN);
-
-                    LogFlowFunc(("hObj=%RU64\n", pReply->u.ObjOpen.uHandle));
-
-                    *phObj = pReply->u.ObjOpen.uHandle;
-
-                    ShClPayloadFree(pPayload);
+                    int               rcEvent;
+                    PSHCLEVENTPAYLOAD pPayload;
+                    rc = ShClEventWaitEx(pEvent, pCtx->pTransfer->uTimeoutMs, &rcEvent, &pPayload);
+                    if (RT_SUCCESS(rc))
+                    {
+                        Assert(pPayload->cbData == sizeof(SHCLREPLY));
+
+                        PSHCLREPLY pReply = (PSHCLREPLY)pPayload->pvData;
+                        AssertPtr(pReply);
+
+                        Assert(pReply->uType == VBOX_SHCL_TX_REPLYMSGTYPE_OBJ_OPEN);
+
+                        LogFlowFunc(("hObj=%RU64\n", pReply->u.ObjOpen.uHandle));
+
+                        *phObj = pReply->u.ObjOpen.uHandle;
+
+                        ShClPayloadFree(pPayload);
+                    }
+                    else
+                        rc = rcEvent;
                 }
-                else
-                    rc = rcEvent;
             }