FreeRDP
Loading...
Searching...
No Matches
sdl_clip.hpp
1
20
21#pragma once
22
23#include <utility>
24#include <vector>
25#include <atomic>
26#include <queue>
27#include <deque>
28#include <map>
29
30#include <winpr/wtypes.h>
31#include <freerdp/freerdp.h>
32#include <freerdp/client/client_cliprdr_file.h>
33#include <SDL3/SDL.h>
34
35#include "sdl_types.hpp"
36#include "sdl_utils.hpp"
37#include "sdl_web_clip_offers.hpp"
38
40class ClipRequest
41{
42 public:
43 ClipRequest(UINT32 format, const std::string& mime);
44 ClipRequest(const ClipRequest& other) = default;
45 ClipRequest(ClipRequest&& other) = default;
46 ~ClipRequest() = default;
47
48 ClipRequest& operator=(const ClipRequest& other) = delete;
49 ClipRequest& operator=(ClipRequest&& other) = delete;
50
51 [[nodiscard]] uint32_t format() const;
52 [[nodiscard]] std::string formatstr() const;
53 [[nodiscard]] std::string mime() const;
54 [[nodiscard]] bool success() const;
55 void setSuccess(bool status);
56
57 private:
58 uint32_t _format;
59 std::string _mime;
60 bool _success;
61};
62
63class CliprdrFormat
64{
65 public:
66 CliprdrFormat(uint32_t formatID, const char* formatName);
67
68 [[nodiscard]] uint32_t formatId() const;
69 [[nodiscard]] const char* formatName() const;
70
71 private:
72 uint32_t _formatID;
73 std::string _formatName;
74};
75
77class sdlClip
78{
79 public:
80 explicit sdlClip(SdlContext* sdl);
81 virtual ~sdlClip();
82
83 sdlClip(const sdlClip&) = delete;
84 sdlClip(sdlClip&&) = delete;
85
86 sdlClip& operator=(const sdlClip&) = delete;
87 sdlClip& operator=(sdlClip&&) = delete;
88
89 [[nodiscard]] bool init(CliprdrClientContext* clip);
90 [[nodiscard]] bool uninit(CliprdrClientContext* clip);
91
92 [[nodiscard]] bool handleEvent(const SDL_ClipboardEvent& ev);
93
94 /* Answers the queued server CB_FORMAT_DATA_REQUESTs. Runs on the SDL main thread: the SDL
95 * clipboard API is main-thread only, and ReceiveFormatDataRequest only queues them. */
96 void handleDataRequests();
97#if defined(__EMSCRIPTEN__)
98 /* SDL3 has no clipboard driver for the browser: the page exchanges text with the
99 * browser clipboard and these functions connect it to the cliprdr channel. */
100 [[nodiscard]] static bool webOffer(const char* utf8, const BYTE* dib, size_t dibSize);
101
102 private:
103 [[nodiscard]] bool webRequestServerText();
104 [[nodiscard]] bool webAnswerDataRequest(const CLIPRDR_FORMAT_DATA_REQUEST* request);
105 [[nodiscard]] bool webTakeDataResponse(const CLIPRDR_FORMAT_DATA_RESPONSE* response);
106 std::string _web_local; /* text from the browser clipboard, offered to the server */
107 std::vector<BYTE> _web_local_dib; /* image from the browser clipboard as CF_DIB */
108 std::deque<size_t> _web_recent; /* hashes of recent offers, to recognise late echoes */
109 SdlWebClipOffers _web_offers;
110#endif
111
112 private:
113 [[nodiscard]] UINT SendClientCapabilities();
114 void clearServerFormats();
115 [[nodiscard]] UINT SendFormatListResponse(BOOL status);
116 [[nodiscard]] UINT SendDataResponse(const BYTE* data, size_t size);
117 [[nodiscard]] UINT SendDataRequest(uint32_t formatID, const std::string& mime);
118
119 [[nodiscard]] std::string getServerFormat(uint32_t id);
120 [[nodiscard]] uint32_t serverIdForMime(const std::string& mime);
121
122 [[nodiscard]] bool contains(const char** mime_types, Sint32 count);
123 [[nodiscard]] bool ownsClipboard() const;
124
125 [[nodiscard]] static UINT MonitorReady(CliprdrClientContext* context,
126 const CLIPRDR_MONITOR_READY* monitorReady);
127
128 [[nodiscard]] static UINT ReceiveServerCapabilities(CliprdrClientContext* context,
129 const CLIPRDR_CAPABILITIES* capabilities);
130 [[nodiscard]] static UINT ReceiveServerFormatList(CliprdrClientContext* context,
131 const CLIPRDR_FORMAT_LIST* formatList);
132 [[nodiscard]] static UINT
133 ReceiveFormatListResponse(CliprdrClientContext* context,
134 const CLIPRDR_FORMAT_LIST_RESPONSE* formatListResponse);
135 [[nodiscard]] std::shared_ptr<BYTE> getLocalData(uint32_t formatId, uint32_t& len);
136 [[nodiscard]] static UINT
137 ReceiveFormatDataRequest(CliprdrClientContext* context,
138 const CLIPRDR_FORMAT_DATA_REQUEST* formatDataRequest);
139 [[nodiscard]] static UINT
140 ReceiveFormatDataResponse(CliprdrClientContext* context,
141 const CLIPRDR_FORMAT_DATA_RESPONSE* formatDataResponse);
142
143 [[nodiscard]] static const void* SDLCALL ClipDataCb(void* userdata, const char* mime_type,
144 size_t* size);
145 static void SDLCALL ClipCleanCb(void* userdata);
146
147 [[nodiscard]] static bool mime_is_file(const std::string& mime);
148 [[nodiscard]] static bool mime_is_text(const std::string& mime);
149 [[nodiscard]] static bool mime_is_utf8(const std::string& mime);
150 [[nodiscard]] static bool mime_is_image(const std::string& mime);
151 [[nodiscard]] static bool mime_is_bmp(const std::string& mime);
152 [[nodiscard]] static bool mime_is_html(const std::string& mime);
153
154 SdlContext* _sdl = nullptr;
155 CliprdrFileContext* _file = nullptr;
156 CliprdrClientContext* _ctx = nullptr;
157 wLog* _log = nullptr;
158 wClipboard* _system = nullptr;
159 std::atomic<bool> _sync = false;
160 HANDLE _event = nullptr;
161 Uint64 _last_timestamp = 0;
162
163 std::vector<CliprdrFormat> _serverFormats;
164 CriticalSection _lock;
165
166 std::queue<ClipRequest> _request_queue;
167
168 struct cache_entry
169 {
170 cache_entry(size_t len, std::shared_ptr<void> p) : size(len), ptr(std::move(p))
171 {
172 }
173
174 size_t size;
175 std::shared_ptr<void> ptr;
176 };
177 std::map<std::string, cache_entry> _cache_data;
178 /* mime types of the latest server format list, not yet handed to SDL (guarded by _lock) */
179 std::vector<std::string> _current_mimetypes;
180 /* guarded by _lock: server data requests not answered yet, and whether ClipDataCb is
181 * waiting for the server (a local application is reading our offer of server data) */
182 std::deque<uint32_t> _server_requests;
183 bool _reading_server = false;
184 std::string _uuid;
185 std::string _mime_uuid;
186};