guacamole-spice-protocol/src/protocols/vnc/client.c

337 lines
9.7 KiB
C
Raw Normal View History

2010-12-08 21:14:04 +00:00
2011-02-16 02:47:51 +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:47:51 +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:47:51 +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:47:51 +00:00
* The Original Code is libguac-client-vnc.
*
* 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):
* James Muehlner
2011-02-16 02:47:51 +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 ***** */
2010-12-08 21:14:04 +00:00
#include <stdlib.h>
#include <string.h>
#include <rfb/rfbclient.h>
#include <guacamole/socket.h>
2010-12-08 21:14:04 +00:00
#include <guacamole/protocol.h>
#include <guacamole/client.h>
#include <guacamole/audio.h>
2011-12-22 02:35:42 +00:00
#include "client.h"
#include "vnc_handlers.h"
#include "guac_handlers.h"
#include "default_pointer.h"
2013-08-09 00:25:08 +00:00
#ifdef ENABLE_PULSE
#include "pulse.h"
2013-08-09 00:25:08 +00:00
#endif
2011-12-22 02:35:42 +00:00
/* Client plugin arguments */
const char* GUAC_CLIENT_ARGS[] = {
"hostname",
"port",
2011-02-11 06:56:47 +00:00
"read-only",
2011-03-14 01:58:31 +00:00
"encodings",
"password",
"swap-red-blue",
2013-02-10 00:39:31 +00:00
"color-depth",
"cursor",
2013-08-21 20:43:47 +00:00
"autoretry",
#ifdef ENABLE_VNC_REPEATER
"dest-host",
"dest-port",
#endif
2013-08-09 00:25:08 +00:00
#ifdef ENABLE_PULSE
2013-08-10 01:21:32 +00:00
"enable-audio",
"audio-servername",
2013-08-09 00:25:08 +00:00
#endif
NULL
};
enum VNC_ARGS_IDX {
IDX_HOSTNAME,
IDX_PORT,
IDX_READ_ONLY,
IDX_ENCODINGS,
IDX_PASSWORD,
IDX_SWAP_RED_BLUE,
IDX_COLOR_DEPTH,
IDX_CURSOR,
2013-08-21 20:43:47 +00:00
IDX_AUTORETRY,
#ifdef ENABLE_VNC_REPEATER
IDX_DEST_HOST,
IDX_DEST_PORT,
#endif
2013-08-09 00:25:08 +00:00
#ifdef ENABLE_PULSE
2013-08-10 01:21:32 +00:00
IDX_ENABLE_AUDIO,
IDX_AUDIO_SERVERNAME,
2013-08-09 00:25:08 +00:00
#endif
VNC_ARGS_COUNT
};
2011-12-22 02:35:42 +00:00
char* __GUAC_CLIENT = "GUAC_CLIENT";
2011-12-22 02:18:25 +00:00
2013-08-21 20:43:47 +00:00
/**
* Allocates a new rfbClient instance given the parameters stored within the
* client, returning NULL on failure.
*/
static rfbClient* __guac_vnc_get_client(guac_client* client) {
rfbClient* rfb_client = rfbGetClient(8, 3, 4); /* 32-bpp client */
vnc_guac_client_data* guac_client_data =
(vnc_guac_client_data*) client->data;
/* Store Guac client in rfb client */
rfbClientSetClientData(rfb_client, __GUAC_CLIENT, client);
/* Framebuffer update handler */
rfb_client->GotFrameBufferUpdate = guac_vnc_update;
rfb_client->GotCopyRect = guac_vnc_copyrect;
/* Do not handle clipboard and local cursor if read-only */
if (guac_client_data->read_only == 0) {
/* Clipboard */
rfb_client->GotXCutText = guac_vnc_cut_text;
/* Set remote cursor */
if (guac_client_data->remote_cursor)
rfb_client->appData.useRemoteCursor = FALSE;
else {
/* Enable client-side cursor */
rfb_client->appData.useRemoteCursor = TRUE;
rfb_client->GotCursorShape = guac_vnc_cursor;
}
}
/* Password */
rfb_client->GetPassword = guac_vnc_get_password;
/* Depth */
guac_vnc_set_pixel_format(rfb_client, guac_client_data->color_depth);
/* Hook into allocation so we can handle resize. */
guac_client_data->rfb_MallocFrameBuffer = rfb_client->MallocFrameBuffer;
rfb_client->MallocFrameBuffer = guac_vnc_malloc_framebuffer;
rfb_client->canHandleNewFBSize = 1;
/* Set hostname and port */
rfb_client->serverHost = strdup(guac_client_data->hostname);
rfb_client->serverPort = guac_client_data->port;
#ifdef ENABLE_VNC_REPEATER
/* Set repeater parameters if specified */
if (guac_client_data->dest_host) {
rfb_client->destHost = strdup(guac_client_data->dest_host);
rfb_client->destPort = guac_client_data->dest_port;
}
#endif
/* Connect */
if (rfbInitClient(rfb_client, NULL, NULL))
return rfb_client;
/* If connection fails, return NULL */
return NULL;
}
2010-12-08 21:14:04 +00:00
int guac_client_init(guac_client* client, int argc, char** argv) {
rfbClient* rfb_client;
vnc_guac_client_data* guac_client_data;
2013-08-21 20:43:47 +00:00
int retries_remaining;
2010-12-08 21:14:04 +00:00
2011-12-22 02:18:25 +00:00
/* Set up libvncclient logging */
2011-12-22 02:35:42 +00:00
rfbClientLog = guac_vnc_client_log_info;
rfbClientErr = guac_vnc_client_log_error;
2011-03-20 07:22:22 +00:00
2011-02-11 06:56:47 +00:00
/*** PARSE ARGUMENTS ***/
2010-12-08 21:14:04 +00:00
if (argc != VNC_ARGS_COUNT) {
guac_protocol_send_error(client->socket, "Wrong argument count received.");
guac_socket_flush(client->socket);
2010-12-08 21:14:04 +00:00
return 1;
}
/* Alloc client data */
guac_client_data = malloc(sizeof(vnc_guac_client_data));
client->data = guac_client_data;
2013-08-21 20:43:47 +00:00
guac_client_data->hostname = strdup(argv[IDX_HOSTNAME]);
guac_client_data->port = atoi(argv[IDX_PORT]);
/* Set remote cursor flag */
2013-08-21 20:43:47 +00:00
guac_client_data->remote_cursor = (strcmp(argv[IDX_CURSOR], "remote") == 0);
/* Set red/blue swap flag */
guac_client_data->swap_red_blue = (strcmp(argv[IDX_SWAP_RED_BLUE], "true") == 0);
2010-12-08 21:14:04 +00:00
2013-08-21 20:43:47 +00:00
/* Set read-only flag */
guac_client_data->read_only = (strcmp(argv[IDX_READ_ONLY], "true") == 0);
2011-03-14 01:58:31 +00:00
/* Freed after use by libvncclient */
guac_client_data->password = strdup(argv[IDX_PASSWORD]);
2010-12-08 21:14:04 +00:00
2013-08-21 20:43:47 +00:00
#ifdef ENABLE_VNC_REPEATER
/* Set repeater parameters if specified */
if (argv[IDX_DEST_HOST][0] != '\0')
guac_client_data->dest_host = strdup(argv[IDX_DEST_HOST]);
else
guac_client_data->dest_host = NULL;
2011-02-11 06:56:47 +00:00
2013-08-21 20:43:47 +00:00
if (argv[IDX_DEST_PORT][0] != '\0')
guac_client_data->dest_port = atoi(argv[IDX_DEST_PORT]);
#endif
2011-02-11 06:56:47 +00:00
2013-08-21 20:43:47 +00:00
/* Set encodings if specified */
if (argv[IDX_ENCODINGS][0] != '\0')
guac_client_data->encodings = strdup(argv[IDX_ENCODINGS]);
else
guac_client_data->encodings = NULL;
2013-08-21 20:43:47 +00:00
/* Parse autoretry */
if (argv[IDX_AUTORETRY][0] != '\0')
retries_remaining = atoi(argv[IDX_AUTORETRY]);
else
retries_remaining = 0;
2011-02-11 06:56:47 +00:00
2013-08-21 20:43:47 +00:00
/* Attempt connection */
rfb_client = __guac_vnc_get_client(client);
2011-02-11 06:56:47 +00:00
2013-08-21 20:43:47 +00:00
/* If unsuccessful, retry as many times as specified */
while (!rfb_client && retries_remaining > 0) {
2011-02-11 06:56:47 +00:00
2013-08-21 20:43:47 +00:00
guac_client_log_info(client,
"Connect failed. Waiting %ims before retrying...",
GUAC_VNC_CONNECT_INTERVAL);
2013-08-21 20:43:47 +00:00
/* Wait for given interval then retry */
usleep(GUAC_VNC_CONNECT_INTERVAL*1000);
rfb_client = __guac_vnc_get_client(client);
retries_remaining--;
2013-02-10 00:39:31 +00:00
2013-08-21 20:43:47 +00:00
}
/* If the final connect attempt fails, return error */
if (!rfb_client) {
guac_protocol_send_error(client->socket,
"Error initializing VNC client");
guac_socket_flush(client->socket);
return 1;
}
2013-08-09 00:25:08 +00:00
#ifdef ENABLE_PULSE
2013-08-10 01:21:32 +00:00
guac_client_data->audio_enabled =
(strcmp(argv[IDX_ENABLE_AUDIO], "true") == 0);
/* If an encoding is available, load an audio stream */
if (guac_client_data->audio_enabled) {
guac_client_data->audio = guac_audio_stream_alloc(client, NULL);
2013-08-10 01:21:32 +00:00
/* Load servername if specified */
if (argv[IDX_AUDIO_SERVERNAME][0] != '\0')
guac_client_data->pa_servername =
strdup(argv[IDX_AUDIO_SERVERNAME]);
else
guac_client_data->pa_servername = NULL;
/* If successful, init audio system */
if (guac_client_data->audio != NULL) {
guac_client_log_info(client,
"Audio will be encoded as %s",
guac_client_data->audio->encoder->mimetype);
2013-08-09 22:11:31 +00:00
/* Require threadsafe sockets if audio enabled */
guac_socket_require_threadsafe(client->socket);
/* Start audio stream */
guac_pa_start_stream(client);
}
/* Otherwise, audio loading failed */
else
guac_client_log_info(client,
"No available audio encoding. Sound disabled.");
} /* end if audio enabled */
2013-08-09 00:25:08 +00:00
#endif
2010-12-08 21:14:04 +00:00
/* Set remaining client data */
guac_client_data->rfb_client = rfb_client;
guac_client_data->copy_rect_used = 0;
guac_client_data->cursor = guac_client_alloc_buffer(client);
2010-12-08 21:14:04 +00:00
/* Set handlers */
client->handle_messages = vnc_guac_client_handle_messages;
client->free_handler = vnc_guac_client_free_handler;
2013-08-21 20:43:47 +00:00
/* If not read-only, set input handlers and pointer */
if (guac_client_data->read_only == 0) {
/* Only handle mouse/keyboard/clipboard if not read-only */
2011-02-11 06:56:47 +00:00
client->mouse_handler = vnc_guac_client_mouse_handler;
client->key_handler = vnc_guac_client_key_handler;
client->clipboard_handler = vnc_guac_client_clipboard_handler;
2013-08-21 20:43:47 +00:00
/* If not read-only but cursor is remote, set a default pointer */
if (guac_client_data->remote_cursor)
guac_vnc_set_default_pointer(client);
2011-02-11 06:56:47 +00:00
}
2010-12-08 21:14:04 +00:00
/* Send name */
guac_protocol_send_name(client->socket, rfb_client->desktopName);
2010-12-08 21:14:04 +00:00
/* Send size */
guac_protocol_send_size(client->socket,
GUAC_DEFAULT_LAYER, rfb_client->width, rfb_client->height);
2010-12-08 21:14:04 +00:00
return 0;
}