22#include <freerdp/config.h>
31#include <X11/extensions/Xfixes.h>
35#include <winpr/assert.h>
36#include <winpr/image.h>
37#include <winpr/stream.h>
38#include <winpr/clipboard.h>
39#include <winpr/path.h>
41#include <freerdp/utils/signal.h>
42#include <freerdp/log.h>
43#include <freerdp/client/cliprdr.h>
44#include <freerdp/channels/channels.h>
45#include <freerdp/channels/cliprdr.h>
47#include <freerdp/client/client_cliprdr_file.h>
49#include "xf_cliprdr.h"
53#define TAG CLIENT_TAG("x11.cliprdr")
55#define MAX_CLIPBOARD_FORMATS 255
57#ifdef WITH_DEBUG_CLIPRDR
58#define DEBUG_CLIPRDR(...) WLog_DBG(TAG, __VA_ARGS__)
60#define DEBUG_CLIPRDR(...) \
69 UINT32 formatToRequest;
84 UINT32 formatToRequest;
91 rdpChannels* channels;
92 CliprdrClientContext* context;
100 Atom timestamp_property_atom;
101 Time selection_ownership_timestamp;
103 Atom raw_transfer_atom;
104 Atom raw_format_list_atom;
106 UINT32 numClientFormats;
107 xfCliprdrFormat clientFormats[20];
109 UINT32 numServerFormats;
115 UINT32 requestedFormatId;
117 wHashTable* cachedData;
118 wHashTable* cachedRawData;
120 BOOL data_raw_format;
122 RequestedFormat* requestedFormat;
124 XSelectionEvent* respond;
133 size_t incr_data_length;
137 int xfixes_event_base;
138 int xfixes_error_base;
139 BOOL xfixes_supported;
143 UINT32 lastSentNumFormats;
144 CliprdrFileContext* file;
148static const char mime_text_plain[] =
"text/plain";
149static const char mime_uri_list[] =
"text/uri-list";
150static const char mime_html[] =
"text/html";
151static const char* mime_bitmap[] = {
"image/bmp",
"image/x-bmp",
"image/x-MS-bmp",
152 "image/x-win-bitmap" };
153static const char mime_webp[] =
"image/webp";
154static const char mime_png[] =
"image/png";
155static const char mime_jpeg[] =
"image/jpeg";
156static const char mime_tiff[] =
"image/tiff";
157static const char* mime_images[] = { mime_webp, mime_png, mime_jpeg, mime_tiff };
159static const char mime_gnome_copied_files[] =
"x-special/gnome-copied-files";
160static const char mime_mate_copied_files[] =
"x-special/mate-copied-files";
162static const char type_FileGroupDescriptorW[] =
"FileGroupDescriptorW";
163static const char type_HtmlFormat[] =
"HTML Format";
165static void xf_cliprdr_clear_cached_data(xfClipboard* clipboard);
166static UINT xf_cliprdr_send_client_format_list(xfClipboard* clipboard, BOOL force);
167static void xf_cliprdr_set_selection_owner(xfContext* xfc, xfClipboard* clipboard, Time timestamp);
169static void requested_format_free(RequestedFormat** ppRequestedFormat)
171 if (!ppRequestedFormat)
173 if (!(*ppRequestedFormat))
176 free((*ppRequestedFormat)->formatName);
177 free(*ppRequestedFormat);
178 *ppRequestedFormat = NULL;
181static BOOL requested_format_replace(RequestedFormat** ppRequestedFormat, UINT32 formatId,
182 const char* formatName)
184 if (!ppRequestedFormat)
187 requested_format_free(ppRequestedFormat);
188 RequestedFormat* requested = calloc(1,
sizeof(RequestedFormat));
191 requested->localFormat = formatId;
192 requested->formatToRequest = formatId;
195 requested->formatName = _strdup(formatName);
196 if (!requested->formatName)
203 *ppRequestedFormat = requested;
207static void xf_cached_data_free(
void* ptr)
209 xfCachedData* cached_data = ptr;
213 free(cached_data->data);
217static xfCachedData* xf_cached_data_new(BYTE* data,
size_t data_length)
219 if (data_length > UINT32_MAX)
222 xfCachedData* cached_data = calloc(1,
sizeof(xfCachedData));
226 cached_data->data = data;
227 cached_data->data_length = (UINT32)data_length;
232static xfCachedData* xf_cached_data_new_copy(
const BYTE* data,
size_t data_length)
237 copy = calloc(data_length + 1,
sizeof(BYTE));
240 memcpy(copy, data, data_length);
243 xfCachedData* cache = xf_cached_data_new(copy, data_length);
249static void xf_clipboard_free_server_formats(xfClipboard* clipboard)
251 WINPR_ASSERT(clipboard);
252 if (clipboard->serverFormats)
254 for (
size_t i = 0; i < clipboard->numServerFormats; i++)
257 free(format->formatName);
260 free(clipboard->serverFormats);
261 clipboard->serverFormats = NULL;
265static BOOL xf_cliprdr_update_owner(xfClipboard* clipboard)
267 WINPR_ASSERT(clipboard);
269 xfContext* xfc = clipboard->xfc;
272 if (!clipboard->sync)
275 Window owner = XGetSelectionOwner(xfc->display, clipboard->clipboard_atom);
276 if (clipboard->owner == owner)
279 clipboard->owner = owner;
283static void xf_cliprdr_check_owner(xfClipboard* clipboard)
285 if (xf_cliprdr_update_owner(clipboard))
286 xf_cliprdr_send_client_format_list(clipboard, FALSE);
289static BOOL xf_cliprdr_is_self_owned(xfClipboard* clipboard)
291 xfContext* xfc = NULL;
293 WINPR_ASSERT(clipboard);
295 xfc = clipboard->xfc;
297 return XGetSelectionOwner(xfc->display, clipboard->clipboard_atom) == xfc->drawable;
300static void xf_cliprdr_set_raw_transfer_enabled(xfClipboard* clipboard, BOOL enabled)
302 UINT32 data = WINPR_ASSERTING_INT_CAST(uint32_t, enabled);
303 xfContext* xfc = NULL;
305 WINPR_ASSERT(clipboard);
307 xfc = clipboard->xfc;
309 LogTagAndXChangeProperty(TAG, xfc->display, xfc->drawable, clipboard->raw_transfer_atom,
310 XA_INTEGER, 32, PropModeReplace, (
const BYTE*)&data, 1);
313static BOOL xf_cliprdr_is_raw_transfer_available(xfClipboard* clipboard)
318 unsigned long length = 0;
319 unsigned long bytes_left = 0;
321 UINT32 is_enabled = 0;
323 xfContext* xfc = NULL;
325 WINPR_ASSERT(clipboard);
327 xfc = clipboard->xfc;
330 owner = XGetSelectionOwner(xfc->display, clipboard->clipboard_atom);
334 result = LogTagAndXGetWindowProperty(TAG, xfc->display, owner, clipboard->raw_transfer_atom,
335 0, 4, 0, XA_INTEGER, &type, &format, &length,
336 &bytes_left, (BYTE**)&data);
345 if ((owner == None) || (owner == xfc->drawable))
348 if (result != Success)
351 return is_enabled ? TRUE : FALSE;
354static BOOL xf_cliprdr_formats_equal(
const CLIPRDR_FORMAT* server,
const xfCliprdrFormat* client)
356 WINPR_ASSERT(server);
357 WINPR_ASSERT(client);
359 if (server->formatName && client->formatName)
362 return (0 == strncmp(server->formatName, client->formatName, strlen(server->formatName)));
365 if (!server->formatName && !client->formatName)
367 return (server->formatId == client->formatToRequest);
373static const xfCliprdrFormat* xf_cliprdr_get_client_format_by_id(xfClipboard* clipboard,
376 WINPR_ASSERT(clipboard);
378 const BOOL formatIsHtml = formatId == ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
379 const BOOL fetchImage = clipboard->isImageContent && formatIsHtml;
380 for (
size_t index = 0; index < clipboard->numClientFormats; index++)
382 const xfCliprdrFormat* format = &(clipboard->clientFormats[index]);
384 if (fetchImage && format->isImage)
387 if (format->formatToRequest == formatId)
394static const xfCliprdrFormat* xf_cliprdr_get_client_format_by_atom(xfClipboard* clipboard,
397 WINPR_ASSERT(clipboard);
399 for (UINT32 i = 0; i < clipboard->numClientFormats; i++)
401 const xfCliprdrFormat* format = &(clipboard->clientFormats[i]);
403 if (format->atom == atom)
410static const CLIPRDR_FORMAT* xf_cliprdr_get_server_format_by_atom(xfClipboard* clipboard, Atom atom)
412 WINPR_ASSERT(clipboard);
414 for (
size_t i = 0; i < clipboard->numClientFormats; i++)
416 const xfCliprdrFormat* client_format = &(clipboard->clientFormats[i]);
418 if (client_format->atom == atom)
420 for (
size_t j = 0; j < clipboard->numServerFormats; j++)
422 const CLIPRDR_FORMAT* server_format = &(clipboard->serverFormats[j]);
424 if (xf_cliprdr_formats_equal(server_format, client_format))
425 return server_format;
438static UINT xf_cliprdr_send_data_request(xfClipboard* clipboard, UINT32 formatId,
439 WINPR_ATTR_UNUSED
const xfCliprdrFormat* cformat)
442 request.requestedFormatId = formatId;
444 DEBUG_CLIPRDR(
"requesting format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
"} [%s]", formatId,
445 ClipboardGetFormatIdString(formatId), cformat->localFormat, cformat->formatName);
447 WINPR_ASSERT(clipboard);
448 WINPR_ASSERT(clipboard->context);
449 WINPR_ASSERT(clipboard->context->ClientFormatDataRequest);
450 return clipboard->context->ClientFormatDataRequest(clipboard->context, &request);
458static UINT xf_cliprdr_send_data_response(xfClipboard* clipboard,
const xfCliprdrFormat* format,
459 const BYTE* data,
size_t size)
463 WINPR_ASSERT(clipboard);
466 if (clipboard->requestedFormatId == UINT32_MAX)
467 return CHANNEL_RC_OK;
472 DEBUG_CLIPRDR(
"send CB_RESPONSE_FAIL response {format 0x%08" PRIx32
473 " [%s] {local 0x%08" PRIx32
"} [%s]",
474 format->formatToRequest,
475 ClipboardGetFormatIdString(format->formatToRequest), format->localFormat,
478 DEBUG_CLIPRDR(
"send CB_RESPONSE_FAIL response");
482 WINPR_ASSERT(format);
483 DEBUG_CLIPRDR(
"send response format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
"} [%s]",
484 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
485 format->localFormat, format->formatName);
488 clipboard->requestedFormatId = UINT32_MAX;
490 response.common.msgFlags = (data) ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
492 WINPR_ASSERT(size <= UINT32_MAX);
493 response.common.dataLen = (UINT32)size;
494 response.requestedFormatData = data;
496 WINPR_ASSERT(clipboard->context);
497 WINPR_ASSERT(clipboard->context->ClientFormatDataResponse);
498 return clipboard->context->ClientFormatDataResponse(clipboard->context, &response);
501static wStream* xf_cliprdr_serialize_server_format_list(xfClipboard* clipboard)
503 UINT32 formatCount = 0;
506 WINPR_ASSERT(clipboard);
509 if (!(s = Stream_New(NULL, 128)))
511 WLog_ERR(TAG,
"failed to allocate serialized format list");
516 formatCount = (clipboard->numServerFormats > 0) ? clipboard->numServerFormats - 1 : 0;
517 Stream_Write_UINT32(s, formatCount);
519 for (UINT32 i = 0; i < formatCount; i++)
522 size_t name_length = format->formatName ? strlen(format->formatName) : 0;
524 DEBUG_CLIPRDR(
"server announced 0x%08" PRIx32
" [%s][%s]", format->formatId,
525 ClipboardGetFormatIdString(format->formatId), format->formatName);
526 if (!Stream_EnsureRemainingCapacity(s,
sizeof(UINT32) + name_length + 1))
528 WLog_ERR(TAG,
"failed to expand serialized format list");
532 Stream_Write_UINT32(s, format->formatId);
534 if (format->formatName)
535 Stream_Write(s, format->formatName, name_length);
537 Stream_Write_UINT8(s,
'\0');
540 Stream_SealLength(s);
543 Stream_Free(s, TRUE);
547static CLIPRDR_FORMAT* xf_cliprdr_parse_server_format_list(BYTE* data,
size_t length,
553 WINPR_ASSERT(data || (length == 0));
554 WINPR_ASSERT(numFormats);
556 if (!(s = Stream_New(data, length)))
558 WLog_ERR(TAG,
"failed to allocate stream for parsing serialized format list");
562 if (!Stream_CheckAndLogRequiredLength(TAG, s,
sizeof(UINT32)))
565 Stream_Read_UINT32(s, *numFormats);
567 if (*numFormats > MAX_CLIPBOARD_FORMATS)
569 WLog_ERR(TAG,
"unexpectedly large number of formats: %" PRIu32
"", *numFormats);
575 WLog_ERR(TAG,
"failed to allocate format list");
579 for (UINT32 i = 0; i < *numFormats; i++)
581 const char* formatName = NULL;
582 size_t formatNameLength = 0;
584 if (!Stream_CheckAndLogRequiredLength(TAG, s,
sizeof(UINT32)))
587 Stream_Read_UINT32(s, formats[i].formatId);
588 formatName = (
const char*)Stream_Pointer(s);
589 formatNameLength = strnlen(formatName, Stream_GetRemainingLength(s));
591 if (formatNameLength == Stream_GetRemainingLength(s))
593 WLog_ERR(TAG,
"missing terminating null byte, %" PRIuz
" bytes left to read",
598 formats[i].formatName = strndup(formatName, formatNameLength);
599 Stream_Seek(s, formatNameLength + 1);
602 Stream_Free(s, FALSE);
605 Stream_Free(s, FALSE);
611static void xf_cliprdr_free_formats(
CLIPRDR_FORMAT* formats, UINT32 numFormats)
613 WINPR_ASSERT(formats || (numFormats == 0));
615 for (UINT32 i = 0; i < numFormats; i++)
617 free(formats[i].formatName);
623static CLIPRDR_FORMAT* xf_cliprdr_get_raw_server_formats(xfClipboard* clipboard, UINT32* numFormats)
627 unsigned long length = 0;
628 unsigned long remaining = 0;
631 xfContext* xfc = NULL;
633 WINPR_ASSERT(clipboard);
634 WINPR_ASSERT(numFormats);
636 xfc = clipboard->xfc;
641 Window owner = XGetSelectionOwner(xfc->display, clipboard->clipboard_atom);
642 LogTagAndXGetWindowProperty(TAG, xfc->display, owner, clipboard->raw_format_list_atom, 0, 4096,
643 False, clipboard->raw_format_list_atom, &type, &format, &length,
646 if (data && length > 0 && format == 8 && type == clipboard->raw_format_list_atom)
648 formats = xf_cliprdr_parse_server_format_list(data, length, numFormats);
653 "failed to retrieve raw format list: data=%p, length=%lu, format=%d, type=%lu "
655 (
void*)data, length, format, (
unsigned long)type,
656 (
unsigned long)clipboard->raw_format_list_atom);
665static BOOL xf_cliprdr_should_add_format(
const CLIPRDR_FORMAT* formats,
size_t count,
666 const xfCliprdrFormat* xformat)
668 WINPR_ASSERT(formats);
673 for (
size_t x = 0; x < count; x++)
676 if (format->formatId == xformat->formatToRequest)
682static CLIPRDR_FORMAT* xf_cliprdr_get_formats_from_targets(xfClipboard* clipboard,
687 int format_property = 0;
688 unsigned long proplength = 0;
689 unsigned long bytes_left = 0;
692 WINPR_ASSERT(clipboard);
693 WINPR_ASSERT(numFormats);
695 xfContext* xfc = clipboard->xfc;
699 LogTagAndXGetWindowProperty(TAG, xfc->display, xfc->drawable, clipboard->property_atom, 0, 200,
700 0, XA_ATOM, &atom, &format_property, &proplength, &bytes_left,
705 unsigned long length = proplength + 1;
708 WLog_ERR(TAG,
"XGetWindowProperty set length = %lu but data is NULL", length);
714 WLog_ERR(TAG,
"failed to allocate %lu CLIPRDR_FORMAT structs", length);
719 BOOL isImage = FALSE;
720 BOOL hasHtml = FALSE;
721 const uint32_t htmlFormatId = ClipboardRegisterFormat(clipboard->system, type_HtmlFormat);
722 for (
unsigned long i = 0; i < proplength; i++)
724 Atom tatom = ((Atom*)data)[i];
725 const xfCliprdrFormat* format = xf_cliprdr_get_client_format_by_atom(clipboard, tatom);
727 if (xf_cliprdr_should_add_format(formats, *numFormats, format))
730 cformat->formatId = format->formatToRequest;
734 if (cformat->formatId == htmlFormatId)
739 if (cformat->formatId == CF_TIFF)
741 else if (cformat->formatId == CF_DIB)
743 else if (cformat->formatId == CF_DIBV5)
746 if (format->formatName)
748 cformat->formatName = _strdup(format->formatName);
749 WINPR_ASSERT(cformat->formatName);
752 cformat->formatName = NULL;
758 clipboard->isImageContent = isImage;
759 if (isImage && !hasHtml)
762 cformat->formatId = htmlFormatId;
763 cformat->formatName = _strdup(type_HtmlFormat);
775static CLIPRDR_FORMAT* xf_cliprdr_get_client_formats(xfClipboard* clipboard, UINT32* numFormats)
779 WINPR_ASSERT(clipboard);
780 WINPR_ASSERT(numFormats);
784 if (xf_cliprdr_is_raw_transfer_available(clipboard))
786 formats = xf_cliprdr_get_raw_server_formats(clipboard, numFormats);
789 if (*numFormats == 0)
791 xf_cliprdr_free_formats(formats, *numFormats);
792 formats = xf_cliprdr_get_formats_from_targets(clipboard, numFormats);
798static void xf_cliprdr_provide_server_format_list(xfClipboard* clipboard)
801 xfContext* xfc = NULL;
803 WINPR_ASSERT(clipboard);
805 xfc = clipboard->xfc;
808 formats = xf_cliprdr_serialize_server_format_list(clipboard);
812 const size_t len = Stream_Length(formats);
813 WINPR_ASSERT(len <= INT32_MAX);
814 LogTagAndXChangeProperty(TAG, xfc->display, xfc->drawable, clipboard->raw_format_list_atom,
815 clipboard->raw_format_list_atom, 8, PropModeReplace,
816 Stream_Buffer(formats), (
int)len);
820 LogTagAndXDeleteProperty(TAG, xfc->display, xfc->drawable, clipboard->raw_format_list_atom);
823 Stream_Free(formats, TRUE);
831 if (a->formatId != b->formatId)
833 if (!a->formatName && !b->formatName)
835 if (!a->formatName || !b->formatName)
837 return strcmp(a->formatName, b->formatName) == 0;
840static BOOL xf_clipboard_changed(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
843 WINPR_ASSERT(clipboard);
844 WINPR_ASSERT(formats || (numFormats == 0));
846 if (clipboard->lastSentNumFormats != numFormats)
849 for (UINT32 x = 0; x < numFormats; x++)
852 BOOL contained = FALSE;
853 for (UINT32 y = 0; y < numFormats; y++)
855 if (xf_clipboard_format_equal(cur, &formats[y]))
868static void xf_clipboard_formats_free(xfClipboard* clipboard)
870 WINPR_ASSERT(clipboard);
872 xf_cliprdr_free_formats(clipboard->lastSentFormats, clipboard->lastSentNumFormats);
873 clipboard->lastSentFormats = NULL;
874 clipboard->lastSentNumFormats = 0;
877static BOOL xf_clipboard_copy_formats(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
880 WINPR_ASSERT(clipboard);
881 WINPR_ASSERT(formats || (numFormats == 0));
883 xf_clipboard_formats_free(clipboard);
885 clipboard->lastSentFormats = calloc(numFormats,
sizeof(
CLIPRDR_FORMAT));
886 if (!clipboard->lastSentFormats)
888 clipboard->lastSentNumFormats = numFormats;
889 for (UINT32 x = 0; x < numFormats; x++)
895 lcur->formatName = _strdup(cur->formatName);
900static UINT xf_cliprdr_send_format_list(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
901 UINT32 numFormats, BOOL force)
907 } cnv = { .cpv = formats };
909 .numFormats = numFormats,
911 .common.msgType = CB_FORMAT_LIST };
914 WINPR_ASSERT(clipboard);
915 WINPR_ASSERT(formats || (numFormats == 0));
917 if (!force && !xf_clipboard_changed(clipboard, formats, numFormats))
918 return CHANNEL_RC_OK;
920#if defined(WITH_DEBUG_CLIPRDR)
921 for (UINT32 x = 0; x < numFormats; x++)
924 DEBUG_CLIPRDR(
"announcing format 0x%08" PRIx32
" [%s] [%s]", format->formatId,
925 ClipboardGetFormatIdString(format->formatId), format->formatName);
929 xf_clipboard_copy_formats(clipboard, formats, numFormats);
931 xf_cliprdr_send_data_response(clipboard, NULL, NULL, 0);
933 xf_cliprdr_clear_cached_data(clipboard);
935 ret = cliprdr_file_context_notify_new_client_format_list(clipboard->file);
939 WINPR_ASSERT(clipboard->context);
940 WINPR_ASSERT(clipboard->context->ClientFormatList);
941 return clipboard->context->ClientFormatList(clipboard->context, &formatList);
944static void xf_cliprdr_get_requested_targets(xfClipboard* clipboard)
946 UINT32 numFormats = 0;
947 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
948 xf_cliprdr_send_format_list(clipboard, formats, numFormats, FALSE);
949 xf_cliprdr_free_formats(formats, numFormats);
952static void xf_cliprdr_process_requested_data(xfClipboard* clipboard, BOOL hasData,
953 const BYTE* data,
size_t size)
958 INT64 srcFormatId = -1;
959 BYTE* pDstData = NULL;
960 const xfCliprdrFormat* format = NULL;
962 WINPR_ASSERT(clipboard);
964 if (clipboard->incr_starts && hasData)
969 clipboard->incr_data_length = 0;
971 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
973 if (!hasData || !data || !format)
975 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
979 switch (format->formatToRequest)
982 srcFormatId = CF_RAW;
988 srcFormatId = format->localFormat;
992 srcFormatId = format->localFormat;
998 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1002 ClipboardLock(clipboard->system);
1003 SrcSize = (UINT32)size;
1004 bSuccess = ClipboardSetData(clipboard->system, (UINT32)srcFormatId, data, SrcSize);
1010 (BYTE*)ClipboardGetData(clipboard->system, clipboard->requestedFormatId, &DstSize);
1012 ClipboardUnlock(clipboard->system);
1016 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1027 ClipboardLock(clipboard->system);
1028 if (format->formatToRequest &&
1029 (format->formatToRequest ==
1030 ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW)))
1032 UINT error = NO_ERROR;
1038 const UINT32 flags = cliprdr_file_context_remote_get_flags(clipboard->file);
1039 error = cliprdr_serialize_file_list_ex(flags, file_array, file_count, &pDstData, &DstSize);
1042 WLog_ERR(TAG,
"failed to serialize CLIPRDR_FILELIST: 0x%08X", error);
1045 UINT32 formatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
1046 UINT32 url_size = 0;
1048 char* url = ClipboardGetData(clipboard->system, formatId, &url_size);
1049 cliprdr_file_context_update_client_data(clipboard->file, url, url_size);
1055 ClipboardUnlock(clipboard->system);
1057 xf_cliprdr_send_data_response(clipboard, format, pDstData, DstSize);
1061static BOOL xf_restore_input_flags(xfClipboard* clipboard)
1063 WINPR_ASSERT(clipboard);
1065 xfContext* xfc = clipboard->xfc;
1068 if (clipboard->event_mask != 0)
1070 XSelectInput(xfc->display, xfc->drawable, clipboard->event_mask);
1071 clipboard->event_mask = 0;
1076static BOOL append(xfClipboard* clipboard,
const void* sdata,
size_t length)
1078 WINPR_ASSERT(clipboard);
1080 const size_t size = length + clipboard->incr_data_length + 2;
1081 BYTE* data = realloc(clipboard->incr_data, size);
1084 clipboard->incr_data = data;
1085 memcpy(&data[clipboard->incr_data_length], sdata, length);
1086 clipboard->incr_data_length += length;
1087 clipboard->incr_data[clipboard->incr_data_length + 0] =
'\0';
1088 clipboard->incr_data[clipboard->incr_data_length + 1] =
'\0';
1092static BOOL xf_cliprdr_stop_incr(xfClipboard* clipboard)
1094 clipboard->incr_starts = FALSE;
1095 clipboard->incr_data_length = 0;
1096 return xf_restore_input_flags(clipboard);
1099static BOOL xf_cliprdr_get_requested_data(xfClipboard* clipboard, Atom target)
1101 WINPR_ASSERT(clipboard);
1103 xfContext* xfc = clipboard->xfc;
1106 const xfCliprdrFormat* format =
1107 xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1109 if (!format || (format->atom != target))
1111 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1116 BOOL has_data = FALSE;
1117 int format_property = 0;
1118 unsigned long length = 0;
1119 unsigned long total_bytes = 0;
1120 BYTE* property_data = NULL;
1121 const int rc = LogTagAndXGetWindowProperty(
1122 TAG, xfc->display, xfc->drawable, clipboard->property_atom, 0, 0, False, target, &type,
1123 &format_property, &length, &total_bytes, &property_data);
1126 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1133 if ((total_bytes <= 0) && !clipboard->incr_starts)
1135 xf_cliprdr_stop_incr(clipboard);
1138 else if (type == clipboard->incr_atom)
1140 xf_cliprdr_stop_incr(clipboard);
1141 clipboard->incr_starts = TRUE;
1146 BYTE* incremental_data = NULL;
1147 unsigned long incremental_len = 0;
1150 len = clipboard->incr_data_length;
1151 if (total_bytes <= 0)
1153 xf_cliprdr_stop_incr(clipboard);
1157 else if (LogTagAndXGetWindowProperty(
1158 TAG, xfc->display, xfc->drawable, clipboard->property_atom, 0,
1159 WINPR_ASSERTING_INT_CAST(int32_t, total_bytes), False, target, &type,
1160 &format_property, &incremental_len, &length, &incremental_data) == Success)
1162 has_data = append(clipboard, incremental_data, incremental_len);
1163 len = clipboard->incr_data_length;
1166 if (incremental_data)
1167 XFree(incremental_data);
1170 LogTagAndXDeleteProperty(TAG, xfc->display, xfc->drawable, clipboard->property_atom);
1171 xf_cliprdr_process_requested_data(clipboard, has_data, clipboard->incr_data, len);
1176static void xf_cliprdr_append_target(xfClipboard* clipboard, Atom target)
1178 WINPR_ASSERT(clipboard);
1180 if (clipboard->numTargets >= ARRAYSIZE(clipboard->targets))
1183 for (
size_t i = 0; i < clipboard->numTargets; i++)
1185 if (clipboard->targets[i] == target)
1189 clipboard->targets[clipboard->numTargets++] = target;
1192static void xf_cliprdr_provide_targets(xfClipboard* clipboard,
const XSelectionEvent* respond)
1194 xfContext* xfc = NULL;
1196 WINPR_ASSERT(clipboard);
1198 xfc = clipboard->xfc;
1201 if (respond->property != None)
1203 WINPR_ASSERT(clipboard->numTargets <= INT32_MAX);
1204 LogTagAndXChangeProperty(TAG, xfc->display, respond->requestor, respond->property, XA_ATOM,
1205 32, PropModeReplace, (
const BYTE*)clipboard->targets,
1206 (
int)clipboard->numTargets);
1210static void xf_cliprdr_provide_timestamp(xfClipboard* clipboard,
const XSelectionEvent* respond)
1212 xfContext* xfc = NULL;
1214 WINPR_ASSERT(clipboard);
1216 xfc = clipboard->xfc;
1219 if (respond->property != None)
1221 LogTagAndXChangeProperty(TAG, xfc->display, respond->requestor, respond->property,
1222 XA_INTEGER, 32, PropModeReplace,
1223 (
const BYTE*)&clipboard->selection_ownership_timestamp, 1);
1227static void xf_cliprdr_provide_data(xfClipboard* clipboard,
const XSelectionEvent* respond,
1228 const BYTE* data, UINT32 size)
1230 xfContext* xfc = NULL;
1232 WINPR_ASSERT(clipboard);
1234 xfc = clipboard->xfc;
1237 if (respond->property != None)
1239 LogTagAndXChangeProperty(TAG, xfc->display, respond->requestor, respond->property,
1240 respond->target, 8, PropModeReplace, data,
1241 WINPR_ASSERTING_INT_CAST(int32_t, size));
1245static void log_selection_event(xfContext* xfc,
const XEvent* event)
1247 const DWORD level = WLOG_TRACE;
1248 static wLog* _log_cached_ptr = NULL;
1249 if (!_log_cached_ptr)
1250 _log_cached_ptr = WLog_Get(TAG);
1251 if (WLog_IsLevelActive(_log_cached_ptr, level))
1254 switch (event->type)
1256 case SelectionClear:
1258 const XSelectionClearEvent* xevent = &
event->xselectionclear;
1260 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1261 WLog_Print(_log_cached_ptr, level,
"got event %s [selection %s]",
1262 x11_event_string(event->type), selection);
1266 case SelectionNotify:
1268 const XSelectionEvent* xevent = &
event->xselection;
1270 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1271 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1272 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1273 WLog_Print(_log_cached_ptr, level,
1274 "got event %s [selection %s, target %s, property %s]",
1275 x11_event_string(event->type), selection, target, property);
1281 case SelectionRequest:
1283 const XSelectionRequestEvent* xevent = &
event->xselectionrequest;
1285 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1286 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1287 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1288 WLog_Print(_log_cached_ptr, level,
1289 "got event %s [selection %s, target %s, property %s]",
1290 x11_event_string(event->type), selection, target, property);
1296 case PropertyNotify:
1298 const XPropertyEvent* xevent = &
event->xproperty;
1299 char* atom = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->atom);
1300 WLog_Print(_log_cached_ptr, level,
"got event %s [atom %s]",
1301 x11_event_string(event->type), atom);
1311static BOOL xf_cliprdr_process_selection_notify(xfClipboard* clipboard,
1312 const XSelectionEvent* xevent)
1314 WINPR_ASSERT(clipboard);
1315 WINPR_ASSERT(xevent);
1317 if (xevent->target == clipboard->targets[1])
1319 if (xevent->property == None)
1321 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1325 xf_cliprdr_get_requested_targets(clipboard);
1332 return xf_cliprdr_get_requested_data(clipboard, xevent->target);
1336void xf_cliprdr_clear_cached_data(xfClipboard* clipboard)
1338 WINPR_ASSERT(clipboard);
1340 ClipboardLock(clipboard->system);
1341 ClipboardEmpty(clipboard->system);
1343 HashTable_Clear(clipboard->cachedData);
1344 HashTable_Clear(clipboard->cachedRawData);
1346 cliprdr_file_context_clear(clipboard->file);
1348 xf_cliprdr_stop_incr(clipboard);
1349 ClipboardUnlock(clipboard->system);
1352static void* format_to_cache_slot(UINT32 format)
1359 cnv.uptr = 0x100000000ULL + format;
1363static UINT32 get_dst_format_id_for_local_request(xfClipboard* clipboard,
1364 const xfCliprdrFormat* format)
1366 UINT32 dstFormatId = 0;
1368 WINPR_ASSERT(format);
1370 if (!format->formatName)
1371 return format->localFormat;
1373 ClipboardLock(clipboard->system);
1374 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1375 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
1376 ClipboardUnlock(clipboard->system);
1378 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1379 dstFormatId = format->localFormat;
1384static void get_src_format_info_for_local_request(xfClipboard* clipboard,
1385 const xfCliprdrFormat* format,
1386 UINT32* srcFormatId, BOOL* nullTerminated)
1389 *nullTerminated = FALSE;
1391 if (format->formatName)
1393 ClipboardLock(clipboard->system);
1394 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1396 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
1397 *nullTerminated = TRUE;
1399 else if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1401 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
1402 *nullTerminated = TRUE;
1404 ClipboardUnlock(clipboard->system);
1408 *srcFormatId = format->formatToRequest;
1409 switch (format->formatToRequest)
1413 case CF_UNICODETEXT:
1414 *nullTerminated = TRUE;
1417 *srcFormatId = CF_DIB;
1420 *srcFormatId = CF_TIFF;
1428static xfCachedData* convert_data_from_existing_raw_data(xfClipboard* clipboard,
1429 xfCachedData* cached_raw_data,
1430 UINT32 srcFormatId, BOOL nullTerminated,
1433 xfCachedData* cached_data = NULL;
1435 BYTE* dst_data = NULL;
1436 UINT32 dst_size = 0;
1438 WINPR_ASSERT(clipboard);
1439 WINPR_ASSERT(cached_raw_data);
1440 WINPR_ASSERT(cached_raw_data->data);
1442 ClipboardLock(clipboard->system);
1443 success = ClipboardSetData(clipboard->system, srcFormatId, cached_raw_data->data,
1444 cached_raw_data->data_length);
1447 WLog_WARN(TAG,
"Failed to set clipboard data (formatId: %u, data: %p, data_length: %u)",
1448 srcFormatId, cached_raw_data->data, cached_raw_data->data_length);
1449 ClipboardUnlock(clipboard->system);
1453 dst_data = ClipboardGetData(clipboard->system, dstFormatId, &dst_size);
1456 WLog_WARN(TAG,
"Failed to get converted clipboard data");
1457 ClipboardUnlock(clipboard->system);
1460 ClipboardUnlock(clipboard->system);
1464 BYTE* nullTerminator = memchr(dst_data,
'\0', dst_size);
1467 const intptr_t diff = nullTerminator - dst_data;
1468 WINPR_ASSERT(diff >= 0);
1469 WINPR_ASSERT(diff <= UINT32_MAX);
1470 dst_size = (UINT32)diff;
1474 cached_data = xf_cached_data_new(dst_data, dst_size);
1477 WLog_WARN(TAG,
"Failed to allocate cache entry");
1482 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId), cached_data))
1484 WLog_WARN(TAG,
"Failed to cache clipboard data");
1485 xf_cached_data_free(cached_data);
1492static BOOL xf_cliprdr_process_selection_request(xfClipboard* clipboard,
1493 const XSelectionRequestEvent* xevent)
1497 UINT32 formatId = 0;
1498 XSelectionEvent* respond = NULL;
1500 BOOL delayRespond = 0;
1501 BOOL rawTransfer = 0;
1502 unsigned long length = 0;
1503 unsigned long bytes_left = 0;
1504 xfContext* xfc = NULL;
1506 WINPR_ASSERT(clipboard);
1507 WINPR_ASSERT(xevent);
1509 xfc = clipboard->xfc;
1512 if (xevent->owner != xfc->drawable)
1515 delayRespond = FALSE;
1517 if (!(respond = (XSelectionEvent*)calloc(1,
sizeof(XSelectionEvent))))
1519 WLog_ERR(TAG,
"failed to allocate XEvent data");
1523 respond->property = None;
1524 respond->type = SelectionNotify;
1525 respond->display = xevent->display;
1526 respond->requestor = xevent->requestor;
1527 respond->selection = xevent->selection;
1528 respond->target = xevent->target;
1529 respond->time = xevent->time;
1531 if (xevent->target == clipboard->targets[0])
1534 respond->property = xevent->property;
1535 xf_cliprdr_provide_timestamp(clipboard, respond);
1537 else if (xevent->target == clipboard->targets[1])
1540 respond->property = xevent->property;
1541 xf_cliprdr_provide_targets(clipboard, respond);
1546 xf_cliprdr_get_server_format_by_atom(clipboard, xevent->target);
1547 const xfCliprdrFormat* cformat =
1548 xf_cliprdr_get_client_format_by_atom(clipboard, xevent->target);
1550 if (format && (xevent->requestor != xfc->drawable))
1552 formatId = format->formatId;
1553 rawTransfer = FALSE;
1554 xfCachedData* cached_data = NULL;
1555 UINT32 dstFormatId = 0;
1557 if (formatId == CF_RAW)
1559 if (LogTagAndXGetWindowProperty(
1560 TAG, xfc->display, xevent->requestor, clipboard->property_atom, 0, 4, 0,
1561 XA_INTEGER, &type, &fmt, &length, &bytes_left, &data) != Success)
1568 CopyMemory(&formatId, data, 4);
1573 dstFormatId = get_dst_format_id_for_local_request(clipboard, cformat);
1574 DEBUG_CLIPRDR(
"formatId: %u, dstFormatId: %u", formatId, dstFormatId);
1577 cached_data = HashTable_GetItemValue(clipboard->cachedData,
1578 format_to_cache_slot(dstFormatId));
1580 cached_data = HashTable_GetItemValue(clipboard->cachedRawData,
1581 format_to_cache_slot(formatId));
1583 DEBUG_CLIPRDR(
"hasCachedData: %u, rawTransfer: %u", cached_data ? 1 : 0, rawTransfer);
1585 if (!cached_data && !rawTransfer)
1587 UINT32 srcFormatId = 0;
1588 BOOL nullTerminated = FALSE;
1589 xfCachedData* cached_raw_data = NULL;
1591 get_src_format_info_for_local_request(clipboard, cformat, &srcFormatId,
1594 HashTable_GetItemValue(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId);
1596 DEBUG_CLIPRDR(
"hasCachedRawData: %u, rawDataLength: %u", cached_raw_data ? 1 : 0,
1597 cached_raw_data ? cached_raw_data->data_length : 0);
1599 if (cached_raw_data && cached_raw_data->data_length != 0)
1600 cached_data = convert_data_from_existing_raw_data(
1601 clipboard, cached_raw_data, srcFormatId, nullTerminated, dstFormatId);
1604 DEBUG_CLIPRDR(
"hasCachedData: %u", cached_data ? 1 : 0);
1609 respond->property = xevent->property;
1612 xf_cliprdr_provide_data(clipboard, respond, cached_data->data,
1613 cached_data->data_length);
1615 else if (clipboard->respond)
1621 WINPR_ASSERT(cformat);
1627 respond->property = xevent->property;
1628 clipboard->respond = respond;
1629 requested_format_replace(&clipboard->requestedFormat, formatId,
1630 cformat->formatName);
1631 clipboard->data_raw_format = rawTransfer;
1632 delayRespond = TRUE;
1633 xf_cliprdr_send_data_request(clipboard, formatId, cformat);
1643 XSelectionEvent* sev;
1647 XSendEvent(xfc->display, xevent->requestor, 0, 0, conv.ev);
1648 XFlush(xfc->display);
1655static BOOL xf_cliprdr_process_selection_clear(xfClipboard* clipboard,
1656 const XSelectionClearEvent* xevent)
1658 xfContext* xfc = NULL;
1660 WINPR_ASSERT(clipboard);
1661 WINPR_ASSERT(xevent);
1663 xfc = clipboard->xfc;
1666 WINPR_UNUSED(xevent);
1668 if (xf_cliprdr_is_self_owned(clipboard))
1671 LogTagAndXDeleteProperty(TAG, xfc->display, clipboard->root_window, clipboard->property_atom);
1675static BOOL xf_cliprdr_process_property_notify(xfClipboard* clipboard,
const XPropertyEvent* xevent)
1677 const xfCliprdrFormat* format = NULL;
1678 xfContext* xfc = NULL;
1683 xfc = clipboard->xfc;
1685 WINPR_ASSERT(xevent);
1687 if (xevent->atom == clipboard->timestamp_property_atom)
1693 xf_cliprdr_set_selection_owner(xfc, clipboard, xevent->time);
1697 if (xevent->atom != clipboard->property_atom)
1700 if (xevent->window == clipboard->root_window)
1702 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1704 else if ((xevent->window == xfc->drawable) && (xevent->state == PropertyNewValue) &&
1705 clipboard->incr_starts)
1707 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1710 xf_cliprdr_get_requested_data(clipboard, format->atom);
1716void xf_cliprdr_handle_xevent(xfContext* xfc,
const XEvent* event)
1718 xfClipboard* clipboard = NULL;
1723 clipboard = xfc->clipboard;
1730 if (clipboard->xfixes_supported &&
1731 event->type == XFixesSelectionNotify + clipboard->xfixes_event_base)
1733 const XFixesSelectionNotifyEvent* se = (
const XFixesSelectionNotifyEvent*)event;
1735 if (se->subtype == XFixesSetSelectionOwnerNotify)
1737 if (se->selection != clipboard->clipboard_atom)
1740 if (XGetSelectionOwner(xfc->display, se->selection) == xfc->drawable)
1743 clipboard->owner = None;
1744 xf_cliprdr_check_owner(clipboard);
1752 switch (event->type)
1754 case SelectionNotify:
1755 log_selection_event(xfc, event);
1756 xf_cliprdr_process_selection_notify(clipboard, &event->xselection);
1759 case SelectionRequest:
1760 log_selection_event(xfc, event);
1761 xf_cliprdr_process_selection_request(clipboard, &event->xselectionrequest);
1764 case SelectionClear:
1765 log_selection_event(xfc, event);
1766 xf_cliprdr_process_selection_clear(clipboard, &event->xselectionclear);
1769 case PropertyNotify:
1770 log_selection_event(xfc, event);
1771 xf_cliprdr_process_property_notify(clipboard, &event->xproperty);
1775 if (!clipboard->xfixes_supported)
1777 xf_cliprdr_check_owner(clipboard);
1791static UINT xf_cliprdr_send_client_capabilities(xfClipboard* clipboard)
1796 WINPR_ASSERT(clipboard);
1798 capabilities.cCapabilitiesSets = 1;
1800 generalCapabilitySet.capabilitySetType = CB_CAPSTYPE_GENERAL;
1801 generalCapabilitySet.capabilitySetLength = 12;
1802 generalCapabilitySet.version = CB_CAPS_VERSION_2;
1803 generalCapabilitySet.generalFlags = CB_USE_LONG_FORMAT_NAMES;
1805 WINPR_ASSERT(clipboard);
1806 generalCapabilitySet.generalFlags |= cliprdr_file_context_current_flags(clipboard->file);
1808 WINPR_ASSERT(clipboard->context);
1809 WINPR_ASSERT(clipboard->context->ClientCapabilities);
1810 return clipboard->context->ClientCapabilities(clipboard->context, &capabilities);
1818static UINT xf_cliprdr_send_client_format_list(xfClipboard* clipboard, BOOL force)
1820 WINPR_ASSERT(clipboard);
1822 xfContext* xfc = clipboard->xfc;
1825 UINT32 numFormats = 0;
1826 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
1828 const UINT ret = xf_cliprdr_send_format_list(clipboard, formats, numFormats, force);
1830 if (clipboard->owner && clipboard->owner != xfc->drawable)
1833 LogTagAndXConvertSelection(TAG, xfc->display, clipboard->clipboard_atom,
1834 clipboard->targets[1], clipboard->property_atom, xfc->drawable,
1838 xf_cliprdr_free_formats(formats, numFormats);
1848static UINT xf_cliprdr_send_client_format_list_response(xfClipboard* clipboard, BOOL status)
1852 formatListResponse.common.msgType = CB_FORMAT_LIST_RESPONSE;
1853 formatListResponse.common.msgFlags = status ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
1854 formatListResponse.common.dataLen = 0;
1856 WINPR_ASSERT(clipboard);
1857 WINPR_ASSERT(clipboard->context);
1858 WINPR_ASSERT(clipboard->context->ClientFormatListResponse);
1859 return clipboard->context->ClientFormatListResponse(clipboard->context, &formatListResponse);
1867static UINT xf_cliprdr_monitor_ready(CliprdrClientContext* context,
1871 xfClipboard* clipboard = NULL;
1873 WINPR_ASSERT(context);
1874 WINPR_ASSERT(monitorReady);
1876 clipboard = cliprdr_file_context_get_context(context->custom);
1877 WINPR_ASSERT(clipboard);
1879 WINPR_UNUSED(monitorReady);
1881 if ((ret = xf_cliprdr_send_client_capabilities(clipboard)) != CHANNEL_RC_OK)
1884 xf_clipboard_formats_free(clipboard);
1886 if ((ret = xf_cliprdr_send_client_format_list(clipboard, TRUE)) != CHANNEL_RC_OK)
1889 clipboard->sync = TRUE;
1890 return CHANNEL_RC_OK;
1898static UINT xf_cliprdr_server_capabilities(CliprdrClientContext* context,
1902 const BYTE* capsPtr = NULL;
1903 xfClipboard* clipboard = NULL;
1905 WINPR_ASSERT(context);
1906 WINPR_ASSERT(capabilities);
1908 clipboard = cliprdr_file_context_get_context(context->custom);
1909 WINPR_ASSERT(clipboard);
1911 capsPtr = (
const BYTE*)capabilities->capabilitySets;
1912 WINPR_ASSERT(capsPtr);
1914 cliprdr_file_context_remote_set_flags(clipboard->file, 0);
1916 for (UINT32 i = 0; i < capabilities->cCapabilitiesSets; i++)
1920 if (caps->capabilitySetType == CB_CAPSTYPE_GENERAL)
1924 cliprdr_file_context_remote_set_flags(clipboard->file, generalCaps->generalFlags);
1927 capsPtr += caps->capabilitySetLength;
1930 return CHANNEL_RC_OK;
1933static void xf_cliprdr_prepare_to_set_selection_owner(xfContext* xfc, xfClipboard* clipboard)
1936 WINPR_ASSERT(clipboard);
1953 Atom value = clipboard->timestamp_property_atom;
1955 LogTagAndXChangeProperty(TAG, xfc->display, xfc->drawable, clipboard->timestamp_property_atom,
1956 XA_ATOM, 32, PropModeReplace, (
const BYTE*)&value, 1);
1957 XFlush(xfc->display);
1960static void xf_cliprdr_set_selection_owner(xfContext* xfc, xfClipboard* clipboard, Time timestamp)
1963 WINPR_ASSERT(clipboard);
1969 clipboard->selection_ownership_timestamp = timestamp;
1970 XSetSelectionOwner(xfc->display, clipboard->clipboard_atom, xfc->drawable, timestamp);
1971 XFlush(xfc->display);
1979static UINT xf_cliprdr_server_format_list(CliprdrClientContext* context,
1982 xfContext* xfc = NULL;
1984 xfClipboard* clipboard = NULL;
1986 WINPR_ASSERT(context);
1987 WINPR_ASSERT(formatList);
1989 clipboard = cliprdr_file_context_get_context(context->custom);
1990 WINPR_ASSERT(clipboard);
1992 xfc = clipboard->xfc;
1998 free(clipboard->respond);
1999 clipboard->respond = NULL;
2001 xf_clipboard_formats_free(clipboard);
2002 xf_cliprdr_clear_cached_data(clipboard);
2003 requested_format_free(&clipboard->requestedFormat);
2005 xf_clipboard_free_server_formats(clipboard);
2007 clipboard->numServerFormats = formatList->numFormats + 1;
2009 if (!(clipboard->serverFormats =
2012 WLog_ERR(TAG,
"failed to allocate %d CLIPRDR_FORMAT structs", clipboard->numServerFormats);
2013 ret = CHANNEL_RC_NO_MEMORY;
2017 for (
size_t i = 0; i < formatList->numFormats; i++)
2022 srvFormat->formatId = format->formatId;
2024 if (format->formatName)
2026 srvFormat->formatName = _strdup(format->formatName);
2028 if (!srvFormat->formatName)
2030 for (UINT32 k = 0; k < i; k++)
2031 free(clipboard->serverFormats[k].formatName);
2033 clipboard->numServerFormats = 0;
2034 free(clipboard->serverFormats);
2035 clipboard->serverFormats = NULL;
2036 ret = CHANNEL_RC_NO_MEMORY;
2042 ret = cliprdr_file_context_notify_new_server_format_list(clipboard->file);
2048 CLIPRDR_FORMAT* format = &clipboard->serverFormats[formatList->numFormats];
2049 format->formatId = CF_RAW;
2050 format->formatName = NULL;
2052 xf_cliprdr_provide_server_format_list(clipboard);
2053 clipboard->numTargets = 2;
2055 for (
size_t i = 0; i < formatList->numFormats; i++)
2059 for (
size_t j = 0; j < clipboard->numClientFormats; j++)
2061 const xfCliprdrFormat* clientFormat = &clipboard->clientFormats[j];
2062 if (xf_cliprdr_formats_equal(format, clientFormat))
2064 if ((clientFormat->formatName != NULL) &&
2065 (strcmp(type_FileGroupDescriptorW, clientFormat->formatName) == 0))
2067 if (!cliprdr_file_context_has_local_support(clipboard->file))
2070 xf_cliprdr_append_target(clipboard, clientFormat->atom);
2075 ret = xf_cliprdr_send_client_format_list_response(clipboard, TRUE);
2076 if (xfc->remote_app)
2077 xf_cliprdr_set_selection_owner(xfc, clipboard, CurrentTime);
2079 xf_cliprdr_prepare_to_set_selection_owner(xfc, clipboard);
2092static UINT xf_cliprdr_server_format_list_response(
2093 WINPR_ATTR_UNUSED CliprdrClientContext* context,
2096 WINPR_ASSERT(context);
2097 WINPR_ASSERT(formatListResponse);
2099 return CHANNEL_RC_OK;
2108xf_cliprdr_server_format_data_request(CliprdrClientContext* context,
2111 const xfCliprdrFormat* format = NULL;
2113 WINPR_ASSERT(context);
2114 WINPR_ASSERT(formatDataRequest);
2116 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2117 WINPR_ASSERT(clipboard);
2119 xfContext* xfc = clipboard->xfc;
2122 const uint32_t formatId = formatDataRequest->requestedFormatId;
2124 const BOOL rawTransfer = xf_cliprdr_is_raw_transfer_available(clipboard);
2128 format = xf_cliprdr_get_client_format_by_id(clipboard, CF_RAW);
2129 LogTagAndXChangeProperty(TAG, xfc->display, xfc->drawable, clipboard->property_atom,
2130 XA_INTEGER, 32, PropModeReplace, (
const BYTE*)&formatId, 1);
2133 format = xf_cliprdr_get_client_format_by_id(clipboard, formatId);
2135 clipboard->requestedFormatId = rawTransfer ? CF_RAW : formatId;
2137 return xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
2139 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
"} [%s]",
2140 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2141 format->localFormat, format->formatName);
2142 LogTagAndXConvertSelection(TAG, xfc->display, clipboard->clipboard_atom, format->atom,
2143 clipboard->property_atom, xfc->drawable, CurrentTime);
2144 XFlush(xfc->display);
2146 return CHANNEL_RC_OK;
2155xf_cliprdr_server_format_data_response(CliprdrClientContext* context,
2159 BYTE* pDstData = NULL;
2162 UINT32 srcFormatId = 0;
2163 UINT32 dstFormatId = 0;
2164 BOOL nullTerminated = FALSE;
2166 const BYTE* data = NULL;
2167 xfContext* xfc = NULL;
2168 xfClipboard* clipboard = NULL;
2169 xfCachedData* cached_data = NULL;
2171 WINPR_ASSERT(context);
2172 WINPR_ASSERT(formatDataResponse);
2174 clipboard = cliprdr_file_context_get_context(context->custom);
2175 WINPR_ASSERT(clipboard);
2177 xfc = clipboard->xfc;
2180 size = formatDataResponse->common.dataLen;
2181 data = formatDataResponse->requestedFormatData;
2183 if (formatDataResponse->common.msgFlags == CB_RESPONSE_FAIL)
2185 WLog_WARN(TAG,
"Format Data Response PDU msgFlags is CB_RESPONSE_FAIL");
2186 free(clipboard->respond);
2187 clipboard->respond = NULL;
2188 return CHANNEL_RC_OK;
2191 if (!clipboard->respond)
2192 return CHANNEL_RC_OK;
2199 const RequestedFormat* format = clipboard->requestedFormat;
2200 if (clipboard->data_raw_format)
2202 srcFormatId = CF_RAW;
2203 dstFormatId = CF_RAW;
2206 return ERROR_INTERNAL_ERROR;
2207 else if (format->formatName)
2209 ClipboardLock(clipboard->system);
2210 if (strcmp(format->formatName, type_HtmlFormat) == 0)
2212 srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
2213 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
2214 nullTerminated = TRUE;
2217 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
2219 if (!cliprdr_file_context_update_server_data(clipboard->file, clipboard->system, data,
2221 WLog_WARN(TAG,
"failed to update file descriptors");
2223 srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2224 const xfCliprdrFormat* dstTargetFormat =
2225 xf_cliprdr_get_client_format_by_atom(clipboard, clipboard->respond->target);
2226 if (!dstTargetFormat)
2228 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2232 dstFormatId = dstTargetFormat->localFormat;
2235 nullTerminated = TRUE;
2237 ClipboardUnlock(clipboard->system);
2241 srcFormatId = format->formatToRequest;
2242 dstFormatId = format->localFormat;
2243 switch (format->formatToRequest)
2246 nullTerminated = TRUE;
2250 nullTerminated = TRUE;
2253 case CF_UNICODETEXT:
2254 nullTerminated = TRUE;
2258 srcFormatId = CF_DIB;
2262 srcFormatId = CF_TIFF;
2270 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
"} [%s]",
2271 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2272 format->localFormat, format->formatName);
2275 DEBUG_CLIPRDR(
"srcFormatId: %u, dstFormatId: %u", srcFormatId, dstFormatId);
2277 ClipboardLock(clipboard->system);
2278 bSuccess = ClipboardSetData(clipboard->system, srcFormatId, data, SrcSize);
2280 BOOL willQuit = FALSE;
2285 WLog_DBG(TAG,
"skipping, empty data detected!");
2286 free(clipboard->respond);
2287 clipboard->respond = NULL;
2292 pDstData = (BYTE*)ClipboardGetData(clipboard->system, dstFormatId, &DstSize);
2296 WLog_WARN(TAG,
"failed to get clipboard data in format %s [source format %s]",
2297 ClipboardGetFormatName(clipboard->system, dstFormatId),
2298 ClipboardGetFormatName(clipboard->system, srcFormatId));
2301 if (nullTerminated && pDstData)
2303 BYTE* nullTerminator = memchr(pDstData,
'\0', DstSize);
2306 const intptr_t diff = nullTerminator - pDstData;
2307 WINPR_ASSERT(diff >= 0);
2308 WINPR_ASSERT(diff <= UINT32_MAX);
2309 DstSize = (UINT32)diff;
2314 ClipboardUnlock(clipboard->system);
2316 return CHANNEL_RC_OK;
2322 cached_data = xf_cached_data_new(pDstData, DstSize);
2325 WLog_WARN(TAG,
"Failed to allocate cache entry");
2327 return CHANNEL_RC_OK;
2329 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId),
2332 WLog_WARN(TAG,
"Failed to cache clipboard data");
2333 xf_cached_data_free(cached_data);
2334 return CHANNEL_RC_OK;
2344 xfCachedData* cached_raw_data = xf_cached_data_new_copy(data, size);
2345 if (!cached_raw_data)
2346 WLog_WARN(TAG,
"Failed to allocate cache entry");
2349 if (!HashTable_Insert(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId,
2352 WLog_WARN(TAG,
"Failed to cache clipboard data");
2353 xf_cached_data_free(cached_raw_data);
2360 xf_cliprdr_provide_data(clipboard, clipboard->respond, pDstData, DstSize);
2365 XSelectionEvent* sev;
2368 conv.sev = clipboard->respond;
2370 XSendEvent(xfc->display, clipboard->respond->requestor, 0, 0, conv.ev);
2371 XFlush(xfc->display);
2373 free(clipboard->respond);
2374 clipboard->respond = NULL;
2375 return CHANNEL_RC_OK;
2378static BOOL xf_cliprdr_is_valid_unix_filename(LPCWSTR filename)
2383 if (filename[0] == L
'\0')
2387 for (
const WCHAR* c = filename; *c; ++c)
2396xfClipboard* xf_clipboard_new(xfContext* xfc, BOOL relieveFilenameRestriction)
2399 rdpChannels* channels = NULL;
2400 xfClipboard* clipboard = NULL;
2401 const char* selectionAtom = NULL;
2402 xfCliprdrFormat* clientFormat = NULL;
2406 WINPR_ASSERT(xfc->common.context.settings);
2408 if (!(clipboard = (xfClipboard*)calloc(1,
sizeof(xfClipboard))))
2410 WLog_ERR(TAG,
"failed to allocate xfClipboard data");
2414 clipboard->file = cliprdr_file_context_new(clipboard);
2415 if (!clipboard->file)
2418 xfc->clipboard = clipboard;
2419 clipboard->xfc = xfc;
2420 channels = xfc->common.context.channels;
2421 clipboard->channels = channels;
2422 clipboard->system = ClipboardCreate();
2423 clipboard->requestedFormatId = UINT32_MAX;
2424 clipboard->root_window = DefaultRootWindow(xfc->display);
2429 selectionAtom =
"CLIPBOARD";
2431 clipboard->clipboard_atom = Logging_XInternAtom(xfc->log, xfc->display, selectionAtom, FALSE);
2433 if (clipboard->clipboard_atom == None)
2435 WLog_ERR(TAG,
"unable to get %s atom", selectionAtom);
2439 clipboard->timestamp_property_atom =
2440 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_TIMESTAMP_PROPERTY", FALSE);
2441 clipboard->property_atom =
2442 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR", FALSE);
2443 clipboard->raw_transfer_atom =
2444 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_RAW", FALSE);
2445 clipboard->raw_format_list_atom =
2446 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_FORMATS", FALSE);
2447 xf_cliprdr_set_raw_transfer_enabled(clipboard, TRUE);
2448 XSelectInput(xfc->display, clipboard->root_window, PropertyChangeMask);
2451 if (XFixesQueryExtension(xfc->display, &clipboard->xfixes_event_base,
2452 &clipboard->xfixes_error_base))
2457 if (XFixesQueryVersion(xfc->display, &xfmajor, &xfminor))
2459 XFixesSelectSelectionInput(xfc->display, clipboard->root_window,
2460 clipboard->clipboard_atom,
2461 XFixesSetSelectionOwnerNotifyMask);
2462 clipboard->xfixes_supported = TRUE;
2466 WLog_ERR(TAG,
"Error querying X Fixes extension version");
2471 WLog_ERR(TAG,
"Error loading X Fixes extension");
2477 "Warning: Using clipboard redirection without XFIXES extension is strongly discouraged!");
2479 clientFormat = &clipboard->clientFormats[n++];
2480 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_RAW", False);
2481 clientFormat->localFormat = clientFormat->formatToRequest = CF_RAW;
2483 clientFormat = &clipboard->clientFormats[n++];
2484 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"UTF8_STRING", False);
2485 clientFormat->formatToRequest = CF_UNICODETEXT;
2486 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2488 clientFormat = &clipboard->clientFormats[n++];
2489 clientFormat->atom = XA_STRING;
2490 clientFormat->formatToRequest = CF_TEXT;
2491 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2493 clientFormat = &clipboard->clientFormats[n++];
2494 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_tiff, False);
2495 clientFormat->formatToRequest = clientFormat->localFormat = CF_TIFF;
2497 for (
size_t x = 0; x < ARRAYSIZE(mime_bitmap); x++)
2499 const char* mime_bmp = mime_bitmap[x];
2500 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2503 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2507 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2508 clientFormat = &clipboard->clientFormats[n++];
2509 clientFormat->localFormat = format;
2510 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2511 clientFormat->formatToRequest = CF_DIB;
2512 clientFormat->isImage = TRUE;
2515 for (
size_t x = 0; x < ARRAYSIZE(mime_images); x++)
2517 const char* mime_bmp = mime_images[x];
2518 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2521 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2525 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2526 clientFormat = &clipboard->clientFormats[n++];
2527 clientFormat->localFormat = format;
2528 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2529 clientFormat->formatToRequest = CF_DIB;
2530 clientFormat->isImage = TRUE;
2533 clientFormat = &clipboard->clientFormats[n++];
2534 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_html, False);
2535 clientFormat->formatToRequest = ClipboardGetFormatId(xfc->clipboard->system, type_HtmlFormat);
2536 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_html);
2537 clientFormat->formatName = _strdup(type_HtmlFormat);
2539 if (!clientFormat->formatName)
2542 clientFormat = &clipboard->clientFormats[n++];
2550 const UINT32 fgid = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2551 const UINT32 uid = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2554 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2555 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_uri_list, False);
2556 clientFormat->localFormat = uid;
2557 clientFormat->formatToRequest = fgid;
2558 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2560 if (!clientFormat->formatName)
2563 clientFormat = &clipboard->clientFormats[n++];
2566 const UINT32 gid = ClipboardGetFormatId(clipboard->system, mime_gnome_copied_files);
2569 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2570 clientFormat->atom =
2571 Logging_XInternAtom(xfc->log, xfc->display, mime_gnome_copied_files, False);
2572 clientFormat->localFormat = gid;
2573 clientFormat->formatToRequest = fgid;
2574 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2576 if (!clientFormat->formatName)
2579 clientFormat = &clipboard->clientFormats[n++];
2582 const UINT32 mid = ClipboardGetFormatId(clipboard->system, mime_mate_copied_files);
2585 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2586 clientFormat->atom =
2587 Logging_XInternAtom(xfc->log, xfc->display, mime_mate_copied_files, False);
2588 clientFormat->localFormat = mid;
2589 clientFormat->formatToRequest = fgid;
2590 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2592 if (!clientFormat->formatName)
2596 clipboard->numClientFormats = WINPR_ASSERTING_INT_CAST(uint32_t, n);
2597 clipboard->targets[0] = Logging_XInternAtom(xfc->log, xfc->display,
"TIMESTAMP", FALSE);
2598 clipboard->targets[1] = Logging_XInternAtom(xfc->log, xfc->display,
"TARGETS", FALSE);
2599 clipboard->numTargets = 2;
2600 clipboard->incr_atom = Logging_XInternAtom(xfc->log, xfc->display,
"INCR", FALSE);
2602 if (relieveFilenameRestriction)
2604 WLog_DBG(TAG,
"Relieving CLIPRDR filename restriction");
2605 ClipboardGetDelegate(clipboard->system)->IsFileNameComponentValid =
2606 xf_cliprdr_is_valid_unix_filename;
2609 clipboard->cachedData = HashTable_New(TRUE);
2610 if (!clipboard->cachedData)
2613 obj = HashTable_ValueObject(clipboard->cachedData);
2614 obj->fnObjectFree = xf_cached_data_free;
2616 clipboard->cachedRawData = HashTable_New(TRUE);
2617 if (!clipboard->cachedRawData)
2620 obj = HashTable_ValueObject(clipboard->cachedRawData);
2621 obj->fnObjectFree = xf_cached_data_free;
2626 WINPR_PRAGMA_DIAG_PUSH
2627 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2628 xf_clipboard_free(clipboard);
2629 WINPR_PRAGMA_DIAG_POP
2633void xf_clipboard_free(xfClipboard* clipboard)
2638 xf_clipboard_free_server_formats(clipboard);
2640 if (clipboard->numClientFormats)
2642 for (UINT32 i = 0; i < clipboard->numClientFormats; i++)
2644 xfCliprdrFormat* format = &clipboard->clientFormats[i];
2645 free(format->formatName);
2649 cliprdr_file_context_free(clipboard->file);
2651 ClipboardDestroy(clipboard->system);
2652 xf_clipboard_formats_free(clipboard);
2653 HashTable_Free(clipboard->cachedRawData);
2654 HashTable_Free(clipboard->cachedData);
2655 requested_format_free(&clipboard->requestedFormat);
2656 free(clipboard->respond);
2657 free(clipboard->incr_data);
2661void xf_cliprdr_init(xfContext* xfc, CliprdrClientContext* cliprdr)
2664 WINPR_ASSERT(cliprdr);
2666 xfc->cliprdr = cliprdr;
2667 xfc->clipboard->context = cliprdr;
2669 cliprdr->MonitorReady = xf_cliprdr_monitor_ready;
2670 cliprdr->ServerCapabilities = xf_cliprdr_server_capabilities;
2671 cliprdr->ServerFormatList = xf_cliprdr_server_format_list;
2672 cliprdr->ServerFormatListResponse = xf_cliprdr_server_format_list_response;
2673 cliprdr->ServerFormatDataRequest = xf_cliprdr_server_format_data_request;
2674 cliprdr->ServerFormatDataResponse = xf_cliprdr_server_format_data_response;
2676 cliprdr_file_context_init(xfc->clipboard->file, cliprdr);
2679void xf_cliprdr_uninit(xfContext* xfc, CliprdrClientContext* cliprdr)
2682 WINPR_ASSERT(cliprdr);
2684 xfc->cliprdr = NULL;
2688 cliprdr_file_context_uninit(xfc->clipboard->file, cliprdr);
2689 xfc->clipboard->context = NULL;
FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
This struct contains function pointer to initialize/free objects.