src/guac_handlers.c

   1
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   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/
   9  *
  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
  13  * License.
  14  *
  15  * The Original Code is libguac-client-rdp.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Michael Jumper.
  19  * Portions created by the Initial Developer are Copyright (C) 2011
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  * Matt Hortman
  24  *
  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.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include <stdlib.h>
  40 #include <string.h>
  41
  42 #include <sys/select.h>
  43 #include <errno.h>
  44
  45 #include <freerdp/freerdp.h>
  46 #include <freerdp/channels/channels.h>
  47 #include <freerdp/input.h>
  48 #include <freerdp/codec/color.h>
  49 #include <freerdp/cache/cache.h>
  50
  51 #include <guacamole/socket.h>
  52 #include <guacamole/protocol.h>
  53 #include <guacamole/client.h>
  54 #include <guacamole/error.h>
  55
  56 #include "client.h"
  57 #include "rdp_keymap.h"
  58 #include "guac_handlers.h"
  59
  60 void __guac_rdp_update_keysyms(guac_client* client, const int* keysym_string, int from, int to);
  61 int __guac_rdp_send_keysym(guac_client* client, int keysym, int pressed);
  62 void __guac_rdp_send_altcode(guac_client* client, int altcode);
  63
  64
  65 int rdp_guac_client_free_handler(guac_client* client) {
  66
  67     rdp_guac_client_data* guac_client_data =
  68         (rdp_guac_client_data*) client->data;
  69
  70     freerdp* rdp_inst = guac_client_data->rdp_inst;
  71     rdpChannels* channels = rdp_inst->context->channels;
  72
  73     /* Clean up RDP client */
  74         freerdp_channels_close(channels, rdp_inst);
  75         freerdp_channels_free(channels);
  76         freerdp_disconnect(rdp_inst);
  77     freerdp_clrconv_free(((rdp_freerdp_context*) rdp_inst->context)->clrconv);
  78     cache_free(rdp_inst->context->cache);
  79     freerdp_free(rdp_inst);
  80
  81     /* Free client data */
  82     free(guac_client_data);
  83
  84     return 0;
  85
  86 }
  87
  88 int rdp_guac_client_handle_messages(guac_client* client) {
  89
  90     rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
  91     freerdp* rdp_inst = guac_client_data->rdp_inst;
  92     rdpChannels* channels = rdp_inst->context->channels;
  93
  94     int index;
  95     int max_fd, fd;
  96     void* read_fds[32];
  97     void* write_fds[32];
  98     int read_count = 0;
  99     int write_count = 0;
 100     fd_set rfds, wfds;
 101
 102     struct timeval timeout = {
 103         .tv_sec = 0,
 104         .tv_usec = 250000
 105     };
 106
 107     /* get rdp fds */
 108     if (!freerdp_get_fds(rdp_inst, read_fds, &read_count, write_fds, &write_count)) {
 109         guac_error = GUAC_STATUS_BAD_STATE;
 110         guac_error_message = "Unable to read RDP file descriptors";
 111         return 1;
 112     }
 113
 114     /* get channel fds */
 115     if (!freerdp_channels_get_fds(channels, rdp_inst, read_fds, &read_count, write_fds, &write_count)) {
 116         guac_error = GUAC_STATUS_BAD_STATE;
 117         guac_error_message = "Unable to read RDP channel file descriptors";
 118         return 1;
 119     }
 120
 121     /* Construct read fd_set */
 122     max_fd = 0;
 123     FD_ZERO(&rfds);
 124     for (index = 0; index < read_count; index++) {
 125         fd = (int)(long) (read_fds[index]);
 126         if (fd > max_fd)
 127             max_fd = fd;
 128         FD_SET(fd, &rfds);
 129     }
 130
 131     /* Construct write fd_set */
 132     FD_ZERO(&wfds);
 133     for (index = 0; index < write_count; index++) {
 134         fd = (int)(long) (write_fds[index]);
 135         if (fd > max_fd)
 136             max_fd = fd;
 137         FD_SET(fd, &wfds);
 138     }
 139
 140     /* If no file descriptors, error */
 141     if (max_fd == 0) {
 142         guac_error = GUAC_STATUS_BAD_STATE;
 143         guac_error_message = "No file descriptors";
 144         return 1;
 145     }
 146
 147     /* Otherwise, wait for file descriptors given */
 148     if (select(max_fd + 1, &rfds, &wfds, NULL, &timeout) == -1) {
 149         /* these are not really errors */
 150         if (!((errno == EAGAIN) ||
 151             (errno == EWOULDBLOCK) ||
 152             (errno == EINPROGRESS) ||
 153             (errno == EINTR))) /* signal occurred */
 154         {
 155             guac_error = GUAC_STATUS_SEE_ERRNO;
 156             guac_error_message = "Error waiting for file descriptor";
 157             return 1;
 158         }
 159     }
 160
 161     /* Check the libfreerdp fds */
 162     if (!freerdp_check_fds(rdp_inst)) {
 163         guac_error = GUAC_STATUS_BAD_STATE;
 164         guac_error_message = "Error handling RDP file descriptors";
 165         return 1;
 166     }
 167
 168     /* Check channel fds */
 169     if (!freerdp_channels_check_fds(channels, rdp_inst)) {
 170         guac_error = GUAC_STATUS_BAD_STATE;
 171         guac_error_message = "Error handling RDP channel file descriptors";
 172         return 1;
 173     }
 174
 175     /* Success */
 176     return 0;
 177
 178 }
 179
 180 int rdp_guac_client_mouse_handler(guac_client* client, int x, int y, int mask) {
 181
 182     rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
 183     freerdp* rdp_inst = guac_client_data->rdp_inst;
 184
 185     /* If button mask unchanged, just send move event */
 186     if (mask == guac_client_data->mouse_button_mask)
 187         rdp_inst->input->MouseEvent(rdp_inst->input, PTR_FLAGS_MOVE, x, y);
 188
 189     /* Otherwise, send events describing button change */
 190     else {
 191
 192         /* Mouse buttons which have JUST become released */
 193         int released_mask =  guac_client_data->mouse_button_mask & ~mask;
 194
 195         /* Mouse buttons which have JUST become pressed */
 196         int pressed_mask  = ~guac_client_data->mouse_button_mask &  mask;
 197
 198         /* Release event */
 199         if (released_mask & 0x07) {
 200
 201             /* Calculate flags */
 202             int flags = 0;
 203             if (released_mask & 0x01) flags |= PTR_FLAGS_BUTTON1;
 204             if (released_mask & 0x02) flags |= PTR_FLAGS_BUTTON3;
 205             if (released_mask & 0x04) flags |= PTR_FLAGS_BUTTON2;
 206
 207             rdp_inst->input->MouseEvent(rdp_inst->input, flags, x, y);
 208
 209         }
 210
 211         /* Press event */
 212         if (pressed_mask & 0x07) {
 213
 214             /* Calculate flags */
 215             int flags = PTR_FLAGS_DOWN;
 216             if (pressed_mask & 0x01) flags |= PTR_FLAGS_BUTTON1;
 217             if (pressed_mask & 0x02) flags |= PTR_FLAGS_BUTTON3;
 218             if (pressed_mask & 0x04) flags |= PTR_FLAGS_BUTTON2;
 219             if (pressed_mask & 0x08) flags |= PTR_FLAGS_WHEEL | 0x78;
 220             if (pressed_mask & 0x10) flags |= PTR_FLAGS_WHEEL | PTR_FLAGS_WHEEL_NEGATIVE | 0x88;
 221
 222             /* Send event */
 223             rdp_inst->input->MouseEvent(rdp_inst->input, flags, x, y);
 224
 225         }
 226
 227         /* Scroll event */
 228         if (pressed_mask & 0x18) {
 229
 230             /* Down */
 231             if (pressed_mask & 0x08)
 232                 rdp_inst->input->MouseEvent(
 233                         rdp_inst->input,
 234                         PTR_FLAGS_WHEEL | 0x78,
 235                         x, y);
 236
 237             /* Up */
 238             if (pressed_mask & 0x10)
 239                 rdp_inst->input->MouseEvent(
 240                         rdp_inst->input,
 241                         PTR_FLAGS_WHEEL | PTR_FLAGS_WHEEL_NEGATIVE | 0x88,
 242                         x, y);
 243
 244         }
 245
 246
 247         guac_client_data->mouse_button_mask = mask;
 248     }
 249
 250     return 0;
 251 }
 252
 253 void __guac_rdp_send_altcode(guac_client* client, int altcode) {
 254
 255     rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
 256     freerdp* rdp_inst = guac_client_data->rdp_inst;
 257     int i;
 258
 259     /* Lookup scancode for Alt */
 260     int alt = GUAC_RDP_KEYSYM_LOOKUP(
 261             guac_client_data->keymap,
 262             0xFFE9 /* Alt_L */).scancode;
 263
 264     /* Release all pressed modifiers */
 265     __guac_rdp_update_keysyms(client, GUAC_KEYSYMS_ALL_MODIFIERS, 1, 0);
 266
 267     /* Press Alt */
 268     rdp_inst->input->KeyboardEvent(rdp_inst->input, KBD_FLAGS_DOWN, alt);
 269
 270     /* For each character in four-digit Alt-code ... */
 271     for (i=0; i<4; i++) {
 272
 273         /* Get scancode of keypad digit */
 274         int scancode = GUAC_RDP_KEYSYM_LOOKUP(
 275                 guac_client_data->keymap,
 276                 0xFFB0 + (altcode / 1000)
 277         ).scancode;
 278
 279         /* Press and release digit */
 280         rdp_inst->input->KeyboardEvent(rdp_inst->input, KBD_FLAGS_DOWN, scancode);
 281         rdp_inst->input->KeyboardEvent(rdp_inst->input, KBD_FLAGS_RELEASE, scancode);
 282
 283         /* Shift digits left by one place */
 284         altcode = (altcode * 10) % 10000;
 285
 286     }
 287
 288     /* Release Alt */
 289     rdp_inst->input->KeyboardEvent(rdp_inst->input, KBD_FLAGS_RELEASE, alt);
 290
 291     /* Press all originally pressed modifiers */
 292     __guac_rdp_update_keysyms(client, GUAC_KEYSYMS_ALL_MODIFIERS, 1, 1);
 293
 294 }
 295
 296 int __guac_rdp_send_keysym(guac_client* client, int keysym, int pressed) {
 297
 298     rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
 299     freerdp* rdp_inst = guac_client_data->rdp_inst;
 300
 301     /* If keysym can be in lookup table */
 302     if (keysym <= 0xFFFF) {
 303
 304         /* Look up scancode mapping */
 305         const guac_rdp_keysym_desc* keysym_desc =
 306             &GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keymap, keysym);
 307
 308         /* If defined, send event */
 309         if (keysym_desc->scancode != 0) {
 310
 311             /* If defined, send any prerequesite keys that must be set */
 312             if (keysym_desc->set_keysyms != NULL)
 313                 __guac_rdp_update_keysyms(client, keysym_desc->set_keysyms, 0, 1);
 314
 315             /* If defined, release any keys that must be cleared */
 316             if (keysym_desc->clear_keysyms != NULL)
 317                 __guac_rdp_update_keysyms(client, keysym_desc->clear_keysyms, 1, 0);
 318
 319             /* Send actual key */
 320             rdp_inst->input->KeyboardEvent(
 321                     rdp_inst->input,
 322                     keysym_desc->flags
 323                         | (pressed ? KBD_FLAGS_DOWN : KBD_FLAGS_RELEASE),
 324                     keysym_desc->scancode);
 325
 326             /* If defined, release any keys that were originally released */
 327             if (keysym_desc->set_keysyms != NULL)
 328                 __guac_rdp_update_keysyms(client, keysym_desc->set_keysyms, 0, 0);
 329
 330             /* If defined, send any keys that were originally set */
 331             if (keysym_desc->clear_keysyms != NULL)
 332                 __guac_rdp_update_keysyms(client, keysym_desc->clear_keysyms, 1, 1);
 333
 334         }
 335
 336         /* If undefined but has Alt-code, use Alt-Code */
 337         else if (keysym <= 0xFF) {
 338
 339             /* NOTE: The Alt-codes are conveniently identical to keysyms. */
 340
 341             /* Only send Alt-code on press */
 342             if (pressed)
 343                 __guac_rdp_send_altcode(client, keysym);
 344
 345         }
 346
 347         /* If no defined Alt-code, log warning */
 348         else
 349             guac_client_log_info(client, "unmapped keysym: 0x%x", keysym);
 350
 351     }
 352
 353     return 0;
 354 }
 355
 356 void __guac_rdp_update_keysyms(guac_client* client, const int* keysym_string, int from, int to) {
 357
 358     rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
 359     int keysym;
 360
 361     /* Send all keysyms in string, NULL terminated */
 362     while ((keysym = *keysym_string) != 0) {
 363
 364         /* Get current keysym state */
 365         int current_state = GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keysym_state, keysym);
 366
 367         /* If key is currently in given state, send event for changing it to specified "to" state */
 368         if (current_state == from)
 369             __guac_rdp_send_keysym(client, *keysym_string, to);
 370
 371         /* Next keysym */
 372         keysym_string++;
 373
 374     }
 375
 376 }
 377
 378 int rdp_guac_client_key_handler(guac_client* client, int keysym, int pressed) {
 379
 380     rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
 381
 382     /* Update keysym state */
 383     GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keysym_state, keysym) = pressed;
 384
 385     return __guac_rdp_send_keysym(client, keysym, pressed);
 386
 387 }
 388