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#define DEBUG_CLIPRDR(...) WLog_DBG(TAG, __VA_ARGS__)
62 UINT32 formatToRequest;
77 UINT32 formatToRequest;
84 rdpChannels* channels;
85 CliprdrClientContext* context;
93 Atom timestamp_property_atom;
94 Time selection_ownership_timestamp;
96 Atom raw_transfer_atom;
97 Atom raw_format_list_atom;
99 UINT32 numClientFormats;
100 xfCliprdrFormat clientFormats[20];
102 UINT32 numServerFormats;
108 UINT32 requestedFormatId;
110 wHashTable* cachedData;
111 wHashTable* cachedRawData;
113 BOOL data_raw_format;
115 RequestedFormat* requestedFormat;
117 XSelectionEvent* respond;
126 size_t incr_data_length;
130 int xfixes_event_base;
131 int xfixes_error_base;
132 BOOL xfixes_supported;
136 UINT32 lastSentNumFormats;
137 CliprdrFileContext* file;
141static const char mime_text_plain[] =
"text/plain";
142static const char mime_uri_list[] =
"text/uri-list";
143static const char mime_html[] =
"text/html";
144static const char* mime_bitmap[] = {
"image/bmp",
"image/x-bmp",
"image/x-MS-bmp",
145 "image/x-win-bitmap" };
146static const char mime_webp[] =
"image/webp";
147static const char mime_png[] =
"image/png";
148static const char mime_jpeg[] =
"image/jpeg";
149static const char mime_tiff[] =
"image/tiff";
150static const char* mime_images[] = { mime_webp, mime_png, mime_jpeg, mime_tiff };
152static const char mime_gnome_copied_files[] =
"x-special/gnome-copied-files";
153static const char mime_mate_copied_files[] =
"x-special/mate-copied-files";
155static const char type_FileGroupDescriptorW[] =
"FileGroupDescriptorW";
156static const char type_HtmlFormat[] =
"HTML Format";
158static void xf_cliprdr_clear_cached_data(xfClipboard* clipboard);
159static UINT xf_cliprdr_send_client_format_list(xfClipboard* clipboard, BOOL force);
160static void xf_cliprdr_set_selection_owner(xfContext* xfc, xfClipboard* clipboard, Time timestamp);
162static void requested_format_free(RequestedFormat** ppRequestedFormat)
164 if (!ppRequestedFormat)
166 if (!(*ppRequestedFormat))
169 free((*ppRequestedFormat)->formatName);
170 free(*ppRequestedFormat);
171 *ppRequestedFormat = NULL;
174static BOOL requested_format_replace(RequestedFormat** ppRequestedFormat, UINT32 remoteFormatId,
175 UINT32 localFormatId,
const char* formatName)
177 if (!ppRequestedFormat)
180 requested_format_free(ppRequestedFormat);
181 RequestedFormat* requested = calloc(1,
sizeof(RequestedFormat));
184 requested->localFormat = localFormatId;
185 requested->formatToRequest = remoteFormatId;
188 requested->formatName = _strdup(formatName);
189 if (!requested->formatName)
196 *ppRequestedFormat = requested;
200static void xf_cached_data_free(
void* ptr)
202 xfCachedData* cached_data = ptr;
206 free(cached_data->data);
210static xfCachedData* xf_cached_data_new(BYTE* data,
size_t data_length)
212 if (data_length > UINT32_MAX)
215 xfCachedData* cached_data = calloc(1,
sizeof(xfCachedData));
219 cached_data->data = data;
220 cached_data->data_length = (UINT32)data_length;
225static xfCachedData* xf_cached_data_new_copy(
const BYTE* data,
size_t data_length)
230 copy = calloc(data_length + 1,
sizeof(BYTE));
233 memcpy(copy, data, data_length);
236 xfCachedData* cache = xf_cached_data_new(copy, data_length);
242static void xf_clipboard_free_server_formats(xfClipboard* clipboard)
244 WINPR_ASSERT(clipboard);
245 if (clipboard->serverFormats)
247 for (
size_t i = 0; i < clipboard->numServerFormats; i++)
250 free(format->formatName);
253 free(clipboard->serverFormats);
254 clipboard->serverFormats = NULL;
258static BOOL xf_cliprdr_update_owner(xfClipboard* clipboard)
260 WINPR_ASSERT(clipboard);
262 xfContext* xfc = clipboard->xfc;
265 if (!clipboard->sync)
268 Window owner = LogDynAndXGetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom);
269 if (clipboard->owner == owner)
272 clipboard->owner = owner;
276static void xf_cliprdr_check_owner(xfClipboard* clipboard)
278 if (xf_cliprdr_update_owner(clipboard))
279 xf_cliprdr_send_client_format_list(clipboard, FALSE);
282static BOOL xf_cliprdr_is_self_owned(xfClipboard* clipboard)
284 xfContext* xfc = NULL;
286 WINPR_ASSERT(clipboard);
288 xfc = clipboard->xfc;
290 return LogDynAndXGetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom) ==
294static void xf_cliprdr_set_raw_transfer_enabled(xfClipboard* clipboard, BOOL enabled)
296 UINT32 data = WINPR_ASSERTING_INT_CAST(uint32_t, enabled);
297 xfContext* xfc = NULL;
299 WINPR_ASSERT(clipboard);
301 xfc = clipboard->xfc;
303 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable, clipboard->raw_transfer_atom,
304 XA_INTEGER, 32, PropModeReplace, (
const BYTE*)&data, 1);
307static BOOL xf_cliprdr_is_raw_transfer_available(xfClipboard* clipboard)
312 unsigned long length = 0;
313 unsigned long bytes_left = 0;
315 UINT32 is_enabled = 0;
317 xfContext* xfc = NULL;
319 WINPR_ASSERT(clipboard);
321 xfc = clipboard->xfc;
324 owner = LogDynAndXGetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom);
328 result = LogDynAndXGetWindowProperty(xfc->log, xfc->display, owner,
329 clipboard->raw_transfer_atom, 0, 4, 0, XA_INTEGER,
330 &type, &format, &length, &bytes_left, (BYTE**)&data);
339 if ((owner == None) || (owner == xfc->drawable))
342 if (result != Success)
345 return is_enabled ? TRUE : FALSE;
348static BOOL xf_cliprdr_formats_equal(
const CLIPRDR_FORMAT* server,
const xfCliprdrFormat* client)
350 WINPR_ASSERT(server);
351 WINPR_ASSERT(client);
353 if (server->formatName && client->formatName)
356 return (0 == strncmp(server->formatName, client->formatName, strlen(server->formatName)));
359 if (!server->formatName && !client->formatName)
361 return (server->formatId == client->formatToRequest);
367static const xfCliprdrFormat* xf_cliprdr_get_client_format_by_id(xfClipboard* clipboard,
370 WINPR_ASSERT(clipboard);
372 const BOOL formatIsHtml = formatId == ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
373 const BOOL fetchImage = clipboard->isImageContent && formatIsHtml;
374 for (
size_t index = 0; index < clipboard->numClientFormats; index++)
376 const xfCliprdrFormat* format = &(clipboard->clientFormats[index]);
378 if (fetchImage && format->isImage)
381 if (format->formatToRequest == formatId)
388static const xfCliprdrFormat* xf_cliprdr_get_client_format_by_atom(xfClipboard* clipboard,
391 WINPR_ASSERT(clipboard);
393 for (UINT32 i = 0; i < clipboard->numClientFormats; i++)
395 const xfCliprdrFormat* format = &(clipboard->clientFormats[i]);
397 if (format->atom == atom)
404static const CLIPRDR_FORMAT* xf_cliprdr_get_server_format_by_atom(xfClipboard* clipboard, Atom atom)
406 WINPR_ASSERT(clipboard);
408 for (
size_t i = 0; i < clipboard->numClientFormats; i++)
410 const xfCliprdrFormat* client_format = &(clipboard->clientFormats[i]);
412 if (client_format->atom == atom)
414 for (
size_t j = 0; j < clipboard->numServerFormats; j++)
416 const CLIPRDR_FORMAT* server_format = &(clipboard->serverFormats[j]);
418 if (xf_cliprdr_formats_equal(server_format, client_format))
419 return server_format;
432static UINT xf_cliprdr_send_data_request(xfClipboard* clipboard, UINT32 formatId,
433 WINPR_ATTR_UNUSED
const xfCliprdrFormat* cformat)
436 request.requestedFormatId = formatId;
438 DEBUG_CLIPRDR(
"requesting format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
"} [%s]", formatId,
439 ClipboardGetFormatIdString(formatId), cformat->localFormat, cformat->formatName);
441 WINPR_ASSERT(clipboard);
442 WINPR_ASSERT(clipboard->context);
443 WINPR_ASSERT(clipboard->context->ClientFormatDataRequest);
444 return clipboard->context->ClientFormatDataRequest(clipboard->context, &request);
452static UINT xf_cliprdr_send_data_response(xfClipboard* clipboard,
const xfCliprdrFormat* format,
453 const BYTE* data,
size_t size)
457 WINPR_ASSERT(clipboard);
460 if (clipboard->requestedFormatId == UINT32_MAX)
461 return CHANNEL_RC_OK;
466 DEBUG_CLIPRDR(
"send CB_RESPONSE_FAIL response {format 0x%08" PRIx32
467 " [%s] {local 0x%08" PRIx32
"} [%s]",
468 format->formatToRequest,
469 ClipboardGetFormatIdString(format->formatToRequest), format->localFormat,
472 DEBUG_CLIPRDR(
"send CB_RESPONSE_FAIL response");
476 WINPR_ASSERT(format);
477 DEBUG_CLIPRDR(
"send response format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
478 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
480 ClipboardGetFormatName(clipboard->system, format->localFormat),
484 clipboard->requestedFormatId = UINT32_MAX;
486 response.common.msgFlags = (data) ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
488 WINPR_ASSERT(size <= UINT32_MAX);
489 response.common.dataLen = (UINT32)size;
490 response.requestedFormatData = data;
492 WINPR_ASSERT(clipboard->context);
493 WINPR_ASSERT(clipboard->context->ClientFormatDataResponse);
494 return clipboard->context->ClientFormatDataResponse(clipboard->context, &response);
497static wStream* xf_cliprdr_serialize_server_format_list(xfClipboard* clipboard)
499 UINT32 formatCount = 0;
502 WINPR_ASSERT(clipboard);
505 if (!(s = Stream_New(NULL, 128)))
507 WLog_ERR(TAG,
"failed to allocate serialized format list");
512 formatCount = (clipboard->numServerFormats > 0) ? clipboard->numServerFormats - 1 : 0;
513 Stream_Write_UINT32(s, formatCount);
515 for (UINT32 i = 0; i < formatCount; i++)
518 size_t name_length = format->formatName ? strlen(format->formatName) : 0;
520 DEBUG_CLIPRDR(
"server announced 0x%08" PRIx32
" [%s][%s]", format->formatId,
521 ClipboardGetFormatIdString(format->formatId), format->formatName);
522 if (!Stream_EnsureRemainingCapacity(s,
sizeof(UINT32) + name_length + 1))
524 WLog_ERR(TAG,
"failed to expand serialized format list");
528 Stream_Write_UINT32(s, format->formatId);
530 if (format->formatName)
531 Stream_Write(s, format->formatName, name_length);
533 Stream_Write_UINT8(s,
'\0');
536 Stream_SealLength(s);
539 Stream_Free(s, TRUE);
543static CLIPRDR_FORMAT* xf_cliprdr_parse_server_format_list(BYTE* data,
size_t length,
549 WINPR_ASSERT(data || (length == 0));
550 WINPR_ASSERT(numFormats);
552 if (!(s = Stream_New(data, length)))
554 WLog_ERR(TAG,
"failed to allocate stream for parsing serialized format list");
558 if (!Stream_CheckAndLogRequiredLength(TAG, s,
sizeof(UINT32)))
561 Stream_Read_UINT32(s, *numFormats);
563 if (*numFormats > MAX_CLIPBOARD_FORMATS)
565 WLog_ERR(TAG,
"unexpectedly large number of formats: %" PRIu32
"", *numFormats);
571 WLog_ERR(TAG,
"failed to allocate format list");
575 for (UINT32 i = 0; i < *numFormats; i++)
577 const char* formatName = NULL;
578 size_t formatNameLength = 0;
580 if (!Stream_CheckAndLogRequiredLength(TAG, s,
sizeof(UINT32)))
583 Stream_Read_UINT32(s, formats[i].formatId);
584 formatName = (
const char*)Stream_Pointer(s);
585 formatNameLength = strnlen(formatName, Stream_GetRemainingLength(s));
587 if (formatNameLength == Stream_GetRemainingLength(s))
589 WLog_ERR(TAG,
"missing terminating null byte, %" PRIuz
" bytes left to read",
594 formats[i].formatName = strndup(formatName, formatNameLength);
595 Stream_Seek(s, formatNameLength + 1);
598 Stream_Free(s, FALSE);
601 Stream_Free(s, FALSE);
607static void xf_cliprdr_free_formats(
CLIPRDR_FORMAT* formats, UINT32 numFormats)
609 WINPR_ASSERT(formats || (numFormats == 0));
611 for (UINT32 i = 0; i < numFormats; i++)
613 free(formats[i].formatName);
619static CLIPRDR_FORMAT* xf_cliprdr_get_raw_server_formats(xfClipboard* clipboard, UINT32* numFormats)
623 unsigned long length = 0;
624 unsigned long remaining = 0;
627 xfContext* xfc = NULL;
629 WINPR_ASSERT(clipboard);
630 WINPR_ASSERT(numFormats);
632 xfc = clipboard->xfc;
637 Window owner = LogDynAndXGetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom);
638 LogDynAndXGetWindowProperty(xfc->log, xfc->display, owner, clipboard->raw_format_list_atom, 0,
639 4096, False, clipboard->raw_format_list_atom, &type, &format,
640 &length, &remaining, &data);
642 if (data && length > 0 && format == 8 && type == clipboard->raw_format_list_atom)
644 formats = xf_cliprdr_parse_server_format_list(data, length, numFormats);
649 "failed to retrieve raw format list: data=%p, length=%lu, format=%d, type=%lu "
651 (
void*)data, length, format, (
unsigned long)type,
652 (
unsigned long)clipboard->raw_format_list_atom);
661static BOOL xf_cliprdr_should_add_format(
const CLIPRDR_FORMAT* formats,
size_t count,
662 const xfCliprdrFormat* xformat)
664 WINPR_ASSERT(formats);
669 for (
size_t x = 0; x < count; x++)
672 if (format->formatId == xformat->formatToRequest)
678static CLIPRDR_FORMAT* xf_cliprdr_get_formats_from_targets(xfClipboard* clipboard,
683 int format_property = 0;
684 unsigned long proplength = 0;
685 unsigned long bytes_left = 0;
688 WINPR_ASSERT(clipboard);
689 WINPR_ASSERT(numFormats);
691 xfContext* xfc = clipboard->xfc;
695 LogDynAndXGetWindowProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0,
696 200, 0, XA_ATOM, &atom, &format_property, &proplength, &bytes_left,
701 unsigned long length = proplength + 1;
704 WLog_ERR(TAG,
"XGetWindowProperty set length = %lu but data is NULL", length);
710 WLog_ERR(TAG,
"failed to allocate %lu CLIPRDR_FORMAT structs", length);
716 BOOL isImage = FALSE;
717 BOOL hasHtml = FALSE;
718 const uint32_t htmlFormatId = ClipboardRegisterFormat(clipboard->system, type_HtmlFormat);
719 for (
unsigned long i = 0; i < proplength; i++)
721 Atom tatom = ((Atom*)data)[i];
722 const xfCliprdrFormat* format = xf_cliprdr_get_client_format_by_atom(clipboard, tatom);
724 if (xf_cliprdr_should_add_format(formats, *numFormats, format))
727 cformat->formatId = format->formatToRequest;
732 if (cformat->formatId == htmlFormatId)
737 if (cformat->formatId == CF_TIFF)
739 else if (cformat->formatId == CF_DIB)
741 else if (cformat->formatId == CF_DIBV5)
744 if (format->formatName)
746 cformat->formatName = _strdup(format->formatName);
747 WINPR_ASSERT(cformat->formatName);
750 cformat->formatName = NULL;
756 clipboard->isImageContent = isImage;
757 if (isImage && !hasHtml)
760 cformat->formatId = htmlFormatId;
761 cformat->formatName = _strdup(type_HtmlFormat);
774static CLIPRDR_FORMAT* xf_cliprdr_get_client_formats(xfClipboard* clipboard, UINT32* numFormats)
778 WINPR_ASSERT(clipboard);
779 WINPR_ASSERT(numFormats);
783 if (xf_cliprdr_is_raw_transfer_available(clipboard))
785 formats = xf_cliprdr_get_raw_server_formats(clipboard, numFormats);
788 if (*numFormats == 0)
790 xf_cliprdr_free_formats(formats, *numFormats);
791 formats = xf_cliprdr_get_formats_from_targets(clipboard, numFormats);
797static void xf_cliprdr_provide_server_format_list(xfClipboard* clipboard)
800 xfContext* xfc = NULL;
802 WINPR_ASSERT(clipboard);
804 xfc = clipboard->xfc;
807 formats = xf_cliprdr_serialize_server_format_list(clipboard);
811 const size_t len = Stream_Length(formats);
812 WINPR_ASSERT(len <= INT32_MAX);
813 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable,
814 clipboard->raw_format_list_atom, clipboard->raw_format_list_atom,
815 8, PropModeReplace, Stream_Buffer(formats), (
int)len);
819 LogDynAndXDeleteProperty(xfc->log, xfc->display, xfc->drawable,
820 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 = LogDynAndXGetWindowProperty(
1122 xfc->log, 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 (LogDynAndXGetWindowProperty(
1158 xfc->log, 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 LogDynAndXDeleteProperty(xfc->log, 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 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1205 XA_ATOM, 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 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1222 XA_INTEGER, 32, PropModeReplace,
1223 (
const BYTE*)&clipboard->selection_ownership_timestamp, 1);
1227#define xf_cliprdr_provide_data(clipboard, respond, data, size) \
1228 xf_cliprdr_provide_data_((clipboard), (respond), (data), (size), __FILE__, __func__, __LINE__)
1229static void xf_cliprdr_provide_data_(xfClipboard* clipboard,
const XSelectionEvent* respond,
1230 const BYTE* data, UINT32 size,
const char* file,
1231 const char* fkt,
size_t line)
1233 WINPR_ASSERT(clipboard);
1235 xfContext* xfc = clipboard->xfc;
1238 if (respond->property != None)
1240 LogDynAndXChangeProperty_ex(xfc->log, file, fkt, line, xfc->display, respond->requestor,
1241 respond->property, respond->target, 8, PropModeReplace, data,
1242 WINPR_ASSERTING_INT_CAST(int32_t, size));
1246static void log_selection_event(xfContext* xfc,
const XEvent* event)
1248 const DWORD level = WLOG_TRACE;
1249 static wLog* _log_cached_ptr = NULL;
1250 if (!_log_cached_ptr)
1251 _log_cached_ptr = WLog_Get(TAG);
1252 if (WLog_IsLevelActive(_log_cached_ptr, level))
1255 switch (event->type)
1257 case SelectionClear:
1259 const XSelectionClearEvent* xevent = &
event->xselectionclear;
1261 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1262 WLog_Print(_log_cached_ptr, level,
"got event %s [selection %s]",
1263 x11_event_string(event->type), selection);
1267 case SelectionNotify:
1269 const XSelectionEvent* xevent = &
event->xselection;
1271 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1272 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1273 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1274 WLog_Print(_log_cached_ptr, level,
1275 "got event %s [selection %s, target %s, property %s]",
1276 x11_event_string(event->type), selection, target, property);
1282 case SelectionRequest:
1284 const XSelectionRequestEvent* xevent = &
event->xselectionrequest;
1286 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1287 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1288 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1289 WLog_Print(_log_cached_ptr, level,
1290 "got event %s [selection %s, target %s, property %s]",
1291 x11_event_string(event->type), selection, target, property);
1297 case PropertyNotify:
1299 const XPropertyEvent* xevent = &
event->xproperty;
1300 char* atom = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->atom);
1301 WLog_Print(_log_cached_ptr, level,
"got event %s [atom %s]",
1302 x11_event_string(event->type), atom);
1312static BOOL xf_cliprdr_process_selection_notify(xfClipboard* clipboard,
1313 const XSelectionEvent* xevent)
1315 WINPR_ASSERT(clipboard);
1316 WINPR_ASSERT(xevent);
1318 if (xevent->target == clipboard->targets[1])
1320 if (xevent->property == None)
1322 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1326 xf_cliprdr_get_requested_targets(clipboard);
1333 return xf_cliprdr_get_requested_data(clipboard, xevent->target);
1337void xf_cliprdr_clear_cached_data(xfClipboard* clipboard)
1339 WINPR_ASSERT(clipboard);
1341 ClipboardLock(clipboard->system);
1342 ClipboardEmpty(clipboard->system);
1344 HashTable_Clear(clipboard->cachedData);
1345 HashTable_Clear(clipboard->cachedRawData);
1347 cliprdr_file_context_clear(clipboard->file);
1349 xf_cliprdr_stop_incr(clipboard);
1350 ClipboardUnlock(clipboard->system);
1353static void* format_to_cache_slot(UINT32 format)
1360 cnv.uptr = 0x100000000ULL + format;
1364static UINT32 get_dst_format_id_for_local_request(xfClipboard* clipboard,
1365 const xfCliprdrFormat* format)
1367 UINT32 dstFormatId = 0;
1369 WINPR_ASSERT(format);
1371 if (!format->formatName)
1372 return format->localFormat;
1374 ClipboardLock(clipboard->system);
1375 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1376 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
1377 ClipboardUnlock(clipboard->system);
1379 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1380 dstFormatId = format->localFormat;
1385static void get_src_format_info_for_local_request(xfClipboard* clipboard,
1386 const xfCliprdrFormat* format,
1387 UINT32* srcFormatId, BOOL* nullTerminated)
1390 *nullTerminated = FALSE;
1392 if (format->formatName)
1394 ClipboardLock(clipboard->system);
1395 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1397 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
1398 *nullTerminated = TRUE;
1400 else if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1402 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
1403 *nullTerminated = TRUE;
1405 ClipboardUnlock(clipboard->system);
1409 *srcFormatId = format->formatToRequest;
1410 switch (format->formatToRequest)
1414 case CF_UNICODETEXT:
1415 *nullTerminated = TRUE;
1418 *srcFormatId = CF_DIB;
1421 *srcFormatId = CF_TIFF;
1429static xfCachedData* convert_data_from_existing_raw_data(xfClipboard* clipboard,
1430 xfCachedData* cached_raw_data,
1431 UINT32 srcFormatId, BOOL nullTerminated,
1434 UINT32 dst_size = 0;
1436 WINPR_ASSERT(clipboard);
1437 WINPR_ASSERT(cached_raw_data);
1438 WINPR_ASSERT(cached_raw_data->data);
1440 ClipboardLock(clipboard->system);
1441 BOOL success = ClipboardSetData(clipboard->system, srcFormatId, cached_raw_data->data,
1442 cached_raw_data->data_length);
1445 WLog_WARN(TAG,
"Failed to set clipboard data (formatId: %u, data: %p, data_length: %u)",
1446 srcFormatId, cached_raw_data->data, cached_raw_data->data_length);
1447 ClipboardUnlock(clipboard->system);
1451 BYTE* dst_data = ClipboardGetData(clipboard->system, dstFormatId, &dst_size);
1454 WLog_WARN(TAG,
"Failed to get converted clipboard data");
1455 ClipboardUnlock(clipboard->system);
1458 ClipboardUnlock(clipboard->system);
1462 BYTE* nullTerminator = memchr(dst_data,
'\0', dst_size);
1465 const intptr_t diff = nullTerminator - dst_data;
1466 WINPR_ASSERT(diff >= 0);
1467 WINPR_ASSERT(diff <= UINT32_MAX);
1468 dst_size = (UINT32)diff;
1472 xfCachedData* cached_data = xf_cached_data_new(dst_data, dst_size);
1475 WLog_WARN(TAG,
"Failed to allocate cache entry");
1480 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId), cached_data))
1482 WLog_WARN(TAG,
"Failed to cache clipboard data");
1483 xf_cached_data_free(cached_data);
1490static BOOL xf_cliprdr_process_selection_request(xfClipboard* clipboard,
1491 const XSelectionRequestEvent* xevent)
1495 UINT32 formatId = 0;
1496 XSelectionEvent* respond = NULL;
1498 BOOL delayRespond = 0;
1499 BOOL rawTransfer = 0;
1500 unsigned long length = 0;
1501 unsigned long bytes_left = 0;
1502 xfContext* xfc = NULL;
1504 WINPR_ASSERT(clipboard);
1505 WINPR_ASSERT(xevent);
1507 xfc = clipboard->xfc;
1510 if (xevent->owner != xfc->drawable)
1513 delayRespond = FALSE;
1515 if (!(respond = (XSelectionEvent*)calloc(1,
sizeof(XSelectionEvent))))
1517 WLog_ERR(TAG,
"failed to allocate XEvent data");
1521 respond->property = None;
1522 respond->type = SelectionNotify;
1523 respond->display = xevent->display;
1524 respond->requestor = xevent->requestor;
1525 respond->selection = xevent->selection;
1526 respond->target = xevent->target;
1527 respond->time = xevent->time;
1529 if (xevent->target == clipboard->targets[0])
1532 respond->property = xevent->property;
1533 xf_cliprdr_provide_timestamp(clipboard, respond);
1535 else if (xevent->target == clipboard->targets[1])
1538 respond->property = xevent->property;
1539 xf_cliprdr_provide_targets(clipboard, respond);
1544 xf_cliprdr_get_server_format_by_atom(clipboard, xevent->target);
1545 const xfCliprdrFormat* cformat =
1546 xf_cliprdr_get_client_format_by_atom(clipboard, xevent->target);
1548 if (format && (xevent->requestor != xfc->drawable))
1550 formatId = format->formatId;
1551 rawTransfer = FALSE;
1552 xfCachedData* cached_data = NULL;
1554 if (formatId == CF_RAW)
1556 if (LogDynAndXGetWindowProperty(
1557 xfc->log, xfc->display, xevent->requestor, clipboard->property_atom, 0, 4,
1558 0, XA_INTEGER, &type, &fmt, &length, &bytes_left, &data) != Success)
1565 CopyMemory(&formatId, data, 4);
1570 const UINT32 dstFormatId = get_dst_format_id_for_local_request(clipboard, cformat);
1571 DEBUG_CLIPRDR(
"formatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", formatId,
1575 cached_data = HashTable_GetItemValue(clipboard->cachedData,
1576 format_to_cache_slot(dstFormatId));
1578 cached_data = HashTable_GetItemValue(clipboard->cachedRawData,
1579 format_to_cache_slot(formatId));
1581 DEBUG_CLIPRDR(
"hasCachedData: %u, rawTransfer: %u", cached_data ? 1 : 0, rawTransfer);
1583 if (!cached_data && !rawTransfer)
1585 UINT32 srcFormatId = 0;
1586 BOOL nullTerminated = FALSE;
1587 xfCachedData* cached_raw_data = NULL;
1589 get_src_format_info_for_local_request(clipboard, cformat, &srcFormatId,
1592 HashTable_GetItemValue(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId);
1594 DEBUG_CLIPRDR(
"hasCachedRawData: %u, rawDataLength: %u", cached_raw_data ? 1 : 0,
1595 cached_raw_data ? cached_raw_data->data_length : 0);
1597 if (cached_raw_data && cached_raw_data->data_length != 0)
1598 cached_data = convert_data_from_existing_raw_data(
1599 clipboard, cached_raw_data, srcFormatId, nullTerminated, dstFormatId);
1602 DEBUG_CLIPRDR(
"hasCachedData: %u", cached_data ? 1 : 0);
1607 respond->property = xevent->property;
1610 xf_cliprdr_provide_data(clipboard, respond, cached_data->data,
1611 cached_data->data_length);
1613 else if (clipboard->respond)
1619 WINPR_ASSERT(cformat);
1625 respond->property = xevent->property;
1626 clipboard->respond = respond;
1627 requested_format_replace(&clipboard->requestedFormat, formatId, dstFormatId,
1628 cformat->formatName);
1629 clipboard->data_raw_format = rawTransfer;
1630 delayRespond = TRUE;
1631 xf_cliprdr_send_data_request(clipboard, formatId, cformat);
1641 XSelectionEvent* sev;
1645 LogDynAndXSendEvent(xfc->log, xfc->display, xevent->requestor, 0, 0, conv.ev);
1646 LogDynAndXFlush(xfc->log, xfc->display);
1653static BOOL xf_cliprdr_process_selection_clear(xfClipboard* clipboard,
1654 const XSelectionClearEvent* xevent)
1656 xfContext* xfc = NULL;
1658 WINPR_ASSERT(clipboard);
1659 WINPR_ASSERT(xevent);
1661 xfc = clipboard->xfc;
1664 WINPR_UNUSED(xevent);
1666 if (xf_cliprdr_is_self_owned(clipboard))
1669 LogDynAndXDeleteProperty(xfc->log, xfc->display, clipboard->root_window,
1670 clipboard->property_atom);
1674static BOOL xf_cliprdr_process_property_notify(xfClipboard* clipboard,
const XPropertyEvent* xevent)
1676 const xfCliprdrFormat* format = NULL;
1677 xfContext* xfc = NULL;
1682 xfc = clipboard->xfc;
1684 WINPR_ASSERT(xevent);
1686 if (xevent->atom == clipboard->timestamp_property_atom)
1692 xf_cliprdr_set_selection_owner(xfc, clipboard, xevent->time);
1696 if (xevent->atom != clipboard->property_atom)
1699 if (xevent->window == clipboard->root_window)
1701 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1703 else if ((xevent->window == xfc->drawable) && (xevent->state == PropertyNewValue) &&
1704 clipboard->incr_starts)
1706 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1709 xf_cliprdr_get_requested_data(clipboard, format->atom);
1715void xf_cliprdr_handle_xevent(xfContext* xfc,
const XEvent* event)
1717 xfClipboard* clipboard = NULL;
1722 clipboard = xfc->clipboard;
1729 if (clipboard->xfixes_supported &&
1730 event->type == XFixesSelectionNotify + clipboard->xfixes_event_base)
1732 const XFixesSelectionNotifyEvent* se = (
const XFixesSelectionNotifyEvent*)event;
1734 if (se->subtype == XFixesSetSelectionOwnerNotify)
1736 if (se->selection != clipboard->clipboard_atom)
1739 if (LogDynAndXGetSelectionOwner(xfc->log, xfc->display, se->selection) == xfc->drawable)
1742 clipboard->owner = None;
1743 xf_cliprdr_check_owner(clipboard);
1751 switch (event->type)
1753 case SelectionNotify:
1754 log_selection_event(xfc, event);
1755 xf_cliprdr_process_selection_notify(clipboard, &event->xselection);
1758 case SelectionRequest:
1759 log_selection_event(xfc, event);
1760 xf_cliprdr_process_selection_request(clipboard, &event->xselectionrequest);
1763 case SelectionClear:
1764 log_selection_event(xfc, event);
1765 xf_cliprdr_process_selection_clear(clipboard, &event->xselectionclear);
1768 case PropertyNotify:
1769 log_selection_event(xfc, event);
1770 xf_cliprdr_process_property_notify(clipboard, &event->xproperty);
1774 if (!clipboard->xfixes_supported)
1776 xf_cliprdr_check_owner(clipboard);
1790static UINT xf_cliprdr_send_client_capabilities(xfClipboard* clipboard)
1795 WINPR_ASSERT(clipboard);
1797 capabilities.cCapabilitiesSets = 1;
1799 generalCapabilitySet.capabilitySetType = CB_CAPSTYPE_GENERAL;
1800 generalCapabilitySet.capabilitySetLength = 12;
1801 generalCapabilitySet.version = CB_CAPS_VERSION_2;
1802 generalCapabilitySet.generalFlags = CB_USE_LONG_FORMAT_NAMES;
1804 WINPR_ASSERT(clipboard);
1805 generalCapabilitySet.generalFlags |= cliprdr_file_context_current_flags(clipboard->file);
1807 WINPR_ASSERT(clipboard->context);
1808 WINPR_ASSERT(clipboard->context->ClientCapabilities);
1809 return clipboard->context->ClientCapabilities(clipboard->context, &capabilities);
1817static UINT xf_cliprdr_send_client_format_list(xfClipboard* clipboard, BOOL force)
1819 WINPR_ASSERT(clipboard);
1821 xfContext* xfc = clipboard->xfc;
1824 UINT32 numFormats = 0;
1825 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
1827 const UINT ret = xf_cliprdr_send_format_list(clipboard, formats, numFormats, force);
1829 if (clipboard->owner && clipboard->owner != xfc->drawable)
1832 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom,
1833 clipboard->targets[1], clipboard->property_atom, xfc->drawable,
1837 xf_cliprdr_free_formats(formats, numFormats);
1847static UINT xf_cliprdr_send_client_format_list_response(xfClipboard* clipboard, BOOL status)
1851 formatListResponse.common.msgType = CB_FORMAT_LIST_RESPONSE;
1852 formatListResponse.common.msgFlags = status ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
1853 formatListResponse.common.dataLen = 0;
1855 WINPR_ASSERT(clipboard);
1856 WINPR_ASSERT(clipboard->context);
1857 WINPR_ASSERT(clipboard->context->ClientFormatListResponse);
1858 return clipboard->context->ClientFormatListResponse(clipboard->context, &formatListResponse);
1866static UINT xf_cliprdr_monitor_ready(CliprdrClientContext* context,
1870 xfClipboard* clipboard = NULL;
1872 WINPR_ASSERT(context);
1873 WINPR_ASSERT(monitorReady);
1875 clipboard = cliprdr_file_context_get_context(context->custom);
1876 WINPR_ASSERT(clipboard);
1878 WINPR_UNUSED(monitorReady);
1880 if ((ret = xf_cliprdr_send_client_capabilities(clipboard)) != CHANNEL_RC_OK)
1883 xf_clipboard_formats_free(clipboard);
1885 if ((ret = xf_cliprdr_send_client_format_list(clipboard, TRUE)) != CHANNEL_RC_OK)
1888 clipboard->sync = TRUE;
1889 return CHANNEL_RC_OK;
1897static UINT xf_cliprdr_server_capabilities(CliprdrClientContext* context,
1901 const BYTE* capsPtr = NULL;
1902 xfClipboard* clipboard = NULL;
1904 WINPR_ASSERT(context);
1905 WINPR_ASSERT(capabilities);
1907 clipboard = cliprdr_file_context_get_context(context->custom);
1908 WINPR_ASSERT(clipboard);
1910 capsPtr = (
const BYTE*)capabilities->capabilitySets;
1911 WINPR_ASSERT(capsPtr);
1913 cliprdr_file_context_remote_set_flags(clipboard->file, 0);
1915 for (UINT32 i = 0; i < capabilities->cCapabilitiesSets; i++)
1919 if (caps->capabilitySetType == CB_CAPSTYPE_GENERAL)
1923 cliprdr_file_context_remote_set_flags(clipboard->file, generalCaps->generalFlags);
1926 capsPtr += caps->capabilitySetLength;
1929 return CHANNEL_RC_OK;
1932static void xf_cliprdr_prepare_to_set_selection_owner(xfContext* xfc, xfClipboard* clipboard)
1935 WINPR_ASSERT(clipboard);
1952 Atom value = clipboard->timestamp_property_atom;
1954 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable,
1955 clipboard->timestamp_property_atom, XA_ATOM, 32, PropModeReplace,
1956 (
const BYTE*)&value, 1);
1957 LogDynAndXFlush(xfc->log, 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 LogDynAndXSetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom, xfc->drawable,
1972 LogDynAndXFlush(xfc->log, xfc->display);
1980static UINT xf_cliprdr_server_format_list(CliprdrClientContext* context,
1983 xfContext* xfc = NULL;
1985 xfClipboard* clipboard = NULL;
1987 WINPR_ASSERT(context);
1988 WINPR_ASSERT(formatList);
1990 clipboard = cliprdr_file_context_get_context(context->custom);
1991 WINPR_ASSERT(clipboard);
1993 xfc = clipboard->xfc;
1999 free(clipboard->respond);
2000 clipboard->respond = NULL;
2002 xf_clipboard_formats_free(clipboard);
2003 xf_cliprdr_clear_cached_data(clipboard);
2004 requested_format_free(&clipboard->requestedFormat);
2006 xf_clipboard_free_server_formats(clipboard);
2008 clipboard->numServerFormats = formatList->numFormats + 1;
2010 if (!(clipboard->serverFormats =
2013 WLog_ERR(TAG,
"failed to allocate %d CLIPRDR_FORMAT structs", clipboard->numServerFormats);
2014 ret = CHANNEL_RC_NO_MEMORY;
2018 for (
size_t i = 0; i < formatList->numFormats; i++)
2023 srvFormat->formatId = format->formatId;
2025 if (format->formatName)
2027 srvFormat->formatName = _strdup(format->formatName);
2029 if (!srvFormat->formatName)
2031 for (UINT32 k = 0; k < i; k++)
2032 free(clipboard->serverFormats[k].formatName);
2034 clipboard->numServerFormats = 0;
2035 free(clipboard->serverFormats);
2036 clipboard->serverFormats = NULL;
2037 ret = CHANNEL_RC_NO_MEMORY;
2043 ClipboardLock(clipboard->system);
2044 ret = cliprdr_file_context_notify_new_server_format_list(clipboard->file);
2045 ClipboardUnlock(clipboard->system);
2051 CLIPRDR_FORMAT* format = &clipboard->serverFormats[formatList->numFormats];
2052 format->formatId = CF_RAW;
2053 format->formatName = NULL;
2055 xf_cliprdr_provide_server_format_list(clipboard);
2056 clipboard->numTargets = 2;
2058 for (
size_t i = 0; i < formatList->numFormats; i++)
2062 for (
size_t j = 0; j < clipboard->numClientFormats; j++)
2064 const xfCliprdrFormat* clientFormat = &clipboard->clientFormats[j];
2065 if (xf_cliprdr_formats_equal(format, clientFormat))
2067 if ((clientFormat->formatName != NULL) &&
2068 (strcmp(type_FileGroupDescriptorW, clientFormat->formatName) == 0))
2070 if (!cliprdr_file_context_has_local_support(clipboard->file))
2073 xf_cliprdr_append_target(clipboard, clientFormat->atom);
2078 ret = xf_cliprdr_send_client_format_list_response(clipboard, TRUE);
2079 if (xfc->remote_app)
2080 xf_cliprdr_set_selection_owner(xfc, clipboard, CurrentTime);
2082 xf_cliprdr_prepare_to_set_selection_owner(xfc, clipboard);
2095static UINT xf_cliprdr_server_format_list_response(
2096 WINPR_ATTR_UNUSED CliprdrClientContext* context,
2099 WINPR_ASSERT(context);
2100 WINPR_ASSERT(formatListResponse);
2102 return CHANNEL_RC_OK;
2111xf_cliprdr_server_format_data_request(CliprdrClientContext* context,
2114 const xfCliprdrFormat* format = NULL;
2116 WINPR_ASSERT(context);
2117 WINPR_ASSERT(formatDataRequest);
2119 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2120 WINPR_ASSERT(clipboard);
2122 xfContext* xfc = clipboard->xfc;
2125 const uint32_t formatId = formatDataRequest->requestedFormatId;
2127 const BOOL rawTransfer = xf_cliprdr_is_raw_transfer_available(clipboard);
2131 format = xf_cliprdr_get_client_format_by_id(clipboard, CF_RAW);
2132 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom,
2133 XA_INTEGER, 32, PropModeReplace, (
const BYTE*)&formatId, 1);
2136 format = xf_cliprdr_get_client_format_by_id(clipboard, formatId);
2138 clipboard->requestedFormatId = rawTransfer ? CF_RAW : formatId;
2140 return xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
2142 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2143 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2144 format->localFormat,
2145 ClipboardGetFormatName(clipboard->system, format->localFormat),
2146 format->formatName);
2147 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom, format->atom,
2148 clipboard->property_atom, xfc->drawable, CurrentTime);
2149 LogDynAndXFlush(xfc->log, xfc->display);
2151 return CHANNEL_RC_OK;
2160xf_cliprdr_server_format_data_response(CliprdrClientContext* context,
2164 BYTE* pDstData = NULL;
2167 UINT32 srcFormatId = 0;
2168 UINT32 dstFormatId = 0;
2169 BOOL nullTerminated = FALSE;
2170 xfCachedData* cached_data = NULL;
2172 WINPR_ASSERT(context);
2173 WINPR_ASSERT(formatDataResponse);
2175 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2176 WINPR_ASSERT(clipboard);
2178 xfContext* xfc = clipboard->xfc;
2181 const UINT32 size = formatDataResponse->common.dataLen;
2182 const BYTE* data = formatDataResponse->requestedFormatData;
2184 if (formatDataResponse->common.msgFlags == CB_RESPONSE_FAIL)
2186 WLog_WARN(TAG,
"Format Data Response PDU msgFlags is CB_RESPONSE_FAIL");
2187 free(clipboard->respond);
2188 clipboard->respond = NULL;
2189 return CHANNEL_RC_OK;
2192 if (!clipboard->respond)
2193 return CHANNEL_RC_OK;
2195 const RequestedFormat* format = clipboard->requestedFormat;
2196 if (clipboard->data_raw_format)
2198 srcFormatId = CF_RAW;
2199 dstFormatId = CF_RAW;
2202 return ERROR_INTERNAL_ERROR;
2203 else if (format->formatName)
2205 dstFormatId = format->localFormat;
2207 ClipboardLock(clipboard->system);
2208 if (strcmp(format->formatName, type_HtmlFormat) == 0)
2210 srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
2211 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
2212 nullTerminated = TRUE;
2215 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
2217 if (!cliprdr_file_context_update_server_data(clipboard->file, clipboard->system, data,
2219 WLog_WARN(TAG,
"failed to update file descriptors");
2221 srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2222 const xfCliprdrFormat* dstTargetFormat =
2223 xf_cliprdr_get_client_format_by_atom(clipboard, clipboard->respond->target);
2224 if (!dstTargetFormat)
2226 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2230 dstFormatId = dstTargetFormat->localFormat;
2233 nullTerminated = TRUE;
2235 ClipboardUnlock(clipboard->system);
2239 srcFormatId = format->formatToRequest;
2240 dstFormatId = format->localFormat;
2241 switch (format->formatToRequest)
2244 nullTerminated = TRUE;
2248 nullTerminated = TRUE;
2251 case CF_UNICODETEXT:
2252 nullTerminated = TRUE;
2256 srcFormatId = CF_DIB;
2260 srcFormatId = CF_TIFF;
2268 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2269 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2270 format->localFormat,
2271 ClipboardGetFormatName(clipboard->system, format->localFormat),
2272 format->formatName);
2275 DEBUG_CLIPRDR(
"srcFormatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", srcFormatId,
2278 ClipboardLock(clipboard->system);
2279 bSuccess = ClipboardSetData(clipboard->system, srcFormatId, data, SrcSize);
2281 BOOL willQuit = FALSE;
2286 WLog_DBG(TAG,
"skipping, empty data detected!");
2287 free(clipboard->respond);
2288 clipboard->respond = NULL;
2293 pDstData = (BYTE*)ClipboardGetData(clipboard->system, dstFormatId, &DstSize);
2297 WLog_WARN(TAG,
"failed to get clipboard data in format %s [source format %s]",
2298 ClipboardGetFormatName(clipboard->system, dstFormatId),
2299 ClipboardGetFormatName(clipboard->system, srcFormatId));
2302 if (nullTerminated && pDstData)
2304 BYTE* nullTerminator = memchr(pDstData,
'\0', DstSize);
2307 const intptr_t diff = nullTerminator - pDstData;
2308 WINPR_ASSERT(diff >= 0);
2309 WINPR_ASSERT(diff <= UINT32_MAX);
2310 DstSize = (UINT32)diff;
2315 ClipboardUnlock(clipboard->system);
2317 return CHANNEL_RC_OK;
2323 cached_data = xf_cached_data_new(pDstData, DstSize);
2326 WLog_WARN(TAG,
"Failed to allocate cache entry");
2328 return CHANNEL_RC_OK;
2330 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId),
2333 WLog_WARN(TAG,
"Failed to cache clipboard data");
2334 xf_cached_data_free(cached_data);
2335 return CHANNEL_RC_OK;
2345 xfCachedData* cached_raw_data = xf_cached_data_new_copy(data, size);
2346 if (!cached_raw_data)
2347 WLog_WARN(TAG,
"Failed to allocate cache entry");
2350 if (!HashTable_Insert(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId,
2353 WLog_WARN(TAG,
"Failed to cache clipboard data");
2354 xf_cached_data_free(cached_raw_data);
2361 xf_cliprdr_provide_data(clipboard, clipboard->respond, pDstData, DstSize);
2366 XSelectionEvent* sev;
2369 conv.sev = clipboard->respond;
2371 LogDynAndXSendEvent(xfc->log, xfc->display, clipboard->respond->requestor, 0, 0, conv.ev);
2372 LogDynAndXFlush(xfc->log, xfc->display);
2374 free(clipboard->respond);
2375 clipboard->respond = NULL;
2376 return CHANNEL_RC_OK;
2379static BOOL xf_cliprdr_is_valid_unix_filename(LPCWSTR filename)
2384 if (filename[0] == L
'\0')
2388 for (
const WCHAR* c = filename; *c; ++c)
2397xfClipboard* xf_clipboard_new(xfContext* xfc, BOOL relieveFilenameRestriction)
2400 rdpChannels* channels = NULL;
2401 xfClipboard* clipboard = NULL;
2402 const char* selectionAtom = NULL;
2403 xfCliprdrFormat* clientFormat = NULL;
2407 WINPR_ASSERT(xfc->common.context.settings);
2409 if (!(clipboard = (xfClipboard*)calloc(1,
sizeof(xfClipboard))))
2411 WLog_ERR(TAG,
"failed to allocate xfClipboard data");
2415 clipboard->file = cliprdr_file_context_new(clipboard);
2416 if (!clipboard->file)
2419 xfc->clipboard = clipboard;
2420 clipboard->xfc = xfc;
2421 channels = xfc->common.context.channels;
2422 clipboard->channels = channels;
2423 clipboard->system = ClipboardCreate();
2424 clipboard->requestedFormatId = UINT32_MAX;
2425 clipboard->root_window = DefaultRootWindow(xfc->display);
2430 selectionAtom =
"CLIPBOARD";
2432 clipboard->clipboard_atom = Logging_XInternAtom(xfc->log, xfc->display, selectionAtom, FALSE);
2434 if (clipboard->clipboard_atom == None)
2436 WLog_ERR(TAG,
"unable to get %s atom", selectionAtom);
2440 clipboard->timestamp_property_atom =
2441 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_TIMESTAMP_PROPERTY", FALSE);
2442 clipboard->property_atom =
2443 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR", FALSE);
2444 clipboard->raw_transfer_atom =
2445 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_RAW", FALSE);
2446 clipboard->raw_format_list_atom =
2447 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_FORMATS", FALSE);
2448 xf_cliprdr_set_raw_transfer_enabled(clipboard, TRUE);
2449 XSelectInput(xfc->display, clipboard->root_window, PropertyChangeMask);
2452 if (XFixesQueryExtension(xfc->display, &clipboard->xfixes_event_base,
2453 &clipboard->xfixes_error_base))
2458 if (XFixesQueryVersion(xfc->display, &xfmajor, &xfminor))
2460 XFixesSelectSelectionInput(xfc->display, clipboard->root_window,
2461 clipboard->clipboard_atom,
2462 XFixesSetSelectionOwnerNotifyMask);
2463 clipboard->xfixes_supported = TRUE;
2467 WLog_ERR(TAG,
"Error querying X Fixes extension version");
2472 WLog_ERR(TAG,
"Error loading X Fixes extension");
2478 "Warning: Using clipboard redirection without XFIXES extension is strongly discouraged!");
2480 clientFormat = &clipboard->clientFormats[n++];
2481 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_RAW", False);
2482 clientFormat->localFormat = clientFormat->formatToRequest = CF_RAW;
2484 clientFormat = &clipboard->clientFormats[n++];
2485 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"UTF8_STRING", False);
2486 clientFormat->formatToRequest = CF_UNICODETEXT;
2487 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2489 clientFormat = &clipboard->clientFormats[n++];
2490 clientFormat->atom = XA_STRING;
2491 clientFormat->formatToRequest = CF_TEXT;
2492 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2494 clientFormat = &clipboard->clientFormats[n++];
2495 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_tiff, False);
2496 clientFormat->formatToRequest = clientFormat->localFormat = CF_TIFF;
2498 for (
size_t x = 0; x < ARRAYSIZE(mime_bitmap); x++)
2500 const char* mime_bmp = mime_bitmap[x];
2501 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2504 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2508 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2509 clientFormat = &clipboard->clientFormats[n++];
2510 clientFormat->localFormat = format;
2511 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2512 clientFormat->formatToRequest = CF_DIB;
2513 clientFormat->isImage = TRUE;
2516 for (
size_t x = 0; x < ARRAYSIZE(mime_images); x++)
2518 const char* mime_bmp = mime_images[x];
2519 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2522 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2526 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2527 clientFormat = &clipboard->clientFormats[n++];
2528 clientFormat->localFormat = format;
2529 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2530 clientFormat->formatToRequest = CF_DIB;
2531 clientFormat->isImage = TRUE;
2534 clientFormat = &clipboard->clientFormats[n++];
2535 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_html, False);
2536 clientFormat->formatToRequest = ClipboardGetFormatId(xfc->clipboard->system, type_HtmlFormat);
2537 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_html);
2538 clientFormat->formatName = _strdup(type_HtmlFormat);
2540 if (!clientFormat->formatName)
2543 clientFormat = &clipboard->clientFormats[n++];
2552 const UINT32 fgid = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2554 const UINT32 uid = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2557 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2558 clientFormat->atom =
2559 Logging_XInternAtom(xfc->log, xfc->display, mime_uri_list, False);
2560 clientFormat->localFormat = uid;
2561 clientFormat->formatToRequest = fgid;
2562 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2564 if (!clientFormat->formatName)
2567 clientFormat = &clipboard->clientFormats[n++];
2572 const UINT32 gid = ClipboardGetFormatId(clipboard->system, mime_gnome_copied_files);
2575 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2576 clientFormat->atom =
2577 Logging_XInternAtom(xfc->log, xfc->display, mime_gnome_copied_files, False);
2578 clientFormat->localFormat = gid;
2579 clientFormat->formatToRequest = fgid;
2580 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2582 if (!clientFormat->formatName)
2585 clientFormat = &clipboard->clientFormats[n++];
2590 const UINT32 mid = ClipboardGetFormatId(clipboard->system, mime_mate_copied_files);
2593 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2594 clientFormat->atom =
2595 Logging_XInternAtom(xfc->log, xfc->display, mime_mate_copied_files, False);
2596 clientFormat->localFormat = mid;
2597 clientFormat->formatToRequest = fgid;
2598 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2600 if (!clientFormat->formatName)
2606 clipboard->numClientFormats = WINPR_ASSERTING_INT_CAST(uint32_t, n);
2607 clipboard->targets[0] = Logging_XInternAtom(xfc->log, xfc->display,
"TIMESTAMP", FALSE);
2608 clipboard->targets[1] = Logging_XInternAtom(xfc->log, xfc->display,
"TARGETS", FALSE);
2609 clipboard->numTargets = 2;
2610 clipboard->incr_atom = Logging_XInternAtom(xfc->log, xfc->display,
"INCR", FALSE);
2612 if (relieveFilenameRestriction)
2614 WLog_DBG(TAG,
"Relieving CLIPRDR filename restriction");
2615 ClipboardGetDelegate(clipboard->system)->IsFileNameComponentValid =
2616 xf_cliprdr_is_valid_unix_filename;
2619 clipboard->cachedData = HashTable_New(TRUE);
2620 if (!clipboard->cachedData)
2623 obj = HashTable_ValueObject(clipboard->cachedData);
2624 obj->fnObjectFree = xf_cached_data_free;
2626 clipboard->cachedRawData = HashTable_New(TRUE);
2627 if (!clipboard->cachedRawData)
2630 obj = HashTable_ValueObject(clipboard->cachedRawData);
2631 obj->fnObjectFree = xf_cached_data_free;
2636 WINPR_PRAGMA_DIAG_PUSH
2637 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2638 xf_clipboard_free(clipboard);
2639 WINPR_PRAGMA_DIAG_POP
2643void xf_clipboard_free(xfClipboard* clipboard)
2648 xf_clipboard_free_server_formats(clipboard);
2650 if (clipboard->numClientFormats)
2652 for (UINT32 i = 0; i < clipboard->numClientFormats; i++)
2654 xfCliprdrFormat* format = &clipboard->clientFormats[i];
2655 free(format->formatName);
2659 cliprdr_file_context_free(clipboard->file);
2661 ClipboardDestroy(clipboard->system);
2662 xf_clipboard_formats_free(clipboard);
2663 HashTable_Free(clipboard->cachedRawData);
2664 HashTable_Free(clipboard->cachedData);
2665 requested_format_free(&clipboard->requestedFormat);
2666 free(clipboard->respond);
2667 free(clipboard->incr_data);
2671void xf_cliprdr_init(xfContext* xfc, CliprdrClientContext* cliprdr)
2674 WINPR_ASSERT(cliprdr);
2676 xfc->cliprdr = cliprdr;
2677 xfc->clipboard->context = cliprdr;
2679 cliprdr->MonitorReady = xf_cliprdr_monitor_ready;
2680 cliprdr->ServerCapabilities = xf_cliprdr_server_capabilities;
2681 cliprdr->ServerFormatList = xf_cliprdr_server_format_list;
2682 cliprdr->ServerFormatListResponse = xf_cliprdr_server_format_list_response;
2683 cliprdr->ServerFormatDataRequest = xf_cliprdr_server_format_data_request;
2684 cliprdr->ServerFormatDataResponse = xf_cliprdr_server_format_data_response;
2686 cliprdr_file_context_init(xfc->clipboard->file, cliprdr);
2689void xf_cliprdr_uninit(xfContext* xfc, CliprdrClientContext* cliprdr)
2692 WINPR_ASSERT(cliprdr);
2694 xfc->cliprdr = NULL;
2698 ClipboardLock(xfc->clipboard->system);
2699 cliprdr_file_context_uninit(xfc->clipboard->file, cliprdr);
2700 ClipboardUnlock(xfc->clipboard->system);
2701 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.