2 * FreeRDP: A Remote Desktop Protocol client.
3 * Clipboard Virtual Channel
5 * Copyright 2009-2011 Jay Sorg
6 * Copyright 2010-2011 Vic Lee
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
24 #include <freerdp/types.h>
25 #include <freerdp/constants.h>
26 #include <freerdp/utils/memory.h>
27 #include <freerdp/utils/unicode.h>
28 #include <freerdp/utils/svc_plugin.h>
29 #include <freerdp/plugins/cliprdr.h>
31 #include "cliprdr_constants.h"
32 #include "cliprdr_main.h"
33 #include "cliprdr_format.h"
35 static const char* const CB_MSG_TYPE_STRINGS[] =
40 "CB_FORMAT_LIST_RESPONSE",
41 "CB_FORMAT_DATA_REQUEST",
42 "CB_FORMAT_DATA_RESPONSE",
45 "CB_FILECONTENTS_REQUEST",
46 "CB_FILECONTENTS_RESPONSE",
51 STREAM* cliprdr_packet_new(uint16 msgType, uint16 msgFlags, uint32 dataLen)
55 s = stream_new(dataLen + 8);
56 stream_write_uint16(s, msgType);
57 stream_write_uint16(s, msgFlags);
58 /* Write actual length after the entire packet has been constructed. */
64 void cliprdr_packet_send(cliprdrPlugin* cliprdr, STREAM* s)
69 pos = stream_get_pos(s);
72 stream_write_uint32(s, dataLen);
73 stream_set_pos(s, pos);
75 svc_plugin_send((rdpSvcPlugin*) cliprdr, s);
78 static void cliprdr_process_connect(rdpSvcPlugin* plugin)
80 DEBUG_CLIPRDR("connecting");
82 ((cliprdrPlugin*) plugin)->uniconv = freerdp_uniconv_new();
85 void cliprdr_print_general_capability_flags(uint32 flags)
87 printf("generalFlags (0x%08X) {\n", flags);
89 if (flags & CB_USE_LONG_FORMAT_NAMES)
90 printf("\tCB_USE_LONG_FORMAT_NAMES\n");
91 if (flags & CB_STREAM_FILECLIP_ENABLED)
92 printf("\tCB_STREAM_FILECLIP_ENABLED\n");
93 if (flags & CB_FILECLIP_NO_FILE_PATHS)
94 printf("\tCB_FILECLIP_NO_FILE_PATHS\n");
95 if (flags & CB_CAN_LOCK_CLIPDATA)
96 printf("\tCB_CAN_LOCK_CLIPDATA\n");
101 static void cliprdr_process_general_capability(cliprdrPlugin* cliprdr, STREAM* s)
106 stream_read_uint32(s, version); /* version (4 bytes) */
107 stream_read_uint32(s, generalFlags); /* generalFlags (4 bytes) */
109 DEBUG_CLIPRDR("Version: %d", version);
111 #ifdef WITH_DEBUG_CLIPRDR
112 cliprdr_print_general_capability_flags(generalFlags);
115 if (generalFlags & CB_USE_LONG_FORMAT_NAMES)
116 cliprdr->use_long_format_names = true;
118 if (generalFlags & CB_STREAM_FILECLIP_ENABLED)
119 cliprdr->stream_fileclip_enabled = true;
121 if (generalFlags & CB_FILECLIP_NO_FILE_PATHS)
122 cliprdr->fileclip_no_file_paths = true;
124 if (generalFlags & CB_CAN_LOCK_CLIPDATA)
125 cliprdr->can_lock_clipdata = true;
127 cliprdr->received_caps = true;
130 static void cliprdr_process_clip_caps(cliprdrPlugin* cliprdr, STREAM* s, uint16 length, uint16 flags)
133 uint16 lengthCapability;
134 uint16 cCapabilitiesSets;
135 uint16 capabilitySetType;
137 stream_read_uint16(s, cCapabilitiesSets); /* cCapabilitiesSets (2 bytes) */
138 stream_seek_uint16(s); /* pad1 (2 bytes) */
140 DEBUG_CLIPRDR("cCapabilitiesSets %d", cCapabilitiesSets);
142 for (i = 0; i < cCapabilitiesSets; i++)
144 stream_read_uint16(s, capabilitySetType); /* capabilitySetType (2 bytes) */
145 stream_read_uint16(s, lengthCapability); /* lengthCapability (2 bytes) */
147 switch (capabilitySetType)
149 case CB_CAPSTYPE_GENERAL:
150 cliprdr_process_general_capability(cliprdr, s);
154 DEBUG_WARN("unknown cliprdr capability set: %d", capabilitySetType);
160 static void cliprdr_send_clip_caps(cliprdrPlugin* cliprdr)
165 s = cliprdr_packet_new(CB_CLIP_CAPS, 0, 4 + CB_CAPSTYPE_GENERAL_LEN);
167 DEBUG_CLIPRDR("Sending Capabilities");
169 flags = CB_USE_LONG_FORMAT_NAMES;
171 stream_write_uint16(s, 1); /* cCapabilitiesSets */
172 stream_write_uint16(s, 0); /* pad1 */
173 stream_write_uint16(s, CB_CAPSTYPE_GENERAL); /* capabilitySetType */
174 stream_write_uint16(s, CB_CAPSTYPE_GENERAL_LEN); /* lengthCapability */
175 stream_write_uint32(s, CB_CAPS_VERSION_2); /* version */
176 stream_write_uint32(s, flags); /* generalFlags */
178 cliprdr_packet_send(cliprdr, s);
181 static void cliprdr_process_monitor_ready(cliprdrPlugin* cliprdr, STREAM* s, uint16 length, uint16 flags)
185 if (cliprdr->received_caps)
186 cliprdr_send_clip_caps(cliprdr);
188 event = freerdp_event_new(RDP_EVENT_CLASS_CLIPRDR, RDP_EVENT_TYPE_CB_MONITOR_READY, NULL, NULL);
189 svc_plugin_send_event((rdpSvcPlugin*) cliprdr, event);
192 static void cliprdr_process_receive(rdpSvcPlugin* plugin, STREAM* s)
197 cliprdrPlugin* cliprdr = (cliprdrPlugin*) plugin;
199 stream_read_uint16(s, msgType);
200 stream_read_uint16(s, msgFlags);
201 stream_read_uint32(s, dataLen);
203 DEBUG_CLIPRDR("msgType: %s (%d), msgFlags: %d dataLen: %d",
204 CB_MSG_TYPE_STRINGS[msgType], msgType, msgFlags, dataLen);
209 cliprdr_process_clip_caps(cliprdr, s, dataLen, msgFlags);
212 case CB_MONITOR_READY:
213 cliprdr_process_monitor_ready(cliprdr, s, dataLen, msgFlags);
217 cliprdr_process_format_list(cliprdr, s, dataLen, msgFlags);
220 case CB_FORMAT_LIST_RESPONSE:
221 cliprdr_process_format_list_response(cliprdr, s, dataLen, msgFlags);
224 case CB_FORMAT_DATA_REQUEST:
225 cliprdr_process_format_data_request(cliprdr, s, dataLen, msgFlags);
228 case CB_FORMAT_DATA_RESPONSE:
229 cliprdr_process_format_data_response(cliprdr, s, dataLen, msgFlags);
233 DEBUG_WARN("unknown msgType %d", msgType);
240 static void cliprdr_process_event(rdpSvcPlugin* plugin, RDP_EVENT* event)
242 switch (event->event_type)
244 case RDP_EVENT_TYPE_CB_FORMAT_LIST:
245 cliprdr_process_format_list_event((cliprdrPlugin*) plugin, (RDP_CB_FORMAT_LIST_EVENT*) event);
248 case RDP_EVENT_TYPE_CB_DATA_REQUEST:
249 cliprdr_process_format_data_request_event((cliprdrPlugin*) plugin, (RDP_CB_DATA_REQUEST_EVENT*) event);
252 case RDP_EVENT_TYPE_CB_DATA_RESPONSE:
253 cliprdr_process_format_data_response_event((cliprdrPlugin*) plugin, (RDP_CB_DATA_RESPONSE_EVENT*) event);
257 DEBUG_WARN("unknown event type %d", event->event_type);
261 freerdp_event_free(event);
264 static void cliprdr_process_terminate(rdpSvcPlugin* plugin)
266 cliprdrPlugin* cliprdr_plugin = (cliprdrPlugin*) plugin;
268 if (cliprdr_plugin->uniconv != NULL)
269 freerdp_uniconv_free(cliprdr_plugin->uniconv);
274 DEFINE_SVC_PLUGIN(cliprdr, "cliprdr",
275 CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP |
276 CHANNEL_OPTION_COMPRESS_RDP | CHANNEL_OPTION_SHOW_PROTOCOL)