guacamole-spice-protocol/protocols/rdp/src/guac_handlers.c

451 lines
14 KiB
C
Raw Normal View History

2011-03-26 04:58:46 +00:00
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is libguac-client-rdp.
*
* The Initial Developer of the Original Code is
* Michael Jumper.
* Portions created by the Initial Developer are Copyright (C) 2011
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Matt Hortman
2011-03-26 04:58:46 +00:00
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
2011-03-26 05:49:48 +00:00
#include <stdlib.h>
#include <string.h>
#include <sys/select.h>
#include <errno.h>
2011-03-26 05:49:48 +00:00
#include <freerdp/freerdp.h>
#include <freerdp/channels/channels.h>
#include <freerdp/input.h>
2012-03-22 17:27:57 +00:00
#include <freerdp/codec/color.h>
#include <freerdp/cache/cache.h>
2012-03-30 18:26:52 +00:00
#include <freerdp/utils/event.h>
#include <freerdp/plugins/cliprdr.h>
2011-03-26 04:58:46 +00:00
#include <guacamole/socket.h>
2011-03-26 04:58:46 +00:00
#include <guacamole/protocol.h>
#include <guacamole/client.h>
2012-03-25 20:07:31 +00:00
#include <guacamole/error.h>
2011-03-26 04:58:46 +00:00
#include "client.h"
2011-07-24 07:47:38 +00:00
#include "rdp_keymap.h"
2012-03-30 18:26:52 +00:00
#include "rdp_cliprdr.h"
#include "guac_handlers.h"
#include "unicode_convtable.h"
2011-03-26 05:49:48 +00:00
void __guac_rdp_update_keysyms(guac_client* client, const int* keysym_string, int from, int to);
2012-03-21 02:26:23 +00:00
int __guac_rdp_send_keysym(guac_client* client, int keysym, int pressed);
void __guac_rdp_send_altcode(guac_client* client, int altcode);
2012-03-21 02:26:23 +00:00
2012-03-22 17:27:57 +00:00
2011-03-26 05:59:39 +00:00
int rdp_guac_client_free_handler(guac_client* client) {
2012-03-22 17:27:57 +00:00
rdp_guac_client_data* guac_client_data =
(rdp_guac_client_data*) client->data;
freerdp* rdp_inst = guac_client_data->rdp_inst;
rdpChannels* channels = rdp_inst->context->channels;
/* Clean up RDP client */
freerdp_channels_close(channels, rdp_inst);
freerdp_channels_free(channels);
freerdp_disconnect(rdp_inst);
freerdp_clrconv_free(((rdp_freerdp_context*) rdp_inst->context)->clrconv);
cache_free(rdp_inst->context->cache);
freerdp_free(rdp_inst);
2011-03-26 05:59:39 +00:00
2012-03-22 17:27:57 +00:00
/* Free client data */
cairo_surface_destroy(guac_client_data->opaque_glyph_surface);
cairo_surface_destroy(guac_client_data->trans_glyph_surface);
free(guac_client_data->clipboard);
2012-03-22 17:27:57 +00:00
free(guac_client_data);
2011-03-26 05:59:39 +00:00
return 0;
}
int rdp_guac_client_handle_messages(guac_client* client) {
rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
freerdp* rdp_inst = guac_client_data->rdp_inst;
2012-01-03 09:01:33 +00:00
rdpChannels* channels = rdp_inst->context->channels;
int index;
int max_fd, fd;
void* read_fds[32];
void* write_fds[32];
int read_count = 0;
int write_count = 0;
fd_set rfds, wfds;
2012-03-30 18:26:52 +00:00
RDP_EVENT* event;
struct timeval timeout = {
2012-03-05 20:10:56 +00:00
.tv_sec = 0,
.tv_usec = 250000
};
/* get rdp fds */
if (!freerdp_get_fds(rdp_inst, read_fds, &read_count, write_fds, &write_count)) {
2012-03-25 20:07:31 +00:00
guac_error = GUAC_STATUS_BAD_STATE;
guac_error_message = "Unable to read RDP file descriptors";
return 1;
}
/* get channel fds */
if (!freerdp_channels_get_fds(channels, rdp_inst, read_fds, &read_count, write_fds, &write_count)) {
2012-03-25 20:07:31 +00:00
guac_error = GUAC_STATUS_BAD_STATE;
guac_error_message = "Unable to read RDP channel file descriptors";
return 1;
}
/* Construct read fd_set */
max_fd = 0;
FD_ZERO(&rfds);
for (index = 0; index < read_count; index++) {
fd = (int)(long) (read_fds[index]);
if (fd > max_fd)
max_fd = fd;
FD_SET(fd, &rfds);
}
/* Construct write fd_set */
FD_ZERO(&wfds);
for (index = 0; index < write_count; index++) {
fd = (int)(long) (write_fds[index]);
if (fd > max_fd)
max_fd = fd;
FD_SET(fd, &wfds);
}
/* If no file descriptors, error */
if (max_fd == 0) {
2012-03-25 20:07:31 +00:00
guac_error = GUAC_STATUS_BAD_STATE;
guac_error_message = "No file descriptors";
return 1;
}
/* Otherwise, wait for file descriptors given */
if (select(max_fd + 1, &rfds, &wfds, NULL, &timeout) == -1) {
/* these are not really errors */
if (!((errno == EAGAIN) ||
(errno == EWOULDBLOCK) ||
(errno == EINPROGRESS) ||
(errno == EINTR))) /* signal occurred */
{
2012-03-25 20:07:31 +00:00
guac_error = GUAC_STATUS_SEE_ERRNO;
guac_error_message = "Error waiting for file descriptor";
return 1;
}
}
/* Check the libfreerdp fds */
if (!freerdp_check_fds(rdp_inst)) {
2012-03-25 20:07:31 +00:00
guac_error = GUAC_STATUS_BAD_STATE;
guac_error_message = "Error handling RDP file descriptors";
return 1;
}
/* Check channel fds */
if (!freerdp_channels_check_fds(channels, rdp_inst)) {
2012-03-25 20:07:31 +00:00
guac_error = GUAC_STATUS_BAD_STATE;
guac_error_message = "Error handling RDP channel file descriptors";
return 1;
}
2012-03-30 18:26:52 +00:00
/* Check for channel events */
event = freerdp_channels_pop_event(channels);
if (event) {
/* Handle clipboard events */
if (event->event_class == RDP_EVENT_CLASS_CLIPRDR)
guac_rdp_process_cliprdr_event(client, event);
freerdp_event_free(event);
}
2012-03-26 04:46:20 +00:00
/* Handle RDP disconnect */
if (freerdp_shall_disconnect(rdp_inst)) {
guac_error = GUAC_STATUS_NO_INPUT;
guac_error_message = "RDP server closed connection";
return 1;
}
/* Success */
return 0;
}
int rdp_guac_client_mouse_handler(guac_client* client, int x, int y, int mask) {
rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
freerdp* rdp_inst = guac_client_data->rdp_inst;
2011-07-25 21:57:40 +00:00
/* If button mask unchanged, just send move event */
if (mask == guac_client_data->mouse_button_mask)
rdp_inst->input->MouseEvent(rdp_inst->input, PTR_FLAGS_MOVE, x, y);
2011-07-25 21:57:40 +00:00
/* Otherwise, send events describing button change */
else {
2011-07-27 17:06:12 +00:00
/* Mouse buttons which have JUST become released */
int released_mask = guac_client_data->mouse_button_mask & ~mask;
/* Mouse buttons which have JUST become pressed */
int pressed_mask = ~guac_client_data->mouse_button_mask & mask;
2011-07-25 21:57:40 +00:00
/* Release event */
2011-07-27 17:06:12 +00:00
if (released_mask & 0x07) {
/* Calculate flags */
int flags = 0;
if (released_mask & 0x01) flags |= PTR_FLAGS_BUTTON1;
if (released_mask & 0x02) flags |= PTR_FLAGS_BUTTON3;
if (released_mask & 0x04) flags |= PTR_FLAGS_BUTTON2;
2011-07-27 17:06:12 +00:00
rdp_inst->input->MouseEvent(rdp_inst->input, flags, x, y);
2011-07-27 17:06:12 +00:00
}
2011-07-25 21:57:40 +00:00
/* Press event */
2011-07-27 17:06:12 +00:00
if (pressed_mask & 0x07) {
/* Calculate flags */
int flags = PTR_FLAGS_DOWN;
if (pressed_mask & 0x01) flags |= PTR_FLAGS_BUTTON1;
if (pressed_mask & 0x02) flags |= PTR_FLAGS_BUTTON3;
if (pressed_mask & 0x04) flags |= PTR_FLAGS_BUTTON2;
if (pressed_mask & 0x08) flags |= PTR_FLAGS_WHEEL | 0x78;
if (pressed_mask & 0x10) flags |= PTR_FLAGS_WHEEL | PTR_FLAGS_WHEEL_NEGATIVE | 0x88;
2011-07-27 17:06:12 +00:00
/* Send event */
rdp_inst->input->MouseEvent(rdp_inst->input, flags, x, y);
2011-07-27 17:06:12 +00:00
}
/* Scroll event */
if (pressed_mask & 0x18) {
/* Down */
if (pressed_mask & 0x08)
rdp_inst->input->MouseEvent(
rdp_inst->input,
PTR_FLAGS_WHEEL | 0x78,
2011-07-27 17:06:12 +00:00
x, y);
/* Up */
if (pressed_mask & 0x10)
rdp_inst->input->MouseEvent(
rdp_inst->input,
PTR_FLAGS_WHEEL | PTR_FLAGS_WHEEL_NEGATIVE | 0x88,
2011-07-27 17:06:12 +00:00
x, y);
}
2011-07-25 21:57:40 +00:00
guac_client_data->mouse_button_mask = mask;
}
return 0;
}
2011-07-24 07:47:38 +00:00
void __guac_rdp_send_altcode(guac_client* client, int altcode) {
rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
freerdp* rdp_inst = guac_client_data->rdp_inst;
int i;
/* Lookup scancode for Alt */
int alt = GUAC_RDP_KEYSYM_LOOKUP(
guac_client_data->keymap,
0xFFE9 /* Alt_L */).scancode;
/* Release all pressed modifiers */
__guac_rdp_update_keysyms(client, GUAC_KEYSYMS_ALL_MODIFIERS, 1, 0);
/* Press Alt */
rdp_inst->input->KeyboardEvent(rdp_inst->input, KBD_FLAGS_DOWN, alt);
/* For each character in four-digit Alt-code ... */
for (i=0; i<4; i++) {
/* Get scancode of keypad digit */
int scancode = GUAC_RDP_KEYSYM_LOOKUP(
guac_client_data->keymap,
0xFFB0 + (altcode / 1000)
).scancode;
/* Press and release digit */
rdp_inst->input->KeyboardEvent(rdp_inst->input, KBD_FLAGS_DOWN, scancode);
rdp_inst->input->KeyboardEvent(rdp_inst->input, KBD_FLAGS_RELEASE, scancode);
/* Shift digits left by one place */
altcode = (altcode * 10) % 10000;
}
/* Release Alt */
rdp_inst->input->KeyboardEvent(rdp_inst->input, KBD_FLAGS_RELEASE, alt);
/* Press all originally pressed modifiers */
__guac_rdp_update_keysyms(client, GUAC_KEYSYMS_ALL_MODIFIERS, 1, 1);
}
2012-03-21 02:26:23 +00:00
int __guac_rdp_send_keysym(guac_client* client, int keysym, int pressed) {
2011-07-24 07:47:38 +00:00
rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
freerdp* rdp_inst = guac_client_data->rdp_inst;
2011-07-24 07:47:38 +00:00
/* If keysym can be in lookup table */
//if (keysym <= 0xFFFF) {
2011-07-24 07:47:38 +00:00
/* Look up scancode mapping */
const guac_rdp_keysym_desc* keysym_desc =
&GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keymap, keysym);
2011-07-24 07:47:38 +00:00
/* If defined, send event */
if (keysym_desc->scancode != 0) {
/* If defined, send any prerequesite keys that must be set */
if (keysym_desc->set_keysyms != NULL)
__guac_rdp_update_keysyms(client, keysym_desc->set_keysyms, 0, 1);
/* If defined, release any keys that must be cleared */
if (keysym_desc->clear_keysyms != NULL)
__guac_rdp_update_keysyms(client, keysym_desc->clear_keysyms, 1, 0);
/* Send actual key */
rdp_inst->input->KeyboardEvent(
rdp_inst->input,
keysym_desc->flags
| (pressed ? KBD_FLAGS_DOWN : KBD_FLAGS_RELEASE),
keysym_desc->scancode);
guac_client_log_info(client, "Base flags are %d", keysym_desc->flags);
/* If defined, release any keys that were originally released */
if (keysym_desc->set_keysyms != NULL)
__guac_rdp_update_keysyms(client, keysym_desc->set_keysyms, 0, 0);
/* If defined, send any keys that were originally set */
if (keysym_desc->clear_keysyms != NULL)
__guac_rdp_update_keysyms(client, keysym_desc->clear_keysyms, 1, 1);
} else {
/* Fall back to unicode events if undefined inside current keymap */
int unicode_code = keysym2uni(keysym);
guac_client_log_info(client, "Translated keysym:0x%x to unicode:0x%x (pressed=%d flag=%d)",
keysym, unicode_code, pressed, pressed ? KBD_FLAGS_DOWN : KBD_FLAGS_RELEASE);
/* LibfreeRDP seems not to take into account the DOWN/RELEASE flags.
* So we send only on of the two key events.
*/
if (pressed) {
rdp_inst->input->UnicodeKeyboardEvent(
rdp_inst->input,
//pressed ? KBD_FLAGS_DOW : KBD_FLAGS_RELEASE, <- not
// taken into account
0,
unicode_code);
} else {
guac_client_log_info(client, "Ignoring release");
}
}
//}
2011-07-24 07:47:38 +00:00
return 0;
}
void __guac_rdp_update_keysyms(guac_client* client, const int* keysym_string, int from, int to) {
rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
int keysym;
2012-03-21 02:26:23 +00:00
/* Send all keysyms in string, NULL terminated */
while ((keysym = *keysym_string) != 0) {
/* Get current keysym state */
int current_state = GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keysym_state, keysym);
/* If key is currently in given state, send event for changing it to specified "to" state */
if (current_state == from)
__guac_rdp_send_keysym(client, *keysym_string, to);
/* Next keysym */
keysym_string++;
}
2012-03-21 02:26:23 +00:00
}
int rdp_guac_client_key_handler(guac_client* client, int keysym, int pressed) {
rdp_guac_client_data* guac_client_data = (rdp_guac_client_data*) client->data;
/* Update keysym state */
GUAC_RDP_KEYSYM_LOOKUP(guac_client_data->keysym_state, keysym) = pressed;
return __guac_rdp_send_keysym(client, keysym, pressed);
2012-03-21 02:26:23 +00:00
}
2012-04-30 06:28:29 +00:00
int rdp_guac_client_clipboard_handler(guac_client* client, char* data) {
rdpChannels* channels =
((rdp_guac_client_data*) client->data)->rdp_inst->context->channels;
RDP_CB_FORMAT_LIST_EVENT* format_list =
(RDP_CB_FORMAT_LIST_EVENT*) freerdp_event_new(
RDP_EVENT_CLASS_CLIPRDR,
RDP_EVENT_TYPE_CB_FORMAT_LIST,
NULL, NULL);
2012-04-30 06:33:27 +00:00
/* Free existing data */
free(((rdp_guac_client_data*) client->data)->clipboard);
2012-04-30 06:28:29 +00:00
/* Store data in client */
((rdp_guac_client_data*) client->data)->clipboard = strdup(data);
/* Notify server that text data is now available */
format_list->formats = (uint32*) malloc(sizeof(uint32));
format_list->formats[0] = CB_FORMAT_TEXT;
format_list->num_formats = 1;
freerdp_channels_send_event(channels, (RDP_EVENT*) format_list);
return 0;
}