2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
15 * The Original Code is libguac-client-rdp.
17 * The Initial Developer of the Original Code is
19 * Portions created by the Initial Developer are Copyright (C) 2011
20 * the Initial Developer. All Rights Reserved.
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
37 * ***** END LICENSE BLOCK ***** */
42 #include <sys/select.h>
45 #include <freerdp/freerdp.h>
46 #include <freerdp/utils/memory.h>
47 #include <freerdp/cache/bitmap.h>
48 #include <freerdp/cache/brush.h>
49 #include <freerdp/cache/glyph.h>
50 #include <freerdp/cache/palette.h>
51 #include <freerdp/cache/pointer.h>
52 #include <freerdp/cache/offscreen.h>
53 #include <freerdp/channels/channels.h>
54 #include <freerdp/input.h>
55 #include <freerdp/constants.h>
57 #include <guacamole/socket.h>
58 #include <guacamole/protocol.h>
59 #include <guacamole/client.h>
60 #include <guacamole/error.h>
63 #include "guac_handlers.h"
64 #include "rdp_keymap.h"
65 #include "rdp_bitmap.h"
66 #include "rdp_glyph.h"
67 #include "rdp_pointer.h"
70 /* Client plugin arguments */
71 const char* GUAC_CLIENT_ARGS[] = {
94 boolean rdp_freerdp_pre_connect(freerdp* instance) {
96 rdpContext* context = instance->context;
97 guac_client* client = ((rdp_freerdp_context*) context)->client;
98 rdpChannels* channels = context->channels;
102 rdpPrimaryUpdate* primary;
105 /* Init color conversion structure */
106 clrconv = xnew(CLRCONV);
110 clrconv->palette = xnew(rdpPalette);
111 ((rdp_freerdp_context*) context)->clrconv = clrconv;
113 /* Init FreeRDP cache */
114 instance->context->cache = cache_new(instance->settings);
116 /* Set up bitmap handling */
117 bitmap = xnew(rdpBitmap);
118 bitmap->size = sizeof(guac_rdp_bitmap);
119 bitmap->New = guac_rdp_bitmap_new;
120 bitmap->Free = guac_rdp_bitmap_free;
121 bitmap->Paint = guac_rdp_bitmap_paint;
122 bitmap->Decompress = guac_rdp_bitmap_decompress;
123 bitmap->SetSurface = guac_rdp_bitmap_setsurface;
124 graphics_register_bitmap(context->graphics, bitmap);
127 /* Set up glyph handling */
128 glyph = xnew(rdpGlyph);
129 glyph->size = sizeof(guac_rdp_glyph);
130 glyph->New = guac_rdp_glyph_new;
131 glyph->Free = guac_rdp_glyph_free;
132 glyph->Draw = guac_rdp_glyph_draw;
133 glyph->BeginDraw = guac_rdp_glyph_begindraw;
134 glyph->EndDraw = guac_rdp_glyph_enddraw;
135 graphics_register_glyph(context->graphics, glyph);
138 /* Set up pointer handling */
139 pointer = xnew(rdpPointer);
140 pointer->size = sizeof(guac_rdp_pointer);
141 pointer->New = guac_rdp_pointer_new;
142 pointer->Free = guac_rdp_pointer_free;
143 pointer->Set = guac_rdp_pointer_set;
144 graphics_register_pointer(context->graphics, pointer);
148 instance->update->EndPaint = guac_rdp_gdi_end_paint;
149 instance->update->Palette = guac_rdp_gdi_palette_update;
150 instance->update->SetBounds = guac_rdp_gdi_set_bounds;
152 primary = instance->update->primary;
153 primary->DstBlt = guac_rdp_gdi_dstblt;
154 primary->PatBlt = guac_rdp_gdi_patblt;
155 primary->ScrBlt = guac_rdp_gdi_scrblt;
156 primary->MemBlt = guac_rdp_gdi_memblt;
157 primary->OpaqueRect = guac_rdp_gdi_opaquerect;
159 pointer_cache_register_callbacks(instance->update);
160 glyph_cache_register_callbacks(instance->update);
161 brush_cache_register_callbacks(instance->update);
162 bitmap_cache_register_callbacks(instance->update);
163 offscreen_cache_register_callbacks(instance->update);
164 palette_cache_register_callbacks(instance->update);
166 /* Init channels (pre-connect) */
167 if (freerdp_channels_pre_connect(channels, instance)) {
168 guac_protocol_send_error(client->socket, "Error initializing RDP client channel manager");
169 guac_socket_flush(client->socket);
177 boolean rdp_freerdp_post_connect(freerdp* instance) {
179 rdpContext* context = instance->context;
180 guac_client* client = ((rdp_freerdp_context*) context)->client;
181 rdpChannels* channels = instance->context->channels;
183 /* Init channels (post-connect) */
184 if (freerdp_channels_post_connect(channels, instance)) {
185 guac_protocol_send_error(client->socket, "Error initializing RDP client channel manager");
186 guac_socket_flush(client->socket);
190 /* Client handlers */
191 client->free_handler = rdp_guac_client_free_handler;
192 client->handle_messages = rdp_guac_client_handle_messages;
193 client->mouse_handler = rdp_guac_client_mouse_handler;
194 client->key_handler = rdp_guac_client_key_handler;
200 void rdp_freerdp_context_new(freerdp* instance, rdpContext* context) {
201 context->channels = freerdp_channels_new();
204 void rdp_freerdp_context_free(freerdp* instance, rdpContext* context) {
208 void __guac_rdp_client_load_keymap(guac_client* client,
209 const guac_rdp_keymap* keymap) {
211 rdp_guac_client_data* guac_client_data =
212 (rdp_guac_client_data*) client->data;
214 const guac_rdp_keysym_desc* mapping = keymap->mapping;
216 /* If parent exists, load parent first */
217 if (keymap->parent != NULL)
218 __guac_rdp_client_load_keymap(client, keymap->parent);
221 guac_client_log_info(client, "Loading keymap \"%s\"", keymap->name);
223 /* Load mapping into keymap */
224 while (mapping->keysym != 0) {
227 GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keymap, mapping->keysym) =
237 int guac_client_init(guac_client* client, int argc, char** argv) {
239 rdp_guac_client_data* guac_client_data;
242 rdpSettings* settings;
245 int port = RDP_DEFAULT_PORT;
246 boolean bitmap_cache;
250 guac_protocol_send_error(client->socket,
251 "Wrong argument count received.");
252 guac_socket_flush(client->socket);
254 guac_error = GUAC_STATUS_BAD_ARGUMENT;
255 guac_error_message = "Wrong argument count received";
260 /* If port specified, use it */
261 if (argv[IDX_PORT][0] != '\0')
262 port = atoi(argv[IDX_PORT]);
264 hostname = argv[IDX_HOSTNAME];
266 /* Allocate client data */
267 guac_client_data = malloc(sizeof(rdp_guac_client_data));
270 freerdp_channels_global_init();
271 rdp_inst = freerdp_new();
272 rdp_inst->PreConnect = rdp_freerdp_pre_connect;
273 rdp_inst->PostConnect = rdp_freerdp_post_connect;
275 /* Allocate FreeRDP context */
276 rdp_inst->context_size = sizeof(rdp_freerdp_context);
277 rdp_inst->ContextNew = (pContextNew) rdp_freerdp_context_new;
278 rdp_inst->ContextFree = (pContextFree) rdp_freerdp_context_free;
279 freerdp_context_new(rdp_inst);
282 settings = rdp_inst->settings;
285 settings->authentication = false;
288 settings->rdp_security = true;
289 settings->tls_security = false;
290 settings->nla_security = false;
291 settings->encryption = true;
292 settings->encryption_method = ENCRYPTION_METHOD_40BIT | ENCRYPTION_METHOD_128BIT | ENCRYPTION_METHOD_FIPS;
293 settings->encryption_level = ENCRYPTION_LEVEL_CLIENT_COMPATIBLE;
296 settings->width = 1024;
297 if (argv[IDX_WIDTH][0] != '\0')
298 settings->width = atoi(argv[IDX_WIDTH]);
299 if (settings->width == 0)
300 settings->width = 1024;
303 settings->height = 768;
304 if (argv[IDX_HEIGHT][0] != '\0')
305 settings->height = atoi(argv[IDX_HEIGHT]);
306 if (settings->height == 0)
307 settings->height = 768;
310 settings->hostname = strdup(hostname);
311 settings->port = port;
312 settings->window_title = strdup(hostname);
315 settings->username = "guest";
316 if (argv[IDX_USERNAME][0] != '\0')
317 settings->username = strdup (argv[IDX_USERNAME]);
320 if (argv[IDX_PASSWORD][0] != '\0') {
321 settings->password = strdup (argv[IDX_PASSWORD]);
322 settings->autologon = 1;
325 /* initial program */
326 if (argv[IDX_INITIAL_PROGRAM][0] != '\0')
327 settings->shell = strdup (argv[IDX_INITIAL_PROGRAM]);
330 bitmap_cache = settings->bitmap_cache;
331 settings->os_major_type = OSMAJORTYPE_UNSPECIFIED;
332 settings->os_minor_type = OSMINORTYPE_UNSPECIFIED;
333 settings->order_support[NEG_DSTBLT_INDEX] = true;
334 settings->order_support[NEG_PATBLT_INDEX] = false; /* PATBLT not yet supported */
335 settings->order_support[NEG_SCRBLT_INDEX] = true;
336 settings->order_support[NEG_OPAQUE_RECT_INDEX] = true;
337 settings->order_support[NEG_DRAWNINEGRID_INDEX] = false;
338 settings->order_support[NEG_MULTIDSTBLT_INDEX] = false;
339 settings->order_support[NEG_MULTIPATBLT_INDEX] = false;
340 settings->order_support[NEG_MULTISCRBLT_INDEX] = false;
341 settings->order_support[NEG_MULTIOPAQUERECT_INDEX] = false;
342 settings->order_support[NEG_MULTI_DRAWNINEGRID_INDEX] = false;
343 settings->order_support[NEG_LINETO_INDEX] = false;
344 settings->order_support[NEG_POLYLINE_INDEX] = false;
345 settings->order_support[NEG_MEMBLT_INDEX] = bitmap_cache;
346 settings->order_support[NEG_MEM3BLT_INDEX] = false;
347 settings->order_support[NEG_MEMBLT_V2_INDEX] = bitmap_cache;
348 settings->order_support[NEG_MEM3BLT_V2_INDEX] = false;
349 settings->order_support[NEG_SAVEBITMAP_INDEX] = false;
350 settings->order_support[NEG_GLYPH_INDEX_INDEX] = true;
351 settings->order_support[NEG_FAST_INDEX_INDEX] = true;
352 settings->order_support[NEG_FAST_GLYPH_INDEX] = true;
353 settings->order_support[NEG_POLYGON_SC_INDEX] = false;
354 settings->order_support[NEG_POLYGON_CB_INDEX] = false;
355 settings->order_support[NEG_ELLIPSE_SC_INDEX] = false;
356 settings->order_support[NEG_ELLIPSE_CB_INDEX] = false;
358 /* Store client data */
359 guac_client_data->rdp_inst = rdp_inst;
360 guac_client_data->mouse_button_mask = 0;
361 guac_client_data->current_surface = GUAC_DEFAULT_LAYER;
363 /* Clear keysym state mapping and keymap */
364 memset(guac_client_data->keysym_state, 0,
365 sizeof(guac_rdp_keysym_state_map));
367 memset(guac_client_data->keymap, 0,
368 sizeof(guac_rdp_static_keymap));
370 client->data = guac_client_data;
371 ((rdp_freerdp_context*) rdp_inst->context)->client = client;
373 /* Load keymap into client */
374 __guac_rdp_client_load_keymap(client, &guac_rdp_keymap_en_us);
376 /* Connect to RDP server */
377 if (!freerdp_connect(rdp_inst)) {
379 guac_protocol_send_error(client->socket,
380 "Error connecting to RDP server");
381 guac_socket_flush(client->socket);
383 guac_error = GUAC_STATUS_BAD_STATE;
384 guac_error_message = "Error connecting to RDP server";
389 /* Send connection name */
390 guac_protocol_send_name(client->socket, settings->window_title);
393 guac_protocol_send_size(client->socket, GUAC_DEFAULT_LAYER,
394 settings->width, settings->height);
396 /* Create glyph surfaces */
397 guac_client_data->opaque_glyph_surface = cairo_image_surface_create(
398 CAIRO_FORMAT_RGB24, settings->width, settings->height);
400 guac_client_data->trans_glyph_surface = cairo_image_surface_create(
401 CAIRO_FORMAT_ARGB32, settings->width, settings->height);