2 |
rdesktop: A Remote Desktop Protocol client. |
rdesktop: A Remote Desktop Protocol client. |
3 |
Protocol services - Clipboard functions |
Protocol services - Clipboard functions |
4 |
Copyright (C) Erik Forsberg <forsberg@cendio.se> 2003 |
Copyright (C) Erik Forsberg <forsberg@cendio.se> 2003 |
5 |
|
Copyright (C) Matthew Chapman 2003 |
6 |
|
|
7 |
This program is free software; you can redistribute it and/or modify |
This program is free software; you can redistribute it and/or modify |
8 |
it under the terms of the GNU General Public License as published by |
it under the terms of the GNU General Public License as published by |
19 |
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
20 |
*/ |
*/ |
21 |
|
|
|
#include <X11/Xlib.h> |
|
|
#include <X11/Xatom.h> |
|
22 |
#include "rdesktop.h" |
#include "rdesktop.h" |
23 |
|
|
24 |
extern BOOL encryption; |
#define CLIPRDR_CONNECT 1 |
25 |
extern Display *display; |
#define CLIPRDR_FORMAT_ANNOUNCE 2 |
26 |
extern Window wnd; |
#define CLIPRDR_FORMAT_ACK 3 |
27 |
extern Time last_keyrelease; |
#define CLIPRDR_DATA_REQUEST 4 |
28 |
|
#define CLIPRDR_DATA_RESPONSE 5 |
29 |
static Atom clipboard_atom, primary_atom, targets_atom, timestamp_atom; |
|
30 |
static cliprdr_dataformat *server_formats = NULL; |
#define CLIPRDR_REQUEST 0 |
31 |
static uint16 num_server_formats = 0; |
#define CLIPRDR_RESPONSE 1 |
32 |
static XSelectionEvent selection_event; |
#define CLIPRDR_ERROR 2 |
33 |
|
|
34 |
static void |
static VCHANNEL *cliprdr_channel; |
|
cliprdr_print_server_formats(void) |
|
|
{ |
|
|
#ifdef WITH_DEBUG_CLIPBOARD |
|
|
cliprdr_dataformat *this; |
|
|
uint16 i = 0; |
|
|
this = server_formats; |
|
|
DEBUG_CLIPBOARD(("There should be %d server formats.\n", num_server_formats)); |
|
|
while (NULL != this) |
|
|
{ |
|
|
DEBUG_CLIPBOARD(("Format code %d\n", this->identifier)); |
|
|
i++; |
|
|
this = this->next; |
|
|
} |
|
|
DEBUG_CLIPBOARD(("There were %d server formats.\n", i)); |
|
|
#endif |
|
|
} |
|
|
|
|
|
void |
|
|
cliprdr_handle_SelectionNotify(void) |
|
|
{ |
|
|
DEBUG_CLIPBOARD(("cliprdr_handle_SelectionNotify\n")); |
|
|
} |
|
|
|
|
|
void |
|
|
cliprdr_handle_SelectionClear(void) |
|
|
{ |
|
|
DEBUG_CLIPBOARD(("cliprdr_handle_SelectionClear\n")); |
|
|
} |
|
|
|
|
|
void print_X_error(int res) |
|
|
{ |
|
|
switch(res) { |
|
|
case Success: |
|
|
DEBUG_CLIPBOARD(("Success\n")); |
|
|
break; |
|
|
|
|
|
case BadAtom: |
|
|
DEBUG_CLIPBOARD(("BadAtom\n")); |
|
|
break; |
|
|
|
|
|
case BadRequest: |
|
|
DEBUG_CLIPBOARD(("BadRequest\n")); |
|
|
break; |
|
|
|
|
|
case BadAlloc: |
|
|
DEBUG_CLIPBOARD(("BadAlloc\n")); |
|
|
break; |
|
|
|
|
|
case BadMatch: |
|
|
DEBUG_CLIPBOARD(("BadMatch\n")); |
|
|
break; |
|
|
|
|
|
case BadValue: |
|
|
DEBUG_CLIPBOARD(("BadValue\n")); |
|
|
break; |
|
|
|
|
|
case BadWindow: |
|
|
DEBUG_CLIPBOARD(("BadWindow\n")); |
|
|
break; |
|
|
|
|
|
default: |
|
|
DEBUG_CLIPBOARD(("Unknown X error code %d\n", res)); |
|
|
} |
|
|
} |
|
35 |
|
|
36 |
static void |
static void |
37 |
cliprdr_request_clipboard_data(uint32 formatcode) |
cliprdr_send_packet(uint16 type, uint16 status, uint8 * data, uint32 length) |
38 |
{ |
{ |
39 |
STREAM s; |
STREAM s; |
|
s = sec_init(encryption ? SEC_ENCRYPT : 0, 24); |
|
|
out_uint32_le(s, 16); |
|
|
out_uint32_le(s, 0x13); |
|
|
out_uint16_le(s, 4); |
|
|
out_uint16_le(s, 0); |
|
|
out_uint32_le(s, 4); // Remaining length |
|
|
out_uint32_le(s, formatcode); |
|
|
out_uint32_le(s, 0); // Unknown. Garbage pad? |
|
40 |
|
|
41 |
s_mark_end(s); |
DEBUG_CLIPBOARD(("CLIPRDR send: type=%d, status=%d, length=%d\n", type, status, length)); |
42 |
|
|
43 |
sec_send_to_channel(s, encryption ? SEC_ENCRYPT : 0, 1005); // FIXME: Don't hardcode channel! |
s = channel_init(cliprdr_channel, length + 12); |
44 |
|
out_uint16_le(s, type); |
45 |
|
out_uint16_le(s, status); |
46 |
|
out_uint32_le(s, length); |
47 |
|
out_uint8p(s, data, length); |
48 |
|
out_uint32(s, 0); /* pad? */ |
49 |
|
s_mark_end(s); |
50 |
|
channel_send(s, cliprdr_channel); |
51 |
} |
} |
52 |
|
|
53 |
|
/* Helper which announces our readiness to supply clipboard data |
54 |
|
in a single format (such as CF_TEXT) to the RDP side. |
55 |
|
To announce more than one format at a time, use |
56 |
|
cliprdr_send_native_format_announce. |
57 |
|
*/ |
58 |
void |
void |
59 |
cliprdr_handle_SelectionRequest(XSelectionRequestEvent *xevent) |
cliprdr_send_simple_native_format_announce(uint32 format) |
|
{ |
|
|
|
|
|
Atom *targets; |
|
|
int res; |
|
|
|
|
|
XSelectionEvent xev; |
|
|
DEBUG_CLIPBOARD(("cliprdr_handle_SelectionRequest\n")); |
|
|
DEBUG_CLIPBOARD(("Requestor window id 0x%x ", |
|
|
(unsigned)xevent->requestor)); |
|
|
if (clipboard_atom == xevent->selection) { |
|
|
DEBUG_CLIPBOARD(("wants CLIPBOARD\n")); |
|
|
} |
|
|
if (primary_atom == xevent->selection) { |
|
|
DEBUG_CLIPBOARD(("wants PRIMARY\n")); |
|
|
} |
|
|
DEBUG_CLIPBOARD(("Target is %s (0x%x), property is %s (0x%x)\n", |
|
|
XGetAtomName(display, xevent->target), |
|
|
(unsigned)xevent->target, |
|
|
XGetAtomName(display, xevent->property), |
|
|
(unsigned)xevent->property)); |
|
|
|
|
|
xev.type = SelectionNotify; |
|
|
xev.serial = 0; |
|
|
xev.send_event = True; |
|
|
xev.requestor = xevent->requestor; |
|
|
xev.selection = xevent->selection; |
|
|
xev.target = xevent->target; |
|
|
xev.property = xevent->property; |
|
|
xev.time = xevent->time; |
|
|
|
|
|
if (targets_atom == xevent->target) |
|
|
{ |
|
|
DEBUG_CLIPBOARD(("TARGETS requested, sending list..\n")); |
|
|
targets = xmalloc(4*sizeof(Atom)); |
|
|
targets[0] = xevent->target; |
|
|
targets[1] = XInternAtom(display, "TEXT", True); |
|
|
targets[2] = XInternAtom(display, "UTF8_STRING", True); |
|
|
targets[3] = XInternAtom(display, "TIMESTAMP", True); |
|
|
res = XChangeProperty(display, |
|
|
xevent->requestor, |
|
|
xevent->property, |
|
|
XA_ATOM, |
|
|
32, |
|
|
PropModeAppend, |
|
|
(unsigned char *)targets, |
|
|
3); |
|
|
DEBUG_CLIPBOARD(("res after XChangeProperty is ")); |
|
|
print_X_error(res); |
|
|
|
|
|
res = XSendEvent(display, |
|
|
xevent->requestor, |
|
|
False, |
|
|
NoEventMask, |
|
|
(XEvent *)&xev); |
|
|
return; |
|
|
} else if (timestamp_atom == xevent->target) |
|
|
{ |
|
|
DEBUG_CLIPBOARD(("TIMESTAMP requested... sending 0x%x\n", |
|
|
(unsigned)last_keyrelease)); |
|
|
res = XChangeProperty(display, |
|
|
xevent->requestor, |
|
|
xevent->property, |
|
|
XA_INTEGER, |
|
|
32, |
|
|
PropModeAppend, |
|
|
(unsigned char *)&last_keyrelease, |
|
|
1); |
|
|
res = XSendEvent(display, |
|
|
xevent->requestor, |
|
|
False, |
|
|
NoEventMask, |
|
|
(XEvent *)&xev); |
|
|
} else /* Some other target */ |
|
|
{ |
|
|
cliprdr_request_clipboard_data(CF_TEXT); |
|
|
memcpy(&selection_event, &xev, sizeof(xev)); |
|
|
/* Return and wait for data, handled by |
|
|
cliprdr_handle_server_data */ |
|
|
} |
|
|
} |
|
|
|
|
|
|
|
|
static void |
|
|
cliprdr_ack_format_list(void) |
|
60 |
{ |
{ |
61 |
STREAM s; |
uint8 buffer[36]; |
|
s = sec_init(encryption ? SEC_ENCRYPT : 0, 20); |
|
|
out_uint32_le(s, 12); |
|
|
out_uint32_le(s, 0x13); |
|
|
out_uint16_le(s, 3); |
|
|
out_uint16_le(s, 1); |
|
|
out_uint32_le(s, 0); |
|
|
out_uint32_le(s, 0x0000c0da); |
|
62 |
|
|
63 |
s_mark_end(s); |
DEBUG_CLIPBOARD(("cliprdr_send_simple_native_format_announce\n")); |
64 |
|
|
65 |
sec_send_to_channel(s, encryption ? SEC_ENCRYPT : 0, 1005); // FIXME: Don't hardcode channel! |
buf_out_uint32(buffer, format); |
66 |
|
memset(buffer + 4, 0, sizeof(buffer) - 4); /* description */ |
67 |
|
cliprdr_send_native_format_announce(buffer, sizeof(buffer)); |
68 |
} |
} |
69 |
|
|
70 |
|
/* Announces our readiness to supply clipboard data in multiple |
71 |
|
formats, each denoted by a 36-byte format descriptor of |
72 |
|
[ uint32 format + 32-byte description ]. |
73 |
|
*/ |
74 |
static void |
void |
75 |
cliprdr_register_server_formats(STREAM s) |
cliprdr_send_native_format_announce(uint8 * formats_data, uint32 formats_data_length) |
|
{ |
|
|
uint32 remaining_length, pad; |
|
|
uint16 num_formats; |
|
|
cliprdr_dataformat *this, *next; |
|
|
|
|
|
DEBUG_CLIPBOARD(("cliprdr_register_server_formats\n")); |
|
|
in_uint32_le(s, remaining_length); |
|
|
|
|
|
num_formats = remaining_length / 36; |
|
|
if (NULL != server_formats) { |
|
|
this = server_formats; |
|
|
next = this->next; |
|
|
while (NULL != next) { |
|
|
xfree(this); |
|
|
this = NULL; |
|
|
this = next; |
|
|
next = this->next; |
|
|
} |
|
|
} |
|
|
this = xmalloc(sizeof(cliprdr_dataformat)); |
|
|
this->next = NULL; |
|
|
server_formats = this; |
|
|
num_server_formats = num_formats; |
|
|
while (1 < num_formats) { |
|
|
in_uint32_le(s, this->identifier); |
|
|
in_uint8a(s, this->textual_description, 32); |
|
|
DEBUG_CLIPBOARD(("Stored format description with numeric id %d\n", |
|
|
this->identifier)); |
|
|
this-> next = xmalloc(sizeof(cliprdr_dataformat)); |
|
|
this = this->next; |
|
|
num_formats--; |
|
|
} |
|
|
in_uint32_le(s, this->identifier); |
|
|
DEBUG_CLIPBOARD(("Stored format description with numeric id %d\n", this->identifier)); |
|
|
in_uint8a(s, this->textual_description, 32); |
|
|
this -> next = NULL; |
|
|
in_uint32_le(s, pad); |
|
|
cliprdr_print_server_formats(); |
|
|
} |
|
|
|
|
|
static void |
|
|
cliprdr_select_X_clipboards(void) |
|
76 |
{ |
{ |
77 |
XSetSelectionOwner(display, primary_atom, wnd, last_keyrelease); |
DEBUG_CLIPBOARD(("cliprdr_send_native_format_announce\n")); |
78 |
if (wnd != XGetSelectionOwner(display, primary_atom)) |
cliprdr_send_packet(CLIPRDR_FORMAT_ANNOUNCE, CLIPRDR_REQUEST, formats_data, |
79 |
{ |
formats_data_length); |
|
warning("Failed to aquire ownership of PRIMARY clipboard\n"); |
|
|
} |
|
|
XSetSelectionOwner(display, clipboard_atom, wnd, CurrentTime); |
|
|
if (wnd != XGetSelectionOwner(display, clipboard_atom)) |
|
|
{ |
|
|
warning("Failed to aquire ownership of CLIPBOARD clipboard\n"); |
|
|
} |
|
|
|
|
80 |
} |
} |
81 |
|
|
82 |
|
void |
83 |
|
cliprdr_send_data_request(uint32 format) |
|
static void |
|
|
cliprdr_send_format_announce(void) |
|
84 |
{ |
{ |
85 |
STREAM s; |
uint8 buffer[4]; |
|
int number_of_formats = 1; |
|
|
s = sec_init(encryption ? SEC_ENCRYPT : 0, number_of_formats*36+12+4+4); |
|
|
out_uint32_le(s, number_of_formats*36+12); |
|
|
out_uint32_le(s, 0x13); |
|
|
out_uint16_le(s, 2); |
|
|
out_uint16_le(s, 0); |
|
|
out_uint32_le(s, number_of_formats*36); |
|
|
|
|
|
out_uint32_le(s, 0xd); // FIXME: This is a rather bogus unicode text description.. |
|
|
// rdp_out_unistr(s, "", 16); |
|
|
out_uint8s(s, 32); |
|
|
|
|
|
out_uint32_le(s, 0); |
|
86 |
|
|
87 |
s_mark_end(s); |
DEBUG_CLIPBOARD(("cliprdr_send_data_request\n")); |
88 |
sec_send_to_channel(s, encryption ? SEC_ENCRYPT : 0, 1005); // FIXME: Don't hardcode channel! |
buf_out_uint32(buffer, format); |
89 |
|
cliprdr_send_packet(CLIPRDR_DATA_REQUEST, CLIPRDR_REQUEST, buffer, sizeof(buffer)); |
90 |
} |
} |
91 |
|
|
92 |
|
void |
93 |
static void |
cliprdr_send_data(uint8 * data, uint32 length) |
|
cliprdr_handle_first_handshake(STREAM s) |
|
94 |
{ |
{ |
95 |
uint32 remaining_length, pad; |
DEBUG_CLIPBOARD(("cliprdr_send_data\n")); |
96 |
in_uint32_le(s, remaining_length); |
cliprdr_send_packet(CLIPRDR_DATA_RESPONSE, CLIPRDR_RESPONSE, data, length); |
|
in_uint32_le(s, pad); |
|
|
DEBUG_CLIPBOARD(("Remaining length in first handshake frm server is %d, pad is %d\n", |
|
|
remaining_length, pad)); |
|
|
cliprdr_send_format_announce(); |
|
97 |
} |
} |
98 |
|
|
99 |
void cliprdr_handle_server_data(uint32 length, STREAM s) |
static void |
100 |
|
cliprdr_process(STREAM s) |
101 |
{ |
{ |
102 |
uint32 remaining_length; |
uint16 type, status; |
103 |
char *data; |
uint32 length, format; |
104 |
int res; |
uint8 *data; |
|
in_uint32_le(s, remaining_length); |
|
|
data = s->p; |
|
|
res = XChangeProperty(display, |
|
|
selection_event.requestor, |
|
|
selection_event.property, |
|
|
XInternAtom(display, "STRING", False), |
|
|
8, |
|
|
PropModeAppend, |
|
|
data, |
|
|
remaining_length); |
|
|
|
|
|
DEBUG_CLIPBOARD(("res after XChangeProperty is ")); |
|
|
print_X_error(res); |
|
|
|
|
|
res = XSendEvent(display, |
|
|
selection_event.requestor, |
|
|
False, |
|
|
NoEventMask, |
|
|
(XEvent *)&selection_event); |
|
|
|
|
|
DEBUG_CLIPBOARD(("res after XSendEvent is ")); |
|
|
print_X_error(res); |
|
|
|
|
|
} |
|
105 |
|
|
106 |
void cliprdr_callback(STREAM s) |
in_uint16_le(s, type); |
107 |
{ |
in_uint16_le(s, status); |
|
uint32 length, flags; |
|
|
uint16 ptype0, ptype1; |
|
|
DEBUG_CLIPBOARD(("cliprdr_callback called, clipboard data:\n")); |
|
|
#ifdef WITH_DEBUG_CLIPBOARD |
|
|
hexdump(s->p, s->end - s->p); |
|
|
#endif |
|
108 |
in_uint32_le(s, length); |
in_uint32_le(s, length); |
109 |
in_uint32_le(s, flags); |
data = s->p; |
110 |
|
|
111 |
DEBUG_CLIPBOARD(("length is %d, flags are %d\n", length, flags)); |
DEBUG_CLIPBOARD(("CLIPRDR recv: type=%d, status=%d, length=%d\n", type, status, length)); |
112 |
|
|
113 |
if (flags & 0x03 || flags & 0x01) /* Single-write op or first-packet-of-several op */ |
if (status == CLIPRDR_ERROR) |
114 |
{ |
{ |
115 |
in_uint16_le(s, ptype0); |
if (type == CLIPRDR_FORMAT_ACK) |
|
in_uint16_le(s, ptype1); |
|
|
DEBUG_CLIPBOARD(("ptype0 is %d, ptype1 is %d\n", ptype0, ptype1)); |
|
|
if (1 == ptype0 && 0 == ptype1) { |
|
|
cliprdr_handle_first_handshake(s); |
|
|
return; |
|
|
} else if (3 == ptype0 && 1 == ptype1) |
|
116 |
{ |
{ |
117 |
// Acknowledgment on our format announce. Do we care? Not right now. |
/* FIXME: We seem to get this when we send an announce while the server is |
118 |
// There is a strange pad in this packet that we might need some time, |
still processing a paste. Try sending another announce. */ |
119 |
// but probably not. |
cliprdr_send_simple_native_format_announce(CF_TEXT); |
|
DEBUG_CLIPBOARD(("Received format announce ACK\n")); |
|
120 |
return; |
return; |
121 |
|
} |
122 |
|
|
123 |
} else if (2 == ptype0 && 0 == ptype1) |
DEBUG_CLIPBOARD(("CLIPRDR error (type=%d)\n", type)); |
124 |
{ |
return; |
125 |
cliprdr_register_server_formats(s); |
} |
126 |
cliprdr_select_X_clipboards(); |
|
127 |
cliprdr_ack_format_list(); |
switch (type) |
128 |
|
{ |
129 |
|
case CLIPRDR_CONNECT: |
130 |
|
ui_clip_sync(); |
131 |
|
break; |
132 |
|
case CLIPRDR_FORMAT_ANNOUNCE: |
133 |
|
ui_clip_format_announce(data, length); |
134 |
|
cliprdr_send_packet(CLIPRDR_FORMAT_ACK, CLIPRDR_RESPONSE, NULL, 0); |
135 |
return; |
return; |
136 |
} else if (5 == ptype0 && 1 == ptype1) |
case CLIPRDR_FORMAT_ACK: |
137 |
{ |
break; |
138 |
cliprdr_handle_server_data(length, s); |
case CLIPRDR_DATA_REQUEST: |
139 |
} |
in_uint32_le(s, format); |
140 |
|
ui_clip_request_data(format); |
141 |
|
break; |
142 |
|
case CLIPRDR_DATA_RESPONSE: |
143 |
|
ui_clip_handle_data(data, length); |
144 |
|
break; |
145 |
|
case 7: /* TODO: W2K3 SP1 sends this on connect with a value of 1 */ |
146 |
|
break; |
147 |
|
default: |
148 |
|
unimpl("CLIPRDR packet type %d\n", type); |
149 |
} |
} |
150 |
} |
} |
151 |
|
|
152 |
|
BOOL |
153 |
void cliprdr_init(void) |
cliprdr_init(void) |
154 |
{ |
{ |
155 |
primary_atom = XInternAtom(display, "PRIMARY", False); |
cliprdr_channel = |
156 |
clipboard_atom = XInternAtom(display, "CLIPBOARD", False); |
channel_register("cliprdr", |
157 |
targets_atom = XInternAtom(display, "TARGETS", True); |
CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP | |
158 |
timestamp_atom = XInternAtom(display, "TIMESTAMP", True); |
CHANNEL_OPTION_COMPRESS_RDP | CHANNEL_OPTION_SHOW_PROTOCOL, |
159 |
|
cliprdr_process); |
160 |
|
return (cliprdr_channel != NULL); |
161 |
} |
} |