21#include <freerdp/config.h>
26#include <winpr/image.h>
27#include <winpr/stream.h>
28#include <winpr/clipboard.h>
30#include <freerdp/log.h>
31#include <freerdp/client/cliprdr.h>
32#include <freerdp/channels/channels.h>
33#include <freerdp/channels/cliprdr.h>
35#include <freerdp/client/client_cliprdr_file.h>
37#include "wlf_cliprdr.h"
39#define TAG CLIENT_TAG("wayland.cliprdr")
41#define mime_text_plain "text/plain"
43static const char mime_text_utf8[] = mime_text_plain
";charset=utf-8";
46static const char* mime_text[] = { mime_text_plain, mime_text_utf8,
"UTF8_STRING",
47 "COMPOUND_TEXT",
"TEXT",
"STRING" };
49static const char mime_png[] =
"image/png";
50static const char mime_webp[] =
"image/webp";
51static const char mime_jpg[] =
"image/jpeg";
52static const char mime_tiff[] =
"image/tiff";
53static const char mime_uri_list[] =
"text/uri-list";
54static const char mime_html[] =
"text/html";
56#define BMP_MIME_LIST "image/bmp", "image/x-bmp", "image/x-MS-bmp", "image/x-win-bitmap"
57static const char* mime_bitmap[] = { BMP_MIME_LIST };
58static const char* mime_image[] = { mime_png, mime_webp, mime_jpg, mime_tiff, BMP_MIME_LIST };
60static const char mime_gnome_copied_files[] =
"x-special/gnome-copied-files";
61static const char mime_mate_copied_files[] =
"x-special/mate-copied-files";
63static const char type_FileGroupDescriptorW[] =
"FileGroupDescriptorW";
64static const char type_HtmlFormat[] =
"HTML Format";
69 UINT32 responseFormat;
75 const FILE* responseFile;
76 UINT32 responseFormat;
77 const char* responseMime;
83 rdpChannels* channels;
84 CliprdrClientContext* context;
90 size_t numClientFormats;
93 size_t numServerFormats;
99 CliprdrFileContext* file;
101 wQueue* request_queue;
104static void wlf_request_free(
void* rq)
106 wlf_request* request = rq;
109 free(request->responseMime);
110 if (request->responseFile)
111 (void)fclose(request->responseFile);
116static wlf_request* wlf_request_new(
void)
118 return calloc(1,
sizeof(wlf_request));
121static void* wlf_request_clone(
const void* oth)
123 const wlf_request* other = (
const wlf_request*)oth;
124 wlf_request* copy = wlf_request_new();
128 if (other->responseMime)
130 copy->responseMime = _strdup(other->responseMime);
131 if (!copy->responseMime)
136 wlf_request_free(copy);
140static BOOL wlf_mime_is_file(
const char* mime)
142 if (strncmp(mime_uri_list, mime,
sizeof(mime_uri_list)) == 0)
144 if (strncmp(mime_gnome_copied_files, mime,
sizeof(mime_gnome_copied_files)) == 0)
146 if (strncmp(mime_mate_copied_files, mime,
sizeof(mime_mate_copied_files)) == 0)
151static BOOL wlf_mime_is_text(
const char* mime)
153 for (
size_t x = 0; x < ARRAYSIZE(mime_text); x++)
155 if (strcmp(mime, mime_text[x]) == 0)
162static BOOL wlf_mime_is_image(
const char* mime)
164 for (
size_t x = 0; x < ARRAYSIZE(mime_image); x++)
166 if (strcmp(mime, mime_image[x]) == 0)
173static BOOL wlf_mime_is_html(
const char* mime)
175 if (strcmp(mime, mime_html) == 0)
181static void wlf_cliprdr_free_server_formats(wfClipboard* clipboard)
183 if (clipboard && clipboard->serverFormats)
185 for (
size_t j = 0; j < clipboard->numServerFormats; j++)
188 free(format->formatName);
191 free(clipboard->serverFormats);
192 clipboard->serverFormats = NULL;
193 clipboard->numServerFormats = 0;
197 UwacClipboardOfferDestroy(clipboard->seat);
200static void wlf_cliprdr_free_client_formats(wfClipboard* clipboard)
202 if (clipboard && clipboard->numClientFormats)
204 for (
size_t j = 0; j < clipboard->numClientFormats; j++)
207 free(format->formatName);
210 free(clipboard->clientFormats);
211 clipboard->clientFormats = NULL;
212 clipboard->numClientFormats = 0;
216 UwacClipboardOfferDestroy(clipboard->seat);
224static UINT wlf_cliprdr_send_client_format_list(wfClipboard* clipboard)
226 WINPR_ASSERT(clipboard);
229 .numFormats = (UINT32)clipboard->numClientFormats,
230 .formats = clipboard->clientFormats,
231 .common.msgType = CB_FORMAT_LIST };
233 cliprdr_file_context_clear(clipboard->file);
235 WLog_VRB(TAG,
"-------------- client format list [%" PRIu32
"] ------------------",
236 formatList.numFormats);
237 for (UINT32 x = 0; x < formatList.numFormats; x++)
240 WLog_VRB(TAG,
"client announces %" PRIu32
" [%s][%s]", format->formatId,
241 ClipboardGetFormatIdString(format->formatId), format->formatName);
243 WINPR_ASSERT(clipboard->context);
244 WINPR_ASSERT(clipboard->context->ClientFormatList);
245 return clipboard->context->ClientFormatList(clipboard->context, &formatList);
248static void wfl_cliprdr_add_client_format_id(wfClipboard* clipboard, UINT32 formatId)
251 const char* name = ClipboardGetFormatName(clipboard->system, formatId);
253 for (
size_t x = 0; x < clipboard->numClientFormats; x++)
255 format = &clipboard->clientFormats[x];
257 if (format->formatId == formatId)
261 format = realloc(clipboard->clientFormats,
267 clipboard->clientFormats = format;
268 format = &clipboard->clientFormats[clipboard->numClientFormats++];
269 format->formatId = formatId;
270 format->formatName = NULL;
272 if (name && (formatId >= CF_MAX))
273 format->formatName = _strdup(name);
276static BOOL wlf_cliprdr_add_client_format(wfClipboard* clipboard,
const char* mime)
279 ClipboardLock(clipboard->system);
280 if (wlf_mime_is_html(mime))
282 UINT32 formatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
283 wfl_cliprdr_add_client_format_id(clipboard, formatId);
285 else if (wlf_mime_is_text(mime))
287 wfl_cliprdr_add_client_format_id(clipboard, CF_TEXT);
288 wfl_cliprdr_add_client_format_id(clipboard, CF_OEMTEXT);
289 wfl_cliprdr_add_client_format_id(clipboard, CF_UNICODETEXT);
291 else if (wlf_mime_is_image(mime))
293 for (
size_t x = 0; x < ARRAYSIZE(mime_image); x++)
295 const char* mime_bmp = mime_image[x];
296 UINT32 formatId = ClipboardGetFormatId(clipboard->system, mime_bmp);
298 wfl_cliprdr_add_client_format_id(clipboard, formatId);
300 wfl_cliprdr_add_client_format_id(clipboard, CF_DIB);
301 wfl_cliprdr_add_client_format_id(clipboard, CF_TIFF);
303 else if (wlf_mime_is_file(mime))
305 const UINT32 fileFormatId =
306 ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
307 wfl_cliprdr_add_client_format_id(clipboard, fileFormatId);
310 ClipboardUnlock(clipboard->system);
311 if (wlf_cliprdr_send_client_format_list(clipboard) != CHANNEL_RC_OK)
321static UINT wlf_cliprdr_send_data_request(wfClipboard* clipboard,
const wlf_const_request* rq)
327 if (!Queue_Enqueue(clipboard->request_queue, rq))
328 return ERROR_INTERNAL_ERROR;
330 WINPR_ASSERT(clipboard);
331 WINPR_ASSERT(clipboard->context);
332 WINPR_ASSERT(clipboard->context->ClientFormatDataRequest);
333 return clipboard->context->ClientFormatDataRequest(clipboard->context, &request);
341static UINT wlf_cliprdr_send_data_response(wfClipboard* clipboard,
const BYTE* data,
size_t size)
345 if (size > UINT32_MAX)
346 return ERROR_INVALID_PARAMETER;
348 response.common.msgFlags = (data) ? CB_RESPONSE_OK : CB_RESPONSE_FAIL;
349 response.common.dataLen = (UINT32)size;
350 response.requestedFormatData = data;
352 WINPR_ASSERT(clipboard);
353 WINPR_ASSERT(clipboard->context);
354 WINPR_ASSERT(clipboard->context->ClientFormatDataResponse);
355 return clipboard->context->ClientFormatDataResponse(clipboard->context, &response);
358BOOL wlf_cliprdr_handle_event(wfClipboard* clipboard,
const UwacClipboardEvent* event)
360 if (!clipboard || !event)
363 if (!clipboard->context)
368 case UWAC_EVENT_CLIPBOARD_AVAILABLE:
369 clipboard->seat =
event->seat;
372 case UWAC_EVENT_CLIPBOARD_OFFER:
373 WLog_Print(clipboard->log, WLOG_DEBUG,
"client announces mime %s", event->mime);
374 return wlf_cliprdr_add_client_format(clipboard, event->mime);
376 case UWAC_EVENT_CLIPBOARD_SELECT:
377 WLog_Print(clipboard->log, WLOG_DEBUG,
"client announces new data");
378 wlf_cliprdr_free_client_formats(clipboard);
391static UINT wlf_cliprdr_send_client_capabilities(wfClipboard* clipboard)
393 WINPR_ASSERT(clipboard);
396 .capabilitySetType = CB_CAPSTYPE_GENERAL,
397 .capabilitySetLength = 12,
398 .version = CB_CAPS_VERSION_2,
400 CB_USE_LONG_FORMAT_NAMES | cliprdr_file_context_current_flags(clipboard->file)
406 WINPR_ASSERT(clipboard);
407 WINPR_ASSERT(clipboard->context);
408 WINPR_ASSERT(clipboard->context->ClientCapabilities);
409 return clipboard->context->ClientCapabilities(clipboard->context, &capabilities);
417static UINT wlf_cliprdr_send_client_format_list_response(wfClipboard* clipboard, BOOL status)
420 .common.msgType = CB_FORMAT_LIST_RESPONSE,
421 .common.msgFlags = status ? CB_RESPONSE_OK : CB_RESPONSE_FAIL,
424 WINPR_ASSERT(clipboard);
425 WINPR_ASSERT(clipboard->context);
426 WINPR_ASSERT(clipboard->context->ClientFormatListResponse);
427 return clipboard->context->ClientFormatListResponse(clipboard->context, &formatListResponse);
435static UINT wlf_cliprdr_monitor_ready(CliprdrClientContext* context,
440 WINPR_UNUSED(monitorReady);
441 WINPR_ASSERT(context);
442 WINPR_ASSERT(monitorReady);
444 wfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
445 WINPR_ASSERT(clipboard);
447 if ((ret = wlf_cliprdr_send_client_capabilities(clipboard)) != CHANNEL_RC_OK)
450 if ((ret = wlf_cliprdr_send_client_format_list(clipboard)) != CHANNEL_RC_OK)
453 clipboard->sync = TRUE;
454 return CHANNEL_RC_OK;
462static UINT wlf_cliprdr_server_capabilities(CliprdrClientContext* context,
465 WINPR_ASSERT(context);
466 WINPR_ASSERT(capabilities);
468 const BYTE* capsPtr = (
const BYTE*)capabilities->capabilitySets;
469 WINPR_ASSERT(capsPtr);
471 wfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
472 WINPR_ASSERT(clipboard);
474 if (!cliprdr_file_context_remote_set_flags(clipboard->file, 0))
475 return ERROR_INTERNAL_ERROR;
477 for (UINT32 i = 0; i < capabilities->cCapabilitiesSets; i++)
481 if (caps->capabilitySetType == CB_CAPSTYPE_GENERAL)
486 if (!cliprdr_file_context_remote_set_flags(clipboard->file, generalCaps->generalFlags))
487 return ERROR_INTERNAL_ERROR;
490 capsPtr += caps->capabilitySetLength;
493 return CHANNEL_RC_OK;
496static UINT32 wlf_get_server_format_id(
const wfClipboard* clipboard,
const char* name)
498 WINPR_ASSERT(clipboard);
501 for (UINT32 x = 0; x < clipboard->numServerFormats; x++)
504 if (!format->formatName)
506 if (strcmp(name, format->formatName) == 0)
507 return format->formatId;
512static const char* wlf_get_server_format_name(
const wfClipboard* clipboard, UINT32 formatId)
514 WINPR_ASSERT(clipboard);
516 for (UINT32 x = 0; x < clipboard->numServerFormats; x++)
519 if (format->formatId == formatId)
520 return format->formatName;
525static void wlf_cliprdr_transfer_data(UwacSeat* seat,
void* context,
const char* mime,
int fd)
527 wfClipboard* clipboard = (wfClipboard*)context;
530 EnterCriticalSection(&clipboard->lock);
532 wlf_const_request request = { 0 };
533 if (wlf_mime_is_html(mime))
535 request.responseMime = mime_html;
536 request.responseFormat = wlf_get_server_format_id(clipboard, type_HtmlFormat);
538 else if (wlf_mime_is_file(mime))
540 request.responseMime = mime;
541 request.responseFormat = wlf_get_server_format_id(clipboard, type_FileGroupDescriptorW);
543 else if (wlf_mime_is_text(mime))
545 request.responseMime = mime_text_plain;
546 request.responseFormat = CF_UNICODETEXT;
548 else if (wlf_mime_is_image(mime))
550 request.responseMime = mime;
551 if (strcmp(mime, mime_tiff) == 0)
552 request.responseFormat = CF_TIFF;
554 request.responseFormat = CF_DIB;
557 if (request.responseMime != NULL)
559 request.responseFile = fdopen(fd,
"w");
561 if (request.responseFile)
562 wlf_cliprdr_send_data_request(clipboard, &request);
564 WLog_Print(clipboard->log, WLOG_ERROR,
565 "failed to open clipboard file descriptor for MIME %s",
566 request.responseMime);
569 LeaveCriticalSection(&clipboard->lock);
572static void wlf_cliprdr_cancel_data(UwacSeat* seat,
void* context)
574 wfClipboard* clipboard = (wfClipboard*)context;
577 WINPR_ASSERT(clipboard);
578 cliprdr_file_context_clear(clipboard->file);
589static UINT wlf_cliprdr_server_format_list(CliprdrClientContext* context,
597 if (!context || !context->custom)
598 return ERROR_INVALID_PARAMETER;
600 wfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
601 WINPR_ASSERT(clipboard);
603 wlf_cliprdr_free_server_formats(clipboard);
604 cliprdr_file_context_clear(clipboard->file);
606 if (!(clipboard->serverFormats =
609 WLog_Print(clipboard->log, WLOG_ERROR,
610 "failed to allocate %" PRIuz
" CLIPRDR_FORMAT structs",
611 clipboard->numServerFormats);
612 return CHANNEL_RC_NO_MEMORY;
615 clipboard->numServerFormats = formatList->numFormats;
617 if (!clipboard->seat)
619 WLog_Print(clipboard->log, WLOG_ERROR,
620 "clipboard->seat=NULL, check your client implementation");
621 return ERROR_INTERNAL_ERROR;
624 for (UINT32 i = 0; i < formatList->numFormats; i++)
628 srvFormat->formatId = format->formatId;
630 if (format->formatName)
632 srvFormat->formatName = _strdup(format->formatName);
634 if (!srvFormat->formatName)
636 wlf_cliprdr_free_server_formats(clipboard);
637 return CHANNEL_RC_NO_MEMORY;
641 if (format->formatName)
643 if (strcmp(format->formatName, type_HtmlFormat) == 0)
648 else if (strcmp(format->formatName, type_FileGroupDescriptorW) == 0)
656 switch (format->formatId)
676 UwacClipboardOfferCreate(clipboard->seat, mime_html);
679 if (file && cliprdr_file_context_has_local_support(clipboard->file))
681 UwacClipboardOfferCreate(clipboard->seat, mime_uri_list);
682 UwacClipboardOfferCreate(clipboard->seat, mime_gnome_copied_files);
683 UwacClipboardOfferCreate(clipboard->seat, mime_mate_copied_files);
688 for (
size_t x = 0; x < ARRAYSIZE(mime_text); x++)
689 UwacClipboardOfferCreate(clipboard->seat, mime_text[x]);
694 for (
size_t x = 0; x < ARRAYSIZE(mime_image); x++)
695 UwacClipboardOfferCreate(clipboard->seat, mime_image[x]);
698 UwacClipboardOfferAnnounce(clipboard->seat, clipboard, wlf_cliprdr_transfer_data,
699 wlf_cliprdr_cancel_data);
700 return wlf_cliprdr_send_client_format_list_response(clipboard, TRUE);
709wlf_cliprdr_server_format_list_response(WINPR_ATTR_UNUSED CliprdrClientContext* context,
712 WINPR_ASSERT(context);
713 WINPR_ASSERT(formatListResponse);
715 if (formatListResponse->common.msgFlags & CB_RESPONSE_FAIL)
716 WLog_WARN(TAG,
"format list update failed");
717 return CHANNEL_RC_OK;
726wlf_cliprdr_server_format_data_request(CliprdrClientContext* context,
729 UINT rc = CHANNEL_RC_OK;
732 const char* mime = NULL;
734 UINT32 localFormatId = 0;
735 wfClipboard* clipboard = 0;
740 WINPR_ASSERT(context);
741 WINPR_ASSERT(formatDataRequest);
743 localFormatId = formatId = formatDataRequest->requestedFormatId;
744 clipboard = cliprdr_file_context_get_context(context->custom);
745 WINPR_ASSERT(clipboard);
747 ClipboardLock(clipboard->system);
748 const UINT32 fileFormatId = ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
749 const UINT32 htmlFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
756 localFormatId = ClipboardGetFormatId(clipboard->system, mime_text_plain);
757 mime = mime_text_utf8;
762 mime = mime_bitmap[0];
770 if (formatId == fileFormatId)
772 localFormatId = ClipboardGetFormatId(clipboard->system, mime_uri_list);
773 mime = mime_uri_list;
775 else if (formatId == htmlFormatId)
777 localFormatId = ClipboardGetFormatId(clipboard->system, mime_html);
785 data = UwacClipboardDataGet(clipboard->seat, mime, &size);
787 if (!data || (size > UINT32_MAX))
790 if (fileFormatId == formatId)
792 if (!cliprdr_file_context_update_client_data(clipboard->file, data, size))
796 const BOOL res = ClipboardSetData(clipboard->system, localFormatId, data, (UINT32)size);
802 data = ClipboardGetData(clipboard->system, formatId, &len);
807 if (fileFormatId == formatId)
809 const UINT32 flags = cliprdr_file_context_remote_get_flags(clipboard->file);
810 const UINT32 error = cliprdr_serialize_file_list_ex(
816 ClipboardUnlock(clipboard->system);
817 rc = wlf_cliprdr_send_data_response(clipboard, ddata, dsize);
828wlf_cliprdr_server_format_data_response(CliprdrClientContext* context,
831 UINT rc = ERROR_INTERNAL_ERROR;
833 WINPR_ASSERT(context);
834 WINPR_ASSERT(formatDataResponse);
836 const UINT32 size = formatDataResponse->common.dataLen;
837 const BYTE* data = formatDataResponse->requestedFormatData;
839 wfClipboard* clipboard = cliprdr_file_context_get_context(context->custom);
840 WINPR_ASSERT(clipboard);
842 wlf_request* request = Queue_Dequeue(clipboard->request_queue);
847 if (formatDataResponse->common.msgFlags & CB_RESPONSE_FAIL)
849 WLog_WARN(TAG,
"clipboard data request for format %" PRIu32
" [%s], mime %s failed",
850 request->responseFormat, ClipboardGetFormatIdString(request->responseFormat),
851 request->responseMime);
854 rc = ERROR_INTERNAL_ERROR;
856 ClipboardLock(clipboard->system);
857 EnterCriticalSection(&clipboard->lock);
860 UINT32 srcFormatId = 0;
861 UINT32 dstFormatId = 0;
862 switch (request->responseFormat)
867 srcFormatId = request->responseFormat;
868 dstFormatId = ClipboardGetFormatId(clipboard->system, request->responseMime);
873 srcFormatId = request->responseFormat;
874 dstFormatId = ClipboardGetFormatId(clipboard->system, request->responseMime);
879 const char* name = wlf_get_server_format_name(clipboard, request->responseFormat);
882 if (strcmp(type_FileGroupDescriptorW, name) == 0)
885 ClipboardGetFormatId(clipboard->system, type_FileGroupDescriptorW);
886 dstFormatId = ClipboardGetFormatId(clipboard->system, request->responseMime);
888 if (!cliprdr_file_context_update_server_data(clipboard->file, clipboard->system,
892 else if (strcmp(type_HtmlFormat, name) == 0)
894 srcFormatId = ClipboardGetFormatId(clipboard->system, type_HtmlFormat);
895 dstFormatId = ClipboardGetFormatId(clipboard->system, request->responseMime);
904 const BOOL sres = ClipboardSetData(clipboard->system, srcFormatId, data, size);
906 cdata = ClipboardGetData(clipboard->system, dstFormatId, &len);
911 if (request->responseFile)
913 const size_t res = fwrite(cdata, 1, len, request->responseFile);
922 ClipboardUnlock(clipboard->system);
923 LeaveCriticalSection(&clipboard->lock);
925 wlf_request_free(request);
929wfClipboard* wlf_clipboard_new(
wlfContext* wfc)
931 rdpChannels* channels = NULL;
932 wfClipboard* clipboard = NULL;
936 clipboard = (wfClipboard*)calloc(1,
sizeof(wfClipboard));
941 InitializeCriticalSection(&clipboard->lock);
942 clipboard->wfc = wfc;
943 channels = wfc->common.context.channels;
944 clipboard->log = WLog_Get(TAG);
945 clipboard->channels = channels;
946 clipboard->system = ClipboardCreate();
947 if (!clipboard->system)
950 clipboard->file = cliprdr_file_context_new(clipboard);
951 if (!clipboard->file)
954 if (!cliprdr_file_context_set_locally_available(clipboard->file, TRUE))
957 clipboard->request_queue = Queue_New(TRUE, -1, -1);
958 if (!clipboard->request_queue)
961 wObject* obj = Queue_Object(clipboard->request_queue);
963 obj->fnObjectFree = wlf_request_free;
964 obj->fnObjectNew = wlf_request_clone;
969 wlf_clipboard_free(clipboard);
973void wlf_clipboard_free(wfClipboard* clipboard)
978 cliprdr_file_context_free(clipboard->file);
980 wlf_cliprdr_free_server_formats(clipboard);
981 wlf_cliprdr_free_client_formats(clipboard);
982 ClipboardDestroy(clipboard->system);
984 EnterCriticalSection(&clipboard->lock);
986 Queue_Free(clipboard->request_queue);
987 LeaveCriticalSection(&clipboard->lock);
988 DeleteCriticalSection(&clipboard->lock);
992BOOL wlf_cliprdr_init(wfClipboard* clipboard, CliprdrClientContext* cliprdr)
994 WINPR_ASSERT(clipboard);
995 WINPR_ASSERT(cliprdr);
997 clipboard->context = cliprdr;
998 cliprdr->MonitorReady = wlf_cliprdr_monitor_ready;
999 cliprdr->ServerCapabilities = wlf_cliprdr_server_capabilities;
1000 cliprdr->ServerFormatList = wlf_cliprdr_server_format_list;
1001 cliprdr->ServerFormatListResponse = wlf_cliprdr_server_format_list_response;
1002 cliprdr->ServerFormatDataRequest = wlf_cliprdr_server_format_data_request;
1003 cliprdr->ServerFormatDataResponse = wlf_cliprdr_server_format_data_response;
1005 return cliprdr_file_context_init(clipboard->file, cliprdr);
1008BOOL wlf_cliprdr_uninit(wfClipboard* clipboard, CliprdrClientContext* cliprdr)
1010 WINPR_ASSERT(clipboard);
1011 if (!cliprdr_file_context_uninit(clipboard->file, cliprdr))
1015 cliprdr->custom = NULL;
This struct contains function pointer to initialize/free objects.