Changeset 80845 in vbox for trunk/src/VBox/Additions/WINNT/VBoxTray

Timestamp:

Sep 17, 2019 9:05:21 AM (5 years ago)

Author:

vboxsync

Message:

Shared Clipboard/URI: More code for transfer channel handling.

File:

• trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp (modified) (27 diffs)

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp

@@ -55 +55 @@
 {
     /** Pointer to the VBoxClient service environment. */
-    const VBOXSERVICEENV    *pEnv;
+    const VBOXSERVICEENV *pEnv;
     /** Command context. */
-    VBGLR3SHCLCMDCTX         CmdCtx;
+    VBGLR3SHCLCMDCTX      CmdCtx;
     /** Windows-specific context data. */
-    SHCLWINCTX      Win;
-#ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
-    /** URI transfer data. */
-    SHCLURICTX    URI;
+    SHCLWINCTX            Win;
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
+    /** Associated transfer data. */
+    SHCLURICTX            URI;
 #endif
 } SHCLCONTEXT, *PSHCLCONTEXT;
@@ -69 +69 @@
 typedef struct _SHCLURIREADTHREADCTX
 {
-    PSHCLCONTEXT       pClipboardCtx;
+    PSHCLCONTEXT     pClipboardCtx;
     PSHCLURITRANSFER pTransfer;
 } SHCLURIREADTHREADCTX, *PSHCLURIREADTHREADCTX;
@@ -75 +75 @@
 typedef struct _SHCLURIWRITETHREADCTX
 {
-    PSHCLCONTEXT       pClipboardCtx;
+    PSHCLCONTEXT     pClipboardCtx;
     PSHCLURITRANSFER pTransfer;
 } SHCLURIWRITETHREADCTX, *PSHCLURIWRITETHREADCTX;
@@ -100 +100 @@
 
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
+#if 0
 static DECLCALLBACK(int) vboxClipboardURIWriteThread(RTTHREAD ThreadSelf, void *pvUser)
 {
@@ -157 +158 @@
     return rc;
 }
-
-static DECLCALLBACK(void) vboxClipboardURITransferCompleteCallback(PSHCLURITRANSFERCALLBACKDATA pData, int rc)
-{
-    RT_NOREF(rc);
-
-    LogFlowFunc(("pData=%p, rc=%Rrc\n", pData, rc));
-
-    LogRel2(("Shared Clipboard: Transfer to destination complete\n"));
-
+#endif
+
+static void vboxClipboardURITransferCallbackCleanup(PSHCLURITRANSFERCALLBACKDATA pData)
+{
     PSHCLURICTX pCtx = (PSHCLURICTX)pData->pvUser;
     AssertPtr(pCtx);
@@ -178 +174 @@
     }
 
-    int rc2 = SharedClipboardURICtxTransferRemove(pCtx, pTransfer);
+    int rc2 = SharedClipboardURICtxTransferUnregister(pCtx, pTransfer->State.uID);
     AssertRC(rc2);
+
+    SharedClipboardURITransferDestroy(pTransfer);
+
+    RTMemFree(pTransfer);
+    pTransfer = NULL;
+}
+
+static DECLCALLBACK(void) vboxClipboardURITransferCompleteCallback(PSHCLURITRANSFERCALLBACKDATA pData, int rc)
+{
+    RT_NOREF(rc);
+
+    LogFlowFunc(("pData=%p, rc=%Rrc\n", pData, rc));
+
+    LogRel2(("Shared Clipboard: Transfer to destination complete\n"));
+
+    vboxClipboardURITransferCallbackCleanup(pData);
 }
 
@@ -190 +202 @@
     LogRel(("Shared Clipboard: Transfer to destination failed with %Rrc\n", rc));
 
-    PSHCLURICTX pCtx = (PSHCLURICTX)pData->pvUser;
-    AssertPtr(pCtx);
-
-    PSHCLURITRANSFER pTransfer = pData->pTransfer;
-    AssertPtr(pTransfer);
-
-    if (pTransfer->pvUser) /* SharedClipboardWinURITransferCtx */
-    {
-        delete pTransfer->pvUser;
-        pTransfer->pvUser = NULL;
-    }
-
-    int rc2 = SharedClipboardURICtxTransferRemove(pCtx, pTransfer);
-    AssertRC(rc2);
+    vboxClipboardURITransferCallbackCleanup(pData);
 }
 
@@ -640 +639 @@
        case SHCL_WIN_WM_REPORT_FORMATS:
        {
-           LogFunc(("VBOX_CLIPBOARD_WM_REPORT_FORMATS\n"));
+           LogFunc(("SHCL_WIN_WM_REPORT_FORMATS\n"));
 
            /* Announce available formats. Do not insert data -- will be inserted in WM_RENDERFORMAT. */
@@ -647 +646 @@
            Assert(pEvent->enmType == VBGLR3CLIPBOARDEVENTTYPE_REPORT_FORMATS);
 
-           const SHCLFORMATS fFormats =  pEvent->u.ReportFormats.uFormats;
+           const SHCLFORMATS fFormats =  pEvent->u.ReportedFormats.uFormats;
 
            if (fFormats != VBOX_SHARED_CLIPBOARD_FMT_NONE) /* Could arrive with some older GA versions. */
@@ -661 +660 @@
                         LogFunc(("VBOX_SHARED_CLIPBOARD_FMT_URI_LIST\n"));
 
-                        PSHCLURITRANSFER pTransfer = SharedClipboardURICtxGetTransfer(&pCtx->URI,
-                                                                                                 0 /* uIdx */);
+                        PSHCLURITRANSFER pTransfer = SharedClipboardURICtxGetTransfer(&pCtx->URI, 0); /** @todo FIX !!! */
                         if (pTransfer)
                         {
@@ -687 +685 @@
            }
 
-           LogFunc(("VBOX_CLIPBOARD_WM_SET_FORMATS: fFormats=0x%x, lastErr=%ld\n", fFormats, GetLastError()));
+           LogFunc(("SHCL_WIN_WM_REPORT_FORMATS: fFormats=0x%x, lastErr=%ld\n", fFormats, GetLastError()));
            break;
        }
@@ -702 +700 @@
            HANDLE hClip = NULL;
 
-           LogFlowFunc(("VBOX_CLIPBOARD_WM_READ_DATA: uFormat=0x%x\n", uFormat));
+           LogFlowFunc(("SHCL_WIN_WM_READ_DATA: uFormat=0x%x\n", uFormat));
 
            int rc = SharedClipboardWinOpen(hwnd);
@@ -781 +779 @@
                    {
                        PSHCLURITRANSFER pTransfer;
-                       rc = SharedClipboardURITransferCreate(SHCLURITRANSFERDIR_WRITE,
-                                                             SHCLSOURCE_LOCAL,
-                                                             &pTransfer);
+                       rc = SharedClipboardURITransferCreate(&pTransfer);
+                       if (RT_SUCCESS(rc))
+                           rc = SharedClipboardURITransferInit(pTransfer, 0 /* uID */,
+                                                               SHCLURITRANSFERDIR_WRITE, SHCLSOURCE_LOCAL);
                        if (RT_SUCCESS(rc))
                        {
-                           rc = SharedClipboardURICtxTransferAdd(&pCtx->URI, pTransfer);
-                           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)
                            {
-                               /* 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)
                                {
-                                   HDROP hDrop = (HDROP)GlobalLock(hClip);
-                                   if (hDrop)
+                                   char    *papszList;
+                                   uint32_t cbList;
+                                   rc = SharedClipboardWinDropFilesToStringList((DROPFILES *)hDrop, &papszList, &cbList);
+
+                                   GlobalUnlock(hClip);
+
+                                   if (RT_SUCCESS(rc))
                                    {
-                                       char    *papszList;
-                                       uint32_t cbList;
-                                       rc = SharedClipboardWinDropFilesToStringList((DROPFILES *)hDrop, &papszList, &cbList);
-
-                                       GlobalUnlock(hClip);
-
+                                       rc = SharedClipboardURILTransferSetRoots(pTransfer,
+                                                                                papszList, cbList + 1 /* Include termination */);
                                        if (RT_SUCCESS(rc))
                                        {
-                                           rc = SharedClipboardURILTransferSetRoots(pTransfer,
-                                                                                    papszList, cbList + 1 /* Include termination */);
-                                           if (RT_SUCCESS(rc))
+                                           PSHCLURIWRITETHREADCTX pThreadCtx
+                                               = (PSHCLURIWRITETHREADCTX)RTMemAllocZ(sizeof(SHCLURIWRITETHREADCTX));
+                                           if (pThreadCtx)
                                            {
-                                               PSHCLURIWRITETHREADCTX pThreadCtx
-                                                   = (PSHCLURIWRITETHREADCTX)RTMemAllocZ(sizeof(SHCLURIWRITETHREADCTX));
-                                               if (pThreadCtx)
+                                               pThreadCtx->pClipboardCtx = pCtx;
+                                               pThreadCtx->pTransfer     = pTransfer;
+
+                                               rc = SharedClipboardURITransferPrepare(pTransfer);
+                                               if (RT_SUCCESS(rc))
                                                {
-                                                   pThreadCtx->pClipboardCtx = pCtx;
-                                                   pThreadCtx->pTransfer     = pTransfer;
-
-                                                   rc = SharedClipboardURITransferPrepare(pTransfer);
+                                                   rc = SharedClipboardURICtxTransferRegister(&pCtx->URI, pTransfer,
+                                                                                              NULL /* puTransferID */);
+                                            #if 0
                                                    if (RT_SUCCESS(rc))
                                                    {
@@ -823 +824 @@
                                                        /* pThreadCtx now is owned by vboxClipboardURIWriteThread(). */
                                                    }
+                                            #endif
                                                }
-                                               else
-                                                   rc = VERR_NO_MEMORY;
                                            }
-
-                                           if (papszList)
-                                               RTStrFree(papszList);
+                                           else
+                                               rc = VERR_NO_MEMORY;
                                        }
+
+                                       if (papszList)
+                                           RTStrFree(papszList);
                                    }
-                                   else
-                                   {
-                                       hClip = NULL;
-                                   }
+                               }
+                               else
+                               {
+                                   hClip = NULL;
                                }
                            }
@@ -844 +846 @@
 
                    if (RT_FAILURE(rc))
-                       LogFunc(("VBOX_CLIPBOARD_WM_READ_DATA: Failed with rc=%Rrc\n", rc));
-               }
-#endif
+                       LogFunc(("SHCL_WIN_WM_READ_DATA: Failed with rc=%Rrc\n", rc));
+               }
+#endif /* VBOX_WITH_SHARED_CLIPBOARD_URI_LIST */
 
                if (hClip == NULL)
                {
-                   LogFunc(("VBOX_CLIPBOARD_WM_READ_DATA: hClip=NULL, lastError=%ld\n", GetLastError()));
+                   LogFunc(("SHCL_WIN_WM_READ_DATA: hClip=NULL, lastError=%ld\n", GetLastError()));
 
                    /* Requested clipboard format is not available, send empty data. */
@@ -863 +865 @@
            break;
        }
+
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
+       case SHCL_WIN_WM_URI_TRANSFER_STATUS:
+       {
+           LogFunc(("SHCL_WIN_WM_URI_TRANSFER_STATUS\n"));
+
+           break;
+       }
+#endif
 
 #if 0
@@ -942 +953 @@
        }
 
-#if 1
        /* The host wants to write URI data. */
        case VBOX_CLIPBOARD_WM_URI_START_WRITE:
@@ -997 +1007 @@
            break;
        }
-#endif
-#endif /* VBOX_WITH_SHARED_CLIPBOARD_URI_LIST */
+#endif /* 0 */
 
        case WM_DESTROY:
@@ -1097 +1106 @@
 
     UnregisterClass(s_szClipWndClassName, pCtx->pEnv->hInstance);
+
+    SharedClipboardWinCtxDestroy(&pCtx->Win);
 }
 
@@ -1124 +1135 @@
     {
         /* Do not use clipboard for remote sessions. */
-        LogRel(("Clipboard: Clipboard has been disabled for a remote session\n"));
+        LogRel(("Shared Clipboard: Clipboard has been disabled for a remote session\n"));
         return VERR_NOT_SUPPORTED;
     }
@@ -1136 +1147 @@
     if (FAILED(hr))
     {
-        LogRel(("Clipboard: Initializing OLE failed (%Rhrc) -- file transfers unavailable\n"));
+        LogRel(("Shared Clipboard: Initializing OLE failed (%Rhrc) -- file transfers unavailable\n"));
         /* Not critical, the rest of the clipboard might work. */
     }
     else
-        LogRel(("Clipboard: Initialized OLE\n"));
+        LogRel(("Shared Clipboard: Initialized OLE\n"));
 #endif
 
@@ -1146 +1157 @@
     {
         /* Check if new Clipboard API is available. */
-        /* ignore rc */ SharedClipboardWinCheckAndInitNewAPI(&pCtx->Win.newAPI);
-
-        rc = VbglR3ClipboardConnectEx(&pCtx->CmdCtx);
+        rc = SharedClipboardWinCtxInit(&pCtx->Win);
+        if (RT_SUCCESS(rc))
+            rc = VbglR3ClipboardConnectEx(&pCtx->CmdCtx);
         if (RT_SUCCESS(rc))
         {
@@ -1214 +1225 @@
             {
                 pEvent = (PVBGLR3CLIPBOARDEVENT)RTMemAllocZ(sizeof(VBGLR3CLIPBOARDEVENT));
-                if (!pEvent)
-                {
-                    rc = VERR_NO_MEMORY;
-                    break;
-                }
+                AssertPtrBreakStmt(pEvent, rc = VERR_NO_MEMORY);
 
                 switch (uMsg)
@@ -1225 +1232 @@
                     {
                         pEvent->enmType = VBGLR3CLIPBOARDEVENTTYPE_REPORT_FORMATS;
-                        pEvent->u.ReportFormats.uFormats = uFormats;
+                        pEvent->u.ReportedFormats.uFormats = uFormats;
                         break;
                     }
@@ -1244 +1251 @@
         else /* Protocol >= v1. */
         {
-            rc = VbglR3ClipboardEventGetNext(&pCtx->CmdCtx, &pEvent);
+            pEvent = (PVBGLR3CLIPBOARDEVENT)RTMemAllocZ(sizeof(VBGLR3CLIPBOARDEVENT));
+            AssertPtrBreakStmt(pEvent, rc = VERR_NO_MEMORY);
+
+            uint32_t uMsg   = 0;
+            uint32_t cParms = 0;
+            rc = VbglR3ClipboardMsgPeekWait(&pCtx->CmdCtx, &uMsg, &cParms, NULL /* pidRestoreCheck */);
+            if (RT_SUCCESS(rc))
+            {
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
+                rc = VbglR3ClipboardEventGetNextEx(uMsg, cParms, &pCtx->CmdCtx, &pCtx->URI, pEvent);
+#else
+                rc = VbglR3ClipboardEventGetNext(uMsg, cParms, &pCtx->CmdCtx, pEvent);
+#endif
+            }
         }
 
         if (RT_FAILURE(rc))
         {
+            VbglR3ClipboardEventFree(pEvent);
+            pEvent = NULL;
+
             if (*pfShutdown)
                 break;
@@ -1280 +1303 @@
                    break;
                }
-#if 0
-               case VBOX_SHARED_CLIPBOARD_HOST_MSG_URI_TRANSFER_START:
-               {
-                   const UINT uMsg = u32Formats == 0 ?
-                                     VBOX_CLIPBOARD_WM_URI_START_READ : VBOX_CLIPBOARD_WM_URI_START_WRITE;
-
-                   ::PostMessage(pWinCtx->hWnd, uMsg, 0 /* wParm */, 0 /* lParm */);
+
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
+               case VBGLR3CLIPBOARDEVENTTYPE_URI_TRANSFER_STATUS:
+               {
+                   ::PostMessage(pWinCtx->hWnd, SHCL_WIN_WM_URI_TRANSFER_STATUS,
+                                 0 /* wParm */, (LPARAM)pEvent /* lParm */);
                    break;
                }
@@ -1293 +1315 @@
                {
                    /* The host is terminating. */
-                   LogRel(("Clipboard: Terminating ...\n"));
+                   LogRel(("Shared Clipboard: Terminating ...\n"));
                    ASMAtomicXchgBool(pfShutdown, true);
                    break;