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);
873 xf_lock_x11(clipboard->xfc);
874 xf_cliprdr_free_formats(clipboard->lastSentFormats, clipboard->lastSentNumFormats);
875 xf_unlock_x11(clipboard->xfc);
877 clipboard->lastSentFormats =
nullptr;
878 clipboard->lastSentNumFormats = 0;
881static BOOL xf_clipboard_copy_formats(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
884 WINPR_ASSERT(clipboard);
885 WINPR_ASSERT(formats || (numFormats == 0));
887 xf_clipboard_formats_free(clipboard);
889 clipboard->lastSentFormats = calloc(numFormats,
sizeof(
CLIPRDR_FORMAT));
890 if (!clipboard->lastSentFormats)
892 clipboard->lastSentNumFormats = numFormats;
893 for (UINT32 x = 0; x < numFormats; x++)
899 lcur->formatName = _strdup(cur->formatName);
904static UINT xf_cliprdr_send_format_list(xfClipboard* clipboard,
const CLIPRDR_FORMAT* formats,
905 UINT32 numFormats, BOOL force)
911 } cnv = { .cpv = formats };
913 .numFormats = numFormats,
915 .common.msgType = CB_FORMAT_LIST };
918 WINPR_ASSERT(clipboard);
919 WINPR_ASSERT(formats || (numFormats == 0));
921 if (!force && !xf_clipboard_changed(clipboard, formats, numFormats))
922 return CHANNEL_RC_OK;
924#if defined(WITH_DEBUG_CLIPRDR)
925 for (UINT32 x = 0; x < numFormats; x++)
928 DEBUG_CLIPRDR(
"announcing format 0x%08" PRIx32
" [%s] [%s]", format->formatId,
929 ClipboardGetFormatIdString(format->formatId), format->formatName);
933 xf_clipboard_copy_formats(clipboard, formats, numFormats);
935 xf_cliprdr_send_data_response(clipboard,
nullptr,
nullptr, 0);
937 xf_cliprdr_clear_cached_data(clipboard);
939 ret = cliprdr_file_context_notify_new_client_format_list(clipboard->file);
943 WINPR_ASSERT(clipboard->context);
944 WINPR_ASSERT(clipboard->context->ClientFormatList);
945 return clipboard->context->ClientFormatList(clipboard->context, &formatList);
948static void xf_cliprdr_get_requested_targets(xfClipboard* clipboard)
950 UINT32 numFormats = 0;
951 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
952 xf_cliprdr_send_format_list(clipboard, formats, numFormats, FALSE);
953 xf_cliprdr_free_formats(formats, numFormats);
956static void xf_cliprdr_process_requested_data(xfClipboard* clipboard, BOOL hasData,
957 const BYTE* data,
size_t size)
962 INT64 srcFormatId = -1;
963 BYTE* pDstData =
nullptr;
964 const xfCliprdrFormat* format =
nullptr;
966 WINPR_ASSERT(clipboard);
968 if (clipboard->incr_starts && hasData)
973 clipboard->incr_data_length = 0;
975 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
977 if (!hasData || !data || !format)
979 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
983 switch (format->formatToRequest)
986 srcFormatId = CF_RAW;
992 srcFormatId = format->localFormat;
996 srcFormatId = format->localFormat;
1000 if (srcFormatId < 0)
1002 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
1006 ClipboardLock(clipboard->system);
1007 SrcSize = (UINT32)size;
1008 bSuccess = ClipboardSetData(clipboard->system, (UINT32)srcFormatId, data, SrcSize);
1014 (BYTE*)ClipboardGetData(clipboard->system, clipboard->requestedFormatId, &DstSize);
1016 ClipboardUnlock(clipboard->system);
1020 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
1031 ClipboardLock(clipboard->system);
1032 if (format->formatToRequest &&
1033 (format->formatToRequest ==
1034 ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW)))
1036 UINT error = NO_ERROR;
1042 const UINT32 flags = cliprdr_file_context_remote_get_flags(clipboard->file);
1043 error = cliprdr_serialize_file_list_ex(flags, file_array, file_count, &pDstData, &DstSize);
1046 WLog_ERR(TAG,
"failed to serialize CLIPRDR_FILELIST: 0x%08X", error);
1049 UINT32 formatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
1050 UINT32 url_size = 0;
1052 char* url = ClipboardGetData(clipboard->system, formatId, &url_size);
1053 cliprdr_file_context_update_client_data(clipboard->file, url, url_size);
1059 ClipboardUnlock(clipboard->system);
1061 xf_cliprdr_send_data_response(clipboard, format, pDstData, DstSize);
1065static BOOL xf_restore_input_flags(xfClipboard* clipboard)
1067 WINPR_ASSERT(clipboard);
1069 xfContext* xfc = clipboard->xfc;
1072 if (clipboard->event_mask != 0)
1074 XSelectInput(xfc->display, xfc->drawable, clipboard->event_mask);
1075 clipboard->event_mask = 0;
1080static BOOL append(xfClipboard* clipboard,
const void* sdata,
size_t length)
1082 WINPR_ASSERT(clipboard);
1084 const size_t size = length + clipboard->incr_data_length + 2;
1085 BYTE* data = realloc(clipboard->incr_data, size);
1088 clipboard->incr_data = data;
1089 memcpy(&data[clipboard->incr_data_length], sdata, length);
1090 clipboard->incr_data_length += length;
1091 clipboard->incr_data[clipboard->incr_data_length + 0] =
'\0';
1092 clipboard->incr_data[clipboard->incr_data_length + 1] =
'\0';
1096static BOOL xf_cliprdr_stop_incr(xfClipboard* clipboard)
1098 clipboard->incr_starts = FALSE;
1099 clipboard->incr_data_length = 0;
1100 return xf_restore_input_flags(clipboard);
1103static BOOL xf_cliprdr_get_requested_data(xfClipboard* clipboard, Atom target)
1105 WINPR_ASSERT(clipboard);
1107 xfContext* xfc = clipboard->xfc;
1110 const xfCliprdrFormat* format =
1111 xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1113 if (!format || (format->atom != target))
1115 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
1120 BOOL has_data = FALSE;
1121 int format_property = 0;
1122 unsigned long length = 0;
1123 unsigned long total_bytes = 0;
1124 BYTE* property_data =
nullptr;
1125 const int rc = LogDynAndXGetWindowProperty(
1126 xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0, 0, False, target, &type,
1127 &format_property, &length, &total_bytes, &property_data);
1129 XFree(property_data);
1132 xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
1139 if ((total_bytes <= 0) && !clipboard->incr_starts)
1141 xf_cliprdr_stop_incr(clipboard);
1144 else if (type == clipboard->incr_atom)
1146 xf_cliprdr_stop_incr(clipboard);
1147 clipboard->incr_starts = TRUE;
1152 BYTE* incremental_data =
nullptr;
1153 unsigned long incremental_len = 0;
1156 len = clipboard->incr_data_length;
1157 if (total_bytes <= 0)
1159 xf_cliprdr_stop_incr(clipboard);
1163 else if (LogDynAndXGetWindowProperty(
1164 xfc->log, xfc->display, xfc->drawable, clipboard->property_atom, 0,
1165 WINPR_ASSERTING_INT_CAST(int32_t, total_bytes), False, target, &type,
1166 &format_property, &incremental_len, &length, &incremental_data) == Success)
1168 has_data = append(clipboard, incremental_data, incremental_len);
1169 len = clipboard->incr_data_length;
1172 if (incremental_data)
1173 XFree(incremental_data);
1176 LogDynAndXDeleteProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom);
1177 xf_cliprdr_process_requested_data(clipboard, has_data, clipboard->incr_data, len);
1182static void xf_cliprdr_append_target(xfClipboard* clipboard, Atom target)
1184 WINPR_ASSERT(clipboard);
1186 if (clipboard->numTargets >= ARRAYSIZE(clipboard->targets))
1189 for (
size_t i = 0; i < clipboard->numTargets; i++)
1191 if (clipboard->targets[i] == target)
1195 clipboard->targets[clipboard->numTargets++] = target;
1198static void xf_cliprdr_provide_targets(xfClipboard* clipboard,
const XSelectionEvent* respond)
1200 xfContext* xfc =
nullptr;
1202 WINPR_ASSERT(clipboard);
1204 xfc = clipboard->xfc;
1207 if (respond->property != None)
1209 WINPR_ASSERT(clipboard->numTargets <= INT32_MAX);
1210 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1211 XA_ATOM, 32, PropModeReplace, (
const BYTE*)clipboard->targets,
1212 (
int)clipboard->numTargets);
1216static void xf_cliprdr_provide_timestamp(xfClipboard* clipboard,
const XSelectionEvent* respond)
1218 xfContext* xfc =
nullptr;
1220 WINPR_ASSERT(clipboard);
1222 xfc = clipboard->xfc;
1225 if (respond->property != None)
1227 LogDynAndXChangeProperty(xfc->log, xfc->display, respond->requestor, respond->property,
1228 XA_INTEGER, 32, PropModeReplace,
1229 (
const BYTE*)&clipboard->selection_ownership_timestamp, 1);
1233#define xf_cliprdr_provide_data(clipboard, respond, data, size) \
1234 xf_cliprdr_provide_data_((clipboard), (respond), (data), (size), __FILE__, __func__, __LINE__)
1235static void xf_cliprdr_provide_data_(xfClipboard* clipboard,
const XSelectionEvent* respond,
1236 const BYTE* data, UINT32 size,
const char* file,
1237 const char* fkt,
size_t line)
1239 WINPR_ASSERT(clipboard);
1241 xfContext* xfc = clipboard->xfc;
1244 if (respond->property != None)
1246 LogDynAndXChangeProperty_ex(xfc->log, file, fkt, line, xfc->display, respond->requestor,
1247 respond->property, respond->target, 8, PropModeReplace, data,
1248 WINPR_ASSERTING_INT_CAST(int32_t, size));
1252static void log_selection_event(xfContext* xfc,
const XEvent* event)
1254 const DWORD level = WLOG_TRACE;
1255 static wLog* _log_cached_ptr =
nullptr;
1256 if (!_log_cached_ptr)
1257 _log_cached_ptr = WLog_Get(TAG);
1258 if (WLog_IsLevelActive(_log_cached_ptr, level))
1261 switch (event->type)
1263 case SelectionClear:
1265 const XSelectionClearEvent* xevent = &
event->xselectionclear;
1267 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1268 WLog_Print(_log_cached_ptr, level,
"got event %s [selection %s]",
1269 x11_event_string(event->type), selection);
1273 case SelectionNotify:
1275 const XSelectionEvent* xevent = &
event->xselection;
1277 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1278 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1279 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1280 WLog_Print(_log_cached_ptr, level,
1281 "got event %s [selection %s, target %s, property %s]",
1282 x11_event_string(event->type), selection, target, property);
1288 case SelectionRequest:
1290 const XSelectionRequestEvent* xevent = &
event->xselectionrequest;
1292 Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->selection);
1293 char* target = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->target);
1294 char*
property = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->property);
1295 WLog_Print(_log_cached_ptr, level,
1296 "got event %s [selection %s, target %s, property %s]",
1297 x11_event_string(event->type), selection, target, property);
1303 case PropertyNotify:
1305 const XPropertyEvent* xevent = &
event->xproperty;
1306 char* atom = Safe_XGetAtomName(_log_cached_ptr, xfc->display, xevent->atom);
1307 WLog_Print(_log_cached_ptr, level,
"got event %s [atom %s]",
1308 x11_event_string(event->type), atom);
1318static BOOL xf_cliprdr_process_selection_notify(xfClipboard* clipboard,
1319 const XSelectionEvent* xevent)
1321 WINPR_ASSERT(clipboard);
1322 WINPR_ASSERT(xevent);
1324 if (xevent->target == clipboard->targets[1])
1326 if (xevent->property == None)
1328 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1332 xf_cliprdr_get_requested_targets(clipboard);
1339 return xf_cliprdr_get_requested_data(clipboard, xevent->target);
1343void xf_cliprdr_clear_cached_data(xfClipboard* clipboard)
1345 WINPR_ASSERT(clipboard);
1347 ClipboardLock(clipboard->system);
1348 ClipboardEmpty(clipboard->system);
1350 HashTable_Clear(clipboard->cachedData);
1351 HashTable_Clear(clipboard->cachedRawData);
1353 cliprdr_file_context_clear(clipboard->file);
1355 xf_cliprdr_stop_incr(clipboard);
1356 ClipboardUnlock(clipboard->system);
1359static void* format_to_cache_slot(UINT32 format)
1366 cnv.uptr = 0x100000000ULL + format;
1370static UINT32 get_dst_format_id_for_local_request(xfClipboard* clipboard,
1371 const xfCliprdrFormat* format)
1373 UINT32 dstFormatId = 0;
1375 WINPR_ASSERT(format);
1377 if (!format->formatName)
1378 return format->localFormat;
1380 ClipboardLock(clipboard->system);
1381 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1382 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
1383 ClipboardUnlock(clipboard->system);
1385 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1386 dstFormatId = format->localFormat;
1391static void get_src_format_info_for_local_request(xfClipboard* clipboard,
1392 const xfCliprdrFormat* format,
1393 UINT32* srcFormatId, BOOL* nullTerminated)
1396 *nullTerminated = FALSE;
1398 if (format->formatName)
1400 ClipboardLock(clipboard->system);
1401 if (strcmp(format->formatName, type_HtmlFormat) == 0)
1403 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
1404 *nullTerminated = TRUE;
1406 else if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
1408 *srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
1409 *nullTerminated = TRUE;
1411 ClipboardUnlock(clipboard->system);
1415 *srcFormatId = format->formatToRequest;
1416 switch (format->formatToRequest)
1420 case CF_UNICODETEXT:
1421 *nullTerminated = TRUE;
1424 *srcFormatId = CF_DIB;
1427 *srcFormatId = CF_TIFF;
1435static xfCachedData* convert_data_from_existing_raw_data(xfClipboard* clipboard,
1436 xfCachedData* cached_raw_data,
1437 UINT32 srcFormatId, BOOL nullTerminated,
1440 UINT32 dst_size = 0;
1442 WINPR_ASSERT(clipboard);
1443 WINPR_ASSERT(cached_raw_data);
1444 WINPR_ASSERT(cached_raw_data->data);
1446 ClipboardLock(clipboard->system);
1447 BOOL success = ClipboardSetData(clipboard->system, srcFormatId, cached_raw_data->data,
1448 cached_raw_data->data_length);
1451 WLog_WARN(TAG,
"Failed to set clipboard data (formatId: %u, data: %p, data_length: %u)",
1452 srcFormatId, WINPR_CXX_COMPAT_CAST(
const void*, cached_raw_data->data),
1453 cached_raw_data->data_length);
1454 ClipboardUnlock(clipboard->system);
1458 BYTE* dst_data = ClipboardGetData(clipboard->system, dstFormatId, &dst_size);
1461 WLog_WARN(TAG,
"Failed to get converted clipboard data");
1462 ClipboardUnlock(clipboard->system);
1465 ClipboardUnlock(clipboard->system);
1469 BYTE* nullTerminator = memchr(dst_data,
'\0', dst_size);
1472 const intptr_t diff = nullTerminator - dst_data;
1473 WINPR_ASSERT(diff >= 0);
1474 WINPR_ASSERT(diff <= UINT32_MAX);
1475 dst_size = (UINT32)diff;
1479 xfCachedData* cached_data = xf_cached_data_new(dst_data, dst_size);
1482 WLog_WARN(TAG,
"Failed to allocate cache entry");
1487 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId), cached_data))
1489 WLog_WARN(TAG,
"Failed to cache clipboard data");
1490 xf_cached_data_free(cached_data);
1497static BOOL xf_cliprdr_process_selection_request(xfClipboard* clipboard,
1498 const XSelectionRequestEvent* xevent)
1502 UINT32 formatId = 0;
1503 XSelectionEvent* respond =
nullptr;
1504 BYTE* data =
nullptr;
1505 BOOL delayRespond = 0;
1506 BOOL rawTransfer = 0;
1507 unsigned long length = 0;
1508 unsigned long bytes_left = 0;
1509 xfContext* xfc =
nullptr;
1511 WINPR_ASSERT(clipboard);
1512 WINPR_ASSERT(xevent);
1514 xfc = clipboard->xfc;
1517 if (xevent->owner != xfc->drawable)
1520 delayRespond = FALSE;
1522 if (!(respond = (XSelectionEvent*)calloc(1,
sizeof(XSelectionEvent))))
1524 WLog_ERR(TAG,
"failed to allocate XEvent data");
1528 respond->property = None;
1529 respond->type = SelectionNotify;
1530 respond->display = xevent->display;
1531 respond->requestor = xevent->requestor;
1532 respond->selection = xevent->selection;
1533 respond->target = xevent->target;
1534 respond->time = xevent->time;
1536 if (xevent->target == clipboard->targets[0])
1539 respond->property = xevent->property;
1540 xf_cliprdr_provide_timestamp(clipboard, respond);
1542 else if (xevent->target == clipboard->targets[1])
1545 respond->property = xevent->property;
1546 xf_cliprdr_provide_targets(clipboard, respond);
1551 xf_cliprdr_get_server_format_by_atom(clipboard, xevent->target);
1552 const xfCliprdrFormat* cformat =
1553 xf_cliprdr_get_client_format_by_atom(clipboard, xevent->target);
1555 if (format && (xevent->requestor != xfc->drawable))
1557 formatId = format->formatId;
1558 rawTransfer = FALSE;
1559 xfCachedData* cached_data =
nullptr;
1561 if (formatId == CF_RAW)
1563 if (LogDynAndXGetWindowProperty(
1564 xfc->log, xfc->display, xevent->requestor, clipboard->property_atom, 0, 4,
1565 0, XA_INTEGER, &type, &fmt, &length, &bytes_left, &data) != Success)
1572 CopyMemory(&formatId, data, 4);
1577 const UINT32 dstFormatId = get_dst_format_id_for_local_request(clipboard, cformat);
1578 DEBUG_CLIPRDR(
"formatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", formatId,
1581 wHashTable* table = clipboard->cachedData;
1583 table = clipboard->cachedRawData;
1585 HashTable_Lock(table);
1588 cached_data = HashTable_GetItemValue(table, format_to_cache_slot(dstFormatId));
1590 cached_data = HashTable_GetItemValue(table, format_to_cache_slot(formatId));
1592 DEBUG_CLIPRDR(
"hasCachedData: %u, rawTransfer: %d", cached_data ? 1u : 0u, rawTransfer);
1594 if (!cached_data && !rawTransfer)
1596 UINT32 srcFormatId = 0;
1597 BOOL nullTerminated = FALSE;
1598 xfCachedData* cached_raw_data =
nullptr;
1600 get_src_format_info_for_local_request(clipboard, cformat, &srcFormatId,
1603 HashTable_GetItemValue(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId);
1605 DEBUG_CLIPRDR(
"hasCachedRawData: %u, rawDataLength: %u", cached_raw_data ? 1u : 0u,
1606 cached_raw_data ? cached_raw_data->data_length : 0);
1608 if (cached_raw_data && cached_raw_data->data_length != 0)
1609 cached_data = convert_data_from_existing_raw_data(
1610 clipboard, cached_raw_data, srcFormatId, nullTerminated, dstFormatId);
1613 DEBUG_CLIPRDR(
"hasCachedData: %u", cached_data ? 1u : 0u);
1618 respond->property = xevent->property;
1621 xf_cliprdr_provide_data(clipboard, respond, cached_data->data,
1622 cached_data->data_length);
1624 else if (clipboard->respond)
1630 WINPR_ASSERT(cformat);
1636 respond->property = xevent->property;
1637 clipboard->respond = respond;
1638 requested_format_replace(&clipboard->requestedFormat, formatId, dstFormatId,
1639 cformat->formatName);
1640 clipboard->data_raw_format = rawTransfer;
1641 delayRespond = TRUE;
1642 xf_cliprdr_send_data_request(clipboard, formatId, cformat);
1644 HashTable_Unlock(table);
1653 XSelectionEvent* sev;
1657 LogDynAndXSendEvent(xfc->log, xfc->display, xevent->requestor, 0, 0, conv.ev);
1658 LogDynAndXFlush(xfc->log, xfc->display);
1665static BOOL xf_cliprdr_process_selection_clear(xfClipboard* clipboard,
1666 const XSelectionClearEvent* xevent)
1668 xfContext* xfc =
nullptr;
1670 WINPR_ASSERT(clipboard);
1671 WINPR_ASSERT(xevent);
1673 xfc = clipboard->xfc;
1676 WINPR_UNUSED(xevent);
1678 if (xf_cliprdr_is_self_owned(clipboard))
1681 LogDynAndXDeleteProperty(xfc->log, xfc->display, clipboard->root_window,
1682 clipboard->property_atom);
1686static BOOL xf_cliprdr_process_property_notify(xfClipboard* clipboard,
const XPropertyEvent* xevent)
1688 const xfCliprdrFormat* format =
nullptr;
1689 xfContext* xfc =
nullptr;
1694 xfc = clipboard->xfc;
1696 WINPR_ASSERT(xevent);
1698 if (xevent->atom == clipboard->timestamp_property_atom)
1704 xf_cliprdr_set_selection_owner(xfc, clipboard, xevent->time);
1708 if (xevent->atom != clipboard->property_atom)
1711 if (xevent->window == clipboard->root_window)
1713 xf_cliprdr_send_client_format_list(clipboard, FALSE);
1715 else if ((xevent->window == xfc->drawable) && (xevent->state == PropertyNewValue) &&
1716 clipboard->incr_starts)
1718 format = xf_cliprdr_get_client_format_by_id(clipboard, clipboard->requestedFormatId);
1721 xf_cliprdr_get_requested_data(clipboard, format->atom);
1727void xf_cliprdr_handle_xevent(xfContext* xfc,
const XEvent* event)
1729 xfClipboard* clipboard =
nullptr;
1734 clipboard = xfc->clipboard;
1741 if (clipboard->xfixes_supported &&
1742 event->type == XFixesSelectionNotify + clipboard->xfixes_event_base)
1744 const XFixesSelectionNotifyEvent* se = (
const XFixesSelectionNotifyEvent*)event;
1746 if (se->subtype == XFixesSetSelectionOwnerNotify)
1748 if (se->selection != clipboard->clipboard_atom)
1751 if (LogDynAndXGetSelectionOwner(xfc->log, xfc->display, se->selection) == xfc->drawable)
1754 clipboard->owner = None;
1755 xf_cliprdr_check_owner(clipboard);
1763 switch (event->type)
1765 case SelectionNotify:
1766 log_selection_event(xfc, event);
1767 xf_cliprdr_process_selection_notify(clipboard, &event->xselection);
1770 case SelectionRequest:
1771 log_selection_event(xfc, event);
1772 xf_cliprdr_process_selection_request(clipboard, &event->xselectionrequest);
1775 case SelectionClear:
1776 log_selection_event(xfc, event);
1777 xf_cliprdr_process_selection_clear(clipboard, &event->xselectionclear);
1780 case PropertyNotify:
1781 log_selection_event(xfc, event);
1782 xf_cliprdr_process_property_notify(clipboard, &event->xproperty);
1786 if (!clipboard->xfixes_supported)
1788 xf_cliprdr_check_owner(clipboard);
1802static UINT xf_cliprdr_send_client_capabilities(xfClipboard* clipboard)
1807 WINPR_ASSERT(clipboard);
1809 capabilities.cCapabilitiesSets = 1;
1811 generalCapabilitySet.capabilitySetType = CB_CAPSTYPE_GENERAL;
1812 generalCapabilitySet.capabilitySetLength = 12;
1813 generalCapabilitySet.version = CB_CAPS_VERSION_2;
1814 generalCapabilitySet.generalFlags = CB_USE_LONG_FORMAT_NAMES;
1816 WINPR_ASSERT(clipboard);
1817 generalCapabilitySet.generalFlags |= cliprdr_file_context_current_flags(clipboard->file);
1819 WINPR_ASSERT(clipboard->context);
1820 WINPR_ASSERT(clipboard->context->ClientCapabilities);
1821 return clipboard->context->ClientCapabilities(clipboard->context, &capabilities);
1829static UINT xf_cliprdr_send_client_format_list(xfClipboard* clipboard, BOOL force)
1831 WINPR_ASSERT(clipboard);
1833 xfContext* xfc = clipboard->xfc;
1836 UINT32 numFormats = 0;
1837 CLIPRDR_FORMAT* formats = xf_cliprdr_get_client_formats(clipboard, &numFormats);
1839 const UINT ret = xf_cliprdr_send_format_list(clipboard, formats, numFormats, force);
1841 if (clipboard->owner && clipboard->owner != xfc->drawable)
1844 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom,
1845 clipboard->targets[1], clipboard->property_atom, xfc->drawable,
1849 xf_cliprdr_free_formats(formats, numFormats);
1859static UINT xf_cliprdr_send_client_format_list_response(xfClipboard* clipboard, BOOL status)
1863 formatListResponse.common.msgType = CB_FORMAT_LIST_RESPONSE;
1864 formatListResponse.common.msgFlags = status ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
1865 formatListResponse.common.dataLen = 0;
1867 WINPR_ASSERT(clipboard);
1868 WINPR_ASSERT(clipboard->context);
1869 WINPR_ASSERT(clipboard->context->ClientFormatListResponse);
1870 return clipboard->context->ClientFormatListResponse(clipboard->context, &formatListResponse);
1878static UINT xf_cliprdr_monitor_ready(CliprdrClientContext* context,
1881 WINPR_ASSERT(context);
1882 WINPR_ASSERT(monitorReady);
1884 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
1885 WINPR_ASSERT(clipboard);
1887 WINPR_UNUSED(monitorReady);
1889 const UINT ret = xf_cliprdr_send_client_capabilities(clipboard);
1890 if (ret != CHANNEL_RC_OK)
1893 xf_clipboard_formats_free(clipboard);
1895 const UINT ret2 = xf_cliprdr_send_client_format_list(clipboard, TRUE);
1896 if (ret2 != CHANNEL_RC_OK)
1899 clipboard->sync = TRUE;
1900 return CHANNEL_RC_OK;
1908static UINT xf_cliprdr_server_capabilities(CliprdrClientContext* context,
1911 WINPR_ASSERT(context);
1912 WINPR_ASSERT(capabilities);
1914 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
1915 WINPR_ASSERT(clipboard);
1917 const BYTE* capsPtr = (
const BYTE*)capabilities->capabilitySets;
1918 WINPR_ASSERT(capsPtr);
1920 if (!cliprdr_file_context_remote_set_flags(clipboard->file, 0))
1921 return ERROR_INTERNAL_ERROR;
1923 for (UINT32 i = 0; i < capabilities->cCapabilitiesSets; i++)
1927 if (caps->capabilitySetType == CB_CAPSTYPE_GENERAL)
1932 if (!cliprdr_file_context_remote_set_flags(clipboard->file, generalCaps->generalFlags))
1933 return ERROR_INTERNAL_ERROR;
1936 capsPtr += caps->capabilitySetLength;
1939 return CHANNEL_RC_OK;
1942static void xf_cliprdr_prepare_to_set_selection_owner(xfContext* xfc, xfClipboard* clipboard)
1945 WINPR_ASSERT(clipboard);
1962 Atom value = clipboard->timestamp_property_atom;
1964 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable,
1965 clipboard->timestamp_property_atom, XA_ATOM, 32, PropModeReplace,
1966 (
const BYTE*)&value, 1);
1967 LogDynAndXFlush(xfc->log, xfc->display);
1970static void xf_cliprdr_set_selection_owner(xfContext* xfc, xfClipboard* clipboard, Time timestamp)
1973 WINPR_ASSERT(clipboard);
1979 clipboard->selection_ownership_timestamp = timestamp;
1980 LogDynAndXSetSelectionOwner(xfc->log, xfc->display, clipboard->clipboard_atom, xfc->drawable,
1982 LogDynAndXFlush(xfc->log, xfc->display);
1990static UINT xf_cliprdr_server_format_list(CliprdrClientContext* context,
1993 xfContext* xfc =
nullptr;
1995 xfClipboard* clipboard =
nullptr;
1997 WINPR_ASSERT(context);
1998 WINPR_ASSERT(formatList);
2000 clipboard = cliprdr_file_context_get_context(context->custom);
2001 WINPR_ASSERT(clipboard);
2003 xfc = clipboard->xfc;
2009 free(clipboard->respond);
2010 clipboard->respond =
nullptr;
2012 xf_clipboard_formats_free(clipboard);
2013 xf_cliprdr_clear_cached_data(clipboard);
2014 requested_format_free(&clipboard->requestedFormat);
2016 xf_clipboard_free_server_formats(clipboard);
2018 clipboard->numServerFormats = formatList->numFormats + 1;
2020 if (!(clipboard->serverFormats =
2023 WLog_ERR(TAG,
"failed to allocate %" PRIu32
" CLIPRDR_FORMAT structs",
2024 clipboard->numServerFormats);
2025 ret = CHANNEL_RC_NO_MEMORY;
2029 for (
size_t i = 0; i < formatList->numFormats; i++)
2034 srvFormat->formatId = format->formatId;
2036 if (format->formatName)
2038 srvFormat->formatName = _strdup(format->formatName);
2040 if (!srvFormat->formatName)
2042 for (UINT32 k = 0; k < i; k++)
2043 free(clipboard->serverFormats[k].formatName);
2045 clipboard->numServerFormats = 0;
2046 free(clipboard->serverFormats);
2047 clipboard->serverFormats =
nullptr;
2048 ret = CHANNEL_RC_NO_MEMORY;
2054 ClipboardLock(clipboard->system);
2055 ret = cliprdr_file_context_notify_new_server_format_list(clipboard->file);
2056 ClipboardUnlock(clipboard->system);
2062 CLIPRDR_FORMAT* format = &clipboard->serverFormats[formatList->numFormats];
2063 format->formatId = CF_RAW;
2064 format->formatName =
nullptr;
2066 xf_cliprdr_provide_server_format_list(clipboard);
2067 clipboard->numTargets = 2;
2069 for (
size_t i = 0; i < formatList->numFormats; i++)
2073 for (
size_t j = 0; j < clipboard->numClientFormats; j++)
2075 const xfCliprdrFormat* clientFormat = &clipboard->clientFormats[j];
2076 if (xf_cliprdr_formats_equal(format, clientFormat))
2078 if ((clientFormat->formatName !=
nullptr) &&
2079 (strcmp(type_FileGroupDescriptorW, clientFormat->formatName) == 0))
2081 if (!cliprdr_file_context_has_local_support(clipboard->file))
2084 xf_cliprdr_append_target(clipboard, clientFormat->atom);
2089 ret = xf_cliprdr_send_client_format_list_response(clipboard, TRUE);
2090 if (xfc->remote_app)
2091 xf_cliprdr_set_selection_owner(xfc, clipboard, CurrentTime);
2093 xf_cliprdr_prepare_to_set_selection_owner(xfc, clipboard);
2106static UINT xf_cliprdr_server_format_list_response(
2107 WINPR_ATTR_UNUSED CliprdrClientContext* context,
2110 WINPR_ASSERT(context);
2111 WINPR_ASSERT(formatListResponse);
2113 return CHANNEL_RC_OK;
2122xf_cliprdr_server_format_data_request(CliprdrClientContext* context,
2125 const xfCliprdrFormat* format =
nullptr;
2127 WINPR_ASSERT(context);
2128 WINPR_ASSERT(formatDataRequest);
2130 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2131 WINPR_ASSERT(clipboard);
2133 xfContext* xfc = clipboard->xfc;
2136 const uint32_t formatId = formatDataRequest->requestedFormatId;
2138 const BOOL rawTransfer = xf_cliprdr_is_raw_transfer_available(clipboard);
2142 format = xf_cliprdr_get_client_format_by_id(clipboard, CF_RAW);
2143 LogDynAndXChangeProperty(xfc->log, xfc->display, xfc->drawable, clipboard->property_atom,
2144 XA_INTEGER, 32, PropModeReplace, (
const BYTE*)&formatId, 1);
2147 format = xf_cliprdr_get_client_format_by_id(clipboard, formatId);
2149 clipboard->requestedFormatId = rawTransfer ? CF_RAW : formatId;
2151 return xf_cliprdr_send_data_response(clipboard, format,
nullptr, 0);
2153 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2154 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2155 format->localFormat,
2156 ClipboardGetFormatName(clipboard->system, format->localFormat),
2157 format->formatName);
2158 LogDynAndXConvertSelection(xfc->log, xfc->display, clipboard->clipboard_atom, format->atom,
2159 clipboard->property_atom, xfc->drawable, CurrentTime);
2160 LogDynAndXFlush(xfc->log, xfc->display);
2162 return CHANNEL_RC_OK;
2171xf_cliprdr_server_format_data_response(CliprdrClientContext* context,
2175 BYTE* pDstData =
nullptr;
2178 UINT32 srcFormatId = 0;
2179 UINT32 dstFormatId = 0;
2180 BOOL nullTerminated = FALSE;
2181 xfCachedData* cached_data =
nullptr;
2183 WINPR_ASSERT(context);
2184 WINPR_ASSERT(formatDataResponse);
2186 xfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
2187 WINPR_ASSERT(clipboard);
2189 xfContext* xfc = clipboard->xfc;
2192 const UINT32 size = formatDataResponse->common.dataLen;
2193 const BYTE* data = formatDataResponse->requestedFormatData;
2195 if (formatDataResponse->common.msgFlags == CB_RESPONSE_FAIL)
2197 WLog_WARN(TAG,
"Format Data Response PDU msgFlags is CB_RESPONSE_FAIL");
2198 free(clipboard->respond);
2199 clipboard->respond =
nullptr;
2200 return CHANNEL_RC_OK;
2203 if (!clipboard->respond)
2204 return CHANNEL_RC_OK;
2206 const RequestedFormat* format = clipboard->requestedFormat;
2207 if (clipboard->data_raw_format)
2209 srcFormatId = CF_RAW;
2210 dstFormatId = CF_RAW;
2213 return ERROR_INTERNAL_ERROR;
2214 else if (format->formatName)
2216 dstFormatId = format->localFormat;
2218 ClipboardLock(clipboard->system);
2219 if (strcmp(format->formatName, type_HtmlFormat) == 0)
2221 srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
2222 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
2223 nullTerminated = TRUE;
2226 if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
2228 if (!cliprdr_file_context_update_server_data(clipboard->file, clipboard->system, data,
2230 WLog_WARN(TAG,
"failed to update file descriptors");
2232 srcFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2233 const xfCliprdrFormat* dstTargetFormat =
2234 xf_cliprdr_get_client_format_by_atom(clipboard, clipboard->respond->target);
2235 if (!dstTargetFormat)
2237 dstFormatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2241 dstFormatId = dstTargetFormat->localFormat;
2244 nullTerminated = TRUE;
2246 ClipboardUnlock(clipboard->system);
2250 srcFormatId = format->formatToRequest;
2251 dstFormatId = format->localFormat;
2252 switch (format->formatToRequest)
2255 nullTerminated = TRUE;
2259 nullTerminated = TRUE;
2262 case CF_UNICODETEXT:
2263 nullTerminated = TRUE;
2267 srcFormatId = CF_DIB;
2271 srcFormatId = CF_TIFF;
2279 DEBUG_CLIPRDR(
"requested format 0x%08" PRIx32
" [%s] {local 0x%08" PRIx32
" [%s]} [%s]",
2280 format->formatToRequest, ClipboardGetFormatIdString(format->formatToRequest),
2281 format->localFormat,
2282 ClipboardGetFormatName(clipboard->system, format->localFormat),
2283 format->formatName);
2286 DEBUG_CLIPRDR(
"srcFormatId: 0x%08" PRIx32
", dstFormatId: 0x%08" PRIx32
"", srcFormatId,
2289 ClipboardLock(clipboard->system);
2290 bSuccess = ClipboardSetData(clipboard->system, srcFormatId, data, SrcSize);
2292 BOOL willQuit = FALSE;
2297 WLog_DBG(TAG,
"skipping, empty data detected!");
2298 free(clipboard->respond);
2299 clipboard->respond =
nullptr;
2304 pDstData = (BYTE*)ClipboardGetData(clipboard->system, dstFormatId, &DstSize);
2308 WLog_WARN(TAG,
"failed to get clipboard data in format %s [source format %s]",
2309 ClipboardGetFormatName(clipboard->system, dstFormatId),
2310 ClipboardGetFormatName(clipboard->system, srcFormatId));
2313 if (nullTerminated && pDstData)
2315 BYTE* nullTerminator = memchr(pDstData,
'\0', DstSize);
2318 const intptr_t diff = nullTerminator - pDstData;
2319 WINPR_ASSERT(diff >= 0);
2320 WINPR_ASSERT(diff <= UINT32_MAX);
2321 DstSize = (UINT32)diff;
2326 ClipboardUnlock(clipboard->system);
2328 return CHANNEL_RC_OK;
2334 cached_data = xf_cached_data_new(pDstData, DstSize);
2337 WLog_WARN(TAG,
"Failed to allocate cache entry");
2339 return CHANNEL_RC_OK;
2341 if (!HashTable_Insert(clipboard->cachedData, format_to_cache_slot(dstFormatId),
2344 WLog_WARN(TAG,
"Failed to cache clipboard data");
2345 xf_cached_data_free(cached_data);
2346 return CHANNEL_RC_OK;
2356 xfCachedData* cached_raw_data = xf_cached_data_new_copy(data, size);
2357 if (!cached_raw_data)
2358 WLog_WARN(TAG,
"Failed to allocate cache entry");
2361 if (!HashTable_Insert(clipboard->cachedRawData, (
void*)(UINT_PTR)srcFormatId,
2364 WLog_WARN(TAG,
"Failed to cache clipboard data");
2365 xf_cached_data_free(cached_raw_data);
2372 xf_cliprdr_provide_data(clipboard, clipboard->respond, pDstData, DstSize);
2377 XSelectionEvent* sev;
2380 conv.sev = clipboard->respond;
2382 LogDynAndXSendEvent(xfc->log, xfc->display, clipboard->respond->requestor, 0, 0, conv.ev);
2383 LogDynAndXFlush(xfc->log, xfc->display);
2385 free(clipboard->respond);
2386 clipboard->respond =
nullptr;
2387 return CHANNEL_RC_OK;
2390static BOOL xf_cliprdr_is_valid_unix_filename(LPCWSTR filename)
2395 if (filename[0] == L
'\0')
2399 for (
const WCHAR* c = filename; *c; ++c)
2408xfClipboard* xf_clipboard_new(xfContext* xfc, BOOL relieveFilenameRestriction)
2411 rdpChannels* channels =
nullptr;
2412 xfClipboard* clipboard =
nullptr;
2413 const char* selectionAtom =
nullptr;
2414 xfCliprdrFormat* clientFormat =
nullptr;
2418 WINPR_ASSERT(xfc->common.context.settings);
2420 if (!(clipboard = (xfClipboard*)calloc(1,
sizeof(xfClipboard))))
2422 WLog_ERR(TAG,
"failed to allocate xfClipboard data");
2426 clipboard->file = cliprdr_file_context_new(clipboard);
2427 if (!clipboard->file)
2430 xfc->clipboard = clipboard;
2431 clipboard->xfc = xfc;
2432 channels = xfc->common.context.channels;
2433 clipboard->channels = channels;
2434 clipboard->system = ClipboardCreate();
2435 clipboard->requestedFormatId = UINT32_MAX;
2436 clipboard->root_window = DefaultRootWindow(xfc->display);
2441 selectionAtom =
"CLIPBOARD";
2443 clipboard->clipboard_atom = Logging_XInternAtom(xfc->log, xfc->display, selectionAtom, FALSE);
2445 if (clipboard->clipboard_atom == None)
2447 WLog_ERR(TAG,
"unable to get %s atom", selectionAtom);
2451 clipboard->timestamp_property_atom =
2452 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_TIMESTAMP_PROPERTY", FALSE);
2453 clipboard->property_atom =
2454 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR", FALSE);
2455 clipboard->raw_transfer_atom =
2456 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_RAW", FALSE);
2457 clipboard->raw_format_list_atom =
2458 Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_CLIPRDR_FORMATS", FALSE);
2459 xf_cliprdr_set_raw_transfer_enabled(clipboard, TRUE);
2460 XSelectInput(xfc->display, clipboard->root_window, PropertyChangeMask);
2463 if (XFixesQueryExtension(xfc->display, &clipboard->xfixes_event_base,
2464 &clipboard->xfixes_error_base))
2469 if (XFixesQueryVersion(xfc->display, &xfmajor, &xfminor))
2471 XFixesSelectSelectionInput(xfc->display, clipboard->root_window,
2472 clipboard->clipboard_atom,
2473 XFixesSetSelectionOwnerNotifyMask);
2474 clipboard->xfixes_supported = TRUE;
2478 WLog_ERR(TAG,
"Error querying X Fixes extension version");
2483 WLog_ERR(TAG,
"Error loading X Fixes extension");
2489 "Warning: Using clipboard redirection without XFIXES extension is strongly discouraged!");
2491 clientFormat = &clipboard->clientFormats[n++];
2492 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"_FREERDP_RAW", False);
2493 clientFormat->localFormat = clientFormat->formatToRequest = CF_RAW;
2495 clientFormat = &clipboard->clientFormats[n++];
2496 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display,
"UTF8_STRING", False);
2497 clientFormat->formatToRequest = CF_UNICODETEXT;
2498 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2500 clientFormat = &clipboard->clientFormats[n++];
2501 clientFormat->atom = XA_STRING;
2502 clientFormat->formatToRequest = CF_TEXT;
2503 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_text_plain);
2505 clientFormat = &clipboard->clientFormats[n++];
2506 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_tiff, False);
2507 clientFormat->formatToRequest = clientFormat->localFormat = CF_TIFF;
2509 for (
size_t x = 0; x < ARRAYSIZE(mime_bitmap); x++)
2511 const char* mime_bmp = mime_bitmap[x];
2512 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2515 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2519 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2520 clientFormat = &clipboard->clientFormats[n++];
2521 clientFormat->localFormat = format;
2522 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2523 clientFormat->formatToRequest = CF_DIB;
2524 clientFormat->isImage = TRUE;
2527 for (
size_t x = 0; x < ARRAYSIZE(mime_images); x++)
2529 const char* mime_bmp = mime_images[x];
2530 const DWORD format = ClipboardGetFormatId(xfc->clipboard->system, mime_bmp);
2533 WLog_DBG(TAG,
"skipping local bitmap format %s [NOT SUPPORTED]", mime_bmp);
2537 WLog_DBG(TAG,
"register local bitmap format %s [0x%08" PRIx32
"]", mime_bmp, format);
2538 clientFormat = &clipboard->clientFormats[n++];
2539 clientFormat->localFormat = format;
2540 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_bmp, False);
2541 clientFormat->formatToRequest = CF_DIB;
2542 clientFormat->isImage = TRUE;
2545 clientFormat = &clipboard->clientFormats[n++];
2546 clientFormat->atom = Logging_XInternAtom(xfc->log, xfc->display, mime_html, False);
2547 clientFormat->formatToRequest = ClipboardGetFormatId(xfc->clipboard->system, type_HtmlFormat);
2548 clientFormat->localFormat = ClipboardGetFormatId(xfc->clipboard->system, mime_html);
2549 clientFormat->formatName = _strdup(type_HtmlFormat);
2551 if (!clientFormat->formatName)
2554 clientFormat = &clipboard->clientFormats[n++];
2563 const UINT32 fgid = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
2565 const UINT32 uid = ClipboardGetFormatId(clipboard->system, mime_uri_list);
2568 if (!cliprdr_file_context_set_locally_available(clipboard->file, TRUE))
2570 clientFormat->atom =
2571 Logging_XInternAtom(xfc->log, xfc->display, mime_uri_list, False);
2572 clientFormat->localFormat = uid;
2573 clientFormat->formatToRequest = fgid;
2574 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2576 if (!clientFormat->formatName)
2579 clientFormat = &clipboard->clientFormats[n++];
2584 const UINT32 gid = ClipboardGetFormatId(clipboard->system, mime_gnome_copied_files);
2587 if (!cliprdr_file_context_set_locally_available(clipboard->file, TRUE))
2589 clientFormat->atom =
2590 Logging_XInternAtom(xfc->log, xfc->display, mime_gnome_copied_files, False);
2591 clientFormat->localFormat = gid;
2592 clientFormat->formatToRequest = fgid;
2593 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2595 if (!clientFormat->formatName)
2598 clientFormat = &clipboard->clientFormats[n++];
2603 const UINT32 mid = ClipboardGetFormatId(clipboard->system, mime_mate_copied_files);
2606 if (!cliprdr_file_context_set_locally_available(clipboard->file, TRUE))
2608 clientFormat->atom =
2609 Logging_XInternAtom(xfc->log, xfc->display, mime_mate_copied_files, False);
2610 clientFormat->localFormat = mid;
2611 clientFormat->formatToRequest = fgid;
2612 clientFormat->formatName = _strdup(type_FileGroupDescriptorW);
2614 if (!clientFormat->formatName)
2620 clipboard->numClientFormats = WINPR_ASSERTING_INT_CAST(uint32_t, n);
2621 clipboard->targets[0] = Logging_XInternAtom(xfc->log, xfc->display,
"TIMESTAMP", FALSE);
2622 clipboard->targets[1] = Logging_XInternAtom(xfc->log, xfc->display,
"TARGETS", FALSE);
2623 clipboard->numTargets = 2;
2624 clipboard->incr_atom = Logging_XInternAtom(xfc->log, xfc->display,
"INCR", FALSE);
2626 if (relieveFilenameRestriction)
2628 WLog_DBG(TAG,
"Relieving CLIPRDR filename restriction");
2629 ClipboardGetDelegate(clipboard->system)->IsFileNameComponentValid =
2630 xf_cliprdr_is_valid_unix_filename;
2633 clipboard->cachedData = HashTable_New(TRUE);
2634 if (!clipboard->cachedData)
2637 obj = HashTable_ValueObject(clipboard->cachedData);
2640 clipboard->cachedRawData = HashTable_New(TRUE);
2641 if (!clipboard->cachedRawData)
2644 obj = HashTable_ValueObject(clipboard->cachedRawData);
2650 WINPR_PRAGMA_DIAG_PUSH
2651 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
2652 xf_clipboard_free(clipboard);
2653 WINPR_PRAGMA_DIAG_POP
2657void xf_clipboard_free(xfClipboard* clipboard)
2662 xf_clipboard_free_server_formats(clipboard);
2664 if (clipboard->numClientFormats)
2666 for (UINT32 i = 0; i < clipboard->numClientFormats; i++)
2668 xfCliprdrFormat* format = &clipboard->clientFormats[i];
2669 free(format->formatName);
2673 cliprdr_file_context_free(clipboard->file);
2675 ClipboardDestroy(clipboard->system);
2676 xf_clipboard_formats_free(clipboard);
2677 HashTable_Free(clipboard->cachedRawData);
2678 HashTable_Free(clipboard->cachedData);
2679 requested_format_free(&clipboard->requestedFormat);
2680 free(clipboard->respond);
2681 free(clipboard->incr_data);
2685void xf_cliprdr_init(xfContext* xfc, CliprdrClientContext* cliprdr)
2688 WINPR_ASSERT(cliprdr);
2690 xfc->cliprdr = cliprdr;
2691 xfc->clipboard->context = cliprdr;
2693 cliprdr->MonitorReady = xf_cliprdr_monitor_ready;
2694 cliprdr->ServerCapabilities = xf_cliprdr_server_capabilities;
2695 cliprdr->ServerFormatList = xf_cliprdr_server_format_list;
2696 cliprdr->ServerFormatListResponse = xf_cliprdr_server_format_list_response;
2697 cliprdr->ServerFormatDataRequest = xf_cliprdr_server_format_data_request;
2698 cliprdr->ServerFormatDataResponse = xf_cliprdr_server_format_data_response;
2700 cliprdr_file_context_init(xfc->clipboard->file, cliprdr);
2703void xf_cliprdr_uninit(xfContext* xfc, CliprdrClientContext* cliprdr)
2706 WINPR_ASSERT(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