guacamole-spice-protocol/libguac/src/client.c

548 lines
16 KiB
C
Raw Normal View History

2010-12-08 21:14:04 +00:00
2011-02-16 02:04:36 +00:00
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
2010-12-08 21:14:04 +00:00
*
2011-02-16 02:04:36 +00:00
* 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/
2010-12-08 21:14:04 +00:00
*
2011-02-16 02:04:36 +00:00
* 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.
2010-12-08 21:14:04 +00:00
*
2011-02-16 02:04:36 +00:00
* The Original Code is libguac.
*
* The Initial Developer of the Original Code is
* Michael Jumper.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* 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 ***** */
2010-12-08 21:14:04 +00:00
#include <stdlib.h>
#include <stdio.h>
2011-03-12 02:57:53 +00:00
#ifdef HAVE_CLOCK_GETTIME
#include <time.h>
#else
#include <sys/time.h>
#endif
2010-12-08 21:14:04 +00:00
#include <string.h>
#include <dlfcn.h>
2011-03-16 08:24:17 +00:00
#include <pthread.h>
2010-12-08 21:14:04 +00:00
#include "log.h"
2010-12-08 21:14:04 +00:00
#include "guacio.h"
#include "protocol.h"
#include "client.h"
png_byte** guac_alloc_png_buffer(int w, int h, int bpp) {
png_byte** png_buffer;
png_byte* row;
int y;
/* Allocate rows for PNG */
png_buffer = (png_byte**) malloc(h * sizeof(png_byte*));
for (y=0; y<h; y++) {
row = (png_byte*) malloc(sizeof(png_byte) * bpp * w);
png_buffer[y] = row;
}
return png_buffer;
}
void guac_free_png_buffer(png_byte** png_buffer, int h) {
int y;
/* Free PNG data */
for (y = 0; y<h; y++)
free(png_buffer[y]);
free(png_buffer);
}
guac_client* __guac_alloc_client(GUACIO* io) {
/* Allocate new client (not handoff) */
guac_client* client = malloc(sizeof(guac_client));
memset(client, 0, sizeof(guac_client));
/* Init new client */
client->io = io;
return client;
}
guac_client* guac_get_client(int client_fd) {
guac_client* client;
GUACIO* io = guac_open(client_fd);
/* Pluggable client */
char protocol_lib[256] = "libguac-client-";
2010-12-08 21:14:04 +00:00
union {
guac_client_init_handler* client_init;
void* obj;
} alias;
char* error;
/* Client args description */
const char** client_args;
2010-12-08 21:14:04 +00:00
/* Client arguments */
int argc;
char** argv;
/* Instruction */
2010-12-08 21:14:04 +00:00
guac_instruction instruction;
/* Wait for select instruction */
2010-12-08 21:14:04 +00:00
for (;;) {
2011-03-16 06:02:47 +00:00
int result;
/* Wait for data until timeout */
2011-03-16 08:24:17 +00:00
result = guac_instructions_waiting(io);
2011-03-16 06:02:47 +00:00
if (result == 0) {
guac_send_error(io, "Select timeout.");
guac_close(io);
return NULL;
}
/* If error occurs while waiting, exit with failure */
if (result < 0) {
guac_close(io);
return NULL;
}
result = guac_read_instruction(io, &instruction);
2010-12-08 21:14:04 +00:00
if (result < 0) {
guac_close(io);
2010-12-08 21:14:04 +00:00
return NULL;
}
/* Select instruction read */
2010-12-08 21:14:04 +00:00
if (result > 0) {
if (strcmp(instruction.opcode, "select") == 0) {
2010-12-08 21:14:04 +00:00
/* Get protocol from message */
char* protocol = instruction.argv[0];
strcat(protocol_lib, protocol);
strcat(protocol_lib, ".so");
/* Create new client */
client = __guac_alloc_client(io);
/* Load client plugin */
client->client_plugin_handle = dlopen(protocol_lib, RTLD_LAZY);
if (!(client->client_plugin_handle)) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Could not open client plugin for protocol \"%s\": %s\n", protocol, dlerror());
2010-12-08 21:14:04 +00:00
guac_send_error(io, "Could not load server-side client plugin.");
guac_flush(io);
guac_close(io);
2010-12-08 21:14:04 +00:00
guac_free_instruction_data(&instruction);
return NULL;
}
dlerror(); /* Clear errors */
/* Get init function */
alias.obj = dlsym(client->client_plugin_handle, "guac_client_init");
if ((error = dlerror()) != NULL) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Could not get guac_client_init in plugin: %s\n", error);
2010-12-08 21:14:04 +00:00
guac_send_error(io, "Invalid server-side client plugin.");
guac_flush(io);
guac_close(io);
2010-12-08 21:14:04 +00:00
guac_free_instruction_data(&instruction);
return NULL;
}
/* Get usage strig */
client_args = (const char**) dlsym(client->client_plugin_handle, "GUAC_CLIENT_ARGS");
if ((error = dlerror()) != NULL) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Could not get GUAC_CLIENT_ in plugin: %s\n", error);
guac_send_error(io, "Invalid server-side client plugin.");
guac_flush(io);
guac_close(io);
guac_free_instruction_data(&instruction);
return NULL;
}
/* Send args */
guac_send_args(io, client_args);
guac_flush(io);
guac_free_instruction_data(&instruction);
break;
} /* end if select */
guac_free_instruction_data(&instruction);
}
}
/* Wait for connect instruction */
for (;;) {
2011-03-16 06:02:47 +00:00
int result;
/* Wait for data until timeout */
2011-03-16 08:24:17 +00:00
result = guac_instructions_waiting(io);
2011-03-16 06:02:47 +00:00
if (result == 0) {
guac_send_error(io, "Connect timeout.");
guac_close(io);
return NULL;
}
/* If error occurs while waiting, exit with failure */
if (result < 0) {
guac_close(io);
return NULL;
}
result = guac_read_instruction(io, &instruction);
if (result < 0) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Error reading instruction while waiting for connect");
guac_close(io);
return NULL;
}
/* Connect instruction read */
if (result > 0) {
if (strcmp(instruction.opcode, "connect") == 0) {
2010-12-08 21:14:04 +00:00
/* Initialize client arguments */
argc = instruction.argc;
argv = instruction.argv;
if (alias.client_init(client, argc, argv) != 0) {
/* NOTE: On error, proxy client will send appropriate error message */
guac_free_instruction_data(&instruction);
guac_close(io);
2010-12-08 21:14:04 +00:00
return NULL;
}
guac_free_instruction_data(&instruction);
return client;
} /* end if connect */
guac_free_instruction_data(&instruction);
}
}
}
void guac_free_client(guac_client* client) {
if (client->free_handler) {
if (client->free_handler(client))
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Error calling client free handler");
2010-12-08 21:14:04 +00:00
}
guac_close(client->io);
/* Unload client plugin */
if (dlclose(client->client_plugin_handle)) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Could not close client plugin while unloading client: %s", dlerror());
2010-12-08 21:14:04 +00:00
}
free(client);
}
2011-03-12 02:57:53 +00:00
long __guac_current_timestamp() {
#ifdef HAVE_CLOCK_GETTIME
struct timespec current;
/* Get current time */
clock_gettime(CLOCK_REALTIME, &current);
/* Calculate milliseconds */
return current.tv_sec * 1000 + current.tv_nsec / 1000000;
#else
struct timeval current;
/* Get current time */
gettimeofday(&current, NULL);
/* Calculate milliseconds */
return current.tv_sec * 1000 + current.tv_usec / 1000;
#endif
}
2011-03-13 21:52:19 +00:00
void __guac_sleep(int millis) {
#ifdef HAVE_NANOSLEEP
struct timespec sleep_period;
sleep_period.tv_sec = 0;
sleep_period.tv_nsec = millis * 1000000L;
nanosleep(&sleep_period, NULL);
#elif defined(__MINGW32__)
Sleep(millis)
#else
#warning No sleep/nanosleep function available. Clients may not perform as expected. Consider patching libguac to add support for your platform.
#endif
}
2011-03-16 08:24:17 +00:00
typedef struct __guac_client_thread_common {
2011-03-13 21:52:19 +00:00
2011-03-16 08:24:17 +00:00
guac_client* client;
2011-03-12 02:57:53 +00:00
long last_received_timestamp;
long last_sent_timestamp;
2011-03-16 08:24:17 +00:00
int client_active;
2010-12-08 21:14:04 +00:00
2011-03-16 08:24:17 +00:00
} __guac_client_thread_common;
2010-12-08 21:14:04 +00:00
2011-03-16 06:02:47 +00:00
2011-03-16 08:24:17 +00:00
void* __guac_client_output_thread(void* data) {
__guac_client_thread_common* common = (__guac_client_thread_common*) data;
guac_client* client = common->client;
GUACIO* io = client->io;
/* Guacamole client output loop */
while (common->client_active) {
/* Occasionally ping client with sync */
long timestamp = __guac_current_timestamp();
if (timestamp - common->last_sent_timestamp > GUAC_SYNC_FREQUENCY) {
guac_send_sync(io, timestamp);
common->last_sent_timestamp = timestamp;
2011-03-16 06:02:47 +00:00
guac_flush(io);
}
/* Handle server messages */
if (client->handle_messages) {
2011-03-12 03:35:44 +00:00
/* Get previous GUACIO state */
int last_total_written = io->total_written;
2011-03-12 02:57:53 +00:00
/* Only handle messages if synced within threshold */
2011-03-16 08:24:17 +00:00
if (common->last_sent_timestamp - common->last_received_timestamp
2011-03-13 21:52:19 +00:00
< GUAC_SYNC_THRESHOLD) {
2011-03-12 02:57:53 +00:00
int retval = client->handle_messages(client);
if (retval) {
GUAC_LOG_ERROR("Error handling server messages");
2011-03-16 08:24:17 +00:00
break;
2011-03-12 02:57:53 +00:00
}
2011-03-12 03:35:44 +00:00
/* If data was written during message handling */
if (io->total_written != last_total_written) {
2011-03-13 21:52:19 +00:00
/* Sleep as necessary */
__guac_sleep(GUAC_SERVER_MESSAGE_HANDLE_FREQUENCY);
/* Update sync timestamp and send sync instruction */
2011-03-16 08:24:17 +00:00
common->last_sent_timestamp = __guac_current_timestamp();
guac_send_sync(io, common->last_sent_timestamp);
2011-03-13 21:52:19 +00:00
2011-03-12 03:35:44 +00:00
}
2011-03-12 02:57:53 +00:00
guac_flush(io);
}
}
2011-03-16 08:24:17 +00:00
/* If no message handler, just sleep until next sync ping */
else
__guac_sleep(GUAC_SYNC_FREQUENCY);
} /* End of output loop */
common->client_active = 0;
return NULL;
}
void* __guac_client_input_thread(void* data) {
__guac_client_thread_common* common = (__guac_client_thread_common*) data;
guac_client* client = common->client;
GUACIO* io = client->io;
guac_instruction instruction;
/* Guacamole client input loop */
while (common->client_active) {
int wait_result = guac_instructions_waiting(io);
2010-12-08 21:14:04 +00:00
if (wait_result > 0) {
int retval;
retval = guac_read_instruction(io, &instruction); /* 0 if no instructions finished yet, <0 if error or EOF */
if (retval > 0) {
do {
2011-03-12 02:57:53 +00:00
if (strcmp(instruction.opcode, "sync") == 0) {
2011-03-16 08:24:17 +00:00
common->last_received_timestamp = atol(instruction.argv[0]);
if (common->last_received_timestamp > common->last_sent_timestamp) {
2011-03-12 02:57:53 +00:00
guac_send_error(io, "Received sync from future.");
guac_free_instruction_data(&instruction);
2011-03-16 08:24:17 +00:00
break;
2011-03-12 02:57:53 +00:00
}
}
else if (strcmp(instruction.opcode, "mouse") == 0) {
2010-12-08 21:14:04 +00:00
if (client->mouse_handler)
if (
client->mouse_handler(
client,
atoi(instruction.argv[0]), /* x */
atoi(instruction.argv[1]), /* y */
atoi(instruction.argv[2]) /* mask */
)
) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Error handling mouse instruction");
2010-12-08 21:14:04 +00:00
guac_free_instruction_data(&instruction);
2011-03-16 08:24:17 +00:00
break;
2010-12-08 21:14:04 +00:00
}
}
else if (strcmp(instruction.opcode, "key") == 0) {
if (client->key_handler)
if (
client->key_handler(
client,
atoi(instruction.argv[0]), /* keysym */
atoi(instruction.argv[1]) /* pressed */
)
) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Error handling key instruction");
2010-12-08 21:14:04 +00:00
guac_free_instruction_data(&instruction);
2011-03-16 08:24:17 +00:00
break;
2010-12-08 21:14:04 +00:00
}
}
else if (strcmp(instruction.opcode, "clipboard") == 0) {
if (client->clipboard_handler)
if (
client->clipboard_handler(
client,
guac_unescape_string_inplace(instruction.argv[0]) /* data */
)
) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Error handling clipboard instruction");
2010-12-08 21:14:04 +00:00
guac_free_instruction_data(&instruction);
2011-03-16 08:24:17 +00:00
break;
2010-12-08 21:14:04 +00:00
}
}
else if (strcmp(instruction.opcode, "disconnect") == 0) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_INFO("Client requested disconnect");
2010-12-08 21:14:04 +00:00
guac_free_instruction_data(&instruction);
2011-03-16 08:24:17 +00:00
break;
2010-12-08 21:14:04 +00:00
}
guac_free_instruction_data(&instruction);
} while ((retval = guac_read_instruction(io, &instruction)) > 0);
if (retval < 0) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Error reading instruction from stream");
2011-03-16 08:24:17 +00:00
break;
2010-12-08 21:14:04 +00:00
}
}
if (retval < 0) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Error or end of stream");
2011-03-16 08:24:17 +00:00
break; /* EOF or error */
2010-12-08 21:14:04 +00:00
}
/* Otherwise, retval == 0 implies unfinished instruction */
}
else if (wait_result < 0) {
2011-02-09 02:02:27 +00:00
GUAC_LOG_ERROR("Error waiting for next instruction");
2011-03-16 08:24:17 +00:00
break;
}
else { /* wait_result == 0 */
GUAC_LOG_ERROR("Timeout");
break;
2010-12-08 21:14:04 +00:00
}
}
2011-03-16 08:24:17 +00:00
common->client_active = 0;
return NULL;
}
void guac_start_client(guac_client* client) {
pthread_t input_thread, output_thread;
__guac_client_thread_common common;
/* Init thread data */
common.client = client;
common.last_received_timestamp = common.last_sent_timestamp = __guac_current_timestamp();
common.client_active = 1;
if (pthread_create(&output_thread, NULL, __guac_client_output_thread, (void*) &common)) {
/* THIS FUNCTION SHOULD RETURN A VALUE! */
return;
}
if (pthread_create(&input_thread, NULL, __guac_client_input_thread, (void*) &common)) {
/* THIS FUNCTION SHOULD RETURN A VALUE! */
return;
}
/* Wait for I/O threads */
pthread_join(input_thread, NULL);
pthread_join(output_thread, NULL);
/* Done */
2010-12-08 21:14:04 +00:00
}