593 lines
19 KiB
C
593 lines
19 KiB
C
|
|
/* ***** 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.
|
|
*
|
|
* 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 ***** */
|
|
|
|
|
|
#ifndef _GUAC_CLIENT_H
|
|
#define _GUAC_CLIENT_H
|
|
|
|
#include "guacio.h"
|
|
#include "protocol.h"
|
|
|
|
/**
|
|
* Provides functions and structures required for defining (and handling) a proxy client.
|
|
*
|
|
* @file client.h
|
|
*/
|
|
|
|
/**
|
|
* The time to allow between sync responses in milliseconds. If a sync
|
|
* instruction is sent to the client and no response is received within this
|
|
* timeframe, server messages will not be handled until a sync instruction is
|
|
* received from the client.
|
|
*/
|
|
#define GUAC_SYNC_THRESHOLD 500
|
|
|
|
/**
|
|
* The time to allow between server sync messages in milliseconds. A sync
|
|
* message from the server will be sent every GUAC_SYNC_FREQUENCY milliseconds.
|
|
* As this will induce a response from a client that is not malfunctioning,
|
|
* this is used to detect when a client has died. This must be set to a
|
|
* reasonable value to avoid clients being disconnected unnecessarily due
|
|
* to timeout.
|
|
*/
|
|
#define GUAC_SYNC_FREQUENCY 5000
|
|
|
|
/**
|
|
* The amount of time to wait after handling server messages. If a client
|
|
* plugin has a message handler, and sends instructions when server messages
|
|
* are being handled, there will be a pause of this many milliseconds before
|
|
* the next call to the message handler.
|
|
*/
|
|
#define GUAC_SERVER_MESSAGE_HANDLE_FREQUENCY 50
|
|
|
|
typedef struct guac_client guac_client;
|
|
|
|
/**
|
|
* Handler for server messages (where "server" refers to the server that
|
|
* the proxy client is connected to).
|
|
*/
|
|
typedef int guac_client_handle_messages(guac_client* client);
|
|
|
|
/**
|
|
* Handler for Guacamole mouse events.
|
|
*/
|
|
typedef int guac_client_mouse_handler(guac_client* client, int x, int y, int button_mask);
|
|
|
|
/**
|
|
* Handler for Guacamole key events.
|
|
*/
|
|
typedef int guac_client_key_handler(guac_client* client, int keysym, int pressed);
|
|
|
|
/**
|
|
* Handler for Guacamole clipboard events.
|
|
*/
|
|
typedef int guac_client_clipboard_handler(guac_client* client, char* copied);
|
|
|
|
/**
|
|
* Handler for freeing up any extra data allocated by the client
|
|
* implementation.
|
|
*/
|
|
typedef int guac_client_free_handler(guac_client* client);
|
|
|
|
typedef struct guac_client_update guac_client_update;
|
|
|
|
/**
|
|
* The type of a layer update (png, copy, or rect, for
|
|
* example).
|
|
*/
|
|
typedef enum guac_client_update_type_t {
|
|
|
|
GUAC_CLIENT_UPDATE_PNG,
|
|
GUAC_CLIENT_UPDATE_COPY,
|
|
GUAC_CLIENT_UPDATE_CLIP,
|
|
GUAC_CLIENT_UPDATE_RECT
|
|
|
|
} guac_client_update_type_t;
|
|
|
|
/**
|
|
* Represents an abstract graphical update or state change
|
|
* of a client, including dirty rectangle information.
|
|
*/
|
|
struct guac_client_update {
|
|
|
|
/**
|
|
* The type of this update. Update type corresponds
|
|
* directly to the instruction that would be sent
|
|
* if the queue is flushed.
|
|
*/
|
|
guac_client_update_type_t type;
|
|
|
|
/**
|
|
* The composite mode to use in this update.
|
|
*/
|
|
guac_composite_mode_t mode;
|
|
|
|
/**
|
|
* The layer to retrieve image data from.
|
|
*/
|
|
const guac_layer* src_layer;
|
|
|
|
/**
|
|
* The surface to retrieve image data from.
|
|
*/
|
|
cairo_surface_t* src_image;
|
|
|
|
/**
|
|
* The red component of the source color.
|
|
*/
|
|
int src_red;
|
|
|
|
/**
|
|
* The green component of the source color.
|
|
*/
|
|
int src_green;
|
|
|
|
/**
|
|
* The blue component of the source color.
|
|
*/
|
|
int src_blue;
|
|
|
|
/**
|
|
* The alpha component of the source color.
|
|
*/
|
|
int src_alpha;
|
|
|
|
/**
|
|
* The X coordinage of the upper-left corner of the
|
|
* source rectangle.
|
|
*/
|
|
int src_x;
|
|
|
|
/**
|
|
* The Y coordinage of the upper-left corner of the
|
|
* source rectangle.
|
|
*/
|
|
int src_y;
|
|
|
|
/**
|
|
* The layer this update should affect.
|
|
*/
|
|
const guac_layer* dst_layer;
|
|
|
|
/**
|
|
* The X coordinate of the upper-left corner of the
|
|
* destination rectangle.
|
|
*/
|
|
int dst_x;
|
|
|
|
/**
|
|
* The Y coordinate of the upper-left corner of the
|
|
* destination rectangle.
|
|
*/
|
|
int dst_y;
|
|
|
|
/**
|
|
* The width of the destination or source rectangle.
|
|
* The dimensions of the destination and source
|
|
* rectangles are always identical.
|
|
*/
|
|
int width;
|
|
|
|
/**
|
|
* The height of the destination or source rectangle.
|
|
* The dimensions of the destination and source
|
|
* rectangles are always identical.
|
|
*/
|
|
int height;
|
|
|
|
/**
|
|
* The next update in the update queue, if any.
|
|
*/
|
|
guac_client_update* next;
|
|
|
|
};
|
|
|
|
|
|
/**
|
|
* Possible current states of the Guacamole client. Currently, the only
|
|
* two states are RUNNING and STOPPING.
|
|
*/
|
|
typedef enum guac_client_state {
|
|
|
|
/**
|
|
* The state of the client from when it has been allocated by the main
|
|
* daemon until it is killed or disconnected.
|
|
*/
|
|
RUNNING,
|
|
|
|
/**
|
|
* The state of the client when a stop has been requested, signalling the
|
|
* I/O threads to shutdown.
|
|
*/
|
|
STOPPING
|
|
|
|
} guac_client_state;
|
|
|
|
/**
|
|
* Guacamole proxy client.
|
|
*
|
|
* Represents a Guacamole proxy client (the client which communicates to
|
|
* a server on behalf of Guacamole, on behalf of the web-client).
|
|
*/
|
|
struct guac_client {
|
|
|
|
/**
|
|
* The GUACIO structure to be used to communicate with the web-client. It is
|
|
* expected that the implementor of any Guacamole proxy client will provide
|
|
* their own mechanism of I/O for their protocol. The GUACIO structure is
|
|
* used only to communicate conveniently with the Guacamole web-client.
|
|
*/
|
|
GUACIO* io;
|
|
|
|
/**
|
|
* The current state of the client. When the client is first allocated,
|
|
* this will be initialized to RUNNING. It will remain at RUNNING until
|
|
* an event occurs which requires the client to shutdown, at which point
|
|
* the state becomes STOPPING.
|
|
*/
|
|
guac_client_state state;
|
|
|
|
/**
|
|
* The index of the next available buffer.
|
|
*/
|
|
int next_buffer_index;
|
|
|
|
/**
|
|
* The head pointer of the list of all available (allocated but not used)
|
|
* buffers.
|
|
*/
|
|
guac_layer* available_buffers;
|
|
|
|
/**
|
|
* The head pointer of the list of all allocated layers, regardless of use
|
|
* status.
|
|
*/
|
|
guac_layer* all_layers;
|
|
|
|
/**
|
|
* The first element in this client's update queue.
|
|
*/
|
|
guac_client_update* update_queue_head;
|
|
|
|
/**
|
|
* The last element in this client's update queue.
|
|
*/
|
|
guac_client_update* update_queue_tail;
|
|
|
|
/**
|
|
* The time (in milliseconds) of receipt of the last sync message from
|
|
* the client.
|
|
*/
|
|
guac_timestamp_t last_received_timestamp;
|
|
|
|
/**
|
|
* The time (in milliseconds) that the last sync message was sent to the
|
|
* client.
|
|
*/
|
|
guac_timestamp_t last_sent_timestamp;
|
|
|
|
/**
|
|
* Reference to dlopen'd client plugin.
|
|
*/
|
|
void* client_plugin_handle;
|
|
|
|
/**
|
|
* Arbitrary reference to proxy client-specific data. Implementors of a
|
|
* Guacamole proxy client can store any data they want here, which can then
|
|
* be retrieved as necessary in the message handlers.
|
|
*/
|
|
void* data;
|
|
|
|
/**
|
|
* Handler for server messages. If set, this function will be called
|
|
* occasionally by the Guacamole proxy to give the client a chance to
|
|
* handle messages from whichever server it is connected to.
|
|
*
|
|
* Example:
|
|
* @code
|
|
* void handle_messages(guac_client* client);
|
|
*
|
|
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
|
* client->handle_messages = handle_messages;
|
|
* }
|
|
* @endcode
|
|
*/
|
|
guac_client_handle_messages* handle_messages;
|
|
|
|
/**
|
|
* Handler for mouse events sent by the Gaucamole web-client.
|
|
*
|
|
* The handler takes the integer mouse X and Y coordinates, as well as
|
|
* a button mask containing the bitwise OR of all button values currently
|
|
* being pressed. Those values are:
|
|
*
|
|
* <table>
|
|
* <tr><th>Button</th> <th>Value</th></tr>
|
|
* <tr><td>Left</td> <td>1</td></tr>
|
|
* <tr><td>Middle</td> <td>2</td></tr>
|
|
* <tr><td>Right</td> <td>4</td></tr>
|
|
* <tr><td>Scrollwheel Up</td> <td>8</td></tr>
|
|
* <tr><td>Scrollwheel Down</td><td>16</td></tr>
|
|
* </table>
|
|
|
|
* Example:
|
|
* @code
|
|
* void mouse_handler(guac_client* client, int x, int y, int button_mask);
|
|
*
|
|
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
|
* client->mouse_handler = mouse_handler;
|
|
* }
|
|
* @endcode
|
|
*/
|
|
guac_client_mouse_handler* mouse_handler;
|
|
|
|
/**
|
|
* Handler for key events sent by the Guacamole web-client.
|
|
*
|
|
* The handler takes the integer X11 keysym associated with the key
|
|
* being pressed/released, and an integer representing whether the key
|
|
* is being pressed (1) or released (0).
|
|
*
|
|
* Example:
|
|
* @code
|
|
* void key_handler(guac_client* client, int keysym, int pressed);
|
|
*
|
|
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
|
* client->key_handler = key_handler;
|
|
* }
|
|
* @endcode
|
|
*/
|
|
guac_client_key_handler* key_handler;
|
|
|
|
/**
|
|
* Handler for clipboard events sent by the Guacamole web-client. This
|
|
* handler will be called whenever the web-client sets the data of the
|
|
* clipboard.
|
|
*
|
|
* This handler takes a single string which contains the text which
|
|
* has been set in the clipboard. This text is already unescaped from
|
|
* the Guacamole escaped version sent within the clipboard message
|
|
* in the protocol.
|
|
*
|
|
* Example:
|
|
* @code
|
|
* void clipboard_handler(guac_client* client, char* copied);
|
|
*
|
|
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
|
* client->clipboard_handler = clipboard_handler;
|
|
* }
|
|
* @endcode
|
|
*/
|
|
guac_client_clipboard_handler* clipboard_handler;
|
|
|
|
/**
|
|
* Handler for freeing data when the client is being unloaded.
|
|
*
|
|
* This handler will be called when the client needs to be unloaded
|
|
* by the proxy, and any data allocated by the proxy client should be
|
|
* freed.
|
|
*
|
|
* Implement this handler if you store data inside the client.
|
|
*
|
|
* Example:
|
|
* @code
|
|
* void free_handler(guac_client* client);
|
|
*
|
|
* int guac_client_init(guac_client* client, int argc, char** argv) {
|
|
* client->free_handler = free_handler;
|
|
* }
|
|
* @endcode
|
|
*/
|
|
guac_client_free_handler* free_handler;
|
|
|
|
};
|
|
|
|
/**
|
|
* Handler which should initialize the given guac_client.
|
|
*/
|
|
typedef int guac_client_init_handler(guac_client* client, int argc, char** argv);
|
|
|
|
/**
|
|
* Initialize and return a new guac_client. The pluggable client will be chosen based on
|
|
* the first connect message received on the given file descriptor.
|
|
*
|
|
* @param client_fd The file descriptor associated with the socket associated with the connection to the
|
|
* web-client tunnel.
|
|
* @return A pointer to the newly initialized client.
|
|
*/
|
|
guac_client* guac_get_client(int client_fd);
|
|
|
|
/**
|
|
* Enter the main network message handling loop for the given client.
|
|
*
|
|
* @param client The proxy client to start handling messages of/for.
|
|
* @return Zero if the client successfully started, non-zero if an error
|
|
* occurs during startup. Note that this function will still return
|
|
* zero if an error occurs while the client is running.
|
|
*/
|
|
int guac_start_client(guac_client* client);
|
|
|
|
/**
|
|
* Free all resources associated with the given client.
|
|
*
|
|
* @param client The proxy client to free all reasources of.
|
|
*/
|
|
void guac_free_client(guac_client* client);
|
|
|
|
/**
|
|
* Call the appropriate handler defined by the given client for the given
|
|
* instruction. A comparison is made between the instruction opcode and the
|
|
* initial handler lookup table defined in client-handlers.c. The intial
|
|
* handlers will in turn call the client's handler (if defined).
|
|
*
|
|
* @param client The proxy client whose handlers should be called.
|
|
* @param instruction The instruction to pass to the proxy client via the
|
|
* appropriate handler.
|
|
*/
|
|
int guac_client_handle_instruction(guac_client* client, guac_instruction* instruction);
|
|
|
|
/**
|
|
* Signal the given client to stop. This will set the state of the given client
|
|
* to STOPPING, which signals the I/O threads to shutdown, and ultimately
|
|
* results in shutdown of the client.
|
|
*
|
|
* @param client The proxy client to stop.
|
|
*/
|
|
void guac_client_stop(guac_client* client);
|
|
|
|
/**
|
|
* Allocates a new buffer (invisible layer). An arbitrary index is
|
|
* automatically assigned if no existing buffer is available for use.
|
|
*
|
|
* @param client The proxy client to allocate the buffer for.
|
|
* @return The next available buffer, or a newly allocated buffer.
|
|
*/
|
|
guac_layer* guac_client_alloc_buffer(guac_client* client);
|
|
|
|
/**
|
|
* Allocates a new layer. The layer will be given the specified index,
|
|
* even if the layer returned was a previously used (and free'd) layer.
|
|
*
|
|
* @param client The proxy client to allocate the layer buffer for.
|
|
* @param index The index of the layer to allocate.
|
|
* @return The next available layer, or a newly allocated layer.
|
|
*/
|
|
guac_layer* guac_client_alloc_layer(guac_client* client, int index);
|
|
|
|
/**
|
|
* Returns the given buffer to the pool of available buffers, such that it
|
|
* can be reused by any subsequent call to guac_client_allow_buffer().
|
|
*
|
|
* @param client The proxy client to return the buffer to.
|
|
* @param layer The buffer to return to the pool of available buffers.
|
|
*/
|
|
void guac_client_free_buffer(guac_client* client, guac_layer* layer);
|
|
|
|
/**
|
|
* Queues a png instruction in the given client. The client may combine
|
|
* and re-order multiple instructions into more efficient instructions
|
|
* providing the end result is the same image.
|
|
*
|
|
* @param client The proxy client which will queue the instruction.
|
|
* @param layer The destination layer.
|
|
* @param mode The composite mode to use.
|
|
* @param x The destination X coordinate.
|
|
* @param y The destination Y coordinate.
|
|
* @param surface A cairo surface containing the image data to send.
|
|
*/
|
|
void guac_client_queue_png(guac_client* client, guac_composite_mode_t mode,
|
|
const guac_layer* layer, int x, int y, cairo_surface_t* surface);
|
|
|
|
/**
|
|
* Queues a copy instruction in a given client. The client may combine
|
|
* and re-order multiple instructions into more efficient instructions
|
|
* providing the end result is the same image.
|
|
*
|
|
* @param client The proxy client which will queue the instruction.
|
|
* @param srcl The source layer.
|
|
* @param srcx The X coordinate of the source rectangle.
|
|
* @param srcy The Y coordinate of the source rectangle.
|
|
* @param w The width of the source rectangle.
|
|
* @param h The height of the source rectangle.
|
|
* @param mode The composite mode to use.
|
|
* @param dstl The destination layer.
|
|
* @param dstx The X coordinate of the destination, where the source rectangle
|
|
* should be copied.
|
|
* @param dsty The Y coordinate of the destination, where the source rectangle
|
|
* should be copied.
|
|
*/
|
|
void guac_client_queue_copy(guac_client* client,
|
|
const guac_layer* srcl, int srcx, int srcy, int w, int h,
|
|
guac_composite_mode_t mode, const guac_layer* dstl, int dstx, int dsty);
|
|
|
|
/**
|
|
* Queues a clip instruction in a given client. The client may combine
|
|
* and re-order multiple instructions into more efficient instructions
|
|
* providing the end result is the same image.
|
|
*
|
|
* @param client The proxy client which will queue the instruction.
|
|
* @param layer The layer to set the clipping region of.
|
|
* @param x The X coordinate of the clipping rectangle.
|
|
* @param y The Y coordinate of the clipping rectangle.
|
|
* @param width The width of the clipping rectangle.
|
|
* @param height The height of the clipping rectangle.
|
|
*/
|
|
void guac_client_queue_clip(guac_client* client, const guac_layer* layer,
|
|
int x, int y, int width, int height);
|
|
|
|
/**
|
|
* Queues a rect instruction in a given layer. The layer may combine
|
|
* and re-order multiple instructions into more efficient instructions
|
|
* providing the end result is the same image.
|
|
*
|
|
* @param client The proxy client which will queue the instruction.
|
|
* @param mode The composite mode to use.
|
|
* @param layer The destination layer.
|
|
* @param x The X coordinate of the rectangle.
|
|
* @param y The Y coordinate of the rectangle.
|
|
* @param width The width of the rectangle.
|
|
* @param height The height of the rectangle.
|
|
* @param r The red component of the color of the rectangle.
|
|
* @param g The green component of the color of the rectangle.
|
|
* @param b The blue component of the color of the rectangle.
|
|
* @param a The alpha (transparency) component of the color of the rectangle.
|
|
*/
|
|
void guac_client_queue_rect(guac_client* client,
|
|
const guac_layer* layer, guac_composite_mode_t mode,
|
|
int x, int y, int width, int height,
|
|
int r, int g, int b, int a);
|
|
|
|
/**
|
|
* Flushes any queued instructions in the given client, sending those
|
|
* instructions over the given GUACIO connection. These instructions
|
|
* may not be identical to the instructions originally queued; they
|
|
* may be re-ordered or combined providing the end result of executing
|
|
* all instructions sent by guac_client_queue_flush() is identical to
|
|
* executing all previously queued instructions as specified and in order.
|
|
*
|
|
* @param client The client to flush.
|
|
* @return Zero on success, non-zero on error.
|
|
*/
|
|
int guac_client_queue_flush(guac_client* client);
|
|
|
|
/**
|
|
* The default Guacamole client layer, layer 0.
|
|
*/
|
|
extern const guac_layer* GUAC_DEFAULT_LAYER;
|
|
|
|
#endif
|