Changeset 100676 in vbox for trunk

Timestamp:

Jul 21, 2023 11:26:04 AM (21 months ago)

Author:

vboxsync

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

158516

Message:

Shared Clipboard: HTTP transfers with multiple files are also working now. bugref:9437

Location:

trunk

Files:

• include/VBox/GuestHost/SharedClipboard-transfers.h (modified) (2 diffs)
• src/VBox/Additions/x11/VBoxClient/clipboard-x11.cpp (modified) (3 diffs)
• src/VBox/GuestHost/SharedClipboard/clipboard-transfers-http.cpp (modified) (8 diffs)
• src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp (modified) (3 diffs)
• src/VBox/GuestHost/SharedClipboard/testcase/tstClipboardHttpServer.cpp (modified) (2 diffs)
• src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-x11.cpp (modified) (2 diffs)

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

@@ -1188 +1188 @@
 int ShClTransferSetProvider(PSHCLTRANSFER pTransfer, PSHCLTXPROVIDER pProvider);
 
+int ShClTransferRootsInitFromStringListEx(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots, const char *pszSep);
 int ShClTransferRootsInitFromStringList(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots);
 int ShClTransferRootsInitFromStringListUnicode(PSHCLTRANSFER pTransfer, PRTUTF16 pwszRoots, size_t cbRoots);
@@ -1243 +1244 @@
 uint32_t ShClTransferHttpServerGetTransferCount(PSHCLHTTPSERVER pSrv);
 char *ShClTransferHttpServerGetAddressA(PSHCLHTTPSERVER pSrv);
-char *ShClTransferHttpServerGetUrlA(PSHCLHTTPSERVER pSrv, SHCLTRANSFERID idTransfer);
+char *ShClTransferHttpServerGetUrlA(PSHCLHTTPSERVER pSrv, SHCLTRANSFERID idTransfer, uint64_t idxEntry);
 bool ShClTransferHttpServerIsInitialized(PSHCLHTTPSERVER pSrv);
 bool ShClTransferHttpServerIsRunning(PSHCLHTTPSERVER pSrv);

trunk/src/VBox/Additions/x11/VBoxClient/clipboard-x11.cpp

@@ -95 +95 @@
                             PSHCLX11RESPONSE pResp = (PSHCLX11RESPONSE)pPayload->pvData;
 
-                            rc = ShClTransferRootsInitFromStringList(pTransfer, (const char *)pResp->Read.pvData, pResp->Read.cbData);
+                            rc = ShClTransferRootsInitFromStringListEx(pTransfer, (const char *)pResp->Read.pvData, pResp->Read.cbData,
+                                                                       "\n" /* X11-based Desktop environments separate entries with "\n" */);
 
                             RTMemFree(pResp->Read.pvData);
@@ -329 +330 @@
                         if (RT_SUCCESS(rc))
                         {
-                            char *pszURL = ShClTransferHttpServerGetUrlA(pSrv, pTransfer->State.uID);
-                            if (pszURL)
+                            char *pszURL = NULL;
+
+                            uint64_t const cRoots = ShClTransferRootsCount(pTransfer);
+                            for (uint32_t i = 0; i < cRoots; i++)
+                            {
+                                char *pszEntry = ShClTransferHttpServerGetUrlA(pSrv, ShClTransferGetID(pTransfer), i /* Entry index */);
+                                AssertPtrBreakStmt(pszEntry, rc = VERR_NO_MEMORY);
+
+                                if (i > 0)
+                                {
+                                    rc = RTStrAAppend(&pszURL, "\n"); /* Separate entries with a newline. */
+                                    AssertRCBreak(rc);
+                                }
+
+                                rc = RTStrAAppend(&pszURL, pszEntry);
+                                AssertRCBreak(rc);
+
+                                RTStrFree(pszEntry);
+                            }
+
+                            if (RT_SUCCESS(rc))
                             {
                                 *ppv = pszURL;
@@ -339 +359 @@
                                 /* ppv has ownership of pszURL. */
                             }
-                            else
-                                rc = VERR_NO_MEMORY;
                         }
                     }

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

@@ -69 +69 @@
 *********************************************************************************************************************************/
 
-#ifdef DEBUG_andy
+#ifdef DEBUG_andy_0
 /** When enabled, this lets the HTTP server run at a predictable URL and port for debugging:
  *  URL: http://localhost:49200/transfer<ID> */
@@ -401 +401 @@
     RT_NOREF(ppszMIMEHint);
 
+    AssertReturn(RTStrIsValidEncoding(pReq->pszUrl), VERR_INVALID_PARAMETER);
+
+    size_t const cchUrl  = strlen(pReq->pszUrl);
+    AssertReturn(cchUrl, VERR_INVALID_PARAMETER);
+
     int rc;
 
+    /* For now we only know the transfer -- now we need to figure out the entry we want to serve. */
     PSHCLHTTPSERVERTRANSFER pSrvTx = (PSHCLHTTPSERVERTRANSFER)pReq->pvUser;
     if (pSrvTx)
     {
+        size_t const cchBase = strlen(pSrvTx->szPathVirtual) + 1 /* Skip slash separating the base from the rest */;
+        AssertReturn(cchUrl >= cchBase, VERR_INVALID_PARAMETER);
+
         SHCLOBJOPENCREATEPARMS openParms;
         rc = ShClTransferObjOpenParmsInit(&openParms);
@@ -416 +425 @@
             AssertPtr(pTx);
 
-            /** @todo For now we only serve single files, hence index 0 below. */
-            PCSHCLLISTENTRY pEntry = ShClTransferRootsEntryGet(pTx, 0 /* First file */);
-            if (pEntry)
+            rc = VERR_NOT_FOUND; /* Must find the matching root entry first. */
+
+            uint64_t const cRoots = ShClTransferRootsCount(pTx);
+            for (uint32_t i = 0; i < cRoots; i++)
             {
+                PCSHCLLISTENTRY pEntry = ShClTransferRootsEntryGet(pTx, i);
+                AssertPtrBreakStmt(pEntry, rc = VERR_NOT_FOUND);
+
+                const char *pszName = pReq->pszUrl + cchBase;
+
+                Log3Func(("pReqUrl=%s -> pszName=%s vs. pEntry=%s\n", pReq->pszUrl, pszName, pEntry->pszName));
+
+                if (RTStrCmp(pEntry->pszName, pszName)) /* Case-sensitive! */
+                    continue;
+
                 LogRel2(("Shared Clipboard: Querying HTTP transfer information for '%s' ...\n", pEntry->pszName));
 
@@ -449 +469 @@
                     }
                 }
+
+                break;
             }
-            else
-                rc = VERR_NOT_FOUND;
 
             ShClTransferObjOpenParmsDestroy(&openParms);
@@ -856 +876 @@
     uint64_t const cRoots = ShClTransferRootsCount(pTransfer);
     AssertMsgReturn(cRoots  > 0, ("Transfer has no root entries\n"), VERR_INVALID_PARAMETER);
-    AssertMsgReturn(cRoots == 1, ("Only single files are supported for now\n"), VERR_NOT_SUPPORTED);
     /** @todo Check for directories? */
 
@@ -875 +894 @@
             AssertRCReturn(rc, rc);
 
-            PCSHCLLISTENTRY pEntry = ShClTransferRootsEntryGet(pTransfer, 0 /* First file */);
-            if (pEntry)
-            {
-                /* Create the virtual HTTP path for the transfer.
-                 * Every transfer has a dedicated HTTP path (but live in the same URL namespace). */
-                char *pszPath;
+            /* Create the virtual HTTP path for the transfer.
+             * Every transfer has a dedicated HTTP path (but live in the same URL namespace). */
+            char *pszPath;
 #ifdef VBOX_SHCL_DEBUG_HTTPSERVER
 # ifdef DEBUG_andy /** Too lazy to specify a different transfer ID for debugging. */
-                ssize_t cch = RTStrAPrintf(&pszPath, "//transfer");
+            ssize_t cch = RTStrAPrintf(&pszPath, "//transfer");
 # else
-                ssize_t cch = RTStrAPrintf(&pszPath, "//transfer%RU16", pTransfer->State.uID);
+            ssize_t cch = RTStrAPrintf(&pszPath, "//transfer%RU16", pTransfer->State.uID);
 # endif
 #else /* Release mode */
-                ssize_t cch = RTStrAPrintf(&pszPath, "//%s/%s/%s", SHCL_HTTPT_URL_NAMESPACE, szUuid, pEntry->pszName);
+            ssize_t cch = RTStrAPrintf(&pszPath, "//%s/%s", SHCL_HTTPT_URL_NAMESPACE, szUuid);
 #endif
-                AssertReturn(cch, VERR_NO_MEMORY);
-
-                const char   szScheme[] = "http"; /** @todo For now we only support HTTP. */
-                const size_t cchScheme  = strlen(szScheme) + 3 /* "://" */;
-
-                char *pszURI = RTUriCreate(szScheme, NULL /* pszAuthority */, pszPath, NULL /* pszQuery */, NULL /* pszFragment */);
-                if (pszURI)
+            AssertReturn(cch, VERR_NO_MEMORY);
+
+            const char   szScheme[] = "http"; /** @todo For now we only support HTTP. */
+            const size_t cchScheme  = strlen(szScheme) + 3 /* "://" */;
+
+            char *pszURI = RTUriCreate(szScheme, NULL /* pszAuthority */, pszPath, NULL /* pszQuery */, NULL /* pszFragment */);
+            if (pszURI)
+            {
+                if (strlen(pszURI) >= cchScheme)
                 {
-                    if (strlen(pszURI) >= cchScheme)
-                    {
-                        /* For the virtual path we only keep everything after the full scheme (e.g. "http://").
-                         * The virtual path always has to start with a "/". */
-                        if (RTStrPrintf2(pSrvTx->szPathVirtual, sizeof(pSrvTx->szPathVirtual), "/%s", pszURI + cchScheme) <= 0)
-                            rc = VERR_BUFFER_OVERFLOW;
-                    }
-                    else
-                        rc = VERR_INVALID_PARAMETER;
-
-                    RTStrFree(pszURI);
-                    pszURI = NULL;
+                    /* For the virtual path we only keep everything after the full scheme (e.g. "http://").
+                     * The virtual path always has to start with a "/". */
+                    if (RTStrPrintf2(pSrvTx->szPathVirtual, sizeof(pSrvTx->szPathVirtual), "/%s", pszURI + cchScheme) <= 0)
+                        rc = VERR_BUFFER_OVERFLOW;
                 }
                 else
-                    rc = VERR_NO_MEMORY;
-
-                RTStrFree(pszPath);
-                pszPath = NULL;
-
-                AssertRCReturn(rc, rc);
-
-                pSrvTx->pTransfer = pTransfer;
-                pSrvTx->hObj      = NIL_SHCLOBJHANDLE;
-
-                RTListAppend(&pSrv->lstTransfers, &pSrvTx->Node);
-                pSrv->cTransfers++;
-
-                shclTransferHttpServerSetStatusLocked(pSrv, SHCLHTTPSERVERSTATUS_TRANSFER_REGISTERED);
-
-                LogFunc(("pTransfer=%p, idTransfer=%RU16, szPath=%s -> %RU32 transfers\n",
-                         pSrvTx->pTransfer, pSrvTx->pTransfer->State.uID, pSrvTx->szPathVirtual, pSrv->cTransfers));
-
-                LogRel2(("Shared Clipboard: Registered HTTP transfer %RU16, now %RU32 HTTP transfers total\n",
-                         pTransfer->State.uID, pSrv->cTransfers));
+                    rc = VERR_INVALID_PARAMETER;
+
+                RTStrFree(pszURI);
+                pszURI = NULL;
             }
+            else
+                rc = VERR_NO_MEMORY;
+
+            RTStrFree(pszPath);
+            pszPath = NULL;
+
+            AssertRCReturn(rc, rc);
+
+            pSrvTx->pTransfer = pTransfer;
+            pSrvTx->hObj      = NIL_SHCLOBJHANDLE;
+
+            RTListAppend(&pSrv->lstTransfers, &pSrvTx->Node);
+            pSrv->cTransfers++;
+
+            shclTransferHttpServerSetStatusLocked(pSrv, SHCLHTTPSERVERSTATUS_TRANSFER_REGISTERED);
+
+            LogFunc(("pTransfer=%p, idTransfer=%RU16, szPath=%s -> %RU32 transfers\n",
+                     pSrvTx->pTransfer, pSrvTx->pTransfer->State.uID, pSrvTx->szPathVirtual, pSrv->cTransfers));
+
+            LogRel2(("Shared Clipboard: Registered HTTP transfer %RU16, now %RU32 HTTP transfers total\n",
+                     pTransfer->State.uID, pSrv->cTransfers));
         }
+
     }
 
@@ -1126 +1142 @@
  * @param   pSrv                HTTP server instance to return URL for.
  * @param   idTransfer          Transfer ID to return the URL for.
- */
-char *ShClTransferHttpServerGetUrlA(PSHCLHTTPSERVER pSrv, SHCLTRANSFERID idTransfer)
+ * @param   idxEntry            Index of transfer entry to return URL for.
+ */
+char *ShClTransferHttpServerGetUrlA(PSHCLHTTPSERVER pSrv, SHCLTRANSFERID idTransfer, uint64_t idxEntry)
 {
     AssertPtrReturn(pSrv, NULL);
@@ -1142 +1159 @@
     }
 
-    AssertReturn(RTStrNLen(pSrvTx->szPathVirtual, RTPATH_MAX), NULL);
-    char *pszUrl = RTStrAPrintf2("%s:%RU16%s", shClTransferHttpServerGetHost(pSrv), pSrv->uPort, pSrvTx->szPathVirtual);
-    AssertPtr(pszUrl);
-
-    shClTransferHttpServerUnlock(pSrv);
+    PSHCLTRANSFER pTx = pSrvTx->pTransfer;
+    AssertPtr(pTx);
+
+    char *pszUrl = NULL;
+
+    /* For now this only supports root entries. */
+    PCSHCLLISTENTRY pEntry = ShClTransferRootsEntryGet(pTx, idxEntry);
+    if (pEntry)
+    {
+        AssertReturn(RTStrNLen(pSrvTx->szPathVirtual, RTPATH_MAX), NULL);
+        pszUrl = RTStrAPrintf2("%s:%RU16%s/%s", shClTransferHttpServerGetHost(pSrv), pSrv->uPort, pSrvTx->szPathVirtual, pEntry->pszName);
+        AssertPtr(pszUrl);
+
+        shClTransferHttpServerUnlock(pSrv);
+    }
 
     return pszUrl;

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

@@ -1811 +1811 @@
 
 /**
- * Initializes the root list entries for a given clipboard transfer.
+ * Initializes the root list entries for a given clipboard transfer, extended version.
  *
  * @returns VBox status code.
  * @param   pTransfer           Transfer to set transfer list entries for.
- * @param   pszRoots            String list (separated by CRLF) of root entries to set.
+ * @param   pszRoots            String list (separated by \a pszSep) of root entries to set.
  *                              All entries must have the same root path.
  * @param   cbRoots             Size (in bytes) of string list. Includes zero terminator.
+ * @param   pszSep              String separator to use for splitting up the root entries.
  *
  * @note    Accepts local paths or URI string lists (absolute only).
  */
-int ShClTransferRootsInitFromStringList(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots)
+int ShClTransferRootsInitFromStringListEx(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots, const char *pszSep)
 {
     AssertPtrReturn(pTransfer,      VERR_INVALID_POINTER);
     AssertPtrReturn(pszRoots,       VERR_INVALID_POINTER);
     AssertReturn(cbRoots,           VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pszSep,         VERR_INVALID_POINTER);
 
 #ifdef DEBUG_andy
@@ -1843 +1845 @@
     char     *pszPathRootAbs = NULL;
 
-    RTCList<RTCString> lstRootEntries = RTCString(pszRoots, cbRoots).split(SHCL_TRANSFER_URI_LIST_SEP_STR);
+    RTCList<RTCString> lstRootEntries = RTCString(pszRoots, cbRoots).split(pszSep);
     if (!lstRootEntries.size())
     {
@@ -1971 +1973 @@
     LogFlowFuncLeaveRC(rc);
     return rc;
+}
+
+/**
+ * Initializes the root list entries for a given clipboard transfer.
+ *
+ * @returns VBox status code.
+ * @param   pTransfer           Transfer to set transfer list entries for.
+ * @param   pszRoots            String list (separated by SHCL_TRANSFER_URI_LIST_SEP_STR) of root entries to set.
+ *                              All entries must have the same root path.
+ * @param   cbRoots             Size (in bytes) of string list. Includes zero terminator.
+ *
+ * @note    Accepts local paths or URI string lists (absolute only).
+ */
+int ShClTransferRootsInitFromStringList(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots)
+{
+    return ShClTransferRootsInitFromStringListEx(pTransfer, pszRoots, cbRoots, SHCL_TRANSFER_URI_LIST_SEP_STR);
 }
 

trunk/src/VBox/GuestHost/SharedClipboard/testcase/tstClipboardHttpServer.cpp

@@ -251 +251 @@
 
                 uint16_t const uID    = ShClTransferGetID(pTx);
-                char          *pszURL = ShClTransferHttpServerGetUrlA(&HttpSrv, uID);
+                char          *pszURL = ShClTransferHttpServerGetUrlA(&HttpSrv, uID, 0 /* Entry index */);
                 RTTEST_CHECK(hTest, pszURL != NULL);
                 RTTestPrintf(hTest, RTTESTLVL_ALWAYS, "URL #%02RU32: %s\n", i, pszURL);
@@ -275 +275 @@
 
                         uint16_t const uID    = ShClTransferGetID(pTx);
-                        char          *pszURL = ShClTransferHttpServerGetUrlA(&HttpSrv, uID);
+                        char          *pszURL = ShClTransferHttpServerGetUrlA(&HttpSrv, uID, 0 /* Entry index */);
                         RTTEST_CHECK(hTest, pszURL != NULL);
                         RTTestPrintf(hTest, RTTESTLVL_ALWAYS, "Downloading: %s -> %s\n", pszURL, szFileTemp);

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

@@ -615 +615 @@
                     if (RT_SUCCESS(rc))
                     {
-                        char *pszURL = ShClTransferHttpServerGetUrlA(pHttpSrv, pTransfer->State.uID);
-                        if (pszURL)
+                        char *pszURL = NULL;
+
+                        uint64_t const cRoots = ShClTransferRootsCount(pTransfer);
+                        for (uint32_t i = 0; i < cRoots; i++)
+                        {
+                            char *pszEntry = ShClTransferHttpServerGetUrlA(pHttpSrv, ShClTransferGetID(pTransfer), i /* Entry index */);
+                            AssertPtrBreakStmt(pszEntry, rc = VERR_NO_MEMORY);
+
+                            if (i > 0)
+                            {
+                                rc = RTStrAAppend(&pszURL, "\n"); /* Separate entries with a newline. */
+                                AssertRCBreak(rc);
+                            }
+
+                            rc = RTStrAAppend(&pszURL, pszEntry);
+                            AssertRCBreak(rc);
+
+                            RTStrFree(pszEntry);
+                        }
+
+                        if (RT_SUCCESS(rc))
                         {
                             *ppv = pszURL;
@@ -624 +643 @@
 
                             /* ppv has ownership of pszURL. */
-
-                            rc = VINF_SUCCESS;
                         }
-                        else
-                            rc = VERR_NO_MEMORY;
                     }
 # else