2 * QEMU VNC display driver -- clipboard support
4 * Copyright (C) 2021 Gerd Hoffmann <kraxel@redhat.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
29 static uint8_t *inflate_buffer(uint8_t *in, uint32_t in_len, uint32_t *size)
38 uint8_t *out = g_malloc(out_len);
41 stream.next_out = out + stream.total_out;
42 stream.avail_out = out_len - stream.total_out;
44 ret = inflateInit(&stream);
49 while (stream.avail_in) {
50 ret = inflate(&stream, Z_FINISH);
55 *size = stream.total_out;
60 if (out_len > (1 << 20)) {
63 out = g_realloc(out, out_len);
64 stream.next_out = out + stream.total_out;
65 stream.avail_out = out_len - stream.total_out;
79 static uint8_t *deflate_buffer(uint8_t *in, uint32_t in_len, uint32_t *size)
88 uint8_t *out = g_malloc(out_len);
91 stream.next_out = out + stream.total_out;
92 stream.avail_out = out_len - stream.total_out;
94 ret = deflateInit(&stream, Z_DEFAULT_COMPRESSION);
99 while (ret != Z_STREAM_END) {
100 ret = deflate(&stream, Z_FINISH);
107 if (out_len > (1 << 20)) {
110 out = g_realloc(out, out_len);
111 stream.next_out = out + stream.total_out;
112 stream.avail_out = out_len - stream.total_out;
119 *size = stream.total_out;
131 static void vnc_clipboard_send(VncState *vs, uint32_t count, uint32_t *dwords)
136 vnc_write_u8(vs, VNC_MSG_SERVER_CUT_TEXT);
140 vnc_write_s32(vs, -(count * sizeof(uint32_t))); /* -(message length) */
141 for (i = 0; i < count; i++) {
142 vnc_write_u32(vs, dwords[i]);
144 vnc_unlock_output(vs);
148 static void vnc_clipboard_provide(VncState *vs,
149 QemuClipboardInfo *info,
150 QemuClipboardType type)
153 g_autofree uint8_t *buf = NULL;
154 g_autofree void *zbuf = NULL;
158 case QEMU_CLIPBOARD_TYPE_TEXT:
159 flags |= VNC_CLIPBOARD_TEXT;
164 flags |= VNC_CLIPBOARD_PROVIDE;
166 buf = g_malloc(info->types[type].size + 4);
167 buf[0] = (info->types[type].size >> 24) & 0xff;
168 buf[1] = (info->types[type].size >> 16) & 0xff;
169 buf[2] = (info->types[type].size >> 8) & 0xff;
170 buf[3] = (info->types[type].size >> 0) & 0xff;
171 memcpy(buf + 4, info->types[type].data, info->types[type].size);
172 zbuf = deflate_buffer(buf, info->types[type].size + 4, &zsize);
178 vnc_write_u8(vs, VNC_MSG_SERVER_CUT_TEXT);
182 vnc_write_s32(vs, -(sizeof(uint32_t) + zsize)); /* -(message length) */
183 vnc_write_u32(vs, flags);
184 vnc_write(vs, zbuf, zsize);
185 vnc_unlock_output(vs);
189 static void vnc_clipboard_update_info(VncState *vs, QemuClipboardInfo *info)
191 QemuClipboardType type;
192 bool self_update = info->owner == &vs->cbpeer;
195 if (info != vs->cbinfo) {
196 qemu_clipboard_info_unref(vs->cbinfo);
197 vs->cbinfo = qemu_clipboard_info_ref(info);
200 if (info->types[QEMU_CLIPBOARD_TYPE_TEXT].available) {
201 flags |= VNC_CLIPBOARD_TEXT;
203 flags |= VNC_CLIPBOARD_NOTIFY;
204 vnc_clipboard_send(vs, 1, &flags);
213 for (type = 0; type < QEMU_CLIPBOARD_TYPE__COUNT; type++) {
214 if (vs->cbpending & (1 << type)) {
215 vs->cbpending &= ~(1 << type);
216 vnc_clipboard_provide(vs, info, type);
221 static void vnc_clipboard_notify(Notifier *notifier, void *data)
223 VncState *vs = container_of(notifier, VncState, cbpeer.notifier);
224 QemuClipboardNotify *notify = data;
226 switch (notify->type) {
227 case QEMU_CLIPBOARD_UPDATE_INFO:
228 vnc_clipboard_update_info(vs, notify->info);
230 case QEMU_CLIPBOARD_RESET_SERIAL:
236 static void vnc_clipboard_request(QemuClipboardInfo *info,
237 QemuClipboardType type)
239 VncState *vs = container_of(info->owner, VncState, cbpeer);
242 if (type == QEMU_CLIPBOARD_TYPE_TEXT) {
243 flags |= VNC_CLIPBOARD_TEXT;
248 flags |= VNC_CLIPBOARD_REQUEST;
250 vnc_clipboard_send(vs, 1, &flags);
253 void vnc_client_cut_text_ext(VncState *vs, int32_t len, uint32_t flags, uint8_t *data)
255 if (flags & VNC_CLIPBOARD_CAPS) {
256 /* need store caps somewhere ? */
260 if (flags & VNC_CLIPBOARD_NOTIFY) {
261 QemuClipboardInfo *info =
262 qemu_clipboard_info_new(&vs->cbpeer, QEMU_CLIPBOARD_SELECTION_CLIPBOARD);
263 if (flags & VNC_CLIPBOARD_TEXT) {
264 info->types[QEMU_CLIPBOARD_TYPE_TEXT].available = true;
266 qemu_clipboard_update(info);
267 qemu_clipboard_info_unref(info);
271 if (flags & VNC_CLIPBOARD_PROVIDE &&
273 vs->cbinfo->owner == &vs->cbpeer) {
275 g_autofree uint8_t *buf = inflate_buffer(data, len - 4, &size);
276 if ((flags & VNC_CLIPBOARD_TEXT) &&
278 uint32_t tsize = read_u32(buf, 0);
279 uint8_t *tbuf = buf + 4;
281 qemu_clipboard_set_data(&vs->cbpeer, vs->cbinfo,
282 QEMU_CLIPBOARD_TYPE_TEXT,
288 if (flags & VNC_CLIPBOARD_REQUEST &&
290 vs->cbinfo->owner != &vs->cbpeer) {
291 if ((flags & VNC_CLIPBOARD_TEXT) &&
292 vs->cbinfo->types[QEMU_CLIPBOARD_TYPE_TEXT].available) {
293 if (vs->cbinfo->types[QEMU_CLIPBOARD_TYPE_TEXT].data) {
294 vnc_clipboard_provide(vs, vs->cbinfo, QEMU_CLIPBOARD_TYPE_TEXT);
296 vs->cbpending |= (1 << QEMU_CLIPBOARD_TYPE_TEXT);
297 qemu_clipboard_request(vs->cbinfo, QEMU_CLIPBOARD_TYPE_TEXT);
303 void vnc_client_cut_text(VncState *vs, size_t len, uint8_t *text)
305 QemuClipboardInfo *info =
306 qemu_clipboard_info_new(&vs->cbpeer, QEMU_CLIPBOARD_SELECTION_CLIPBOARD);
308 qemu_clipboard_set_data(&vs->cbpeer, info, QEMU_CLIPBOARD_TYPE_TEXT,
310 qemu_clipboard_info_unref(info);
313 void vnc_server_cut_text_caps(VncState *vs)
317 if (!vnc_has_feature(vs, VNC_FEATURE_CLIPBOARD_EXT)) {
321 caps[0] = (VNC_CLIPBOARD_PROVIDE |
322 VNC_CLIPBOARD_NOTIFY |
323 VNC_CLIPBOARD_REQUEST |
327 vnc_clipboard_send(vs, 2, caps);
329 if (!vs->cbpeer.notifier.notify) {
330 vs->cbpeer.name = "vnc";
331 vs->cbpeer.notifier.notify = vnc_clipboard_notify;
332 vs->cbpeer.request = vnc_clipboard_request;
333 qemu_clipboard_peer_register(&vs->cbpeer);