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);
873 xf_lock_x11(clipboard->xfc);
874 xf_cliprdr_free_formats(clipboard->lastSentFormats, clipboard->lastSentNumFormats);
875 xf_unlock_x11(clipboard->xfc);
877 clipboard->lastSentFormats = NULL;
878 clipboard->lastSentNumFormats = 0;
881static BOOL xf_clipboard_copy_formats(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
884 WINPR_ASSERT(clipboard);
885 WINPR_ASSERT(formats || (numFormats == 0));
887 xf_clipboard_formats_free(clipboard);
889 clipboard->lastSentFormats = calloc(numFormats,
sizeof(
CLIPRDR_FORMAT));
890 if (!clipboard->lastSentFormats)
892 clipboard->lastSentNumFormats = numFormats;
893 for (UINT32 x = 0; x < numFormats; x++)
899 lcur->formatName = _strdup(cur->formatName);
904static UINT xf_cliprdr_send_format_list(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
905 UINT32 numFormats, BOOL force)
911 } cnv = { .cpv = formats };
913 .numFormats = numFormats,
915 .common.msgType = CB_FORMAT_LIST };
918 WINPR_ASSERT(clipboard);
919 WINPR_ASSERT(formats || (numFormats == 0));
921 if (!force && !xf_clipboard_changed(clipboard, formats, numFormats))
922 return CHANNEL_RC_OK;
924#if defined(WITH_DEBUG_CLIPRDR)
925 for (UINT32 x = 0; x < numFormats; x++)
928 DEBUG_CLIPRDR(
"announcing format 0x%08" PRIx32
" [%s] [%s]", format->formatId,
929 ClipboardGetFormatIdString(format->formatId), format->formatName);
933 xf_clipboard_copy_formats(clipboard, formats, numFormats);
935 xf_cliprdr_send_data_response(clipboard, NULL, NULL, 0);
937 xf_cliprdr_clear_cached_data(clipboard);
939 ret = cliprdr_file_context_notify_new_client_format_list(clipboard->file);
943 WINPR_ASSERT(clipboard->context);
944 WINPR_ASSERT(clipboard->context->ClientFormatList);
945 return clipboard->context->ClientFormatList(clipboard->context, &formatList);
948static void xf_cliprdr_get_requested_targets(xfClipboard* clipboard)
950 UINT32 numFormats = 0;
951 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
952 xf_cliprdr_send_format_list(clipboard, formats, numFormats, FALSE);
953 xf_cliprdr_free_formats(formats, numFormats);
956static void xf_cliprdr_process_requested_data(xfClipboard* clipboard, BOOL hasData,
957 const BYTE* data,
size_t size)
962 INT64 srcFormatId = -1;
963 BYTE* pDstData = NULL;
964 const xfCliprdrFormat* format = NULL;
966 WINPR_ASSERT(clipboard);
968 if (clipboard->incr_starts && hasData)
973 clipboard->incr_data_length = 0;
975 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
977 if (!hasData || !data || !format)
979 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
983 switch (format->formatToRequest)
986 srcFormatId = CF_RAW;
992 srcFormatId = format->localFormat;
996 srcFormatId = format->localFormat;
1000 if (srcFormatId < 0)
1002 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1006 ClipboardLock(clipboard->system);
1007 SrcSize = (UINT32)size;
1008 bSuccess = ClipboardSetData(clipboard->system, (UINT32)srcFormatId, data, SrcSize);
1014 (BYTE*)ClipboardGetData(clipboard->system, clipboard->requestedFormatId, &DstSize);
1016 ClipboardUnlock(clipboard->system);
1020 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1031 ClipboardLock(clipboard->system);
1032 if (format->formatToRequest &&
1033 (format->formatToRequest ==
1034 ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW)))
1036 UINT error = NO_ERROR;
1042 const UINT32 flags = cliprdr_file_context_remote_get_flags(clipboard->file);
1043 error = cliprdr_serialize_file_list_ex(flags, file_array, file_count, &pDstData, &DstSize);
1046 WLog_ERR(TAG,
"failed to serialize CLIPRDR_FILELIST: 0x%08X", error);
1049 UINT32 formatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
1050 UINT32 url_size = 0;
1052 char* url = ClipboardGetData(clipboard->system, formatId, &url_size);
1053 cliprdr_file_context_update_client_data(clipboard->file, url, url_size);
1059 ClipboardUnlock(clipboard->system);
1061 xf_cliprdr_send_data_response(clipboard, format, pDstData, DstSize);
1065static BOOL xf_restore_input_flags(xfClipboard* clipboard)
1067 WINPR_ASSERT(clipboard);
1069 xfContext* xfc = clipboard->xfc;
1072 if (clipboard->event_mask != 0)
1074 XSelectInput(xfc->display, xfc->drawable, clipboard->event_mask);
1075 clipboard->event_mask = 0;
1080static BOOL append(xfClipboard* clipboard,
const void* sdata,
size_t length)
1082 WINPR_ASSERT(clipboard);
1084 const size_t size = length + clipboard->incr_data_length + 2;
1085 BYTE* data = realloc(clipboard->incr_data, size);
1088 clipboard->incr_data = data;
1089 memcpy(&data[clipboard->incr_data_length], sdata, length);
1090 clipboard->incr_data_length += length;
1091 clipboard->incr_data[clipboard->incr_data_length + 0] =
'\0';
1092 clipboard->incr_data[clipboard->incr_data_length + 1] =
'\0';
1096static BOOL xf_cliprdr_stop_incr(xfClipboard* clipboard)
1098 clipboard->incr_starts = FALSE;
1099 clipboard->incr_data_length = 0;
1100 return xf_restore_input_flags(clipboard);
1103static BOOL xf_cliprdr_get_requested_data(xfClipboard* clipboard, Atom target)
1105 WINPR_ASSERT(clipboard);
1107 xfContext* xfc = clipboard->xfc;
1110 const xfCliprdrFormat* format =
1111 xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1113 if (!format || (format->atom != target))
1115 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1120 BOOL has_data = FALSE;
1121 int format_property = 0;
1122 unsigned long length = 0;
1123 unsigned long total_bytes = 0;
1124 BYTE* property_data = NULL;
1125 const int rc = LogDynAndXGetWindowProperty(
1126 xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0, 0, False, target, &type,
1127 &format_property, &length, &total_bytes, &property_data);
1130 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1137 if ((total_bytes <= 0) && !clipboard->incr_starts)
1139 xf_cliprdr_stop_incr(clipboard);
1142 else if (type == clipboard->incr_atom)
1144 xf_cliprdr_stop_incr(clipboard);
1145 clipboard->incr_starts = TRUE;
1150 BYTE* incremental_data = NULL;
1151 unsigned long incremental_len = 0;
1154 len = clipboard->incr_data_length;
1155 if (total_bytes <= 0)
1157 xf_cliprdr_stop_incr(clipboard);
1161 else if (LogDynAndXGetWindowProperty(
1162 xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0,
1163 WINPR_ASSERTING_INT_CAST(int32_t, total_bytes), False, target, &type,
1164 &format_property, &incremental_len, &length, &incremental_data) == Success)
1166 has_data = append(clipboard, incremental_data, incremental_len);
1167 len = clipboard->incr_data_length;
1170 if (incremental_data)
1171 XFree(incremental_data);
1174 LogDynAndXDeleteProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom);
1175 xf_cliprdr_process_requested_data(clipboard, has_data, clipboard->incr_data, len);
1180static void xf_cliprdr_append_target(xfClipboard* clipboard, Atom target)
1182 WINPR_ASSERT(clipboard);
1184 if (clipboard->numTargets >= ARRAYSIZE(clipboard->targets))
1187 for (
size_t i = 0; i < clipboard->numTargets; i++)
1189 if (clipboard->targets[i] == target)
1193 clipboard->targets[clipboard->numTargets++] = target;
1196static void xf_cliprdr_provide_targets(xfClipboard* clipboard,
const XSelectionEvent* respond)
1198 xfContext* xfc = NULL;
1200 WINPR_ASSERT(clipboard);
1202 xfc = clipboard->xfc;
1205 if (respond->property != None)
1207 WINPR_ASSERT(clipboard->numTargets <= INT32_MAX);
1208 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1209 XA_ATOM, 32, PropModeReplace, (
const BYTE*)clipboard->targets,
1210 (
int)clipboard->numTargets);
1214static void xf_cliprdr_provide_timestamp(xfClipboard* clipboard,
const XSelectionEvent* respond)
1216 xfContext* xfc = NULL;
1218 WINPR_ASSERT(clipboard);
1220 xfc = clipboard->xfc;
1223 if (respond->property != None)
1225 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1226 XA_INTEGER, 32, PropModeReplace,
1227 (
const BYTE*)&clipboard->selection_ownership_timestamp, 1);
1231#define xf_cliprdr_provide_data(clipboard, respond, data, size) \
1232 xf_cliprdr_provide_data_((clipboard), (respond), (data), (size), __FILE__, __func__, __LINE__)
1233static void xf_cliprdr_provide_data_(xfClipboard* clipboard,
const XSelectionEvent* respond,
1234 const BYTE* data, UINT32 size,
const char* file,
1235 const char* fkt,
size_t line)
1237 WINPR_ASSERT(clipboard);
1239 xfContext* xfc = clipboard->xfc;
1242 if (respond->property != None)
1244 LogDynAndXChangeProperty_ex(xfc->log, file, fkt, line, xfc->display, respond->requestor,
1245 respond->property, respond->target, 8, PropModeReplace, data,
1246 WINPR_ASSERTING_INT_CAST(int32_t, size));
1250static void log_selection_event(xfContext* xfc,
const XEvent* event)
1252 const DWORD level = WLOG_TRACE;
1253 static wLog* _log_cached_ptr = NULL;
1254 if (!_log_cached_ptr)
1255 _log_cached_ptr = WLog_Get(TAG);
1256 if (WLog_IsLevelActive(_log_cached_ptr, level))
1259 switch (event->type)
1261 case SelectionClear:
1263 const XSelectionClearEvent* xevent = &
event->xselectionclear;
1265 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1266 WLog_Print(_log_cached_ptr, level,
"got event %s [selection %s]",
1267 x11_event_string(event->type), selection);
1271 case SelectionNotify:
1273 const XSelectionEvent* xevent = &
event->xselection;
1275 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1276 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1277 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1278 WLog_Print(_log_cached_ptr, level,
1279 "got event %s [selection %s, target %s, property %s]",
1280 x11_event_string(event->type), selection, target, property);
1286 case SelectionRequest:
1288 const XSelectionRequestEvent* xevent = &
event->xselectionrequest;
1290 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1291 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1292 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1293 WLog_Print(_log_cached_ptr, level,
1294 "got event %s [selection %s, target %s, property %s]",
1295 x11_event_string(event->type), selection, target, property);
1301 case PropertyNotify:
1303 const XPropertyEvent* xevent = &
event->xproperty;
1304 char* atom = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->atom);
1305 WLog_Print(_log_cached_ptr, level,
"got event %s [atom %s]",
1306 x11_event_string(event->type), atom);
1316static BOOL xf_cliprdr_process_selection_notify(xfClipboard* clipboard,
1317 const XSelectionEvent* xevent)
1319 WINPR_ASSERT(clipboard);
1320 WINPR_ASSERT(xevent);
1322 if (xevent->target == clipboard->targets[1])
1324 if (xevent->property == None)
1326 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1330 xf_cliprdr_get_requested_targets(clipboard);
1337 return xf_cliprdr_get_requested_data(clipboard, xevent->target);
1341void xf_cliprdr_clear_cached_data(xfClipboard* clipboard)
1343 WINPR_ASSERT(clipboard);
1345 ClipboardLock(clipboard->system);
1346 ClipboardEmpty(clipboard->system);
1348 HashTable_Clear(clipboard->cachedData);
1349 HashTable_Clear(clipboard->cachedRawData);
1351 cliprdr_file_context_clear(clipboard->file);
1353 xf_cliprdr_stop_incr(clipboard);
1354 ClipboardUnlock(clipboard->system);
1357static void* format_to_cache_slot(UINT32 format)
1364 cnv.uptr = 0x100000000ULL + format;
1368static UINT32 get_dst_format_id_for_local_request(xfClipboard* clipboard,
1369 const xfCliprdrFormat* format)
1371 UINT32 dstFormatId = 0;
1373 WINPR_ASSERT(format);
1375 if (!format->formatName)
1376 return format->localFormat;
1378 ClipboardLock(clipboard->system);
1379 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1380 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
1381 ClipboardUnlock(clipboard->system);
1383 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1384 dstFormatId = format->localFormat;
1389static void get_src_format_info_for_local_request(xfClipboard* clipboard,
1390 const xfCliprdrFormat* format,
1391 UINT32* srcFormatId, BOOL* nullTerminated)
1394 *nullTerminated = FALSE;
1396 if (format->formatName)
1398 ClipboardLock(clipboard->system);
1399 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1401 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
1402 *nullTerminated = TRUE;
1404 else if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1406 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
1407 *nullTerminated = TRUE;
1409 ClipboardUnlock(clipboard->system);
1413 *srcFormatId = format->formatToRequest;
1414 switch (format->formatToRequest)
1418 case CF_UNICODETEXT:
1419 *nullTerminated = TRUE;
1422 *srcFormatId = CF_DIB;
1425 *srcFormatId = CF_TIFF;
1433static xfCachedData* convert_data_from_existing_raw_data(xfClipboard* clipboard,
1434 xfCachedData* cached_raw_data,
1435 UINT32 srcFormatId, BOOL nullTerminated,
1438 UINT32 dst_size = 0;
1440 WINPR_ASSERT(clipboard);
1441 WINPR_ASSERT(cached_raw_data);
1442 WINPR_ASSERT(cached_raw_data->data);
1444 ClipboardLock(clipboard->system);
1445 BOOL success = ClipboardSetData(clipboard->system, srcFormatId, cached_raw_data->data,
1446 cached_raw_data->data_length);
1449 WLog_WARN(TAG,
"Failed to set clipboard data (formatId: %u, data: %p, data_length: %u)",
1450 srcFormatId, WINPR_CXX_COMPAT_CAST(
const void*, cached_raw_data->data),
1451 cached_raw_data->data_length);
1452 ClipboardUnlock(clipboard->system);
1456 BYTE* dst_data = ClipboardGetData(clipboard->system, dstFormatId, &dst_size);
1459 WLog_WARN(TAG,
"Failed to get converted clipboard data");
1460 ClipboardUnlock(clipboard->system);
1463 ClipboardUnlock(clipboard->system);
1467 BYTE* nullTerminator = memchr(dst_data,
'\0', dst_size);
1470 const intptr_t diff = nullTerminator - dst_data;
1471 WINPR_ASSERT(diff >= 0);
1472 WINPR_ASSERT(diff <= UINT32_MAX);
1473 dst_size = (UINT32)diff;
1477 xfCachedData* cached_data = xf_cached_data_new(dst_data, dst_size);
1480 WLog_WARN(TAG,
"Failed to allocate cache entry");
1485 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId), cached_data))
1487 WLog_WARN(TAG,
"Failed to cache clipboard data");
1488 xf_cached_data_free(cached_data);
1495static BOOL xf_cliprdr_process_selection_request(xfClipboard* clipboard,
1496 const XSelectionRequestEvent* xevent)
1500 UINT32 formatId = 0;
1501 XSelectionEvent* respond = NULL;
1503 BOOL delayRespond = 0;
1504 BOOL rawTransfer = 0;
1505 unsigned long length = 0;
1506 unsigned long bytes_left = 0;
1507 xfContext* xfc = NULL;
1509 WINPR_ASSERT(clipboard);
1510 WINPR_ASSERT(xevent);
1512 xfc = clipboard->xfc;
1515 if (xevent->owner != xfc->drawable)
1518 delayRespond = FALSE;
1520 if (!(respond = (XSelectionEvent*)calloc(1,
sizeof(XSelectionEvent))))
1522 WLog_ERR(TAG,
"failed to allocate XEvent data");
1526 respond->property = None;
1527 respond->type = SelectionNotify;
1528 respond->display = xevent->display;
1529 respond->requestor = xevent->requestor;
1530 respond->selection = xevent->selection;
1531 respond->target = xevent->target;
1532 respond->time = xevent->time;
1534 if (xevent->target == clipboard->targets[0])
1537 respond->property = xevent->property;
1538 xf_cliprdr_provide_timestamp(clipboard, respond);
1540 else if (xevent->target == clipboard->targets[1])
1543 respond->property = xevent->property;
1544 xf_cliprdr_provide_targets(clipboard, respond);
1549 xf_cliprdr_get_server_format_by_atom(clipboard, xevent->target);
1550 const xfCliprdrFormat* cformat =
1551 xf_cliprdr_get_client_format_by_atom(clipboard, xevent->target);
1553 if (format && (xevent->requestor != xfc->drawable))
1555 formatId = format->formatId;
1556 rawTransfer = FALSE;
1557 xfCachedData* cached_data = NULL;
1559 if (formatId == CF_RAW)
1561 if (LogDynAndXGetWindowProperty(
1562 xfc->log, xfc->display, xevent->requestor, clipboard->property_atom, 0, 4,
1563 0, XA_INTEGER, &type, &fmt, &length, &bytes_left, &data) != Success)
1570 CopyMemory(&formatId, data, 4);
1575 const UINT32 dstFormatId = get_dst_format_id_for_local_request(clipboard, cformat);
1576 DEBUG_CLIPRDR(
"formatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", formatId,
1579 wHashTable* table = clipboard->cachedData;
1581 table = clipboard->cachedRawData;
1583 HashTable_Lock(table);
1586 cached_data = HashTable_GetItemValue(table, format_to_cache_slot(dstFormatId));
1588 cached_data = HashTable_GetItemValue(table, format_to_cache_slot(formatId));
1590 DEBUG_CLIPRDR(
"hasCachedData: %u, rawTransfer: %d", cached_data ? 1u : 0u, rawTransfer);
1592 if (!cached_data && !rawTransfer)
1594 UINT32 srcFormatId = 0;
1595 BOOL nullTerminated = FALSE;
1596 xfCachedData* cached_raw_data = NULL;
1598 get_src_format_info_for_local_request(clipboard, cformat, &srcFormatId,
1601 HashTable_GetItemValue(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId);
1603 DEBUG_CLIPRDR(
"hasCachedRawData: %u, rawDataLength: %u", cached_raw_data ? 1u : 0u,
1604 cached_raw_data ? cached_raw_data->data_length : 0);
1606 if (cached_raw_data && cached_raw_data->data_length != 0)
1607 cached_data = convert_data_from_existing_raw_data(
1608 clipboard, cached_raw_data, srcFormatId, nullTerminated, dstFormatId);
1611 DEBUG_CLIPRDR(
"hasCachedData: %u", cached_data ? 1u : 0u);
1616 respond->property = xevent->property;
1619 xf_cliprdr_provide_data(clipboard, respond, cached_data->data,
1620 cached_data->data_length);
1622 else if (clipboard->respond)
1628 WINPR_ASSERT(cformat);
1634 respond->property = xevent->property;
1635 clipboard->respond = respond;
1636 requested_format_replace(&clipboard->requestedFormat, formatId, dstFormatId,
1637 cformat->formatName);
1638 clipboard->data_raw_format = rawTransfer;
1639 delayRespond = TRUE;
1640 xf_cliprdr_send_data_request(clipboard, formatId, cformat);
1642 HashTable_Unlock(table);
1651 XSelectionEvent* sev;
1655 LogDynAndXSendEvent(xfc->log, xfc->display, xevent->requestor, 0, 0, conv.ev);
1656 LogDynAndXFlush(xfc->log, xfc->display);
1663static BOOL xf_cliprdr_process_selection_clear(xfClipboard* clipboard,
1664 const XSelectionClearEvent* xevent)
1666 xfContext* xfc = NULL;
1668 WINPR_ASSERT(clipboard);
1669 WINPR_ASSERT(xevent);
1671 xfc = clipboard->xfc;
1674 WINPR_UNUSED(xevent);
1676 if (xf_cliprdr_is_self_owned(clipboard))
1679 LogDynAndXDeleteProperty(xfc->log, xfc->display, clipboard->root_window,
1680 clipboard->property_atom);
1684static BOOL xf_cliprdr_process_property_notify(xfClipboard* clipboard,
const XPropertyEvent* xevent)
1686 const xfCliprdrFormat* format = NULL;
1687 xfContext* xfc = NULL;
1692 xfc = clipboard->xfc;
1694 WINPR_ASSERT(xevent);
1696 if (xevent->atom == clipboard->timestamp_property_atom)
1702 xf_cliprdr_set_selection_owner(xfc, clipboard, xevent->time);
1706 if (xevent->atom != clipboard->property_atom)
1709 if (xevent->window == clipboard->root_window)
1711 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1713 else if ((xevent->window == xfc->drawable) && (xevent->state == PropertyNewValue) &&
1714 clipboard->incr_starts)
1716 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1719 xf_cliprdr_get_requested_data(clipboard, format->atom);
1725void xf_cliprdr_handle_xevent(xfContext* xfc,
const XEvent* event)
1727 xfClipboard* clipboard = NULL;
1732 clipboard = xfc->clipboard;
1739 if (clipboard->xfixes_supported &&
1740 event->type == XFixesSelectionNotify + clipboard->xfixes_event_base)
1742 const XFixesSelectionNotifyEvent* se = (
const XFixesSelectionNotifyEvent*)event;
1744 if (se->subtype == XFixesSetSelectionOwnerNotify)
1746 if (se->selection != clipboard->clipboard_atom)
1749 if (LogDynAndXGetSelectionOwner(xfc->log, xfc->display, se->selection) == xfc->drawable)
1752 clipboard->owner = None;
1753 xf_cliprdr_check_owner(clipboard);
1761 switch (event->type)
1763 case SelectionNotify:
1764 log_selection_event(xfc, event);
1765 xf_cliprdr_process_selection_notify(clipboard, &event->xselection);
1768 case SelectionRequest:
1769 log_selection_event(xfc, event);
1770 xf_cliprdr_process_selection_request(clipboard, &event->xselectionrequest);
1773 case SelectionClear:
1774 log_selection_event(xfc, event);
1775 xf_cliprdr_process_selection_clear(clipboard, &event->xselectionclear);
1778 case PropertyNotify:
1779 log_selection_event(xfc, event);
1780 xf_cliprdr_process_property_notify(clipboard, &event->xproperty);
1784 if (!clipboard->xfixes_supported)
1786 xf_cliprdr_check_owner(clipboard);
1800static UINT xf_cliprdr_send_client_capabilities(xfClipboard* clipboard)
1805 WINPR_ASSERT(clipboard);
1807 capabilities.cCapabilitiesSets = 1;
1809 generalCapabilitySet.capabilitySetType = CB_CAPSTYPE_GENERAL;
1810 generalCapabilitySet.capabilitySetLength = 12;
1811 generalCapabilitySet.version = CB_CAPS_VERSION_2;
1812 generalCapabilitySet.generalFlags = CB_USE_LONG_FORMAT_NAMES;
1814 WINPR_ASSERT(clipboard);
1815 generalCapabilitySet.generalFlags |= cliprdr_file_context_current_flags(clipboard->file);
1817 WINPR_ASSERT(clipboard->context);
1818 WINPR_ASSERT(clipboard->context->ClientCapabilities);
1819 return clipboard->context->ClientCapabilities(clipboard->context, &capabilities);
1827static UINT xf_cliprdr_send_client_format_list(xfClipboard* clipboard, BOOL force)
1829 WINPR_ASSERT(clipboard);
1831 xfContext* xfc = clipboard->xfc;
1834 UINT32 numFormats = 0;
1835 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
1837 const UINT ret = xf_cliprdr_send_format_list(clipboard, formats, numFormats, force);
1839 if (clipboard->owner && clipboard->owner != xfc->drawable)
1842 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom,
1843 clipboard->targets[1], clipboard->property_atom, xfc->drawable,
1847 xf_cliprdr_free_formats(formats, numFormats);
1857static UINT xf_cliprdr_send_client_format_list_response(xfClipboard* clipboard, BOOL status)
1861 formatListResponse.common.msgType = CB_FORMAT_LIST_RESPONSE;
1862 formatListResponse.common.msgFlags = status ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
1863 formatListResponse.common.dataLen = 0;
1865 WINPR_ASSERT(clipboard);
1866 WINPR_ASSERT(clipboard->context);
1867 WINPR_ASSERT(clipboard->context->ClientFormatListResponse);
1868 return clipboard->context->ClientFormatListResponse(clipboard->context, &formatListResponse);
1876static UINT xf_cliprdr_monitor_ready(CliprdrClientContext* context,
1879 WINPR_ASSERT(context);
1880 WINPR_ASSERT(monitorReady);
1882 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
1883 WINPR_ASSERT(clipboard);
1885 WINPR_UNUSED(monitorReady);
1887 const UINT ret = xf_cliprdr_send_client_capabilities(clipboard);
1888 if (ret != CHANNEL_RC_OK)
1891 xf_clipboard_formats_free(clipboard);
1893 const UINT ret2 = xf_cliprdr_send_client_format_list(clipboard, TRUE);
1894 if (ret2 != CHANNEL_RC_OK)
1897 clipboard->sync = TRUE;
1898 return CHANNEL_RC_OK;
1906static UINT xf_cliprdr_server_capabilities(CliprdrClientContext* context,
1910 const BYTE* capsPtr = NULL;
1911 xfClipboard* clipboard = NULL;
1913 WINPR_ASSERT(context);
1914 WINPR_ASSERT(capabilities);
1916 clipboard = cliprdr_file_context_get_context(context->custom);
1917 WINPR_ASSERT(clipboard);
1919 capsPtr = (
const BYTE*)capabilities->capabilitySets;
1920 WINPR_ASSERT(capsPtr);
1922 cliprdr_file_context_remote_set_flags(clipboard->file, 0);
1924 for (UINT32 i = 0; i < capabilities->cCapabilitiesSets; i++)
1928 if (caps->capabilitySetType == CB_CAPSTYPE_GENERAL)
1932 cliprdr_file_context_remote_set_flags(clipboard->file, generalCaps->generalFlags);
1935 capsPtr += caps->capabilitySetLength;
1938 return CHANNEL_RC_OK;
1941static void xf_cliprdr_prepare_to_set_selection_owner(xfContext* xfc, xfClipboard* clipboard)
1944 WINPR_ASSERT(clipboard);
1961 Atom value = clipboard->timestamp_property_atom;
1963 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable,
1964 clipboard->timestamp_property_atom, XA_ATOM, 32, PropModeReplace,
1965 (
const BYTE*)&value, 1);
1966 LogDynAndXFlush(xfc->log, xfc->display);
1969static void xf_cliprdr_set_selection_owner(xfContext* xfc, xfClipboard* clipboard, Time timestamp)
1972 WINPR_ASSERT(clipboard);
1978 clipboard->selection_ownership_timestamp = timestamp;
1979 LogDynAndXSetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom, xfc->drawable,
1981 LogDynAndXFlush(xfc->log, xfc->display);
1989static UINT xf_cliprdr_server_format_list(CliprdrClientContext* context,
1992 xfContext* xfc = NULL;
1994 xfClipboard* clipboard = NULL;
1996 WINPR_ASSERT(context);
1997 WINPR_ASSERT(formatList);
1999 clipboard = cliprdr_file_context_get_context(context->custom);
2000 WINPR_ASSERT(clipboard);
2002 xfc = clipboard->xfc;
2008 free(clipboard->respond);
2009 clipboard->respond = NULL;
2011 xf_clipboard_formats_free(clipboard);
2012 xf_cliprdr_clear_cached_data(clipboard);
2013 requested_format_free(&clipboard->requestedFormat);
2015 xf_clipboard_free_server_formats(clipboard);
2017 clipboard->numServerFormats = formatList->numFormats + 1;
2019 if (!(clipboard->serverFormats =
2022 WLog_ERR(TAG,
"failed to allocate %" PRIu32
" CLIPRDR_FORMAT structs",
2023 clipboard->numServerFormats);
2024 ret = CHANNEL_RC_NO_MEMORY;
2028 for (
size_t i = 0; i < formatList->numFormats; i++)
2033 srvFormat->formatId = format->formatId;
2035 if (format->formatName)
2037 srvFormat->formatName = _strdup(format->formatName);
2039 if (!srvFormat->formatName)
2041 for (UINT32 k = 0; k < i; k++)
2042 free(clipboard->serverFormats[k].formatName);
2044 clipboard->numServerFormats = 0;
2045 free(clipboard->serverFormats);
2046 clipboard->serverFormats = NULL;
2047 ret = CHANNEL_RC_NO_MEMORY;
2053 ClipboardLock(clipboard->system);
2054 ret = cliprdr_file_context_notify_new_server_format_list(clipboard->file);
2055 ClipboardUnlock(clipboard->system);
2061 CLIPRDR_FORMAT* format = &clipboard->serverFormats[formatList->numFormats];
2062 format->formatId = CF_RAW;
2063 format->formatName = NULL;
2065 xf_cliprdr_provide_server_format_list(clipboard);
2066 clipboard->numTargets = 2;
2068 for (
size_t i = 0; i < formatList->numFormats; i++)
2072 for (
size_t j = 0; j < clipboard->numClientFormats; j++)
2074 const xfCliprdrFormat* clientFormat = &clipboard->clientFormats[j];
2075 if (xf_cliprdr_formats_equal(format, clientFormat))
2077 if ((clientFormat->formatName != NULL) &&
2078 (strcmp(type_FileGroupDescriptorW, clientFormat->formatName) == 0))
2080 if (!cliprdr_file_context_has_local_support(clipboard->file))
2083 xf_cliprdr_append_target(clipboard, clientFormat->atom);
2088 ret = xf_cliprdr_send_client_format_list_response(clipboard, TRUE);
2089 if (xfc->remote_app)
2090 xf_cliprdr_set_selection_owner(xfc, clipboard, CurrentTime);
2092 xf_cliprdr_prepare_to_set_selection_owner(xfc, clipboard);
2105static UINT xf_cliprdr_server_format_list_response(
2106 WINPR_ATTR_UNUSED CliprdrClientContext* context,
2109 WINPR_ASSERT(context);
2110 WINPR_ASSERT(formatListResponse);
2112 return CHANNEL_RC_OK;
2121xf_cliprdr_server_format_data_request(CliprdrClientContext* context,
2124 const xfCliprdrFormat* format = NULL;
2126 WINPR_ASSERT(context);
2127 WINPR_ASSERT(formatDataRequest);
2129 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2130 WINPR_ASSERT(clipboard);
2132 xfContext* xfc = clipboard->xfc;
2135 const uint32_t formatId = formatDataRequest->requestedFormatId;
2137 const BOOL rawTransfer = xf_cliprdr_is_raw_transfer_available(clipboard);
2141 format = xf_cliprdr_get_client_format_by_id(clipboard, CF_RAW);
2142 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom,
2143 XA_INTEGER, 32, PropModeReplace, (
const BYTE*)&formatId, 1);
2146 format = xf_cliprdr_get_client_format_by_id(clipboard, formatId);
2148 clipboard->requestedFormatId = rawTransfer ? CF_RAW : formatId;
2150 return xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
2152 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2153 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2154 format->localFormat,
2155 ClipboardGetFormatName(clipboard->system, format->localFormat),
2156 format->formatName);
2157 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom, format->atom,
2158 clipboard->property_atom, xfc->drawable, CurrentTime);
2159 LogDynAndXFlush(xfc->log, xfc->display);
2161 return CHANNEL_RC_OK;
2170xf_cliprdr_server_format_data_response(CliprdrClientContext* context,
2174 BYTE* pDstData = NULL;
2177 UINT32 srcFormatId = 0;
2178 UINT32 dstFormatId = 0;
2179 BOOL nullTerminated = FALSE;
2180 xfCachedData* cached_data = NULL;
2182 WINPR_ASSERT(context);
2183 WINPR_ASSERT(formatDataResponse);
2185 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2186 WINPR_ASSERT(clipboard);
2188 xfContext* xfc = clipboard->xfc;
2191 const UINT32 size = formatDataResponse->common.dataLen;
2192 const BYTE* data = formatDataResponse->requestedFormatData;
2194 if (formatDataResponse->common.msgFlags == CB_RESPONSE_FAIL)
2196 WLog_WARN(TAG,
"Format Data Response PDU msgFlags is CB_RESPONSE_FAIL");
2197 free(clipboard->respond);
2198 clipboard->respond = NULL;
2199 return CHANNEL_RC_OK;
2202 if (!clipboard->respond)
2203 return CHANNEL_RC_OK;
2205 const RequestedFormat* format = clipboard->requestedFormat;
2206 if (clipboard->data_raw_format)
2208 srcFormatId = CF_RAW;
2209 dstFormatId = CF_RAW;
2212 return ERROR_INTERNAL_ERROR;
2213 else if (format->formatName)
2215 dstFormatId = format->localFormat;
2217 ClipboardLock(clipboard->system);
2218 if (strcmp(format->formatName, type_HtmlFormat) == 0)
2220 srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
2221 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
2222 nullTerminated = TRUE;
2225 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
2227 if (!cliprdr_file_context_update_server_data(clipboard->file, clipboard->system, data,
2229 WLog_WARN(TAG,
"failed to update file descriptors");
2231 srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2232 const xfCliprdrFormat* dstTargetFormat =
2233 xf_cliprdr_get_client_format_by_atom(clipboard, clipboard->respond->target);
2234 if (!dstTargetFormat)
2236 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2240 dstFormatId = dstTargetFormat->localFormat;
2243 nullTerminated = TRUE;
2245 ClipboardUnlock(clipboard->system);
2249 srcFormatId = format->formatToRequest;
2250 dstFormatId = format->localFormat;
2251 switch (format->formatToRequest)
2254 nullTerminated = TRUE;
2258 nullTerminated = TRUE;
2261 case CF_UNICODETEXT:
2262 nullTerminated = TRUE;
2266 srcFormatId = CF_DIB;
2270 srcFormatId = CF_TIFF;
2278 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2279 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2280 format->localFormat,
2281 ClipboardGetFormatName(clipboard->system, format->localFormat),
2282 format->formatName);
2285 DEBUG_CLIPRDR(
"srcFormatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", srcFormatId,
2288 ClipboardLock(clipboard->system);
2289 bSuccess = ClipboardSetData(clipboard->system, srcFormatId, data, SrcSize);
2291 BOOL willQuit = FALSE;
2296 WLog_DBG(TAG,
"skipping, empty data detected!");
2297 free(clipboard->respond);
2298 clipboard->respond = NULL;
2303 pDstData = (BYTE*)ClipboardGetData(clipboard->system, dstFormatId, &DstSize);
2307 WLog_WARN(TAG,
"failed to get clipboard data in format %s [source format %s]",
2308 ClipboardGetFormatName(clipboard->system, dstFormatId),
2309 ClipboardGetFormatName(clipboard->system, srcFormatId));
2312 if (nullTerminated && pDstData)
2314 BYTE* nullTerminator = memchr(pDstData,
'\0', DstSize);
2317 const intptr_t diff = nullTerminator - pDstData;
2318 WINPR_ASSERT(diff >= 0);
2319 WINPR_ASSERT(diff <= UINT32_MAX);
2320 DstSize = (UINT32)diff;
2325 ClipboardUnlock(clipboard->system);
2327 return CHANNEL_RC_OK;
2333 cached_data = xf_cached_data_new(pDstData, DstSize);
2336 WLog_WARN(TAG,
"Failed to allocate cache entry");
2338 return CHANNEL_RC_OK;
2340 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId),
2343 WLog_WARN(TAG,
"Failed to cache clipboard data");
2344 xf_cached_data_free(cached_data);
2345 return CHANNEL_RC_OK;
2355 xfCachedData* cached_raw_data = xf_cached_data_new_copy(data, size);
2356 if (!cached_raw_data)
2357 WLog_WARN(TAG,
"Failed to allocate cache entry");
2360 if (!HashTable_Insert(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId,
2363 WLog_WARN(TAG,
"Failed to cache clipboard data");
2364 xf_cached_data_free(cached_raw_data);
2371 xf_cliprdr_provide_data(clipboard, clipboard->respond, pDstData, DstSize);
2376 XSelectionEvent* sev;
2379 conv.sev = clipboard->respond;
2381 LogDynAndXSendEvent(xfc->log, xfc->display, clipboard->respond->requestor, 0, 0, conv.ev);
2382 LogDynAndXFlush(xfc->log, xfc->display);
2384 free(clipboard->respond);
2385 clipboard->respond = NULL;
2386 return CHANNEL_RC_OK;
2389static BOOL xf_cliprdr_is_valid_unix_filename(LPCWSTR filename)
2394 if (filename[0] == L
'\0')
2398 for (
const WCHAR* c = filename; *c; ++c)
2407xfClipboard* xf_clipboard_new(xfContext* xfc, BOOL relieveFilenameRestriction)
2410 rdpChannels* channels = NULL;
2411 xfClipboard* clipboard = NULL;
2412 const char* selectionAtom = NULL;
2413 xfCliprdrFormat* clientFormat = NULL;
2417 WINPR_ASSERT(xfc->common.context.settings);
2419 if (!(clipboard = (xfClipboard*)calloc(1,
sizeof(xfClipboard))))
2421 WLog_ERR(TAG,
"failed to allocate xfClipboard data");
2425 clipboard->file = cliprdr_file_context_new(clipboard);
2426 if (!clipboard->file)
2429 xfc->clipboard = clipboard;
2430 clipboard->xfc = xfc;
2431 channels = xfc->common.context.channels;
2432 clipboard->channels = channels;
2433 clipboard->system = ClipboardCreate();
2434 clipboard->requestedFormatId = UINT32_MAX;
2435 clipboard->root_window = DefaultRootWindow(xfc->display);
2440 selectionAtom =
"CLIPBOARD";
2442 clipboard->clipboard_atom = Logging_XInternAtom(xfc->log, xfc->display, selectionAtom, FALSE);
2444 if (clipboard->clipboard_atom == None)
2446 WLog_ERR(TAG,
"unable to get %s atom", selectionAtom);
2450 clipboard->timestamp_property_atom =
2451 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_TIMESTAMP_PROPERTY", FALSE);
2452 clipboard->property_atom =
2453 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR", FALSE);
2454 clipboard->raw_transfer_atom =
2455 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_RAW", FALSE);
2456 clipboard->raw_format_list_atom =
2457 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_FORMATS", FALSE);
2458 xf_cliprdr_set_raw_transfer_enabled(clipboard, TRUE);
2459 XSelectInput(xfc->display, clipboard->root_window, PropertyChangeMask);
2462 if (XFixesQueryExtension(xfc->display, &clipboard->xfixes_event_base,
2463 &clipboard->xfixes_error_base))
2468 if (XFixesQueryVersion(xfc->display, &xfmajor, &xfminor))
2470 XFixesSelectSelectionInput(xfc->display, clipboard->root_window,
2471 clipboard->clipboard_atom,
2472 XFixesSetSelectionOwnerNotifyMask);
2473 clipboard->xfixes_supported = TRUE;
2477 WLog_ERR(TAG,
"Error querying X Fixes extension version");
2482 WLog_ERR(TAG,
"Error loading X Fixes extension");
2488 "Warning: Using clipboard redirection without XFIXES extension is strongly discouraged!");
2490 clientFormat = &clipboard->clientFormats[n++];
2491 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_RAW", False);
2492 clientFormat->localFormat = clientFormat->formatToRequest = CF_RAW;
2494 clientFormat = &clipboard->clientFormats[n++];
2495 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"UTF8_STRING", False);
2496 clientFormat->formatToRequest = CF_UNICODETEXT;
2497 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2499 clientFormat = &clipboard->clientFormats[n++];
2500 clientFormat->atom = XA_STRING;
2501 clientFormat->formatToRequest = CF_TEXT;
2502 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2504 clientFormat = &clipboard->clientFormats[n++];
2505 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_tiff, False);
2506 clientFormat->formatToRequest = clientFormat->localFormat = CF_TIFF;
2508 for (
size_t x = 0; x < ARRAYSIZE(mime_bitmap); x++)
2510 const char* mime_bmp = mime_bitmap[x];
2511 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2514 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2518 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2519 clientFormat = &clipboard->clientFormats[n++];
2520 clientFormat->localFormat = format;
2521 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2522 clientFormat->formatToRequest = CF_DIB;
2523 clientFormat->isImage = TRUE;
2526 for (
size_t x = 0; x < ARRAYSIZE(mime_images); x++)
2528 const char* mime_bmp = mime_images[x];
2529 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2532 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2536 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2537 clientFormat = &clipboard->clientFormats[n++];
2538 clientFormat->localFormat = format;
2539 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2540 clientFormat->formatToRequest = CF_DIB;
2541 clientFormat->isImage = TRUE;
2544 clientFormat = &clipboard->clientFormats[n++];
2545 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_html, False);
2546 clientFormat->formatToRequest = ClipboardGetFormatId(xfc->clipboard->system, type_HtmlFormat);
2547 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_html);
2548 clientFormat->formatName = _strdup(type_HtmlFormat);
2550 if (!clientFormat->formatName)
2553 clientFormat = &clipboard->clientFormats[n++];
2562 const UINT32 fgid = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2564 const UINT32 uid = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2567 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2568 clientFormat->atom =
2569 Logging_XInternAtom(xfc->log, xfc->display, mime_uri_list, False);
2570 clientFormat->localFormat = uid;
2571 clientFormat->formatToRequest = fgid;
2572 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2574 if (!clientFormat->formatName)
2577 clientFormat = &clipboard->clientFormats[n++];
2582 const UINT32 gid = ClipboardGetFormatId(clipboard->system, mime_gnome_copied_files);
2585 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2586 clientFormat->atom =
2587 Logging_XInternAtom(xfc->log, xfc->display, mime_gnome_copied_files, False);
2588 clientFormat->localFormat = gid;
2589 clientFormat->formatToRequest = fgid;
2590 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2592 if (!clientFormat->formatName)
2595 clientFormat = &clipboard->clientFormats[n++];
2600 const UINT32 mid = ClipboardGetFormatId(clipboard->system, mime_mate_copied_files);
2603 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2604 clientFormat->atom =
2605 Logging_XInternAtom(xfc->log, xfc->display, mime_mate_copied_files, False);
2606 clientFormat->localFormat = mid;
2607 clientFormat->formatToRequest = fgid;
2608 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2610 if (!clientFormat->formatName)
2616 clipboard->numClientFormats = WINPR_ASSERTING_INT_CAST(uint32_t, n);
2617 clipboard->targets[0] = Logging_XInternAtom(xfc->log, xfc->display,
"TIMESTAMP", FALSE);
2618 clipboard->targets[1] = Logging_XInternAtom(xfc->log, xfc->display,
"TARGETS", FALSE);
2619 clipboard->numTargets = 2;
2620 clipboard->incr_atom = Logging_XInternAtom(xfc->log, xfc->display,
"INCR", FALSE);
2622 if (relieveFilenameRestriction)
2624 WLog_DBG(TAG,
"Relieving CLIPRDR filename restriction");
2625 ClipboardGetDelegate(clipboard->system)->IsFileNameComponentValid =
2626 xf_cliprdr_is_valid_unix_filename;
2629 clipboard->cachedData = HashTable_New(TRUE);
2630 if (!clipboard->cachedData)
2633 obj = HashTable_ValueObject(clipboard->cachedData);
2636 clipboard->cachedRawData = HashTable_New(TRUE);
2637 if (!clipboard->cachedRawData)
2640 obj = HashTable_ValueObject(clipboard->cachedRawData);
2646 WINPR_PRAGMA_DIAG_PUSH
2647 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2648 xf_clipboard_free(clipboard);
2649 WINPR_PRAGMA_DIAG_POP
2653void xf_clipboard_free(xfClipboard* clipboard)
2658 xf_clipboard_free_server_formats(clipboard);
2660 if (clipboard->numClientFormats)
2662 for (UINT32 i = 0; i < clipboard->numClientFormats; i++)
2664 xfCliprdrFormat* format = &clipboard->clientFormats[i];
2665 free(format->formatName);
2669 cliprdr_file_context_free(clipboard->file);
2671 ClipboardDestroy(clipboard->system);
2672 xf_clipboard_formats_free(clipboard);
2673 HashTable_Free(clipboard->cachedRawData);
2674 HashTable_Free(clipboard->cachedData);
2675 requested_format_free(&clipboard->requestedFormat);
2676 free(clipboard->respond);
2677 free(clipboard->incr_data);
2681void xf_cliprdr_init(xfContext* xfc, CliprdrClientContext* cliprdr)
2684 WINPR_ASSERT(cliprdr);
2686 xfc->cliprdr = cliprdr;
2687 xfc->clipboard->context = cliprdr;
2689 cliprdr->MonitorReady = xf_cliprdr_monitor_ready;
2690 cliprdr->ServerCapabilities = xf_cliprdr_server_capabilities;
2691 cliprdr->ServerFormatList = xf_cliprdr_server_format_list;
2692 cliprdr->ServerFormatListResponse = xf_cliprdr_server_format_list_response;
2693 cliprdr->ServerFormatDataRequest = xf_cliprdr_server_format_data_request;
2694 cliprdr->ServerFormatDataResponse = xf_cliprdr_server_format_data_response;
2696 cliprdr_file_context_init(xfc->clipboard->file, cliprdr);
2699void xf_cliprdr_uninit(xfContext* xfc, CliprdrClientContext* cliprdr)
2702 WINPR_ASSERT(cliprdr);
2704 xfc->cliprdr = NULL;
2708 ClipboardLock(xfc->clipboard->system);
2709 cliprdr_file_context_uninit(xfc->clipboard->file, cliprdr);
2710 ClipboardUnlock(xfc->clipboard->system);
2711 xfc->clipboard->context = NULL;
WINPR_ATTR_NODISCARD 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.
OBJECT_FREE_FN fnObjectFree