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);
715 BOOL isImage = FALSE;
716 BOOL hasHtml = FALSE;
717 const uint32_t htmlFormatId = ClipboardRegisterFormat(clipboard->system, type_HtmlFormat);
718 for (
unsigned long i = 0; i < proplength; i++)
720 Atom tatom = ((Atom*)data)[i];
721 const xfCliprdrFormat* format = xf_cliprdr_get_client_format_by_atom(clipboard, tatom);
723 if (xf_cliprdr_should_add_format(formats, *numFormats, format))
726 cformat->formatId = format->formatToRequest;
730 if (cformat->formatId == htmlFormatId)
735 if (cformat->formatId == CF_TIFF)
737 else if (cformat->formatId == CF_DIB)
739 else if (cformat->formatId == CF_DIBV5)
742 if (format->formatName)
744 cformat->formatName = _strdup(format->formatName);
745 WINPR_ASSERT(cformat->formatName);
748 cformat->formatName = NULL;
754 clipboard->isImageContent = isImage;
755 if (isImage && !hasHtml)
758 cformat->formatId = htmlFormatId;
759 cformat->formatName = _strdup(type_HtmlFormat);
771static CLIPRDR_FORMAT* xf_cliprdr_get_client_formats(xfClipboard* clipboard, UINT32* numFormats)
775 WINPR_ASSERT(clipboard);
776 WINPR_ASSERT(numFormats);
780 if (xf_cliprdr_is_raw_transfer_available(clipboard))
782 formats = xf_cliprdr_get_raw_server_formats(clipboard, numFormats);
785 if (*numFormats == 0)
787 xf_cliprdr_free_formats(formats, *numFormats);
788 formats = xf_cliprdr_get_formats_from_targets(clipboard, numFormats);
794static void xf_cliprdr_provide_server_format_list(xfClipboard* clipboard)
797 xfContext* xfc = NULL;
799 WINPR_ASSERT(clipboard);
801 xfc = clipboard->xfc;
804 formats = xf_cliprdr_serialize_server_format_list(clipboard);
808 const size_t len = Stream_Length(formats);
809 WINPR_ASSERT(len <= INT32_MAX);
810 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable,
811 clipboard->raw_format_list_atom, clipboard->raw_format_list_atom,
812 8, PropModeReplace, Stream_Buffer(formats), (
int)len);
816 LogDynAndXDeleteProperty(xfc->log, xfc->display, xfc->drawable,
817 clipboard->raw_format_list_atom);
820 Stream_Free(formats, TRUE);
828 if (a->formatId != b->formatId)
830 if (!a->formatName && !b->formatName)
832 if (!a->formatName || !b->formatName)
834 return strcmp(a->formatName, b->formatName) == 0;
837static BOOL xf_clipboard_changed(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
840 WINPR_ASSERT(clipboard);
841 WINPR_ASSERT(formats || (numFormats == 0));
843 if (clipboard->lastSentNumFormats != numFormats)
846 for (UINT32 x = 0; x < numFormats; x++)
849 BOOL contained = FALSE;
850 for (UINT32 y = 0; y < numFormats; y++)
852 if (xf_clipboard_format_equal(cur, &formats[y]))
865static void xf_clipboard_formats_free(xfClipboard* clipboard)
867 WINPR_ASSERT(clipboard);
869 xf_cliprdr_free_formats(clipboard->lastSentFormats, clipboard->lastSentNumFormats);
870 clipboard->lastSentFormats = NULL;
871 clipboard->lastSentNumFormats = 0;
874static BOOL xf_clipboard_copy_formats(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
877 WINPR_ASSERT(clipboard);
878 WINPR_ASSERT(formats || (numFormats == 0));
880 xf_clipboard_formats_free(clipboard);
882 clipboard->lastSentFormats = calloc(numFormats,
sizeof(
CLIPRDR_FORMAT));
883 if (!clipboard->lastSentFormats)
885 clipboard->lastSentNumFormats = numFormats;
886 for (UINT32 x = 0; x < numFormats; x++)
892 lcur->formatName = _strdup(cur->formatName);
897static UINT xf_cliprdr_send_format_list(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
898 UINT32 numFormats, BOOL force)
904 } cnv = { .cpv = formats };
906 .numFormats = numFormats,
908 .common.msgType = CB_FORMAT_LIST };
911 WINPR_ASSERT(clipboard);
912 WINPR_ASSERT(formats || (numFormats == 0));
914 if (!force && !xf_clipboard_changed(clipboard, formats, numFormats))
915 return CHANNEL_RC_OK;
917#if defined(WITH_DEBUG_CLIPRDR)
918 for (UINT32 x = 0; x < numFormats; x++)
921 DEBUG_CLIPRDR(
"announcing format 0x%08" PRIx32
" [%s] [%s]", format->formatId,
922 ClipboardGetFormatIdString(format->formatId), format->formatName);
926 xf_clipboard_copy_formats(clipboard, formats, numFormats);
928 xf_cliprdr_send_data_response(clipboard, NULL, NULL, 0);
930 xf_cliprdr_clear_cached_data(clipboard);
932 ret = cliprdr_file_context_notify_new_client_format_list(clipboard->file);
936 WINPR_ASSERT(clipboard->context);
937 WINPR_ASSERT(clipboard->context->ClientFormatList);
938 return clipboard->context->ClientFormatList(clipboard->context, &formatList);
941static void xf_cliprdr_get_requested_targets(xfClipboard* clipboard)
943 UINT32 numFormats = 0;
944 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
945 xf_cliprdr_send_format_list(clipboard, formats, numFormats, FALSE);
946 xf_cliprdr_free_formats(formats, numFormats);
949static void xf_cliprdr_process_requested_data(xfClipboard* clipboard, BOOL hasData,
950 const BYTE* data,
size_t size)
955 INT64 srcFormatId = -1;
956 BYTE* pDstData = NULL;
957 const xfCliprdrFormat* format = NULL;
959 WINPR_ASSERT(clipboard);
961 if (clipboard->incr_starts && hasData)
966 clipboard->incr_data_length = 0;
968 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
970 if (!hasData || !data || !format)
972 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
976 switch (format->formatToRequest)
979 srcFormatId = CF_RAW;
985 srcFormatId = format->localFormat;
989 srcFormatId = format->localFormat;
995 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
999 ClipboardLock(clipboard->system);
1000 SrcSize = (UINT32)size;
1001 bSuccess = ClipboardSetData(clipboard->system, (UINT32)srcFormatId, data, SrcSize);
1007 (BYTE*)ClipboardGetData(clipboard->system, clipboard->requestedFormatId, &DstSize);
1009 ClipboardUnlock(clipboard->system);
1013 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1024 ClipboardLock(clipboard->system);
1025 if (format->formatToRequest &&
1026 (format->formatToRequest ==
1027 ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW)))
1029 UINT error = NO_ERROR;
1035 const UINT32 flags = cliprdr_file_context_remote_get_flags(clipboard->file);
1036 error = cliprdr_serialize_file_list_ex(flags, file_array, file_count, &pDstData, &DstSize);
1039 WLog_ERR(TAG,
"failed to serialize CLIPRDR_FILELIST: 0x%08X", error);
1042 UINT32 formatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
1043 UINT32 url_size = 0;
1045 char* url = ClipboardGetData(clipboard->system, formatId, &url_size);
1046 cliprdr_file_context_update_client_data(clipboard->file, url, url_size);
1052 ClipboardUnlock(clipboard->system);
1054 xf_cliprdr_send_data_response(clipboard, format, pDstData, DstSize);
1058static BOOL xf_restore_input_flags(xfClipboard* clipboard)
1060 WINPR_ASSERT(clipboard);
1062 xfContext* xfc = clipboard->xfc;
1065 if (clipboard->event_mask != 0)
1067 XSelectInput(xfc->display, xfc->drawable, clipboard->event_mask);
1068 clipboard->event_mask = 0;
1073static BOOL append(xfClipboard* clipboard,
const void* sdata,
size_t length)
1075 WINPR_ASSERT(clipboard);
1077 const size_t size = length + clipboard->incr_data_length + 2;
1078 BYTE* data = realloc(clipboard->incr_data, size);
1081 clipboard->incr_data = data;
1082 memcpy(&data[clipboard->incr_data_length], sdata, length);
1083 clipboard->incr_data_length += length;
1084 clipboard->incr_data[clipboard->incr_data_length + 0] =
'\0';
1085 clipboard->incr_data[clipboard->incr_data_length + 1] =
'\0';
1089static BOOL xf_cliprdr_stop_incr(xfClipboard* clipboard)
1091 clipboard->incr_starts = FALSE;
1092 clipboard->incr_data_length = 0;
1093 return xf_restore_input_flags(clipboard);
1096static BOOL xf_cliprdr_get_requested_data(xfClipboard* clipboard, Atom target)
1098 WINPR_ASSERT(clipboard);
1100 xfContext* xfc = clipboard->xfc;
1103 const xfCliprdrFormat* format =
1104 xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1106 if (!format || (format->atom != target))
1108 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1113 BOOL has_data = FALSE;
1114 int format_property = 0;
1115 unsigned long length = 0;
1116 unsigned long total_bytes = 0;
1117 BYTE* property_data = NULL;
1118 const int rc = LogDynAndXGetWindowProperty(
1119 xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0, 0, False, target, &type,
1120 &format_property, &length, &total_bytes, &property_data);
1123 xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
1130 if ((total_bytes <= 0) && !clipboard->incr_starts)
1132 xf_cliprdr_stop_incr(clipboard);
1135 else if (type == clipboard->incr_atom)
1137 xf_cliprdr_stop_incr(clipboard);
1138 clipboard->incr_starts = TRUE;
1143 BYTE* incremental_data = NULL;
1144 unsigned long incremental_len = 0;
1147 len = clipboard->incr_data_length;
1148 if (total_bytes <= 0)
1150 xf_cliprdr_stop_incr(clipboard);
1154 else if (LogDynAndXGetWindowProperty(
1155 xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0,
1156 WINPR_ASSERTING_INT_CAST(int32_t, total_bytes), False, target, &type,
1157 &format_property, &incremental_len, &length, &incremental_data) == Success)
1159 has_data = append(clipboard, incremental_data, incremental_len);
1160 len = clipboard->incr_data_length;
1163 if (incremental_data)
1164 XFree(incremental_data);
1167 LogDynAndXDeleteProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom);
1168 xf_cliprdr_process_requested_data(clipboard, has_data, clipboard->incr_data, len);
1173static void xf_cliprdr_append_target(xfClipboard* clipboard, Atom target)
1175 WINPR_ASSERT(clipboard);
1177 if (clipboard->numTargets >= ARRAYSIZE(clipboard->targets))
1180 for (
size_t i = 0; i < clipboard->numTargets; i++)
1182 if (clipboard->targets[i] == target)
1186 clipboard->targets[clipboard->numTargets++] = target;
1189static void xf_cliprdr_provide_targets(xfClipboard* clipboard,
const XSelectionEvent* respond)
1191 xfContext* xfc = NULL;
1193 WINPR_ASSERT(clipboard);
1195 xfc = clipboard->xfc;
1198 if (respond->property != None)
1200 WINPR_ASSERT(clipboard->numTargets <= INT32_MAX);
1201 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1202 XA_ATOM, 32, PropModeReplace, (
const BYTE*)clipboard->targets,
1203 (
int)clipboard->numTargets);
1207static void xf_cliprdr_provide_timestamp(xfClipboard* clipboard,
const XSelectionEvent* respond)
1209 xfContext* xfc = NULL;
1211 WINPR_ASSERT(clipboard);
1213 xfc = clipboard->xfc;
1216 if (respond->property != None)
1218 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1219 XA_INTEGER, 32, PropModeReplace,
1220 (
const BYTE*)&clipboard->selection_ownership_timestamp, 1);
1224#define xf_cliprdr_provide_data(clipboard, respond, data, size) \
1225 xf_cliprdr_provide_data_((clipboard), (respond), (data), (size), __FILE__, __func__, __LINE__)
1226static void xf_cliprdr_provide_data_(xfClipboard* clipboard,
const XSelectionEvent* respond,
1227 const BYTE* data, UINT32 size,
const char* file,
1228 const char* fkt,
size_t line)
1230 WINPR_ASSERT(clipboard);
1232 xfContext* xfc = clipboard->xfc;
1235 if (respond->property != None)
1237 LogDynAndXChangeProperty_ex(xfc->log, file, fkt, line, xfc->display, respond->requestor,
1238 respond->property, respond->target, 8, PropModeReplace, data,
1239 WINPR_ASSERTING_INT_CAST(int32_t, size));
1243static void log_selection_event(xfContext* xfc,
const XEvent* event)
1245 const DWORD level = WLOG_TRACE;
1246 static wLog* _log_cached_ptr = NULL;
1247 if (!_log_cached_ptr)
1248 _log_cached_ptr = WLog_Get(TAG);
1249 if (WLog_IsLevelActive(_log_cached_ptr, level))
1252 switch (event->type)
1254 case SelectionClear:
1256 const XSelectionClearEvent* xevent = &
event->xselectionclear;
1258 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1259 WLog_Print(_log_cached_ptr, level,
"got event %s [selection %s]",
1260 x11_event_string(event->type), selection);
1264 case SelectionNotify:
1266 const XSelectionEvent* xevent = &
event->xselection;
1268 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1269 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1270 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1271 WLog_Print(_log_cached_ptr, level,
1272 "got event %s [selection %s, target %s, property %s]",
1273 x11_event_string(event->type), selection, target, property);
1279 case SelectionRequest:
1281 const XSelectionRequestEvent* xevent = &
event->xselectionrequest;
1283 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1284 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1285 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1286 WLog_Print(_log_cached_ptr, level,
1287 "got event %s [selection %s, target %s, property %s]",
1288 x11_event_string(event->type), selection, target, property);
1294 case PropertyNotify:
1296 const XPropertyEvent* xevent = &
event->xproperty;
1297 char* atom = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->atom);
1298 WLog_Print(_log_cached_ptr, level,
"got event %s [atom %s]",
1299 x11_event_string(event->type), atom);
1309static BOOL xf_cliprdr_process_selection_notify(xfClipboard* clipboard,
1310 const XSelectionEvent* xevent)
1312 WINPR_ASSERT(clipboard);
1313 WINPR_ASSERT(xevent);
1315 if (xevent->target == clipboard->targets[1])
1317 if (xevent->property == None)
1319 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1323 xf_cliprdr_get_requested_targets(clipboard);
1330 return xf_cliprdr_get_requested_data(clipboard, xevent->target);
1334void xf_cliprdr_clear_cached_data(xfClipboard* clipboard)
1336 WINPR_ASSERT(clipboard);
1338 ClipboardLock(clipboard->system);
1339 ClipboardEmpty(clipboard->system);
1341 HashTable_Clear(clipboard->cachedData);
1342 HashTable_Clear(clipboard->cachedRawData);
1344 cliprdr_file_context_clear(clipboard->file);
1346 xf_cliprdr_stop_incr(clipboard);
1347 ClipboardUnlock(clipboard->system);
1350static void* format_to_cache_slot(UINT32 format)
1357 cnv.uptr = 0x100000000ULL + format;
1361static UINT32 get_dst_format_id_for_local_request(xfClipboard* clipboard,
1362 const xfCliprdrFormat* format)
1364 UINT32 dstFormatId = 0;
1366 WINPR_ASSERT(format);
1368 if (!format->formatName)
1369 return format->localFormat;
1371 ClipboardLock(clipboard->system);
1372 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1373 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
1374 ClipboardUnlock(clipboard->system);
1376 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1377 dstFormatId = format->localFormat;
1382static void get_src_format_info_for_local_request(xfClipboard* clipboard,
1383 const xfCliprdrFormat* format,
1384 UINT32* srcFormatId, BOOL* nullTerminated)
1387 *nullTerminated = FALSE;
1389 if (format->formatName)
1391 ClipboardLock(clipboard->system);
1392 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1394 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
1395 *nullTerminated = TRUE;
1397 else if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1399 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
1400 *nullTerminated = TRUE;
1402 ClipboardUnlock(clipboard->system);
1406 *srcFormatId = format->formatToRequest;
1407 switch (format->formatToRequest)
1411 case CF_UNICODETEXT:
1412 *nullTerminated = TRUE;
1415 *srcFormatId = CF_DIB;
1418 *srcFormatId = CF_TIFF;
1426static xfCachedData* convert_data_from_existing_raw_data(xfClipboard* clipboard,
1427 xfCachedData* cached_raw_data,
1428 UINT32 srcFormatId, BOOL nullTerminated,
1431 UINT32 dst_size = 0;
1433 WINPR_ASSERT(clipboard);
1434 WINPR_ASSERT(cached_raw_data);
1435 WINPR_ASSERT(cached_raw_data->data);
1437 ClipboardLock(clipboard->system);
1438 BOOL success = ClipboardSetData(clipboard->system, srcFormatId, cached_raw_data->data,
1439 cached_raw_data->data_length);
1442 WLog_WARN(TAG,
"Failed to set clipboard data (formatId: %u, data: %p, data_length: %u)",
1443 srcFormatId, cached_raw_data->data, cached_raw_data->data_length);
1444 ClipboardUnlock(clipboard->system);
1448 BYTE* dst_data = ClipboardGetData(clipboard->system, dstFormatId, &dst_size);
1451 WLog_WARN(TAG,
"Failed to get converted clipboard data");
1452 ClipboardUnlock(clipboard->system);
1455 ClipboardUnlock(clipboard->system);
1459 BYTE* nullTerminator = memchr(dst_data,
'\0', dst_size);
1462 const intptr_t diff = nullTerminator - dst_data;
1463 WINPR_ASSERT(diff >= 0);
1464 WINPR_ASSERT(diff <= UINT32_MAX);
1465 dst_size = (UINT32)diff;
1469 xfCachedData* cached_data = xf_cached_data_new(dst_data, dst_size);
1472 WLog_WARN(TAG,
"Failed to allocate cache entry");
1477 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId), cached_data))
1479 WLog_WARN(TAG,
"Failed to cache clipboard data");
1480 xf_cached_data_free(cached_data);
1487static BOOL xf_cliprdr_process_selection_request(xfClipboard* clipboard,
1488 const XSelectionRequestEvent* xevent)
1492 UINT32 formatId = 0;
1493 XSelectionEvent* respond = NULL;
1495 BOOL delayRespond = 0;
1496 BOOL rawTransfer = 0;
1497 unsigned long length = 0;
1498 unsigned long bytes_left = 0;
1499 xfContext* xfc = NULL;
1501 WINPR_ASSERT(clipboard);
1502 WINPR_ASSERT(xevent);
1504 xfc = clipboard->xfc;
1507 if (xevent->owner != xfc->drawable)
1510 delayRespond = FALSE;
1512 if (!(respond = (XSelectionEvent*)calloc(1,
sizeof(XSelectionEvent))))
1514 WLog_ERR(TAG,
"failed to allocate XEvent data");
1518 respond->property = None;
1519 respond->type = SelectionNotify;
1520 respond->display = xevent->display;
1521 respond->requestor = xevent->requestor;
1522 respond->selection = xevent->selection;
1523 respond->target = xevent->target;
1524 respond->time = xevent->time;
1526 if (xevent->target == clipboard->targets[0])
1529 respond->property = xevent->property;
1530 xf_cliprdr_provide_timestamp(clipboard, respond);
1532 else if (xevent->target == clipboard->targets[1])
1535 respond->property = xevent->property;
1536 xf_cliprdr_provide_targets(clipboard, respond);
1541 xf_cliprdr_get_server_format_by_atom(clipboard, xevent->target);
1542 const xfCliprdrFormat* cformat =
1543 xf_cliprdr_get_client_format_by_atom(clipboard, xevent->target);
1545 if (format && (xevent->requestor != xfc->drawable))
1547 formatId = format->formatId;
1548 rawTransfer = FALSE;
1549 xfCachedData* cached_data = NULL;
1551 if (formatId == CF_RAW)
1553 if (LogDynAndXGetWindowProperty(
1554 xfc->log, xfc->display, xevent->requestor, clipboard->property_atom, 0, 4,
1555 0, XA_INTEGER, &type, &fmt, &length, &bytes_left, &data) != Success)
1562 CopyMemory(&formatId, data, 4);
1567 const UINT32 dstFormatId = get_dst_format_id_for_local_request(clipboard, cformat);
1568 DEBUG_CLIPRDR(
"formatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", formatId,
1572 cached_data = HashTable_GetItemValue(clipboard->cachedData,
1573 format_to_cache_slot(dstFormatId));
1575 cached_data = HashTable_GetItemValue(clipboard->cachedRawData,
1576 format_to_cache_slot(formatId));
1578 DEBUG_CLIPRDR(
"hasCachedData: %u, rawTransfer: %u", cached_data ? 1 : 0, rawTransfer);
1580 if (!cached_data && !rawTransfer)
1582 UINT32 srcFormatId = 0;
1583 BOOL nullTerminated = FALSE;
1584 xfCachedData* cached_raw_data = NULL;
1586 get_src_format_info_for_local_request(clipboard, cformat, &srcFormatId,
1589 HashTable_GetItemValue(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId);
1591 DEBUG_CLIPRDR(
"hasCachedRawData: %u, rawDataLength: %u", cached_raw_data ? 1 : 0,
1592 cached_raw_data ? cached_raw_data->data_length : 0);
1594 if (cached_raw_data && cached_raw_data->data_length != 0)
1595 cached_data = convert_data_from_existing_raw_data(
1596 clipboard, cached_raw_data, srcFormatId, nullTerminated, dstFormatId);
1599 DEBUG_CLIPRDR(
"hasCachedData: %u", cached_data ? 1 : 0);
1604 respond->property = xevent->property;
1607 xf_cliprdr_provide_data(clipboard, respond, cached_data->data,
1608 cached_data->data_length);
1610 else if (clipboard->respond)
1616 WINPR_ASSERT(cformat);
1622 respond->property = xevent->property;
1623 clipboard->respond = respond;
1624 requested_format_replace(&clipboard->requestedFormat, formatId, dstFormatId,
1625 cformat->formatName);
1626 clipboard->data_raw_format = rawTransfer;
1627 delayRespond = TRUE;
1628 xf_cliprdr_send_data_request(clipboard, formatId, cformat);
1638 XSelectionEvent* sev;
1642 LogDynAndXSendEvent(xfc->log, xfc->display, xevent->requestor, 0, 0, conv.ev);
1643 LogDynAndXFlush(xfc->log, xfc->display);
1650static BOOL xf_cliprdr_process_selection_clear(xfClipboard* clipboard,
1651 const XSelectionClearEvent* xevent)
1653 xfContext* xfc = NULL;
1655 WINPR_ASSERT(clipboard);
1656 WINPR_ASSERT(xevent);
1658 xfc = clipboard->xfc;
1661 WINPR_UNUSED(xevent);
1663 if (xf_cliprdr_is_self_owned(clipboard))
1666 LogDynAndXDeleteProperty(xfc->log, xfc->display, clipboard->root_window,
1667 clipboard->property_atom);
1671static BOOL xf_cliprdr_process_property_notify(xfClipboard* clipboard,
const XPropertyEvent* xevent)
1673 const xfCliprdrFormat* format = NULL;
1674 xfContext* xfc = NULL;
1679 xfc = clipboard->xfc;
1681 WINPR_ASSERT(xevent);
1683 if (xevent->atom == clipboard->timestamp_property_atom)
1689 xf_cliprdr_set_selection_owner(xfc, clipboard, xevent->time);
1693 if (xevent->atom != clipboard->property_atom)
1696 if (xevent->window == clipboard->root_window)
1698 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1700 else if ((xevent->window == xfc->drawable) && (xevent->state == PropertyNewValue) &&
1701 clipboard->incr_starts)
1703 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1706 xf_cliprdr_get_requested_data(clipboard, format->atom);
1712void xf_cliprdr_handle_xevent(xfContext* xfc,
const XEvent* event)
1714 xfClipboard* clipboard = NULL;
1719 clipboard = xfc->clipboard;
1726 if (clipboard->xfixes_supported &&
1727 event->type == XFixesSelectionNotify + clipboard->xfixes_event_base)
1729 const XFixesSelectionNotifyEvent* se = (
const XFixesSelectionNotifyEvent*)event;
1731 if (se->subtype == XFixesSetSelectionOwnerNotify)
1733 if (se->selection != clipboard->clipboard_atom)
1736 if (LogDynAndXGetSelectionOwner(xfc->log, xfc->display, se->selection) == xfc->drawable)
1739 clipboard->owner = None;
1740 xf_cliprdr_check_owner(clipboard);
1748 switch (event->type)
1750 case SelectionNotify:
1751 log_selection_event(xfc, event);
1752 xf_cliprdr_process_selection_notify(clipboard, &event->xselection);
1755 case SelectionRequest:
1756 log_selection_event(xfc, event);
1757 xf_cliprdr_process_selection_request(clipboard, &event->xselectionrequest);
1760 case SelectionClear:
1761 log_selection_event(xfc, event);
1762 xf_cliprdr_process_selection_clear(clipboard, &event->xselectionclear);
1765 case PropertyNotify:
1766 log_selection_event(xfc, event);
1767 xf_cliprdr_process_property_notify(clipboard, &event->xproperty);
1771 if (!clipboard->xfixes_supported)
1773 xf_cliprdr_check_owner(clipboard);
1787static UINT xf_cliprdr_send_client_capabilities(xfClipboard* clipboard)
1792 WINPR_ASSERT(clipboard);
1794 capabilities.cCapabilitiesSets = 1;
1796 generalCapabilitySet.capabilitySetType = CB_CAPSTYPE_GENERAL;
1797 generalCapabilitySet.capabilitySetLength = 12;
1798 generalCapabilitySet.version = CB_CAPS_VERSION_2;
1799 generalCapabilitySet.generalFlags = CB_USE_LONG_FORMAT_NAMES;
1801 WINPR_ASSERT(clipboard);
1802 generalCapabilitySet.generalFlags |= cliprdr_file_context_current_flags(clipboard->file);
1804 WINPR_ASSERT(clipboard->context);
1805 WINPR_ASSERT(clipboard->context->ClientCapabilities);
1806 return clipboard->context->ClientCapabilities(clipboard->context, &capabilities);
1814static UINT xf_cliprdr_send_client_format_list(xfClipboard* clipboard, BOOL force)
1816 WINPR_ASSERT(clipboard);
1818 xfContext* xfc = clipboard->xfc;
1821 UINT32 numFormats = 0;
1822 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
1824 const UINT ret = xf_cliprdr_send_format_list(clipboard, formats, numFormats, force);
1826 if (clipboard->owner && clipboard->owner != xfc->drawable)
1829 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom,
1830 clipboard->targets[1], clipboard->property_atom, xfc->drawable,
1834 xf_cliprdr_free_formats(formats, numFormats);
1844static UINT xf_cliprdr_send_client_format_list_response(xfClipboard* clipboard, BOOL status)
1848 formatListResponse.common.msgType = CB_FORMAT_LIST_RESPONSE;
1849 formatListResponse.common.msgFlags = status ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
1850 formatListResponse.common.dataLen = 0;
1852 WINPR_ASSERT(clipboard);
1853 WINPR_ASSERT(clipboard->context);
1854 WINPR_ASSERT(clipboard->context->ClientFormatListResponse);
1855 return clipboard->context->ClientFormatListResponse(clipboard->context, &formatListResponse);
1863static UINT xf_cliprdr_monitor_ready(CliprdrClientContext* context,
1867 xfClipboard* clipboard = NULL;
1869 WINPR_ASSERT(context);
1870 WINPR_ASSERT(monitorReady);
1872 clipboard = cliprdr_file_context_get_context(context->custom);
1873 WINPR_ASSERT(clipboard);
1875 WINPR_UNUSED(monitorReady);
1877 if ((ret = xf_cliprdr_send_client_capabilities(clipboard)) != CHANNEL_RC_OK)
1880 xf_clipboard_formats_free(clipboard);
1882 if ((ret = xf_cliprdr_send_client_format_list(clipboard, TRUE)) != CHANNEL_RC_OK)
1885 clipboard->sync = TRUE;
1886 return CHANNEL_RC_OK;
1894static UINT xf_cliprdr_server_capabilities(CliprdrClientContext* context,
1898 const BYTE* capsPtr = NULL;
1899 xfClipboard* clipboard = NULL;
1901 WINPR_ASSERT(context);
1902 WINPR_ASSERT(capabilities);
1904 clipboard = cliprdr_file_context_get_context(context->custom);
1905 WINPR_ASSERT(clipboard);
1907 capsPtr = (
const BYTE*)capabilities->capabilitySets;
1908 WINPR_ASSERT(capsPtr);
1910 cliprdr_file_context_remote_set_flags(clipboard->file, 0);
1912 for (UINT32 i = 0; i < capabilities->cCapabilitiesSets; i++)
1916 if (caps->capabilitySetType == CB_CAPSTYPE_GENERAL)
1920 cliprdr_file_context_remote_set_flags(clipboard->file, generalCaps->generalFlags);
1923 capsPtr += caps->capabilitySetLength;
1926 return CHANNEL_RC_OK;
1929static void xf_cliprdr_prepare_to_set_selection_owner(xfContext* xfc, xfClipboard* clipboard)
1932 WINPR_ASSERT(clipboard);
1949 Atom value = clipboard->timestamp_property_atom;
1951 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable,
1952 clipboard->timestamp_property_atom, XA_ATOM, 32, PropModeReplace,
1953 (
const BYTE*)&value, 1);
1954 LogDynAndXFlush(xfc->log, xfc->display);
1957static void xf_cliprdr_set_selection_owner(xfContext* xfc, xfClipboard* clipboard, Time timestamp)
1960 WINPR_ASSERT(clipboard);
1966 clipboard->selection_ownership_timestamp = timestamp;
1967 LogDynAndXSetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom, xfc->drawable,
1969 LogDynAndXFlush(xfc->log, xfc->display);
1977static UINT xf_cliprdr_server_format_list(CliprdrClientContext* context,
1980 xfContext* xfc = NULL;
1982 xfClipboard* clipboard = NULL;
1984 WINPR_ASSERT(context);
1985 WINPR_ASSERT(formatList);
1987 clipboard = cliprdr_file_context_get_context(context->custom);
1988 WINPR_ASSERT(clipboard);
1990 xfc = clipboard->xfc;
1996 free(clipboard->respond);
1997 clipboard->respond = NULL;
1999 xf_clipboard_formats_free(clipboard);
2000 xf_cliprdr_clear_cached_data(clipboard);
2001 requested_format_free(&clipboard->requestedFormat);
2003 xf_clipboard_free_server_formats(clipboard);
2005 clipboard->numServerFormats = formatList->numFormats + 1;
2007 if (!(clipboard->serverFormats =
2010 WLog_ERR(TAG,
"failed to allocate %d CLIPRDR_FORMAT structs", clipboard->numServerFormats);
2011 ret = CHANNEL_RC_NO_MEMORY;
2015 for (
size_t i = 0; i < formatList->numFormats; i++)
2020 srvFormat->formatId = format->formatId;
2022 if (format->formatName)
2024 srvFormat->formatName = _strdup(format->formatName);
2026 if (!srvFormat->formatName)
2028 for (UINT32 k = 0; k < i; k++)
2029 free(clipboard->serverFormats[k].formatName);
2031 clipboard->numServerFormats = 0;
2032 free(clipboard->serverFormats);
2033 clipboard->serverFormats = NULL;
2034 ret = CHANNEL_RC_NO_MEMORY;
2040 ClipboardLock(clipboard->system);
2041 ret = cliprdr_file_context_notify_new_server_format_list(clipboard->file);
2042 ClipboardUnlock(clipboard->system);
2048 CLIPRDR_FORMAT* format = &clipboard->serverFormats[formatList->numFormats];
2049 format->formatId = CF_RAW;
2050 format->formatName = NULL;
2052 xf_cliprdr_provide_server_format_list(clipboard);
2053 clipboard->numTargets = 2;
2055 for (
size_t i = 0; i < formatList->numFormats; i++)
2059 for (
size_t j = 0; j < clipboard->numClientFormats; j++)
2061 const xfCliprdrFormat* clientFormat = &clipboard->clientFormats[j];
2062 if (xf_cliprdr_formats_equal(format, clientFormat))
2064 if ((clientFormat->formatName != NULL) &&
2065 (strcmp(type_FileGroupDescriptorW, clientFormat->formatName) == 0))
2067 if (!cliprdr_file_context_has_local_support(clipboard->file))
2070 xf_cliprdr_append_target(clipboard, clientFormat->atom);
2075 ret = xf_cliprdr_send_client_format_list_response(clipboard, TRUE);
2076 if (xfc->remote_app)
2077 xf_cliprdr_set_selection_owner(xfc, clipboard, CurrentTime);
2079 xf_cliprdr_prepare_to_set_selection_owner(xfc, clipboard);
2092static UINT xf_cliprdr_server_format_list_response(
2093 WINPR_ATTR_UNUSED CliprdrClientContext* context,
2096 WINPR_ASSERT(context);
2097 WINPR_ASSERT(formatListResponse);
2099 return CHANNEL_RC_OK;
2108xf_cliprdr_server_format_data_request(CliprdrClientContext* context,
2111 const xfCliprdrFormat* format = NULL;
2113 WINPR_ASSERT(context);
2114 WINPR_ASSERT(formatDataRequest);
2116 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2117 WINPR_ASSERT(clipboard);
2119 xfContext* xfc = clipboard->xfc;
2122 const uint32_t formatId = formatDataRequest->requestedFormatId;
2124 const BOOL rawTransfer = xf_cliprdr_is_raw_transfer_available(clipboard);
2128 format = xf_cliprdr_get_client_format_by_id(clipboard, CF_RAW);
2129 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom,
2130 XA_INTEGER, 32, PropModeReplace, (
const BYTE*)&formatId, 1);
2133 format = xf_cliprdr_get_client_format_by_id(clipboard, formatId);
2135 clipboard->requestedFormatId = rawTransfer ? CF_RAW : formatId;
2137 return xf_cliprdr_send_data_response(clipboard, format, NULL, 0);
2139 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2140 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2141 format->localFormat,
2142 ClipboardGetFormatName(clipboard->system, format->localFormat),
2143 format->formatName);
2144 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom, format->atom,
2145 clipboard->property_atom, xfc->drawable, CurrentTime);
2146 LogDynAndXFlush(xfc->log, xfc->display);
2148 return CHANNEL_RC_OK;
2157xf_cliprdr_server_format_data_response(CliprdrClientContext* context,
2161 BYTE* pDstData = NULL;
2164 UINT32 srcFormatId = 0;
2165 UINT32 dstFormatId = 0;
2166 BOOL nullTerminated = FALSE;
2167 xfCachedData* cached_data = NULL;
2169 WINPR_ASSERT(context);
2170 WINPR_ASSERT(formatDataResponse);
2172 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2173 WINPR_ASSERT(clipboard);
2175 xfContext* xfc = clipboard->xfc;
2178 const UINT32 size = formatDataResponse->common.dataLen;
2179 const BYTE* data = formatDataResponse->requestedFormatData;
2181 if (formatDataResponse->common.msgFlags == CB_RESPONSE_FAIL)
2183 WLog_WARN(TAG,
"Format Data Response PDU msgFlags is CB_RESPONSE_FAIL");
2184 free(clipboard->respond);
2185 clipboard->respond = NULL;
2186 return CHANNEL_RC_OK;
2189 if (!clipboard->respond)
2190 return CHANNEL_RC_OK;
2192 const RequestedFormat* format = clipboard->requestedFormat;
2193 if (clipboard->data_raw_format)
2195 srcFormatId = CF_RAW;
2196 dstFormatId = CF_RAW;
2199 return ERROR_INTERNAL_ERROR;
2200 else if (format->formatName)
2202 dstFormatId = format->localFormat;
2204 ClipboardLock(clipboard->system);
2205 if (strcmp(format->formatName, type_HtmlFormat) == 0)
2207 srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
2208 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
2209 nullTerminated = TRUE;
2212 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
2214 if (!cliprdr_file_context_update_server_data(clipboard->file, clipboard->system, data,
2216 WLog_WARN(TAG,
"failed to update file descriptors");
2218 srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2219 const xfCliprdrFormat* dstTargetFormat =
2220 xf_cliprdr_get_client_format_by_atom(clipboard, clipboard->respond->target);
2221 if (!dstTargetFormat)
2223 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2227 dstFormatId = dstTargetFormat->localFormat;
2230 nullTerminated = TRUE;
2232 ClipboardUnlock(clipboard->system);
2236 srcFormatId = format->formatToRequest;
2237 dstFormatId = format->localFormat;
2238 switch (format->formatToRequest)
2241 nullTerminated = TRUE;
2245 nullTerminated = TRUE;
2248 case CF_UNICODETEXT:
2249 nullTerminated = TRUE;
2253 srcFormatId = CF_DIB;
2257 srcFormatId = CF_TIFF;
2265 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2266 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2267 format->localFormat,
2268 ClipboardGetFormatName(clipboard->system, format->localFormat),
2269 format->formatName);
2272 DEBUG_CLIPRDR(
"srcFormatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", srcFormatId,
2275 ClipboardLock(clipboard->system);
2276 bSuccess = ClipboardSetData(clipboard->system, srcFormatId, data, SrcSize);
2278 BOOL willQuit = FALSE;
2283 WLog_DBG(TAG,
"skipping, empty data detected!");
2284 free(clipboard->respond);
2285 clipboard->respond = NULL;
2290 pDstData = (BYTE*)ClipboardGetData(clipboard->system, dstFormatId, &DstSize);
2294 WLog_WARN(TAG,
"failed to get clipboard data in format %s [source format %s]",
2295 ClipboardGetFormatName(clipboard->system, dstFormatId),
2296 ClipboardGetFormatName(clipboard->system, srcFormatId));
2299 if (nullTerminated && pDstData)
2301 BYTE* nullTerminator = memchr(pDstData,
'\0', DstSize);
2304 const intptr_t diff = nullTerminator - pDstData;
2305 WINPR_ASSERT(diff >= 0);
2306 WINPR_ASSERT(diff <= UINT32_MAX);
2307 DstSize = (UINT32)diff;
2312 ClipboardUnlock(clipboard->system);
2314 return CHANNEL_RC_OK;
2320 cached_data = xf_cached_data_new(pDstData, DstSize);
2323 WLog_WARN(TAG,
"Failed to allocate cache entry");
2325 return CHANNEL_RC_OK;
2327 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId),
2330 WLog_WARN(TAG,
"Failed to cache clipboard data");
2331 xf_cached_data_free(cached_data);
2332 return CHANNEL_RC_OK;
2342 xfCachedData* cached_raw_data = xf_cached_data_new_copy(data, size);
2343 if (!cached_raw_data)
2344 WLog_WARN(TAG,
"Failed to allocate cache entry");
2347 if (!HashTable_Insert(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId,
2350 WLog_WARN(TAG,
"Failed to cache clipboard data");
2351 xf_cached_data_free(cached_raw_data);
2358 xf_cliprdr_provide_data(clipboard, clipboard->respond, pDstData, DstSize);
2363 XSelectionEvent* sev;
2366 conv.sev = clipboard->respond;
2368 LogDynAndXSendEvent(xfc->log, xfc->display, clipboard->respond->requestor, 0, 0, conv.ev);
2369 LogDynAndXFlush(xfc->log, xfc->display);
2371 free(clipboard->respond);
2372 clipboard->respond = NULL;
2373 return CHANNEL_RC_OK;
2376static BOOL xf_cliprdr_is_valid_unix_filename(LPCWSTR filename)
2381 if (filename[0] == L
'\0')
2385 for (
const WCHAR* c = filename; *c; ++c)
2394xfClipboard* xf_clipboard_new(xfContext* xfc, BOOL relieveFilenameRestriction)
2397 rdpChannels* channels = NULL;
2398 xfClipboard* clipboard = NULL;
2399 const char* selectionAtom = NULL;
2400 xfCliprdrFormat* clientFormat = NULL;
2404 WINPR_ASSERT(xfc->common.context.settings);
2406 if (!(clipboard = (xfClipboard*)calloc(1,
sizeof(xfClipboard))))
2408 WLog_ERR(TAG,
"failed to allocate xfClipboard data");
2412 clipboard->file = cliprdr_file_context_new(clipboard);
2413 if (!clipboard->file)
2416 xfc->clipboard = clipboard;
2417 clipboard->xfc = xfc;
2418 channels = xfc->common.context.channels;
2419 clipboard->channels = channels;
2420 clipboard->system = ClipboardCreate();
2421 clipboard->requestedFormatId = UINT32_MAX;
2422 clipboard->root_window = DefaultRootWindow(xfc->display);
2427 selectionAtom =
"CLIPBOARD";
2429 clipboard->clipboard_atom = Logging_XInternAtom(xfc->log, xfc->display, selectionAtom, FALSE);
2431 if (clipboard->clipboard_atom == None)
2433 WLog_ERR(TAG,
"unable to get %s atom", selectionAtom);
2437 clipboard->timestamp_property_atom =
2438 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_TIMESTAMP_PROPERTY", FALSE);
2439 clipboard->property_atom =
2440 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR", FALSE);
2441 clipboard->raw_transfer_atom =
2442 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_RAW", FALSE);
2443 clipboard->raw_format_list_atom =
2444 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_FORMATS", FALSE);
2445 xf_cliprdr_set_raw_transfer_enabled(clipboard, TRUE);
2446 XSelectInput(xfc->display, clipboard->root_window, PropertyChangeMask);
2449 if (XFixesQueryExtension(xfc->display, &clipboard->xfixes_event_base,
2450 &clipboard->xfixes_error_base))
2455 if (XFixesQueryVersion(xfc->display, &xfmajor, &xfminor))
2457 XFixesSelectSelectionInput(xfc->display, clipboard->root_window,
2458 clipboard->clipboard_atom,
2459 XFixesSetSelectionOwnerNotifyMask);
2460 clipboard->xfixes_supported = TRUE;
2464 WLog_ERR(TAG,
"Error querying X Fixes extension version");
2469 WLog_ERR(TAG,
"Error loading X Fixes extension");
2475 "Warning: Using clipboard redirection without XFIXES extension is strongly discouraged!");
2477 clientFormat = &clipboard->clientFormats[n++];
2478 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_RAW", False);
2479 clientFormat->localFormat = clientFormat->formatToRequest = CF_RAW;
2481 clientFormat = &clipboard->clientFormats[n++];
2482 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"UTF8_STRING", False);
2483 clientFormat->formatToRequest = CF_UNICODETEXT;
2484 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2486 clientFormat = &clipboard->clientFormats[n++];
2487 clientFormat->atom = XA_STRING;
2488 clientFormat->formatToRequest = CF_TEXT;
2489 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2491 clientFormat = &clipboard->clientFormats[n++];
2492 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_tiff, False);
2493 clientFormat->formatToRequest = clientFormat->localFormat = CF_TIFF;
2495 for (
size_t x = 0; x < ARRAYSIZE(mime_bitmap); x++)
2497 const char* mime_bmp = mime_bitmap[x];
2498 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2501 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2505 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2506 clientFormat = &clipboard->clientFormats[n++];
2507 clientFormat->localFormat = format;
2508 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2509 clientFormat->formatToRequest = CF_DIB;
2510 clientFormat->isImage = TRUE;
2513 for (
size_t x = 0; x < ARRAYSIZE(mime_images); x++)
2515 const char* mime_bmp = mime_images[x];
2516 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2519 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2523 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2524 clientFormat = &clipboard->clientFormats[n++];
2525 clientFormat->localFormat = format;
2526 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2527 clientFormat->formatToRequest = CF_DIB;
2528 clientFormat->isImage = TRUE;
2531 clientFormat = &clipboard->clientFormats[n++];
2532 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_html, False);
2533 clientFormat->formatToRequest = ClipboardGetFormatId(xfc->clipboard->system, type_HtmlFormat);
2534 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_html);
2535 clientFormat->formatName = _strdup(type_HtmlFormat);
2537 if (!clientFormat->formatName)
2540 clientFormat = &clipboard->clientFormats[n++];
2548 const UINT32 fgid = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2549 const UINT32 uid = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2552 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2553 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_uri_list, False);
2554 clientFormat->localFormat = uid;
2555 clientFormat->formatToRequest = fgid;
2556 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2558 if (!clientFormat->formatName)
2561 clientFormat = &clipboard->clientFormats[n++];
2564 const UINT32 gid = ClipboardGetFormatId(clipboard->system, mime_gnome_copied_files);
2567 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2568 clientFormat->atom =
2569 Logging_XInternAtom(xfc->log, xfc->display, mime_gnome_copied_files, False);
2570 clientFormat->localFormat = gid;
2571 clientFormat->formatToRequest = fgid;
2572 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2574 if (!clientFormat->formatName)
2577 clientFormat = &clipboard->clientFormats[n++];
2580 const UINT32 mid = ClipboardGetFormatId(clipboard->system, mime_mate_copied_files);
2583 cliprdr_file_context_set_locally_available(clipboard->file, TRUE);
2584 clientFormat->atom =
2585 Logging_XInternAtom(xfc->log, xfc->display, mime_mate_copied_files, False);
2586 clientFormat->localFormat = mid;
2587 clientFormat->formatToRequest = fgid;
2588 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2590 if (!clientFormat->formatName)
2594 clipboard->numClientFormats = WINPR_ASSERTING_INT_CAST(uint32_t, n);
2595 clipboard->targets[0] = Logging_XInternAtom(xfc->log, xfc->display,
"TIMESTAMP", FALSE);
2596 clipboard->targets[1] = Logging_XInternAtom(xfc->log, xfc->display,
"TARGETS", FALSE);
2597 clipboard->numTargets = 2;
2598 clipboard->incr_atom = Logging_XInternAtom(xfc->log, xfc->display,
"INCR", FALSE);
2600 if (relieveFilenameRestriction)
2602 WLog_DBG(TAG,
"Relieving CLIPRDR filename restriction");
2603 ClipboardGetDelegate(clipboard->system)->IsFileNameComponentValid =
2604 xf_cliprdr_is_valid_unix_filename;
2607 clipboard->cachedData = HashTable_New(TRUE);
2608 if (!clipboard->cachedData)
2611 obj = HashTable_ValueObject(clipboard->cachedData);
2612 obj->fnObjectFree = xf_cached_data_free;
2614 clipboard->cachedRawData = HashTable_New(TRUE);
2615 if (!clipboard->cachedRawData)
2618 obj = HashTable_ValueObject(clipboard->cachedRawData);
2619 obj->fnObjectFree = xf_cached_data_free;
2624 WINPR_PRAGMA_DIAG_PUSH
2625 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2626 xf_clipboard_free(clipboard);
2627 WINPR_PRAGMA_DIAG_POP
2631void xf_clipboard_free(xfClipboard* clipboard)
2636 xf_clipboard_free_server_formats(clipboard);
2638 if (clipboard->numClientFormats)
2640 for (UINT32 i = 0; i < clipboard->numClientFormats; i++)
2642 xfCliprdrFormat* format = &clipboard->clientFormats[i];
2643 free(format->formatName);
2647 cliprdr_file_context_free(clipboard->file);
2649 ClipboardDestroy(clipboard->system);
2650 xf_clipboard_formats_free(clipboard);
2651 HashTable_Free(clipboard->cachedRawData);
2652 HashTable_Free(clipboard->cachedData);
2653 requested_format_free(&clipboard->requestedFormat);
2654 free(clipboard->respond);
2655 free(clipboard->incr_data);
2659void xf_cliprdr_init(xfContext* xfc, CliprdrClientContext* cliprdr)
2662 WINPR_ASSERT(cliprdr);
2664 xfc->cliprdr = cliprdr;
2665 xfc->clipboard->context = cliprdr;
2667 cliprdr->MonitorReady = xf_cliprdr_monitor_ready;
2668 cliprdr->ServerCapabilities = xf_cliprdr_server_capabilities;
2669 cliprdr->ServerFormatList = xf_cliprdr_server_format_list;
2670 cliprdr->ServerFormatListResponse = xf_cliprdr_server_format_list_response;
2671 cliprdr->ServerFormatDataRequest = xf_cliprdr_server_format_data_request;
2672 cliprdr->ServerFormatDataResponse = xf_cliprdr_server_format_data_response;
2674 cliprdr_file_context_init(xfc->clipboard->file, cliprdr);
2677void xf_cliprdr_uninit(xfContext* xfc, CliprdrClientContext* cliprdr)
2680 WINPR_ASSERT(cliprdr);
2682 xfc->cliprdr = NULL;
2686 ClipboardLock(xfc->clipboard->system);
2687 cliprdr_file_context_uninit(xfc->clipboard->file, cliprdr);
2688 ClipboardUnlock(xfc->clipboard->system);
2689 xfc->clipboard->context = NULL;
FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
This struct contains function pointer to initialize/free objects.