Changeset 81212 in vbox for trunk/src/VBox/GuestHost/SharedClipboard

Timestamp:

Oct 10, 2019 12:22:34 PM (6 years ago)

Author:

vboxsync

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

133874

Message:

Shared Clipboard/Transfers: Update.

Location:

trunk/src/VBox/GuestHost/SharedClipboard

Files:

• clipboard-transfers.cpp (modified) (17 diffs)
• clipboard-win.cpp (modified) (3 diffs)

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

@@ -131 +131 @@
  *
  * @returns VBox status code.
- * @param   pListEntry          Clipboard root list entry to copy.
+ * @param   pDst                Where to copy the source root list entry to.
+ * @param   pSrc                Source root list entry to copy.
  */
 int SharedClipboardTransferRootListEntryCopy(PSHCLROOTLISTENTRY pDst, PSHCLROOTLISTENTRY pSrc)
@@ -139 +140 @@
 
 /**
+ * Initializes a clipboard root list entry structure.
+ *
+ * @param   pRootListEntry      Clipboard root list entry structure to destroy.
+ */
+int SharedClipboardTransferRootListEntryInit(PSHCLROOTLISTENTRY pRootListEntry)
+{
+    return SharedClipboardTransferListEntryInit(pRootListEntry);
+}
+
+/**
+ * Destroys a clipboard root list entry structure.
+ *
+ * @param   pRootListEntry      Clipboard root list entry structure to destroy.
+ */
+void SharedClipboardTransferRootListEntryDestroy(PSHCLROOTLISTENTRY pRootListEntry)
+{
+    return SharedClipboardTransferListEntryDestroy(pRootListEntry);
+}
+
+/**
  * Duplicates (allocates) a clipboard root list entry structure.
  *
  * @returns Duplicated clipboard root list entry structure on success.
- * @param   pListEntry          Clipboard root list entry to duplicate.
+ * @param   pRootListEntry      Clipboard root list entry to duplicate.
  */
 PSHCLROOTLISTENTRY SharedClipboardTransferRootListEntryDup(PSHCLROOTLISTENTRY pRootListEntry)
 {
     return SharedClipboardTransferListEntryDup(pRootListEntry);
-}
-
-/**
- * Destroys a clipboard root list entry structure.
- *
- * @param   pListEntry          Clipboard root list entry structure to destroy.
- */
-void SharedClipboardTransferRootListEntryDestroy(PSHCLROOTLISTENTRY pRootListEntry)
-{
-    return SharedClipboardTransferListEntryDestroy(pRootListEntry);
 }
 
@@ -517 +528 @@
 
     pListEntry->cbName = SHCLLISTENTRY_MAX_NAME;
-    pListEntry->pvInfo = NULL;
-    pListEntry->cbInfo = 0;
-    pListEntry->fInfo  = 0;
-
-    return VINF_SUCCESS;
+
+    pListEntry->pvInfo = (PSHCLFSOBJINFO)RTMemAlloc(sizeof(SHCLFSOBJINFO));
+    if (pListEntry->pvInfo)
+    {
+        pListEntry->cbInfo = sizeof(SHCLFSOBJINFO);
+        pListEntry->fInfo  = VBOX_SHCL_INFO_FLAG_FSOBJINFO;
+
+        return VINF_SUCCESS;
+    }
+
+    return VERR_NO_MEMORY;
 }
 
@@ -607 +624 @@
 
 /**
+ * Initializes an object handle info structure.
+ *
+ * @returns VBox status code.
+ * @param   pInfo               Object handle info structure to initialize.
+ */
+int SharedClipboardTransferObjectHandleInfoInit(PSHCLOBJHANDLEINFO pInfo)
+{
+    AssertPtrReturn(pInfo, VERR_INVALID_POINTER);
+
+    pInfo->hObj    = SHCLOBJHANDLE_INVALID;
+    pInfo->enmType = SHCLOBJTYPE_INVALID;
+
+    pInfo->pszPathLocalAbs = NULL;
+
+    RT_ZERO(pInfo->u);
+
+    return VINF_SUCCESS;
+}
+
+/**
  * Destroys an object handle info structure.
  *
@@ -743 +780 @@
         if (pInfo)
         {
-            const bool fWritable = true; /** @todo Fix this. */
-
-            uint64_t fOpen;
-            rc = sharedClipboardConvertFileCreateFlags(fWritable,
-                                                       pOpenCreateParms->fCreate, pOpenCreateParms->ObjInfo.Attr.fMode,
-                                                       SHCLOBJHANDLE_INVALID, &fOpen);
+            rc = SharedClipboardTransferObjectHandleInfoInit(pInfo);
             if (RT_SUCCESS(rc))
             {
-                char *pszPathAbs = RTStrAPrintf2("%s/%s", pTransfer->pszPathRootAbs, pOpenCreateParms->pszPath);
-                if (pszPathAbs)
+                const bool fWritable = true; /** @todo Fix this. */
+
+                uint64_t fOpen;
+                rc = sharedClipboardConvertFileCreateFlags(fWritable,
+                                                           pOpenCreateParms->fCreate, pOpenCreateParms->ObjInfo.Attr.fMode,
+                                                           SHCLOBJHANDLE_INVALID, &fOpen);
+                if (RT_SUCCESS(rc))
                 {
-                    LogFlowFunc(("%s\n", pszPathAbs));
-
-                    rc = RTFileOpen(&pInfo->u.Local.hFile, pszPathAbs, fOpen);
-                    RTStrFree(pszPathAbs);
+                    char *pszPathAbs = RTStrAPrintf2("%s/%s", pTransfer->pszPathRootAbs, pOpenCreateParms->pszPath);
+                    if (pszPathAbs)
+                    {
+                        LogFlowFunc(("%s\n", pszPathAbs));
+
+                        rc = RTFileOpen(&pInfo->u.Local.hFile, pszPathAbs, fOpen);
+                        RTStrFree(pszPathAbs);
+                    }
+                    else
+                        rc = VERR_NO_MEMORY;
                 }
-                else
-                    rc = VERR_NO_MEMORY;
             }
 
@@ -772 +813 @@
                 *phObj = pInfo->hObj;
             }
-
-            if (RT_FAILURE(rc))
+            else
+            {
+                SharedClipboardTransferObjectHandleInfoDestroy(pInfo);
                 RTMemFree(pInfo);
+            }
         }
         else
@@ -1746 +1789 @@
                                 && !fSkipEntry)
                             {
-                                pEntry->pvInfo = (PSHCLFSOBJINFO)RTMemAlloc(sizeof(SHCLFSOBJINFO));
-                                if (pEntry->pvInfo)
+                                rc = RTStrCopy(pEntry->pszName, pEntry->cbName, pDirEntry->szName);
+                                if (RT_SUCCESS(rc))
                                 {
-                                    rc = RTStrCopy(pEntry->pszName, pEntry->cbName, pDirEntry->szName);
-                                    if (RT_SUCCESS(rc))
-                                    {
-                                        SharedClipboardFsObjFromIPRT(PSHCLFSOBJINFO(pEntry->pvInfo), &pDirEntry->Info);
-
-                                        pEntry->cbInfo = sizeof(SHCLFSOBJINFO);
-                                        pEntry->fInfo  = VBOX_SHCL_INFO_FLAG_FSOBJINFO;
-                                    }
+                                    AssertPtr(pEntry->pvInfo);
+                                    Assert   (pEntry->cbInfo == sizeof(SHCLFSOBJINFO));
+
+                                    SharedClipboardFsObjFromIPRT(PSHCLFSOBJINFO(pEntry->pvInfo), &pDirEntry->Info);
                                 }
-                                else
-                                    rc = VERR_NO_MEMORY;
                             }
 
@@ -2033 +2070 @@
                 {
                     RTFSOBJINFO fsObjInfo;
-                    rc = RTPathQueryInfo(pcszSrcPath, & fsObjInfo, RTFSOBJATTRADD_NOTHING);
+                    rc = RTPathQueryInfo(pcszSrcPath, &fsObjInfo, RTFSOBJATTRADD_NOTHING);
                     if (RT_SUCCESS(rc))
                     {
                         SharedClipboardFsObjFromIPRT(PSHCLFSOBJINFO(pEntry->pvInfo), &fsObjInfo);
 
-                        pEntry->fInfo  = VBOX_SHCL_INFO_FLAG_FSOBJINFO;
+                        pEntry->fInfo = VBOX_SHCL_INFO_FLAG_FSOBJINFO;
                     }
                 }
@@ -2247 +2284 @@
 
 /**
- * Starts (runs) a Shared Clipboard transfer in a dedicated thread.
+ * Runs a started Shared Clipboard transfer in a dedicated thread.
  *
  * @returns VBox status code.
  * @param   pTransfer           Clipboard transfer to run.
  * @param   pfnThreadFunc       Pointer to thread function to use.
- * @param   pvUser              Pointer to user-provided data.
+ * @param   pvUser              Pointer to user-provided data. Optional.
  */
 int SharedClipboardTransferRun(PSHCLTRANSFER pTransfer, PFNRTTHREAD pfnThreadFunc, void *pvUser)
 {
-    AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
-
-    int rc = SharedClipboardTransferStart(pTransfer);
-    if (RT_SUCCESS(rc))
-        rc = sharedClipboardTransferThreadCreate(pTransfer, pfnThreadFunc, pvUser);
+    AssertPtrReturn(pTransfer,     VERR_INVALID_POINTER);
+    AssertPtrReturn(pfnThreadFunc, VERR_INVALID_POINTER);
+    /* pvUser is optional. */
+
+    AssertMsgReturn(pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED,
+                    ("Wrong status (currently is %s)\n", VBoxShClTransferStatusToStr(pTransfer->State.enmStatus)),
+                    VERR_WRONG_ORDER);
+
+    int rc = sharedClipboardTransferThreadCreate(pTransfer, pfnThreadFunc, pvUser);
 
     LogFlowFuncLeaveRC(rc);
@@ -2275 +2316 @@
 {
     AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
+
+    LogFlowFuncEnter();
 
     /* Ready to start? */
@@ -2291 +2334 @@
         rc = VINF_SUCCESS;
 
-    /* Nothing else to do here right now. */
+    if (RT_SUCCESS(rc))
+    {
+        pTransfer->State.enmStatus = SHCLTRANSFERSTATUS_STARTED;
+    }
 
     LogFlowFuncLeaveRC(rc);
@@ -2342 +2388 @@
     AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
 
+    /* Already marked for stopping? */
+    AssertMsgReturn(pTransfer->Thread.fStop == false,
+                    ("Thransfer thread already marked for stopping"), VERR_WRONG_ORDER);
+    /* Already started? */
+    AssertMsgReturn(pTransfer->Thread.fStarted == false,
+                    ("Thransfer thread already started"), VERR_WRONG_ORDER);
+
     /* Spawn a worker thread, so that we don't block the window thread for too long. */
     int rc = RTThreadCreate(&pTransfer->Thread.hThread, pfnThreadFunc,
@@ -2353 +2406 @@
         if (pTransfer->Thread.fStarted) /* Did the thread indicate that it started correctly? */
         {
-            pTransfer->State.enmStatus = SHCLTRANSFERSTATUS_STARTED;
+            /* Nothing to do in here. */
         }
         else
@@ -2391 +2444 @@
 
 /**
- * Initializes a Shared Clipboard transfer.
+ * Initializes a Shared Clipboard transfer context.
  *
  * @returns VBox status code.
@@ -2407 +2460 @@
         RTListInit(&pTransferCtx->List);
 
+        pTransferCtx->cTransfers  = 0;
         pTransferCtx->cRunning    = 0;
-        pTransferCtx->cMaxRunning = UINT16_MAX;
+        pTransferCtx->cMaxRunning = UINT16_MAX; /** @todo Make this configurable? */
 
         RT_ZERO(pTransferCtx->bmTransferIds);
@@ -2419 +2473 @@
 
 /**
- * Destroys a shared Clipboard transfer context context struct.
+ * Destroys a shared Clipboard transfer context struct.
  *
  * @param   pTransferCtx                Transfer context to destroy.
@@ -2642 +2696 @@
                  pTransferCtx, pTransferCtx->cTransfers, pTransferCtx->cRunning));
 
-    if (!RTListIsEmpty(&pTransferCtx->List))
-    {
-        /* Remove all transfers which are not in a running state (e.g. only announced). */
-        PSHCLTRANSFER pTransfer, pTransferNext;
-        RTListForEachSafe(&pTransferCtx->List, pTransfer, pTransferNext, SHCLTRANSFER, Node)
-        {
-            if (SharedClipboardTransferGetStatus(pTransfer) != SHCLTRANSFERSTATUS_STARTED)
-            {
-                SharedClipboardTransferDestroy(pTransfer);
-                RTListNodeRemove(&pTransfer->Node);
-
-                RTMemFree(pTransfer);
-                pTransfer = NULL;
-
-                Assert(pTransferCtx->cTransfers);
-                pTransferCtx->cTransfers--;
-            }
+    if (pTransferCtx->cTransfers == 0)
+        return;
+
+    /* Remove all transfers which are not in a running state (e.g. only announced). */
+    PSHCLTRANSFER pTransfer, pTransferNext;
+    RTListForEachSafe(&pTransferCtx->List, pTransfer, pTransferNext, SHCLTRANSFER, Node)
+    {
+        if (SharedClipboardTransferGetStatus(pTransfer) != SHCLTRANSFERSTATUS_STARTED)
+        {
+            SharedClipboardTransferDestroy(pTransfer);
+            RTListNodeRemove(&pTransfer->Node);
+
+            RTMemFree(pTransfer);
+            pTransfer = NULL;
+
+            Assert(pTransferCtx->cTransfers);
+            pTransferCtx->cTransfers--;
         }
     }

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

@@ -459 +459 @@
         LogFlowFunc(("fFormats=0x%08X\n", fFormats));
 
-        pFormats->uFormats   = fFormats;
-        pFormats->fFlags = 0; /** @todo Handle flags. */
+        pFormats->uFormats = fFormats;
+        pFormats->fFlags   = 0; /** @todo Handle flags. */
     }
 
@@ -889 +889 @@
  * @returns VBox status code.
  * @param   pWinCtx             Windows context to use.
- * @param   pTransferCtxCtx             transfer contextto use.
+ * @param   pTransferCtxCtx     Transfer contextto use.
  * @param   pTransfer           Shared Clipboard transfer to use.
  */
@@ -1003 +1003 @@
 
 /**
+ * Retrieves the roots for a transfer by opening the clipboard and getting the clipboard data
+ * as string list (CF_HDROP), assigning it to the transfer as roots then.
+ *
+ * @returns VBox status code.
+ * @param   pWinCtx             Windows context to use.
+ * @param   pTransfer           Transfer to get roots for.
+ */
+int SharedClipboardWinGetRoots(PSHCLWINCTX pWinCtx, PSHCLTRANSFER pTransfer)
+{
+    AssertPtrReturn(pWinCtx,   VERR_INVALID_POINTER);
+    AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
+
+    Assert(SharedClipboardTransferGetSource(pTransfer) == SHCLSOURCE_LOCAL); /* Sanity. */
+
+    int rc = SharedClipboardWinOpen(pWinCtx->hWnd);
+    if (RT_SUCCESS(rc))
+    {
+        /* The data data in CF_HDROP format, as the files are locally present and don't need to be
+         * presented as a IDataObject or IStream. */
+        HANDLE hClip = hClip = GetClipboardData(CF_HDROP);
+        if (hClip)
+        {
+            HDROP hDrop = (HDROP)GlobalLock(hClip);
+            if (hDrop)
+            {
+                char    *papszList = NULL;
+                uint32_t cbList;
+                rc = SharedClipboardWinDropFilesToStringList((DROPFILES *)hDrop, &papszList, &cbList);
+
+                GlobalUnlock(hClip);
+
+                if (RT_SUCCESS(rc))
+                {
+                    rc = SharedClipboardTransferRootsSet(pTransfer,
+                                                         papszList, cbList + 1 /* Include termination */);
+                    RTStrFree(papszList);
+                }
+            }
+            else
+                LogRel(("Shared Clipboard: Unable to lock clipboard data, last error: %ld\n", GetLastError()));
+        }
+        else
+            LogRel(("Shared Clipboard: Unable to retrieve clipboard data from clipboard (CF_HDROP), last error: %ld\n",
+                    GetLastError()));
+
+        SharedClipboardWinClose();
+    }
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+
+/**
  * Converts a DROPFILES (HDROP) structure to a string list, separated by \r\n.
  * Does not do any locking on the input data.