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 =
nullptr;
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)
227 BYTE* copy =
nullptr;
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 =
nullptr;
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 =
nullptr;
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 =
nullptr;
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;
314 UINT32* data =
nullptr;
315 UINT32 is_enabled = 0;
317 xfContext* xfc =
nullptr;
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 != 0;
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(
nullptr, 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 =
nullptr;
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;
625 BYTE* data =
nullptr;
627 xfContext* xfc =
nullptr;
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,
682 BYTE* data =
nullptr;
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 nullptr", 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 =
nullptr;
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 =
nullptr;
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);
875 xf_lock_x11(clipboard->xfc);
876 xf_cliprdr_free_formats(clipboard->lastSentFormats, clipboard->lastSentNumFormats);
877 clipboard->lastSentFormats =
nullptr;
878 clipboard->lastSentNumFormats = 0;
879 xf_unlock_x11(clipboard->xfc);
882static BOOL xf_clipboard_copy_formats(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
885 WINPR_ASSERT(clipboard);
886 WINPR_ASSERT(formats || (numFormats == 0));
888 xf_clipboard_formats_free(clipboard);
890 clipboard->lastSentFormats = calloc(numFormats,
sizeof(
CLIPRDR_FORMAT));
891 if (!clipboard->lastSentFormats)
893 clipboard->lastSentNumFormats = numFormats;
894 for (UINT32 x = 0; x < numFormats; x++)
900 lcur->formatName = _strdup(cur->formatName);
905static UINT xf_cliprdr_send_format_list(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
906 UINT32 numFormats, BOOL force)
912 } cnv = { .cpv = formats };
914 .numFormats = numFormats,
916 .common.msgType = CB_FORMAT_LIST };
919 WINPR_ASSERT(clipboard);
920 WINPR_ASSERT(formats || (numFormats == 0));
922 if (!force && !xf_clipboard_changed(clipboard, formats, numFormats))
923 return CHANNEL_RC_OK;
925#if defined(WITH_DEBUG_CLIPRDR)
926 for (UINT32 x = 0; x < numFormats; x++)
929 DEBUG_CLIPRDR(
"announcing format 0x%08" PRIx32
" [%s] [%s]", format->formatId,
930 ClipboardGetFormatIdString(format->formatId), format->formatName);
934 xf_clipboard_copy_formats(clipboard, formats, numFormats);
936 xf_cliprdr_send_data_response(clipboard,
nullptr,
nullptr, 0);
938 xf_cliprdr_clear_cached_data(clipboard);
940 ret = cliprdr_file_context_notify_new_client_format_list(clipboard->file);
944 WINPR_ASSERT(clipboard->context);
945 WINPR_ASSERT(clipboard->context->ClientFormatList);
946 return clipboard->context->ClientFormatList(clipboard->context, &formatList);
949static void xf_cliprdr_get_requested_targets(xfClipboard* clipboard)
951 UINT32 numFormats = 0;
952 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
953 xf_cliprdr_send_format_list(clipboard, formats, numFormats, FALSE);
954 xf_cliprdr_free_formats(formats, numFormats);
957static void xf_cliprdr_process_requested_data(xfClipboard* clipboard, BOOL hasData,
958 const BYTE* data,
size_t size)
963 INT64 srcFormatId = -1;
964 BYTE* pDstData =
nullptr;
965 const xfCliprdrFormat* format =
nullptr;
967 WINPR_ASSERT(clipboard);
969 if (clipboard->incr_starts && hasData)
974 clipboard->incr_data_length = 0;
976 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
978 if (!hasData || !data || !format)
980 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
984 switch (format->formatToRequest)
987 srcFormatId = CF_RAW;
993 srcFormatId = format->localFormat;
997 srcFormatId = format->localFormat;
1001 if (srcFormatId < 0)
1003 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
1007 ClipboardLock(clipboard->system);
1008 SrcSize = (UINT32)size;
1009 bSuccess = ClipboardSetData(clipboard->system, (UINT32)srcFormatId, data, SrcSize);
1015 (BYTE*)ClipboardGetData(clipboard->system, clipboard->requestedFormatId, &DstSize);
1017 ClipboardUnlock(clipboard->system);
1021 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
1032 ClipboardLock(clipboard->system);
1033 if (format->formatToRequest &&
1034 (format->formatToRequest ==
1035 ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW)))
1037 UINT error = NO_ERROR;
1043 const UINT32 flags = cliprdr_file_context_remote_get_flags(clipboard->file);
1044 error = cliprdr_serialize_file_list_ex(flags, file_array, file_count, &pDstData, &DstSize);
1047 WLog_ERR(TAG,
"failed to serialize CLIPRDR_FILELIST: 0x%08X", error);
1050 UINT32 formatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
1051 UINT32 url_size = 0;
1053 char* url = ClipboardGetData(clipboard->system, formatId, &url_size);
1054 cliprdr_file_context_update_client_data(clipboard->file, url, url_size);
1060 ClipboardUnlock(clipboard->system);
1062 xf_cliprdr_send_data_response(clipboard, format, pDstData, DstSize);
1066static BOOL xf_restore_input_flags(xfClipboard* clipboard)
1068 WINPR_ASSERT(clipboard);
1070 xfContext* xfc = clipboard->xfc;
1073 if (clipboard->event_mask != 0)
1075 XSelectInput(xfc->display, xfc->drawable, clipboard->event_mask);
1076 clipboard->event_mask = 0;
1081static BOOL append(xfClipboard* clipboard,
const void* sdata,
size_t length)
1083 WINPR_ASSERT(clipboard);
1085 const size_t size = length + clipboard->incr_data_length + 2;
1086 BYTE* data = realloc(clipboard->incr_data, size);
1089 clipboard->incr_data = data;
1090 memcpy(&data[clipboard->incr_data_length], sdata, length);
1091 clipboard->incr_data_length += length;
1092 clipboard->incr_data[clipboard->incr_data_length + 0] =
'\0';
1093 clipboard->incr_data[clipboard->incr_data_length + 1] =
'\0';
1097static BOOL xf_cliprdr_stop_incr(xfClipboard* clipboard)
1099 clipboard->incr_starts = FALSE;
1100 clipboard->incr_data_length = 0;
1101 return xf_restore_input_flags(clipboard);
1104static BOOL xf_cliprdr_get_requested_data(xfClipboard* clipboard, Atom target)
1106 WINPR_ASSERT(clipboard);
1108 xfContext* xfc = clipboard->xfc;
1111 const xfCliprdrFormat* format =
1112 xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1114 if (!format || (format->atom != target))
1116 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
1121 BOOL has_data = FALSE;
1122 int format_property = 0;
1123 unsigned long length = 0;
1124 unsigned long total_bytes = 0;
1125 BYTE* property_data =
nullptr;
1126 const int rc = LogDynAndXGetWindowProperty(
1127 xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0, 0, False, target, &type,
1128 &format_property, &length, &total_bytes, &property_data);
1130 XFree(property_data);
1133 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
1140 if ((total_bytes <= 0) && !clipboard->incr_starts)
1142 xf_cliprdr_stop_incr(clipboard);
1145 else if (type == clipboard->incr_atom)
1147 xf_cliprdr_stop_incr(clipboard);
1148 clipboard->incr_starts = TRUE;
1153 BYTE* incremental_data =
nullptr;
1154 unsigned long incremental_len = 0;
1157 len = clipboard->incr_data_length;
1158 if (total_bytes <= 0)
1160 xf_cliprdr_stop_incr(clipboard);
1164 else if (LogDynAndXGetWindowProperty(
1165 xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0,
1166 WINPR_ASSERTING_INT_CAST(int32_t, total_bytes), False, target, &type,
1167 &format_property, &incremental_len, &length, &incremental_data) == Success)
1169 has_data = append(clipboard, incremental_data, incremental_len);
1170 len = clipboard->incr_data_length;
1173 if (incremental_data)
1174 XFree(incremental_data);
1177 LogDynAndXDeleteProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom);
1178 xf_cliprdr_process_requested_data(clipboard, has_data, clipboard->incr_data, len);
1183static void xf_cliprdr_append_target(xfClipboard* clipboard, Atom target)
1185 WINPR_ASSERT(clipboard);
1187 if (clipboard->numTargets >= ARRAYSIZE(clipboard->targets))
1190 for (
size_t i = 0; i < clipboard->numTargets; i++)
1192 if (clipboard->targets[i] == target)
1196 clipboard->targets[clipboard->numTargets++] = target;
1199static void xf_cliprdr_provide_targets(xfClipboard* clipboard,
const XSelectionEvent* respond)
1201 xfContext* xfc =
nullptr;
1203 WINPR_ASSERT(clipboard);
1205 xfc = clipboard->xfc;
1208 if (respond->property != None)
1210 WINPR_ASSERT(clipboard->numTargets <= INT32_MAX);
1211 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1212 XA_ATOM, 32, PropModeReplace, (
const BYTE*)clipboard->targets,
1213 (
int)clipboard->numTargets);
1217static void xf_cliprdr_provide_timestamp(xfClipboard* clipboard,
const XSelectionEvent* respond)
1219 xfContext* xfc =
nullptr;
1221 WINPR_ASSERT(clipboard);
1223 xfc = clipboard->xfc;
1226 if (respond->property != None)
1228 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1229 XA_INTEGER, 32, PropModeReplace,
1230 (
const BYTE*)&clipboard->selection_ownership_timestamp, 1);
1234#define xf_cliprdr_provide_data(clipboard, respond, data, size) \
1235 xf_cliprdr_provide_data_((clipboard), (respond), (data), (size), __FILE__, __func__, __LINE__)
1236static void xf_cliprdr_provide_data_(xfClipboard* clipboard,
const XSelectionEvent* respond,
1237 const BYTE* data, UINT32 size,
const char* file,
1238 const char* fkt,
size_t line)
1240 WINPR_ASSERT(clipboard);
1242 xfContext* xfc = clipboard->xfc;
1245 if (respond->property != None)
1247 LogDynAndXChangeProperty_ex(xfc->log, file, fkt, line, xfc->display, respond->requestor,
1248 respond->property, respond->target, 8, PropModeReplace, data,
1249 WINPR_ASSERTING_INT_CAST(int32_t, size));
1253static void log_selection_event(xfContext* xfc,
const XEvent* event)
1255 const DWORD level = WLOG_TRACE;
1256 static wLog* _log_cached_ptr =
nullptr;
1257 if (!_log_cached_ptr)
1258 _log_cached_ptr = WLog_Get(TAG);
1259 if (WLog_IsLevelActive(_log_cached_ptr, level))
1262 switch (event->type)
1264 case SelectionClear:
1266 const XSelectionClearEvent* xevent = &
event->xselectionclear;
1268 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1269 WLog_Print(_log_cached_ptr, level,
"got event %s [selection %s]",
1270 x11_event_string(event->type), selection);
1274 case SelectionNotify:
1276 const XSelectionEvent* xevent = &
event->xselection;
1278 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1279 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1280 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1281 WLog_Print(_log_cached_ptr, level,
1282 "got event %s [selection %s, target %s, property %s]",
1283 x11_event_string(event->type), selection, target, property);
1289 case SelectionRequest:
1291 const XSelectionRequestEvent* xevent = &
event->xselectionrequest;
1293 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1294 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1295 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1296 WLog_Print(_log_cached_ptr, level,
1297 "got event %s [selection %s, target %s, property %s]",
1298 x11_event_string(event->type), selection, target, property);
1304 case PropertyNotify:
1306 const XPropertyEvent* xevent = &
event->xproperty;
1307 char* atom = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->atom);
1308 WLog_Print(_log_cached_ptr, level,
"got event %s [atom %s]",
1309 x11_event_string(event->type), atom);
1319static BOOL xf_cliprdr_process_selection_notify(xfClipboard* clipboard,
1320 const XSelectionEvent* xevent)
1322 WINPR_ASSERT(clipboard);
1323 WINPR_ASSERT(xevent);
1325 if (xevent->target == clipboard->targets[1])
1327 if (xevent->property == None)
1329 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1333 xf_cliprdr_get_requested_targets(clipboard);
1340 return xf_cliprdr_get_requested_data(clipboard, xevent->target);
1344void xf_cliprdr_clear_cached_data(xfClipboard* clipboard)
1346 WINPR_ASSERT(clipboard);
1348 ClipboardLock(clipboard->system);
1349 ClipboardEmpty(clipboard->system);
1351 HashTable_Clear(clipboard->cachedData);
1352 HashTable_Clear(clipboard->cachedRawData);
1354 cliprdr_file_context_clear(clipboard->file);
1356 xf_cliprdr_stop_incr(clipboard);
1357 ClipboardUnlock(clipboard->system);
1360static void* format_to_cache_slot(UINT32 format)
1367 cnv.uptr = 0x100000000ULL + format;
1371static UINT32 get_dst_format_id_for_local_request(xfClipboard* clipboard,
1372 const xfCliprdrFormat* format)
1374 UINT32 dstFormatId = 0;
1376 WINPR_ASSERT(format);
1378 if (!format->formatName)
1379 return format->localFormat;
1381 ClipboardLock(clipboard->system);
1382 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1383 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
1384 ClipboardUnlock(clipboard->system);
1386 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1387 dstFormatId = format->localFormat;
1392static void get_src_format_info_for_local_request(xfClipboard* clipboard,
1393 const xfCliprdrFormat* format,
1394 UINT32* srcFormatId, BOOL* nullTerminated)
1397 *nullTerminated = FALSE;
1399 if (format->formatName)
1401 ClipboardLock(clipboard->system);
1402 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1404 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
1405 *nullTerminated = TRUE;
1407 else if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1409 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
1410 *nullTerminated = TRUE;
1412 ClipboardUnlock(clipboard->system);
1416 *srcFormatId = format->formatToRequest;
1417 switch (format->formatToRequest)
1421 case CF_UNICODETEXT:
1422 *nullTerminated = TRUE;
1425 *srcFormatId = CF_DIB;
1428 *srcFormatId = CF_TIFF;
1436static xfCachedData* convert_data_from_existing_raw_data(xfClipboard* clipboard,
1437 xfCachedData* cached_raw_data,
1438 UINT32 srcFormatId, BOOL nullTerminated,
1441 UINT32 dst_size = 0;
1443 WINPR_ASSERT(clipboard);
1444 WINPR_ASSERT(cached_raw_data);
1445 WINPR_ASSERT(cached_raw_data->data);
1447 ClipboardLock(clipboard->system);
1448 BOOL success = ClipboardSetData(clipboard->system, srcFormatId, cached_raw_data->data,
1449 cached_raw_data->data_length);
1452 WLog_WARN(TAG,
"Failed to set clipboard data (formatId: %u, data: %p, data_length: %u)",
1453 srcFormatId, WINPR_CXX_COMPAT_CAST(
const void*, cached_raw_data->data),
1454 cached_raw_data->data_length);
1455 ClipboardUnlock(clipboard->system);
1459 BYTE* dst_data = ClipboardGetData(clipboard->system, dstFormatId, &dst_size);
1462 WLog_WARN(TAG,
"Failed to get converted clipboard data");
1463 ClipboardUnlock(clipboard->system);
1466 ClipboardUnlock(clipboard->system);
1470 BYTE* nullTerminator = memchr(dst_data,
'\0', dst_size);
1473 const intptr_t diff = nullTerminator - dst_data;
1474 WINPR_ASSERT(diff >= 0);
1475 WINPR_ASSERT(diff <= UINT32_MAX);
1476 dst_size = (UINT32)diff;
1480 xfCachedData* cached_data = xf_cached_data_new(dst_data, dst_size);
1483 WLog_WARN(TAG,
"Failed to allocate cache entry");
1488 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId), cached_data))
1490 WLog_WARN(TAG,
"Failed to cache clipboard data");
1491 xf_cached_data_free(cached_data);
1498static BOOL xf_cliprdr_process_selection_request(xfClipboard* clipboard,
1499 const XSelectionRequestEvent* xevent)
1503 UINT32 formatId = 0;
1504 XSelectionEvent* respond =
nullptr;
1505 BYTE* data =
nullptr;
1506 BOOL delayRespond = 0;
1507 BOOL rawTransfer = 0;
1508 unsigned long length = 0;
1509 unsigned long bytes_left = 0;
1510 xfContext* xfc =
nullptr;
1512 WINPR_ASSERT(clipboard);
1513 WINPR_ASSERT(xevent);
1515 xfc = clipboard->xfc;
1518 if (xevent->owner != xfc->drawable)
1521 delayRespond = FALSE;
1523 if (!(respond = (XSelectionEvent*)calloc(1,
sizeof(XSelectionEvent))))
1525 WLog_ERR(TAG,
"failed to allocate XEvent data");
1529 respond->property = None;
1530 respond->type = SelectionNotify;
1531 respond->display = xevent->display;
1532 respond->requestor = xevent->requestor;
1533 respond->selection = xevent->selection;
1534 respond->target = xevent->target;
1535 respond->time = xevent->time;
1537 if (xevent->target == clipboard->targets[0])
1540 respond->property = xevent->property;
1541 xf_cliprdr_provide_timestamp(clipboard, respond);
1543 else if (xevent->target == clipboard->targets[1])
1546 respond->property = xevent->property;
1547 xf_cliprdr_provide_targets(clipboard, respond);
1552 xf_cliprdr_get_server_format_by_atom(clipboard, xevent->target);
1553 const xfCliprdrFormat* cformat =
1554 xf_cliprdr_get_client_format_by_atom(clipboard, xevent->target);
1556 if (format && (xevent->requestor != xfc->drawable))
1558 formatId = format->formatId;
1559 rawTransfer = FALSE;
1560 xfCachedData* cached_data =
nullptr;
1562 if (formatId == CF_RAW)
1564 if (LogDynAndXGetWindowProperty(
1565 xfc->log, xfc->display, xevent->requestor, clipboard->property_atom, 0, 4,
1566 0, XA_INTEGER, &type, &fmt, &length, &bytes_left, &data) != Success)
1573 CopyMemory(&formatId, data, 4);
1578 const UINT32 dstFormatId = get_dst_format_id_for_local_request(clipboard, cformat);
1579 DEBUG_CLIPRDR(
"formatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", formatId,
1582 wHashTable* table = clipboard->cachedData;
1584 table = clipboard->cachedRawData;
1586 HashTable_Lock(table);
1589 cached_data = HashTable_GetItemValue(table, format_to_cache_slot(dstFormatId));
1591 cached_data = HashTable_GetItemValue(table, format_to_cache_slot(formatId));
1593 DEBUG_CLIPRDR(
"hasCachedData: %u, rawTransfer: %d", cached_data ? 1u : 0u, rawTransfer);
1595 if (!cached_data && !rawTransfer)
1597 UINT32 srcFormatId = 0;
1598 BOOL nullTerminated = FALSE;
1599 xfCachedData* cached_raw_data =
nullptr;
1601 get_src_format_info_for_local_request(clipboard, cformat, &srcFormatId,
1604 HashTable_GetItemValue(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId);
1606 DEBUG_CLIPRDR(
"hasCachedRawData: %u, rawDataLength: %u", cached_raw_data ? 1u : 0u,
1607 cached_raw_data ? cached_raw_data->data_length : 0);
1609 if (cached_raw_data && cached_raw_data->data_length != 0)
1610 cached_data = convert_data_from_existing_raw_data(
1611 clipboard, cached_raw_data, srcFormatId, nullTerminated, dstFormatId);
1614 DEBUG_CLIPRDR(
"hasCachedData: %u", cached_data ? 1u : 0u);
1619 respond->property = xevent->property;
1622 xf_cliprdr_provide_data(clipboard, respond, cached_data->data,
1623 cached_data->data_length);
1625 else if (clipboard->respond)
1631 WINPR_ASSERT(cformat);
1637 respond->property = xevent->property;
1638 clipboard->respond = respond;
1639 requested_format_replace(&clipboard->requestedFormat, formatId, dstFormatId,
1640 cformat->formatName);
1641 clipboard->data_raw_format = rawTransfer;
1642 delayRespond = TRUE;
1643 xf_cliprdr_send_data_request(clipboard, formatId, cformat);
1645 HashTable_Unlock(table);
1654 XSelectionEvent* sev;
1658 LogDynAndXSendEvent(xfc->log, xfc->display, xevent->requestor, 0, 0, conv.ev);
1659 LogDynAndXFlush(xfc->log, xfc->display);
1666static BOOL xf_cliprdr_process_selection_clear(xfClipboard* clipboard,
1667 const XSelectionClearEvent* xevent)
1669 xfContext* xfc =
nullptr;
1671 WINPR_ASSERT(clipboard);
1672 WINPR_ASSERT(xevent);
1674 xfc = clipboard->xfc;
1677 WINPR_UNUSED(xevent);
1679 if (xf_cliprdr_is_self_owned(clipboard))
1682 LogDynAndXDeleteProperty(xfc->log, xfc->display, clipboard->root_window,
1683 clipboard->property_atom);
1687static BOOL xf_cliprdr_process_property_notify(xfClipboard* clipboard,
const XPropertyEvent* xevent)
1689 const xfCliprdrFormat* format =
nullptr;
1690 xfContext* xfc =
nullptr;
1695 xfc = clipboard->xfc;
1697 WINPR_ASSERT(xevent);
1699 if (xevent->atom == clipboard->timestamp_property_atom)
1705 xf_cliprdr_set_selection_owner(xfc, clipboard, xevent->time);
1709 if (xevent->atom != clipboard->property_atom)
1712 if (xevent->window == clipboard->root_window)
1714 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1716 else if ((xevent->window == xfc->drawable) && (xevent->state == PropertyNewValue) &&
1717 clipboard->incr_starts)
1719 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1722 xf_cliprdr_get_requested_data(clipboard, format->atom);
1728void xf_cliprdr_handle_xevent(xfContext* xfc,
const XEvent* event)
1730 xfClipboard* clipboard =
nullptr;
1735 clipboard = xfc->clipboard;
1742 if (clipboard->xfixes_supported &&
1743 event->type == XFixesSelectionNotify + clipboard->xfixes_event_base)
1745 const XFixesSelectionNotifyEvent* se = (
const XFixesSelectionNotifyEvent*)event;
1747 if (se->subtype == XFixesSetSelectionOwnerNotify)
1749 if (se->selection != clipboard->clipboard_atom)
1752 if (LogDynAndXGetSelectionOwner(xfc->log, xfc->display, se->selection) == xfc->drawable)
1755 clipboard->owner = None;
1756 xf_cliprdr_check_owner(clipboard);
1764 switch (event->type)
1766 case SelectionNotify:
1767 log_selection_event(xfc, event);
1768 xf_cliprdr_process_selection_notify(clipboard, &event->xselection);
1771 case SelectionRequest:
1772 log_selection_event(xfc, event);
1773 xf_cliprdr_process_selection_request(clipboard, &event->xselectionrequest);
1776 case SelectionClear:
1777 log_selection_event(xfc, event);
1778 xf_cliprdr_process_selection_clear(clipboard, &event->xselectionclear);
1781 case PropertyNotify:
1782 log_selection_event(xfc, event);
1783 xf_cliprdr_process_property_notify(clipboard, &event->xproperty);
1787 if (!clipboard->xfixes_supported)
1789 xf_cliprdr_check_owner(clipboard);
1803static UINT xf_cliprdr_send_client_capabilities(xfClipboard* clipboard)
1808 WINPR_ASSERT(clipboard);
1810 capabilities.cCapabilitiesSets = 1;
1812 generalCapabilitySet.capabilitySetType = CB_CAPSTYPE_GENERAL;
1813 generalCapabilitySet.capabilitySetLength = 12;
1814 generalCapabilitySet.version = CB_CAPS_VERSION_2;
1815 generalCapabilitySet.generalFlags = CB_USE_LONG_FORMAT_NAMES;
1817 WINPR_ASSERT(clipboard);
1818 generalCapabilitySet.generalFlags |= cliprdr_file_context_current_flags(clipboard->file);
1820 WINPR_ASSERT(clipboard->context);
1821 WINPR_ASSERT(clipboard->context->ClientCapabilities);
1822 return clipboard->context->ClientCapabilities(clipboard->context, &capabilities);
1830static UINT xf_cliprdr_send_client_format_list(xfClipboard* clipboard, BOOL force)
1832 WINPR_ASSERT(clipboard);
1834 xfContext* xfc = clipboard->xfc;
1837 UINT32 numFormats = 0;
1838 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
1840 const UINT ret = xf_cliprdr_send_format_list(clipboard, formats, numFormats, force);
1842 if (clipboard->owner && clipboard->owner != xfc->drawable)
1845 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom,
1846 clipboard->targets[1], clipboard->property_atom, xfc->drawable,
1850 xf_cliprdr_free_formats(formats, numFormats);
1860static UINT xf_cliprdr_send_client_format_list_response(xfClipboard* clipboard, BOOL status)
1864 formatListResponse.common.msgType = CB_FORMAT_LIST_RESPONSE;
1865 formatListResponse.common.msgFlags = status ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
1866 formatListResponse.common.dataLen = 0;
1868 WINPR_ASSERT(clipboard);
1869 WINPR_ASSERT(clipboard->context);
1870 WINPR_ASSERT(clipboard->context->ClientFormatListResponse);
1871 return clipboard->context->ClientFormatListResponse(clipboard->context, &formatListResponse);
1879static UINT xf_cliprdr_monitor_ready(CliprdrClientContext* context,
1882 WINPR_ASSERT(context);
1883 WINPR_ASSERT(monitorReady);
1885 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
1886 WINPR_ASSERT(clipboard);
1888 WINPR_UNUSED(monitorReady);
1890 const UINT ret = xf_cliprdr_send_client_capabilities(clipboard);
1891 if (ret != CHANNEL_RC_OK)
1894 xf_clipboard_formats_free(clipboard);
1896 const UINT ret2 = xf_cliprdr_send_client_format_list(clipboard, TRUE);
1897 if (ret2 != CHANNEL_RC_OK)
1900 clipboard->sync = TRUE;
1901 return CHANNEL_RC_OK;
1909static UINT xf_cliprdr_server_capabilities(CliprdrClientContext* context,
1912 WINPR_ASSERT(context);
1913 WINPR_ASSERT(capabilities);
1915 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
1916 WINPR_ASSERT(clipboard);
1918 const BYTE* capsPtr = (
const BYTE*)capabilities->capabilitySets;
1919 WINPR_ASSERT(capsPtr);
1921 if (!cliprdr_file_context_remote_set_flags(clipboard->file, 0))
1922 return ERROR_INTERNAL_ERROR;
1924 for (UINT32 i = 0; i < capabilities->cCapabilitiesSets; i++)
1928 if (caps->capabilitySetType == CB_CAPSTYPE_GENERAL)
1933 if (!cliprdr_file_context_remote_set_flags(clipboard->file, generalCaps->generalFlags))
1934 return ERROR_INTERNAL_ERROR;
1937 capsPtr += caps->capabilitySetLength;
1940 return CHANNEL_RC_OK;
1943static void xf_cliprdr_prepare_to_set_selection_owner(xfContext* xfc, xfClipboard* clipboard)
1946 WINPR_ASSERT(clipboard);
1963 Atom value = clipboard->timestamp_property_atom;
1965 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable,
1966 clipboard->timestamp_property_atom, XA_ATOM, 32, PropModeReplace,
1967 (
const BYTE*)&value, 1);
1968 LogDynAndXFlush(xfc->log, xfc->display);
1971static void xf_cliprdr_set_selection_owner(xfContext* xfc, xfClipboard* clipboard, Time timestamp)
1974 WINPR_ASSERT(clipboard);
1980 clipboard->selection_ownership_timestamp = timestamp;
1981 LogDynAndXSetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom, xfc->drawable,
1983 LogDynAndXFlush(xfc->log, xfc->display);
1991static UINT xf_cliprdr_server_format_list(CliprdrClientContext* context,
1994 xfContext* xfc =
nullptr;
1996 xfClipboard* clipboard =
nullptr;
1998 WINPR_ASSERT(context);
1999 WINPR_ASSERT(formatList);
2001 clipboard = cliprdr_file_context_get_context(context->custom);
2002 WINPR_ASSERT(clipboard);
2004 xfc = clipboard->xfc;
2010 free(clipboard->respond);
2011 clipboard->respond =
nullptr;
2013 xf_clipboard_formats_free(clipboard);
2014 xf_cliprdr_clear_cached_data(clipboard);
2015 requested_format_free(&clipboard->requestedFormat);
2017 xf_clipboard_free_server_formats(clipboard);
2019 clipboard->numServerFormats = formatList->numFormats + 1;
2021 if (!(clipboard->serverFormats =
2024 WLog_ERR(TAG,
"failed to allocate %" PRIu32
" CLIPRDR_FORMAT structs",
2025 clipboard->numServerFormats);
2026 ret = CHANNEL_RC_NO_MEMORY;
2030 for (
size_t i = 0; i < formatList->numFormats; i++)
2035 srvFormat->formatId = format->formatId;
2037 if (format->formatName)
2039 srvFormat->formatName = _strdup(format->formatName);
2041 if (!srvFormat->formatName)
2043 for (UINT32 k = 0; k < i; k++)
2044 free(clipboard->serverFormats[k].formatName);
2046 clipboard->numServerFormats = 0;
2047 free(clipboard->serverFormats);
2048 clipboard->serverFormats =
nullptr;
2049 ret = CHANNEL_RC_NO_MEMORY;
2055 ClipboardLock(clipboard->system);
2056 ret = cliprdr_file_context_notify_new_server_format_list(clipboard->file);
2057 ClipboardUnlock(clipboard->system);
2063 CLIPRDR_FORMAT* format = &clipboard->serverFormats[formatList->numFormats];
2064 format->formatId = CF_RAW;
2065 format->formatName =
nullptr;
2067 xf_cliprdr_provide_server_format_list(clipboard);
2068 clipboard->numTargets = 2;
2070 for (
size_t i = 0; i < formatList->numFormats; i++)
2074 for (
size_t j = 0; j < clipboard->numClientFormats; j++)
2076 const xfCliprdrFormat* clientFormat = &clipboard->clientFormats[j];
2077 if (xf_cliprdr_formats_equal(format, clientFormat))
2079 if ((clientFormat->formatName !=
nullptr) &&
2080 (strcmp(type_FileGroupDescriptorW, clientFormat->formatName) == 0))
2082 if (!cliprdr_file_context_has_local_support(clipboard->file))
2085 xf_cliprdr_append_target(clipboard, clientFormat->atom);
2090 ret = xf_cliprdr_send_client_format_list_response(clipboard, TRUE);
2091 if (xfc->remote_app)
2092 xf_cliprdr_set_selection_owner(xfc, clipboard, CurrentTime);
2094 xf_cliprdr_prepare_to_set_selection_owner(xfc, clipboard);
2107static UINT xf_cliprdr_server_format_list_response(
2108 WINPR_ATTR_UNUSED CliprdrClientContext* context,
2111 WINPR_ASSERT(context);
2112 WINPR_ASSERT(formatListResponse);
2114 return CHANNEL_RC_OK;
2123xf_cliprdr_server_format_data_request(CliprdrClientContext* context,
2126 const xfCliprdrFormat* format =
nullptr;
2128 WINPR_ASSERT(context);
2129 WINPR_ASSERT(formatDataRequest);
2131 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2132 WINPR_ASSERT(clipboard);
2134 xfContext* xfc = clipboard->xfc;
2137 const uint32_t formatId = formatDataRequest->requestedFormatId;
2139 const BOOL rawTransfer = xf_cliprdr_is_raw_transfer_available(clipboard);
2143 format = xf_cliprdr_get_client_format_by_id(clipboard, CF_RAW);
2144 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom,
2145 XA_INTEGER, 32, PropModeReplace, (
const BYTE*)&formatId, 1);
2148 format = xf_cliprdr_get_client_format_by_id(clipboard, formatId);
2150 clipboard->requestedFormatId = rawTransfer ? CF_RAW : formatId;
2152 return xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
2154 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2155 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2156 format->localFormat,
2157 ClipboardGetFormatName(clipboard->system, format->localFormat),
2158 format->formatName);
2159 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom, format->atom,
2160 clipboard->property_atom, xfc->drawable, CurrentTime);
2161 LogDynAndXFlush(xfc->log, xfc->display);
2163 return CHANNEL_RC_OK;
2172xf_cliprdr_server_format_data_response(CliprdrClientContext* context,
2176 BYTE* pDstData =
nullptr;
2179 UINT32 srcFormatId = 0;
2180 UINT32 dstFormatId = 0;
2181 BOOL nullTerminated = FALSE;
2182 xfCachedData* cached_data =
nullptr;
2184 WINPR_ASSERT(context);
2185 WINPR_ASSERT(formatDataResponse);
2187 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2188 WINPR_ASSERT(clipboard);
2190 xfContext* xfc = clipboard->xfc;
2193 const UINT32 size = formatDataResponse->common.dataLen;
2194 const BYTE* data = formatDataResponse->requestedFormatData;
2196 if (formatDataResponse->common.msgFlags == CB_RESPONSE_FAIL)
2198 WLog_WARN(TAG,
"Format Data Response PDU msgFlags is CB_RESPONSE_FAIL");
2199 free(clipboard->respond);
2200 clipboard->respond =
nullptr;
2201 return CHANNEL_RC_OK;
2204 if (!clipboard->respond)
2205 return CHANNEL_RC_OK;
2207 const RequestedFormat* format = clipboard->requestedFormat;
2208 if (clipboard->data_raw_format)
2210 srcFormatId = CF_RAW;
2211 dstFormatId = CF_RAW;
2214 return ERROR_INTERNAL_ERROR;
2215 else if (format->formatName)
2217 dstFormatId = format->localFormat;
2219 ClipboardLock(clipboard->system);
2220 if (strcmp(format->formatName, type_HtmlFormat) == 0)
2222 srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
2223 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
2224 nullTerminated = TRUE;
2227 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
2229 if (!cliprdr_file_context_update_server_data(clipboard->file, clipboard->system, data,
2231 WLog_WARN(TAG,
"failed to update file descriptors");
2233 srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2234 const xfCliprdrFormat* dstTargetFormat =
2235 xf_cliprdr_get_client_format_by_atom(clipboard, clipboard->respond->target);
2236 if (!dstTargetFormat)
2238 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2242 dstFormatId = dstTargetFormat->localFormat;
2245 nullTerminated = TRUE;
2247 ClipboardUnlock(clipboard->system);
2251 srcFormatId = format->formatToRequest;
2252 dstFormatId = format->localFormat;
2253 switch (format->formatToRequest)
2256 nullTerminated = TRUE;
2260 nullTerminated = TRUE;
2263 case CF_UNICODETEXT:
2264 nullTerminated = TRUE;
2268 srcFormatId = CF_DIB;
2272 srcFormatId = CF_TIFF;
2280 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2281 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2282 format->localFormat,
2283 ClipboardGetFormatName(clipboard->system, format->localFormat),
2284 format->formatName);
2287 DEBUG_CLIPRDR(
"srcFormatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", srcFormatId,
2290 ClipboardLock(clipboard->system);
2291 bSuccess = ClipboardSetData(clipboard->system, srcFormatId, data, SrcSize);
2293 BOOL willQuit = FALSE;
2298 WLog_DBG(TAG,
"skipping, empty data detected!");
2299 free(clipboard->respond);
2300 clipboard->respond =
nullptr;
2305 pDstData = (BYTE*)ClipboardGetData(clipboard->system, dstFormatId, &DstSize);
2309 WLog_WARN(TAG,
"failed to get clipboard data in format %s [source format %s]",
2310 ClipboardGetFormatName(clipboard->system, dstFormatId),
2311 ClipboardGetFormatName(clipboard->system, srcFormatId));
2314 if (nullTerminated && pDstData)
2316 BYTE* nullTerminator = memchr(pDstData,
'\0', DstSize);
2319 const intptr_t diff = nullTerminator - pDstData;
2320 WINPR_ASSERT(diff >= 0);
2321 WINPR_ASSERT(diff <= UINT32_MAX);
2322 DstSize = (UINT32)diff;
2327 ClipboardUnlock(clipboard->system);
2329 return CHANNEL_RC_OK;
2335 cached_data = xf_cached_data_new(pDstData, DstSize);
2338 WLog_WARN(TAG,
"Failed to allocate cache entry");
2340 return CHANNEL_RC_OK;
2342 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId),
2345 WLog_WARN(TAG,
"Failed to cache clipboard data");
2346 xf_cached_data_free(cached_data);
2347 return CHANNEL_RC_OK;
2357 xfCachedData* cached_raw_data = xf_cached_data_new_copy(data, size);
2358 if (!cached_raw_data)
2359 WLog_WARN(TAG,
"Failed to allocate cache entry");
2362 if (!HashTable_Insert(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId,
2365 WLog_WARN(TAG,
"Failed to cache clipboard data");
2366 xf_cached_data_free(cached_raw_data);
2373 xf_cliprdr_provide_data(clipboard, clipboard->respond, pDstData, DstSize);
2378 XSelectionEvent* sev;
2381 conv.sev = clipboard->respond;
2383 LogDynAndXSendEvent(xfc->log, xfc->display, clipboard->respond->requestor, 0, 0, conv.ev);
2384 LogDynAndXFlush(xfc->log, xfc->display);
2386 free(clipboard->respond);
2387 clipboard->respond =
nullptr;
2388 return CHANNEL_RC_OK;
2391static BOOL xf_cliprdr_is_valid_unix_filename(LPCWSTR filename)
2396 if (filename[0] == L
'\0')
2400 for (
const WCHAR* c = filename; *c; ++c)
2409xfClipboard* xf_clipboard_new(xfContext* xfc, BOOL relieveFilenameRestriction)
2412 rdpChannels* channels =
nullptr;
2413 xfClipboard* clipboard =
nullptr;
2414 const char* selectionAtom =
nullptr;
2415 xfCliprdrFormat* clientFormat =
nullptr;
2419 WINPR_ASSERT(xfc->common.context.settings);
2421 if (!(clipboard = (xfClipboard*)calloc(1,
sizeof(xfClipboard))))
2423 WLog_ERR(TAG,
"failed to allocate xfClipboard data");
2427 clipboard->file = cliprdr_file_context_new(clipboard);
2428 if (!clipboard->file)
2431 xfc->clipboard = clipboard;
2432 clipboard->xfc = xfc;
2433 channels = xfc->common.context.channels;
2434 clipboard->channels = channels;
2435 clipboard->system = ClipboardCreate();
2436 clipboard->requestedFormatId = UINT32_MAX;
2437 clipboard->root_window = DefaultRootWindow(xfc->display);
2442 selectionAtom =
"CLIPBOARD";
2444 clipboard->clipboard_atom = Logging_XInternAtom(xfc->log, xfc->display, selectionAtom, FALSE);
2446 if (clipboard->clipboard_atom == None)
2448 WLog_ERR(TAG,
"unable to get %s atom", selectionAtom);
2452 clipboard->timestamp_property_atom =
2453 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_TIMESTAMP_PROPERTY", FALSE);
2454 clipboard->property_atom =
2455 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR", FALSE);
2456 clipboard->raw_transfer_atom =
2457 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_RAW", FALSE);
2458 clipboard->raw_format_list_atom =
2459 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_FORMATS", FALSE);
2460 xf_cliprdr_set_raw_transfer_enabled(clipboard, TRUE);
2461 XSelectInput(xfc->display, clipboard->root_window, PropertyChangeMask);
2464 if (XFixesQueryExtension(xfc->display, &clipboard->xfixes_event_base,
2465 &clipboard->xfixes_error_base))
2470 if (XFixesQueryVersion(xfc->display, &xfmajor, &xfminor))
2472 XFixesSelectSelectionInput(xfc->display, clipboard->root_window,
2473 clipboard->clipboard_atom,
2474 XFixesSetSelectionOwnerNotifyMask);
2475 clipboard->xfixes_supported = TRUE;
2479 WLog_ERR(TAG,
"Error querying X Fixes extension version");
2484 WLog_ERR(TAG,
"Error loading X Fixes extension");
2490 "Warning: Using clipboard redirection without XFIXES extension is strongly discouraged!");
2492 clientFormat = &clipboard->clientFormats[n++];
2493 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_RAW", False);
2494 clientFormat->localFormat = clientFormat->formatToRequest = CF_RAW;
2496 clientFormat = &clipboard->clientFormats[n++];
2497 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"UTF8_STRING", False);
2498 clientFormat->formatToRequest = CF_UNICODETEXT;
2499 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2501 clientFormat = &clipboard->clientFormats[n++];
2502 clientFormat->atom = XA_STRING;
2503 clientFormat->formatToRequest = CF_TEXT;
2504 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2506 clientFormat = &clipboard->clientFormats[n++];
2507 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_tiff, False);
2508 clientFormat->formatToRequest = clientFormat->localFormat = CF_TIFF;
2510 for (
size_t x = 0; x < ARRAYSIZE(mime_bitmap); x++)
2512 const char* mime_bmp = mime_bitmap[x];
2513 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2516 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2520 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2521 clientFormat = &clipboard->clientFormats[n++];
2522 clientFormat->localFormat = format;
2523 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2524 clientFormat->formatToRequest = CF_DIB;
2525 clientFormat->isImage = TRUE;
2528 for (
size_t x = 0; x < ARRAYSIZE(mime_images); x++)
2530 const char* mime_bmp = mime_images[x];
2531 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2534 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2538 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2539 clientFormat = &clipboard->clientFormats[n++];
2540 clientFormat->localFormat = format;
2541 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2542 clientFormat->formatToRequest = CF_DIB;
2543 clientFormat->isImage = TRUE;
2546 clientFormat = &clipboard->clientFormats[n++];
2547 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_html, False);
2548 clientFormat->formatToRequest = ClipboardGetFormatId(xfc->clipboard->system, type_HtmlFormat);
2549 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_html);
2550 clientFormat->formatName = _strdup(type_HtmlFormat);
2552 if (!clientFormat->formatName)
2555 clientFormat = &clipboard->clientFormats[n++];
2564 const UINT32 fgid = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2566 const UINT32 uid = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2569 if (!cliprdr_file_context_set_locally_available(clipboard->file, TRUE))
2571 clientFormat->atom =
2572 Logging_XInternAtom(xfc->log, xfc->display, mime_uri_list, False);
2573 clientFormat->localFormat = uid;
2574 clientFormat->formatToRequest = fgid;
2575 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2577 if (!clientFormat->formatName)
2580 clientFormat = &clipboard->clientFormats[n++];
2585 const UINT32 gid = ClipboardGetFormatId(clipboard->system, mime_gnome_copied_files);
2588 if (!cliprdr_file_context_set_locally_available(clipboard->file, TRUE))
2590 clientFormat->atom =
2591 Logging_XInternAtom(xfc->log, xfc->display, mime_gnome_copied_files, False);
2592 clientFormat->localFormat = gid;
2593 clientFormat->formatToRequest = fgid;
2594 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2596 if (!clientFormat->formatName)
2599 clientFormat = &clipboard->clientFormats[n++];
2604 const UINT32 mid = ClipboardGetFormatId(clipboard->system, mime_mate_copied_files);
2607 if (!cliprdr_file_context_set_locally_available(clipboard->file, TRUE))
2609 clientFormat->atom =
2610 Logging_XInternAtom(xfc->log, xfc->display, mime_mate_copied_files, False);
2611 clientFormat->localFormat = mid;
2612 clientFormat->formatToRequest = fgid;
2613 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2615 if (!clientFormat->formatName)
2621 clipboard->numClientFormats = WINPR_ASSERTING_INT_CAST(uint32_t, n);
2622 clipboard->targets[0] = Logging_XInternAtom(xfc->log, xfc->display,
"TIMESTAMP", FALSE);
2623 clipboard->targets[1] = Logging_XInternAtom(xfc->log, xfc->display,
"TARGETS", FALSE);
2624 clipboard->numTargets = 2;
2625 clipboard->incr_atom = Logging_XInternAtom(xfc->log, xfc->display,
"INCR", FALSE);
2627 if (relieveFilenameRestriction)
2629 WLog_DBG(TAG,
"Relieving CLIPRDR filename restriction");
2630 ClipboardGetDelegate(clipboard->system)->IsFileNameComponentValid =
2631 xf_cliprdr_is_valid_unix_filename;
2634 clipboard->cachedData = HashTable_New(TRUE);
2635 if (!clipboard->cachedData)
2638 obj = HashTable_ValueObject(clipboard->cachedData);
2641 clipboard->cachedRawData = HashTable_New(TRUE);
2642 if (!clipboard->cachedRawData)
2645 obj = HashTable_ValueObject(clipboard->cachedRawData);
2651 WINPR_PRAGMA_DIAG_PUSH
2652 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2653 xf_clipboard_free(clipboard);
2654 WINPR_PRAGMA_DIAG_POP
2658void xf_clipboard_free(xfClipboard* clipboard)
2663 xf_clipboard_free_server_formats(clipboard);
2665 if (clipboard->numClientFormats)
2667 for (UINT32 i = 0; i < clipboard->numClientFormats; i++)
2669 xfCliprdrFormat* format = &clipboard->clientFormats[i];
2670 free(format->formatName);
2674 cliprdr_file_context_free(clipboard->file);
2676 ClipboardDestroy(clipboard->system);
2677 xf_clipboard_formats_free(clipboard);
2678 HashTable_Free(clipboard->cachedRawData);
2679 HashTable_Free(clipboard->cachedData);
2680 requested_format_free(&clipboard->requestedFormat);
2681 free(clipboard->respond);
2682 free(clipboard->incr_data);
2686void xf_cliprdr_init(xfContext* xfc, CliprdrClientContext* cliprdr)
2689 WINPR_ASSERT(cliprdr);
2691 xfc->cliprdr = cliprdr;
2692 xfc->clipboard->context = cliprdr;
2694 cliprdr->MonitorReady = xf_cliprdr_monitor_ready;
2695 cliprdr->ServerCapabilities = xf_cliprdr_server_capabilities;
2696 cliprdr->ServerFormatList = xf_cliprdr_server_format_list;
2697 cliprdr->ServerFormatListResponse = xf_cliprdr_server_format_list_response;
2698 cliprdr->ServerFormatDataRequest = xf_cliprdr_server_format_data_request;
2699 cliprdr->ServerFormatDataResponse = xf_cliprdr_server_format_data_response;
2701 cliprdr_file_context_init(xfc->clipboard->file, cliprdr);
2704void xf_cliprdr_uninit(xfContext* xfc, CliprdrClientContext* cliprdr)
2708 xfc->cliprdr =
nullptr;
2712 ClipboardLock(xfc->clipboard->system);
2713 cliprdr_file_context_uninit(xfc->clipboard->file, cliprdr);
2714 ClipboardUnlock(xfc->clipboard->system);
2715 xfc->clipboard->context =
nullptr;
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