VBoxClipboard.cpp revision a29027bb2378172c7c88610ad5311548b66f96f6
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * VBoxClipboard - Shared clipboard
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync * Copyright (C) 2006-2014 Oracle Corporation
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * available from http://www.virtualbox.org. This file is free software;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * General Public License (GPL) as published by the Free Software
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// bool fOperational;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// uint32_t u32LastSentFormat;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// uint64_t u64LastSentCRC64;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic char gachWindowClassName[] = "VBoxSharedClipboardClass";
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsyncstatic int vboxClipboardChanged(VBOXCLIPBOARDCONTEXT *pCtx)
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync /* Query list of available formats and report to host. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync while ((format = EnumClipboardFormats (format)) != 0)
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("vboxClipboardChanged: format = 0x%08X\n", format));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync int cActual = GetClipboardFormatName(format, szFormatName, sizeof(szFormatName)/sizeof (TCHAR));
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync rc = VbglR3ClipboardReportFormats(pCtx->u32ClientID, u32Formats);
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync/* Add ourselves into the chain of cliboard listeners */
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsyncstatic void addToCBChain (VBOXCLIPBOARDCONTEXT *pCtx)
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync pCtx->hwndNextInChain = SetClipboardViewer (pCtx->hwnd);
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync/* Remove ourselves from the chain of cliboard listeners */
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsyncstatic void removeFromCBChain (VBOXCLIPBOARDCONTEXT *pCtx)
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync ChangeClipboardChain (pCtx->hwnd, pCtx->hwndNextInChain);
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync/* Callback which is invoked when we have successfully pinged ourselves down the
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync * clipboard chain. We simply unset a boolean flag to say that we are responding.
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync * There is a race if a ping returns after the next one is initiated, but nothing
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync * very bad is likely to happen. */
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsyncVOID CALLBACK CBChainPingProc(HWND hwnd, UINT uMsg, ULONG_PTR dwData, LRESULT lResult)
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync VBOXCLIPBOARDCONTEXT *pCtx = (VBOXCLIPBOARDCONTEXT *)dwData;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic LRESULT vboxClipboardProcessMsg(VBOXCLIPBOARDCONTEXT *pCtx, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_CHANGECBCHAIN: hwndRemoved %p, hwndNext %p, hwnd %p\n", hwndRemoved, hwndNext, pCtx->hwnd));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The window that was next to our in the chain is being removed.
9b4dd8dffe103b4ef000c75fdd22b50d97d93daavboxsync * Relink to the new next window. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Pass the message further. */
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync rc = SendMessageTimeout(pCtx->hwndNextInChain, WM_CHANGECBCHAIN, wParam, lParam, 0, CBCHAIN_TIMEOUT, &dwResult);
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_DRAWCLIPBOARD, hwnd %p\n", pCtx->hwnd));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Clipboard was updated by another application. */
2724514e7078eb3d64e6ee9a2a0e3ec0d7141ca0vboxsync /* WM_DRAWCLIPBOARD always expects a return code of 0, so don't change "rc" here. */
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("vboxClipboardChanged failed, rc = %Rrc\n", vboxrc));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Pass the message to next windows in the clipboard chain. */
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync SendMessageTimeout(pCtx->hwndNextInChain, msg, wParam, lParam, 0, CBCHAIN_TIMEOUT, NULL);
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync /* Re-register ourselves in the clipboard chain if our last ping
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync * timed out or there seems to be no valid chain. */
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync /* Start a new ping by passing a dummy WM_CHANGECBCHAIN to be
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync * processed by ourselves to the chain. */
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync SendMessageCallback(hViewer, WM_CHANGECBCHAIN, (WPARAM)pCtx->hwndNextInChain, (LPARAM)pCtx->hwndNextInChain, CBChainPingProc, (ULONG_PTR) pCtx);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Do nothing. Ignore the message. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Insert the requested clipboard format data into the clipboard. */
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_RENDERFORMAT, format = %x\n", format));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync u32Format |= VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync int cActual = GetClipboardFormatName(format, szFormatName, sizeof(szFormatName)/sizeof (TCHAR));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Unsupported clipboard format is requested. */
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("Unsupported clipboard format requested: %ld\n", u32Format));
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync const uint32_t cbPrealloc = 4096; /* @todo r=andy Make it dynamic for supporting larger text buffers! */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Preallocate a buffer, most of small text transfers will fit into it. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync HANDLE hMem = GlobalAlloc(GMEM_DDESHARE | GMEM_MOVEABLE, cbPrealloc);
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("Preallocated handle hMem = %p\n", hMem));
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("Locked pMem = %p, GlobalSize = %ld\n", pMem, GlobalSize(hMem)));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Read the host data to the preallocated buffer. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync int vboxrc = VbglR3ClipboardReadData(pCtx->u32ClientID, u32Format, pMem, cbPrealloc, &cb);
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("VbglR3ClipboardReadData returned with rc = %Rrc\n", vboxrc));
d6c1ac4cabb20caef17d53c6fd371433a79343d8vboxsync /* 0 bytes returned means the clipboard is empty.
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync * Deallocate the memory and set hMem to NULL to get to
9b4dd8dffe103b4ef000c75fdd22b50d97d93daavboxsync * the clipboard empty code path. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The preallocated buffer is too small, adjust the size. */
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("Locked pMem = %p, GlobalSize = %ld\n", pMem, GlobalSize(hMem)));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Read the host data to the preallocated buffer. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync vboxrc = VbglR3ClipboardReadData(pCtx->u32ClientID, u32Format, pMem, cb, &cbNew);
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("VbglR3ClipboardReadData returned with rc = %Rrc, cb = %d, cbNew = %d\n", vboxrc, cb, cbNew));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* pMem is the address of the data. cb is the size of returned data. */
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync /* Verify the size of returned text, the memory block for clipboard
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync * must have the exact string size.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync if (u32Format == VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync HRESULT hrc = StringCbLengthW((LPWSTR)pMem, cb, &cbActual);
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync /* Discard invalid data. */
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync /* cbActual is the number of bytes, excluding those used
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync * for the terminating null character.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* 'hMem' contains the host clipboard data.
9b4dd8dffe103b4ef000c75fdd22b50d97d93daavboxsync * size is 'cb' and format is 'format'. */
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_RENDERFORMAT hClip = %p\n", hClip));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The hMem ownership has gone to the system. Finish the processing. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Cleanup follows. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Something went wrong. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Do nothing. The clipboard formats will be unavailable now, because the
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * windows is to be destroyed and therefore the guest side becomes inactive.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Announce available formats. Do not insert data, they will be inserted in WM_RENDER*. */
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_USER: Failed to open clipboard! Last error = %ld\n", GetLastError()));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_USER: VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT\n"));
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_USER: VBOX_SHARED_CLIPBOARD_FMT_BITMAP\n"));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync UINT format = RegisterClipboardFormat ("HTML Format");
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_USER: VBOX_SHARED_CLIPBOARD_FMT_HTML 0x%04X\n", format));
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_USER: hClip = %p, err = %ld\n", hClip, GetLastError ()));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Send data in the specified format to the host. */
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("WM_USER: Failed to open clipboard! Last error = %ld\n", GetLastError()));
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync vboxrc = VbglR3ClipboardWriteData(pCtx->u32ClientID, VBOX_SHARED_CLIPBOARD_FMT_BITMAP,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync else if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync vboxrc = VbglR3ClipboardWriteData(pCtx->u32ClientID, VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync else if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_HTML)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync UINT format = RegisterClipboardFormat ("HTML Format");
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync vboxrc = VbglR3ClipboardWriteData(pCtx->u32ClientID, VBOX_SHARED_CLIPBOARD_FMT_HTML,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Requested clipboard format is not available, send empty data. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync VbglR3ClipboardWriteData(pCtx->u32ClientID, 0, NULL, 0);
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("vboxClipboardProcessMsg returned with rc = %ld\n", rc));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic LRESULT CALLBACK vboxClipboardWndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic int vboxClipboardInit (VBOXCLIPBOARDCONTEXT *pCtx)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Register the Window Class. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Create the window. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync pCtx->hwnd = CreateWindowEx (WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_TOPMOST,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync -200, -200, 100, 100, NULL, NULL, pCtx->pEnv->hInstance, NULL);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync SetWindowPos(pCtx->hwnd, HWND_TOPMOST, -200, -200, 0, 0,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync SWP_NOACTIVATE | SWP_HIDEWINDOW | SWP_NOCOPYBITS | SWP_NOREDRAW | SWP_NOSIZE);
73b1c18a52f0fc96342349987f5aa1b64b774053vboxsync pCtx->timerRefresh = SetTimer(pCtx->hwnd, 0, 10 * 1000, NULL);
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("vboxClipboardInit returned with rc = %Rrc\n", rc));
9b4dd8dffe103b4ef000c75fdd22b50d97d93daavboxsyncstatic void vboxClipboardDestroy(VBOXCLIPBOARDCONTEXT *pCtx)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync UnregisterClass(gachWindowClassName, pCtx->pEnv->hInstance);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync/* Static since it is the single instance. Directly used in the windows proc. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic LRESULT CALLBACK vboxClipboardWndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Forward with proper context. */
9b4dd8dffe103b4ef000c75fdd22b50d97d93daavboxsync return vboxClipboardProcessMsg(&gCtx, hwnd, msg, wParam, lParam);
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsyncint VBoxClipboardInit(const VBOXSERVICEENV *pEnv, void **ppInstance, bool *pfStartThread)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Clipboard was already initialized. 2 or more instances are not supported. */
f6ee0df7a48d6442c9d6587f4a953ab2df3ecba6vboxsync /* Do not use clipboard for remote sessions. */
f6ee0df7a48d6442c9d6587f4a953ab2df3ecba6vboxsync LogRel(("VBoxTray: clipboard has been disabled for a remote session.\n"));
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync int rc = VbglR3ClipboardConnect(&gCtx.u32ClientID);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Always start the thread for host messages. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsyncunsigned __stdcall VBoxClipboardThread(void *pInstance)
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync VBOXCLIPBOARDCONTEXT *pCtx = (VBOXCLIPBOARDCONTEXT *)pInstance;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The thread waits for incoming messages from the host. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync int rc = VbglR3ClipboardGetHostMsg(pCtx->u32ClientID, &u32Msg, &u32Formats);
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("VBoxClipboardThread: Failed to call the driver for host message! rc = %Rrc\n", rc));
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync /* Wait for termination event. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync WaitForSingleObject(pCtx->pEnv->hStopEvent, INFINITE);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Wait a bit before retrying. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync if (WaitForSingleObject(pCtx->pEnv->hStopEvent, 1000) == WAIT_OBJECT_0)
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("VBoxClipboardThread: VbglR3ClipboardGetHostMsg u32Msg = %ld, u32Formats = %ld\n", u32Msg, u32Formats));
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync /* The host has announced available clipboard formats.
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync * Forward the information to the window, so it can later
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync * respond to WM_RENDERFORMAT message. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync ::PostMessage (pCtx->hwnd, WM_USER, 0, u32Formats);
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync /* The host needs data in the specified format. */
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync ::PostMessage (pCtx->hwnd, WM_USER + 1, 0, u32Formats);
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsync /* The host is terminating. */
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("VBoxClipboardThread: Unsupported message from host! Message = %ld\n", u32Msg));
61e014c7370649a36da3a1ad85efda5d04e9fa3cvboxsyncvoid VBoxClipboardDestroy(const VBOXSERVICEENV *pEnv, void *pInstance)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync VBOXCLIPBOARDCONTEXT *pCtx = (VBOXCLIPBOARDCONTEXT *)pInstance;
a29027bb2378172c7c88610ad5311548b66f96f6vboxsync LogFlowFunc(("VBoxClipboardDestroy: invalid instance %p (our = %p)!\n", pCtx, &gCtx));