/* -*- Mode: C; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
Copyright (C) 2010 Red Hat, Inc.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see .
*/
#include "config.h"
#include
#include
#include
#include "spice-client.h"
#include "spice-common.h"
#include "spice-marshal.h"
#include "spice-util-priv.h"
#include "spice-channel-priv.h"
#include "spice-session-priv.h"
#include "spice-audio-priv.h"
#include "spice-file-transfer-task.h"
/**
* SECTION:channel-main
* @short_description: the main Spice channel
* @title: Main Channel
* @section_id:
* @see_also: #SpiceChannel, and the GTK widget #SpiceDisplay
* @stability: Stable
* @include: spice-client.h
*
* The main channel is the Spice session control channel. It handles
* communication initialization (channels list), migrations, mouse
* modes, multimedia time, and agent communication.
*
*
*/
#define SPICE_MAIN_CHANNEL_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), SPICE_TYPE_MAIN_CHANNEL, SpiceMainChannelPrivate))
#define MAX_DISPLAY 16 /* Note must fit in a guint32, see monitors_align */
typedef struct spice_migrate spice_migrate;
/**
* SECTION:file-transfer-task
* @short_description: Monitoring file transfers
* @title: File Transfer Task
* @section_id:
* @see_also: #SpiceMainChannel
* @stability: Stable
* @include: spice-client.h
*
* SpiceFileTransferTask is an object that represents a particular file
* transfer between the client and the guest. The properties and signals of the
* object can be used to monitor the status and result of the transfer. The
* Main Channel's #SpiceMainChannel::new-file-transfer signal will be emitted
* whenever a new file transfer task is initiated.
*
* Since: 0.31
*/
G_DEFINE_TYPE(SpiceFileTransferTask, spice_file_transfer_task, G_TYPE_OBJECT)
#define FILE_TRANSFER_TASK_PRIVATE(o) \
(G_TYPE_INSTANCE_GET_PRIVATE((o), SPICE_TYPE_FILE_TRANSFER_TASK, SpiceFileTransferTaskPrivate))
#define FILE_XFER_CHUNK_SIZE (VD_AGENT_MAX_DATA_SIZE * 32)
struct _SpiceFileTransferTaskPrivate
/* private */
{
uint32_t id;
gboolean pending;
GFile *file;
SpiceMainChannel *channel;
GFileInputStream *file_stream;
GFileCopyFlags flags;
GCancellable *cancellable;
GFileProgressCallback progress_callback;
gpointer progress_callback_data;
GAsyncReadyCallback callback;
gpointer user_data;
char *buffer;
uint64_t read_bytes;
uint64_t file_size;
gint64 start_time;
gint64 last_update;
GError *error;
};
enum {
PROP_TASK_ID = 1,
PROP_TASK_CHANNEL,
PROP_TASK_CANCELLABLE,
PROP_TASK_FILE,
PROP_TASK_PROGRESS,
};
enum {
SIGNAL_FINISHED,
LAST_TASK_SIGNAL
};
static guint task_signals[LAST_TASK_SIGNAL];
typedef enum {
DISPLAY_UNDEFINED,
DISPLAY_DISABLED,
DISPLAY_ENABLED,
} SpiceDisplayState;
struct _SpiceMainChannelPrivate {
enum SpiceMouseMode mouse_mode;
bool agent_connected;
bool agent_caps_received;
gboolean agent_display_config_sent;
guint8 display_color_depth;
gboolean display_disable_wallpaper:1;
gboolean display_disable_font_smooth:1;
gboolean display_disable_animation:1;
gboolean disable_display_position:1;
gboolean disable_display_align:1;
int agent_tokens;
VDAgentMessage agent_msg; /* partial msg reconstruction */
guint8 *agent_msg_data;
guint agent_msg_pos;
uint8_t agent_msg_size;
uint32_t agent_caps[VD_AGENT_CAPS_SIZE];
struct {
int x;
int y;
int width;
int height;
SpiceDisplayState display_state;
} display[MAX_DISPLAY];
gint timer_id;
GQueue *agent_msg_queue;
GHashTable *file_xfer_tasks;
GHashTable *flushing;
guint switch_host_delayed_id;
guint migrate_delayed_id;
spice_migrate *migrate_data;
int max_clipboard;
gboolean agent_volume_playback_sync;
gboolean agent_volume_record_sync;
GCancellable *cancellable_volume_info;
};
struct spice_migrate {
struct coroutine *from;
SpiceMigrationDstInfo *info;
SpiceSession *session;
guint nchannels;
SpiceChannel *src_channel;
SpiceChannel *dst_channel;
bool do_seamless; /* used as input and output for the seamless migration handshake.
input: whether to send to the dest SPICE_MSGC_MAIN_MIGRATE_DST_DO_SEAMLESS
output: whether the dest approved seamless migration
(SPICE_MSG_MAIN_MIGRATE_DST_SEAMLESS_ACK/NACK)
*/
uint32_t src_mig_version;
};
G_DEFINE_TYPE(SpiceMainChannel, spice_main_channel, SPICE_TYPE_CHANNEL)
/* Properties */
enum {
PROP_0,
PROP_MOUSE_MODE,
PROP_AGENT_CONNECTED,
PROP_AGENT_CAPS_0,
PROP_DISPLAY_DISABLE_WALLPAPER,
PROP_DISPLAY_DISABLE_FONT_SMOOTH,
PROP_DISPLAY_DISABLE_ANIMATION,
PROP_DISPLAY_COLOR_DEPTH,
PROP_DISABLE_DISPLAY_POSITION,
PROP_DISABLE_DISPLAY_ALIGN,
PROP_MAX_CLIPBOARD,
};
/* Signals */
enum {
SPICE_MAIN_MOUSE_UPDATE,
SPICE_MAIN_AGENT_UPDATE,
SPICE_MAIN_CLIPBOARD,
SPICE_MAIN_CLIPBOARD_GRAB,
SPICE_MAIN_CLIPBOARD_REQUEST,
SPICE_MAIN_CLIPBOARD_RELEASE,
SPICE_MAIN_CLIPBOARD_SELECTION,
SPICE_MAIN_CLIPBOARD_SELECTION_GRAB,
SPICE_MAIN_CLIPBOARD_SELECTION_REQUEST,
SPICE_MAIN_CLIPBOARD_SELECTION_RELEASE,
SPICE_MIGRATION_STARTED,
SPICE_MAIN_NEW_FILE_TRANSFER,
SPICE_MAIN_LAST_SIGNAL,
};
static guint signals[SPICE_MAIN_LAST_SIGNAL];
static void spice_main_handle_msg(SpiceChannel *channel, SpiceMsgIn *msg);
static void channel_set_handlers(SpiceChannelClass *klass);
static void agent_send_msg_queue(SpiceMainChannel *channel);
static void agent_free_msg_queue(SpiceMainChannel *channel);
static void migrate_channel_event_cb(SpiceChannel *channel, SpiceChannelEvent event,
gpointer data);
static gboolean main_migrate_handshake_done(gpointer data);
static void spice_main_channel_send_migration_handshake(SpiceChannel *channel);
static void file_xfer_continue_read(SpiceFileTransferTask *task);
static void spice_file_transfer_task_completed(SpiceFileTransferTask *self, GError *error);
static void file_xfer_flushed(SpiceMainChannel *channel, gboolean success);
static void spice_main_set_max_clipboard(SpiceMainChannel *self, gint max);
static void set_agent_connected(SpiceMainChannel *channel, gboolean connected);
/* ------------------------------------------------------------------ */
static const char *agent_msg_types[] = {
[ VD_AGENT_MOUSE_STATE ] = "mouse state",
[ VD_AGENT_MONITORS_CONFIG ] = "monitors config",
[ VD_AGENT_REPLY ] = "reply",
[ VD_AGENT_CLIPBOARD ] = "clipboard",
[ VD_AGENT_DISPLAY_CONFIG ] = "display config",
[ VD_AGENT_ANNOUNCE_CAPABILITIES ] = "announce caps",
[ VD_AGENT_CLIPBOARD_GRAB ] = "clipboard grab",
[ VD_AGENT_CLIPBOARD_REQUEST ] = "clipboard request",
[ VD_AGENT_CLIPBOARD_RELEASE ] = "clipboard release",
[ VD_AGENT_AUDIO_VOLUME_SYNC ] = "volume-sync",
};
static const char *agent_caps[] = {
[ VD_AGENT_CAP_MOUSE_STATE ] = "mouse state",
[ VD_AGENT_CAP_MONITORS_CONFIG ] = "monitors config",
[ VD_AGENT_CAP_REPLY ] = "reply",
[ VD_AGENT_CAP_CLIPBOARD ] = "clipboard (old)",
[ VD_AGENT_CAP_DISPLAY_CONFIG ] = "display config",
[ VD_AGENT_CAP_CLIPBOARD_BY_DEMAND ] = "clipboard",
[ VD_AGENT_CAP_CLIPBOARD_SELECTION ] = "clipboard selection",
[ VD_AGENT_CAP_SPARSE_MONITORS_CONFIG ] = "sparse monitors",
[ VD_AGENT_CAP_GUEST_LINEEND_LF ] = "line-end lf",
[ VD_AGENT_CAP_GUEST_LINEEND_CRLF ] = "line-end crlf",
[ VD_AGENT_CAP_MAX_CLIPBOARD ] = "max-clipboard",
[ VD_AGENT_CAP_AUDIO_VOLUME_SYNC ] = "volume-sync",
[ VD_AGENT_CAP_MONITORS_CONFIG_POSITION ] = "monitors config position",
};
#define NAME(_a, _i) ((_i) < SPICE_N_ELEMENTS(_a) ? (_a[(_i)] ?: "?") : "?")
/* ------------------------------------------------------------------ */
static gboolean test_agent_cap(SpiceMainChannel *channel, guint32 cap)
{
SpiceMainChannelPrivate *c = channel->priv;
if (!c->agent_caps_received)
return FALSE;
return VD_AGENT_HAS_CAPABILITY(c->agent_caps, G_N_ELEMENTS(c->agent_caps), cap);
}
static void spice_main_channel_reset_capabilties(SpiceChannel *channel)
{
spice_channel_set_capability(SPICE_CHANNEL(channel), SPICE_MAIN_CAP_SEMI_SEAMLESS_MIGRATE);
spice_channel_set_capability(SPICE_CHANNEL(channel), SPICE_MAIN_CAP_NAME_AND_UUID);
spice_channel_set_capability(SPICE_CHANNEL(channel), SPICE_MAIN_CAP_AGENT_CONNECTED_TOKENS);
spice_channel_set_capability(SPICE_CHANNEL(channel), SPICE_MAIN_CAP_SEAMLESS_MIGRATE);
}
static void spice_main_channel_init(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c;
c = channel->priv = SPICE_MAIN_CHANNEL_GET_PRIVATE(channel);
c->agent_msg_queue = g_queue_new();
c->file_xfer_tasks = g_hash_table_new_full(g_direct_hash, g_direct_equal,
NULL, g_object_unref);
c->flushing = g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL,
g_object_unref);
c->cancellable_volume_info = g_cancellable_new();
spice_main_channel_reset_capabilties(SPICE_CHANNEL(channel));
}
static gint spice_main_get_max_clipboard(SpiceMainChannel *self)
{
g_return_val_if_fail(SPICE_IS_MAIN_CHANNEL(self), 0);
if (g_getenv("SPICE_MAX_CLIPBOARD"))
return atoi(g_getenv("SPICE_MAX_CLIPBOARD"));
return self->priv->max_clipboard;
}
static void spice_main_get_property(GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
SpiceMainChannel *self = SPICE_MAIN_CHANNEL(object);
SpiceMainChannelPrivate *c = self->priv;
switch (prop_id) {
case PROP_MOUSE_MODE:
g_value_set_int(value, c->mouse_mode);
break;
case PROP_AGENT_CONNECTED:
g_value_set_boolean(value, c->agent_connected);
break;
case PROP_AGENT_CAPS_0:
g_value_set_int(value, c->agent_caps[0]);
break;
case PROP_DISPLAY_DISABLE_WALLPAPER:
g_value_set_boolean(value, c->display_disable_wallpaper);
break;
case PROP_DISPLAY_DISABLE_FONT_SMOOTH:
g_value_set_boolean(value, c->display_disable_font_smooth);
break;
case PROP_DISPLAY_DISABLE_ANIMATION:
g_value_set_boolean(value, c->display_disable_animation);
break;
case PROP_DISPLAY_COLOR_DEPTH:
g_value_set_uint(value, c->display_color_depth);
break;
case PROP_DISABLE_DISPLAY_POSITION:
g_value_set_boolean(value, c->disable_display_position);
break;
case PROP_DISABLE_DISPLAY_ALIGN:
g_value_set_boolean(value, c->disable_display_align);
break;
case PROP_MAX_CLIPBOARD:
g_value_set_int(value, spice_main_get_max_clipboard(self));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
break;
}
}
static void spice_main_set_property(GObject *gobject, guint prop_id,
const GValue *value, GParamSpec *pspec)
{
SpiceMainChannel *self = SPICE_MAIN_CHANNEL(gobject);
SpiceMainChannelPrivate *c = self->priv;
switch (prop_id) {
case PROP_DISPLAY_DISABLE_WALLPAPER:
c->display_disable_wallpaper = g_value_get_boolean(value);
break;
case PROP_DISPLAY_DISABLE_FONT_SMOOTH:
c->display_disable_font_smooth = g_value_get_boolean(value);
break;
case PROP_DISPLAY_DISABLE_ANIMATION:
c->display_disable_animation = g_value_get_boolean(value);
break;
case PROP_DISPLAY_COLOR_DEPTH: {
guint color_depth = g_value_get_uint(value);
g_return_if_fail(color_depth % 8 == 0);
c->display_color_depth = color_depth;
break;
}
case PROP_DISABLE_DISPLAY_POSITION:
c->disable_display_position = g_value_get_boolean(value);
break;
case PROP_DISABLE_DISPLAY_ALIGN:
c->disable_display_align = g_value_get_boolean(value);
break;
case PROP_MAX_CLIPBOARD:
spice_main_set_max_clipboard(self, g_value_get_int(value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(gobject, prop_id, pspec);
break;
}
}
static void spice_main_channel_dispose(GObject *obj)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(obj)->priv;
if (c->timer_id) {
g_source_remove(c->timer_id);
c->timer_id = 0;
}
if (c->switch_host_delayed_id) {
g_source_remove(c->switch_host_delayed_id);
c->switch_host_delayed_id = 0;
}
if (c->migrate_delayed_id) {
g_source_remove(c->migrate_delayed_id);
c->migrate_delayed_id = 0;
}
g_clear_pointer(&c->file_xfer_tasks, g_hash_table_unref);
g_clear_pointer (&c->flushing, g_hash_table_unref);
g_cancellable_cancel(c->cancellable_volume_info);
g_clear_object(&c->cancellable_volume_info);
if (G_OBJECT_CLASS(spice_main_channel_parent_class)->dispose)
G_OBJECT_CLASS(spice_main_channel_parent_class)->dispose(obj);
}
static void spice_main_channel_finalize(GObject *obj)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(obj)->priv;
g_free(c->agent_msg_data);
agent_free_msg_queue(SPICE_MAIN_CHANNEL(obj));
if (G_OBJECT_CLASS(spice_main_channel_parent_class)->finalize)
G_OBJECT_CLASS(spice_main_channel_parent_class)->finalize(obj);
}
/* coroutine context */
static void spice_channel_iterate_write(SpiceChannel *channel)
{
agent_send_msg_queue(SPICE_MAIN_CHANNEL(channel));
if (SPICE_CHANNEL_CLASS(spice_main_channel_parent_class)->iterate_write)
SPICE_CHANNEL_CLASS(spice_main_channel_parent_class)->iterate_write(channel);
}
/* main or coroutine context */
static void spice_main_channel_reset_agent(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c = channel->priv;
GError *error;
GList *tasks;
GList *l;
c->agent_connected = FALSE;
c->agent_caps_received = FALSE;
c->agent_display_config_sent = FALSE;
c->agent_msg_pos = 0;
g_free(c->agent_msg_data);
c->agent_msg_data = NULL;
c->agent_msg_size = 0;
tasks = g_hash_table_get_values(c->file_xfer_tasks);
for (l = tasks; l != NULL; l = l->next) {
SpiceFileTransferTask *task = (SpiceFileTransferTask *)l->data;
error = g_error_new(SPICE_CLIENT_ERROR, SPICE_CLIENT_ERROR_FAILED,
"Agent connection closed");
spice_file_transfer_task_completed(task, error);
}
g_list_free(tasks);
file_xfer_flushed(channel, FALSE);
}
/* main or coroutine context */
static void spice_main_channel_reset(SpiceChannel *channel, gboolean migrating)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
/* This is not part of reset_agent, since the spice-server expects any
pending multi-chunk messages to be completed by the client, even after
it has send an agent-disconnected msg as that is what the original
spicec did. Also see the TODO in server/reds.c reds_reset_vdp() */
c->agent_tokens = 0;
agent_free_msg_queue(SPICE_MAIN_CHANNEL(channel));
c->agent_msg_queue = g_queue_new();
c->agent_volume_playback_sync = FALSE;
c->agent_volume_record_sync = FALSE;
set_agent_connected(SPICE_MAIN_CHANNEL(channel), FALSE);
SPICE_CHANNEL_CLASS(spice_main_channel_parent_class)->channel_reset(channel, migrating);
}
static void spice_main_constructed(GObject *object)
{
SpiceMainChannel *self = SPICE_MAIN_CHANNEL(object);
SpiceMainChannelPrivate *c = self->priv;
/* update default value */
c->max_clipboard = spice_main_get_max_clipboard(self);
if (G_OBJECT_CLASS(spice_main_channel_parent_class)->constructed)
G_OBJECT_CLASS(spice_main_channel_parent_class)->constructed(object);
}
static void spice_main_channel_class_init(SpiceMainChannelClass *klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
SpiceChannelClass *channel_class = SPICE_CHANNEL_CLASS(klass);
gobject_class->dispose = spice_main_channel_dispose;
gobject_class->finalize = spice_main_channel_finalize;
gobject_class->get_property = spice_main_get_property;
gobject_class->set_property = spice_main_set_property;
gobject_class->constructed = spice_main_constructed;
channel_class->handle_msg = spice_main_handle_msg;
channel_class->iterate_write = spice_channel_iterate_write;
channel_class->channel_reset = spice_main_channel_reset;
channel_class->channel_reset_capabilities = spice_main_channel_reset_capabilties;
channel_class->channel_send_migration_handshake = spice_main_channel_send_migration_handshake;
/**
* SpiceMainChannel:mouse-mode:
*
* Spice protocol specifies two mouse modes, client mode and
* server mode. In client mode (%SPICE_MOUSE_MODE_CLIENT), the
* affective mouse is the client side mouse: the client sends
* mouse position within the display and the server sends mouse
* shape messages. In server mode (%SPICE_MOUSE_MODE_SERVER), the
* client sends relative mouse movements and the server sends
* position and shape commands.
**/
g_object_class_install_property
(gobject_class, PROP_MOUSE_MODE,
g_param_spec_int("mouse-mode",
"Mouse mode",
"Mouse mode",
0, INT_MAX, 0,
G_PARAM_READABLE |
G_PARAM_STATIC_NAME |
G_PARAM_STATIC_NICK |
G_PARAM_STATIC_BLURB));
g_object_class_install_property
(gobject_class, PROP_AGENT_CONNECTED,
g_param_spec_boolean("agent-connected",
"Agent connected",
"Whether the agent is connected",
FALSE,
G_PARAM_READABLE |
G_PARAM_STATIC_NAME |
G_PARAM_STATIC_NICK |
G_PARAM_STATIC_BLURB));
g_object_class_install_property
(gobject_class, PROP_AGENT_CAPS_0,
g_param_spec_int("agent-caps-0",
"Agent caps 0",
"Agent capability bits 0 -> 31",
0, INT_MAX, 0,
G_PARAM_READABLE |
G_PARAM_STATIC_NAME |
G_PARAM_STATIC_NICK |
G_PARAM_STATIC_BLURB));
g_object_class_install_property
(gobject_class, PROP_DISPLAY_DISABLE_WALLPAPER,
g_param_spec_boolean("disable-wallpaper",
"Disable guest wallpaper",
"Disable guest wallpaper",
FALSE,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
g_object_class_install_property
(gobject_class, PROP_DISPLAY_DISABLE_FONT_SMOOTH,
g_param_spec_boolean("disable-font-smooth",
"Disable guest font smooth",
"Disable guest font smoothing",
FALSE,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
g_object_class_install_property
(gobject_class, PROP_DISPLAY_DISABLE_ANIMATION,
g_param_spec_boolean("disable-animation",
"Disable guest animations",
"Disable guest animations",
FALSE,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
g_object_class_install_property
(gobject_class, PROP_DISABLE_DISPLAY_POSITION,
g_param_spec_boolean("disable-display-position",
"Disable display position",
"Disable using display position when setting monitor config",
TRUE,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
g_object_class_install_property
(gobject_class, PROP_DISPLAY_COLOR_DEPTH,
g_param_spec_uint("color-depth",
"Color depth",
"Color depth", 0, 32, 0,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
* SpiceMainChannel:disable-display-align:
*
* Disable automatic horizontal display position alignment.
*
* Since: 0.13
*/
g_object_class_install_property
(gobject_class, PROP_DISABLE_DISPLAY_ALIGN,
g_param_spec_boolean("disable-display-align",
"Disable display align",
"Disable display position alignment",
FALSE,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
* SpiceMainChannel:max-clipboard:
*
* Maximum size of clipboard operations in bytes (default 100MB,
* -1 for unlimited size);
*
* Since: 0.22
**/
g_object_class_install_property
(gobject_class, PROP_MAX_CLIPBOARD,
g_param_spec_int("max-clipboard",
"max clipboard",
"Maximum clipboard data size",
-1, G_MAXINT, 100 * 1024 * 1024,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/* TODO use notify instead */
/**
* SpiceMainChannel::main-mouse-update:
* @main: the #SpiceMainChannel that emitted the signal
*
* Notify when the mouse mode has changed.
**/
signals[SPICE_MAIN_MOUSE_UPDATE] =
g_signal_new("main-mouse-update",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET(SpiceMainChannelClass, mouse_update),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE,
0);
/* TODO use notify instead */
/**
* SpiceMainChannel::main-agent-update:
* @main: the #SpiceMainChannel that emitted the signal
*
* Notify when the %SpiceMainChannel:agent-connected or
* %SpiceMainChannel:agent-caps-0 property change.
**/
signals[SPICE_MAIN_AGENT_UPDATE] =
g_signal_new("main-agent-update",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET(SpiceMainChannelClass, agent_update),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE,
0);
/**
* SpiceMainChannel::main-clipboard:
* @main: the #SpiceMainChannel that emitted the signal
* @type: the VD_AGENT_CLIPBOARD data type
* @data: clipboard data
* @size: size of @data in bytes
*
* Provides guest clipboard data requested by spice_main_clipboard_request().
*
* Deprecated: 0.6: use SpiceMainChannel::main-clipboard-selection instead.
**/
signals[SPICE_MAIN_CLIPBOARD] =
g_signal_new("main-clipboard",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED,
0,
NULL, NULL,
g_cclosure_user_marshal_VOID__UINT_POINTER_UINT,
G_TYPE_NONE,
3,
G_TYPE_UINT, G_TYPE_POINTER, G_TYPE_UINT);
/**
* SpiceMainChannel::main-clipboard-selection:
* @main: the #SpiceMainChannel that emitted the signal
* @selection: a VD_AGENT_CLIPBOARD_SELECTION clipboard
* @type: the VD_AGENT_CLIPBOARD data type
* @data: clipboard data
* @size: size of @data in bytes
*
* Informs that clipboard selection data are available.
*
* Since: 0.6
**/
signals[SPICE_MAIN_CLIPBOARD_SELECTION] =
g_signal_new("main-clipboard-selection",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST,
0,
NULL, NULL,
g_cclosure_user_marshal_VOID__UINT_UINT_POINTER_UINT,
G_TYPE_NONE,
4,
G_TYPE_UINT, G_TYPE_UINT, G_TYPE_POINTER, G_TYPE_UINT);
/**
* SpiceMainChannel::main-clipboard-grab:
* @main: the #SpiceMainChannel that emitted the signal
* @types: the VD_AGENT_CLIPBOARD data types
* @ntypes: the number of @types
*
* Inform when clipboard data is available from the guest, and for
* which @types.
*
* Deprecated: 0.6: use SpiceMainChannel::main-clipboard-selection-grab instead.
**/
signals[SPICE_MAIN_CLIPBOARD_GRAB] =
g_signal_new("main-clipboard-grab",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED,
0,
NULL, NULL,
g_cclosure_user_marshal_BOOLEAN__POINTER_UINT,
G_TYPE_BOOLEAN,
2,
G_TYPE_POINTER, G_TYPE_UINT);
/**
* SpiceMainChannel::main-clipboard-selection-grab:
* @main: the #SpiceMainChannel that emitted the signal
* @selection: a VD_AGENT_CLIPBOARD_SELECTION clipboard
* @types: the VD_AGENT_CLIPBOARD data types
* @ntypes: the number of @types
*
* Inform when clipboard data is available from the guest, and for
* which @types.
*
* Since: 0.6
**/
signals[SPICE_MAIN_CLIPBOARD_SELECTION_GRAB] =
g_signal_new("main-clipboard-selection-grab",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST,
0,
NULL, NULL,
g_cclosure_user_marshal_BOOLEAN__UINT_POINTER_UINT,
G_TYPE_BOOLEAN,
3,
G_TYPE_UINT, G_TYPE_POINTER, G_TYPE_UINT);
/**
* SpiceMainChannel::main-clipboard-request:
* @main: the #SpiceMainChannel that emitted the signal
* @types: the VD_AGENT_CLIPBOARD request type
*
* Request clipboard data from the client.
*
* Return value: %TRUE if the request is successful
*
* Deprecated: 0.6: use SpiceMainChannel::main-clipboard-selection-request instead.
**/
signals[SPICE_MAIN_CLIPBOARD_REQUEST] =
g_signal_new("main-clipboard-request",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED,
0,
NULL, NULL,
g_cclosure_user_marshal_BOOLEAN__UINT,
G_TYPE_BOOLEAN,
1,
G_TYPE_UINT);
/**
* SpiceMainChannel::main-clipboard-selection-request:
* @main: the #SpiceMainChannel that emitted the signal
* @selection: a VD_AGENT_CLIPBOARD_SELECTION clipboard
* @types: the VD_AGENT_CLIPBOARD request type
*
* Request clipboard data from the client.
*
* Return value: %TRUE if the request is successful
*
* Since: 0.6
**/
signals[SPICE_MAIN_CLIPBOARD_SELECTION_REQUEST] =
g_signal_new("main-clipboard-selection-request",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST,
0,
NULL, NULL,
g_cclosure_user_marshal_BOOLEAN__UINT_UINT,
G_TYPE_BOOLEAN,
2,
G_TYPE_UINT, G_TYPE_UINT);
/**
* SpiceMainChannel::main-clipboard-release:
* @main: the #SpiceMainChannel that emitted the signal
*
* Inform when the clipboard is released from the guest, when no
* clipboard data is available from the guest.
*
* Deprecated: 0.6: use SpiceMainChannel::main-clipboard-selection-release instead.
**/
signals[SPICE_MAIN_CLIPBOARD_RELEASE] =
g_signal_new("main-clipboard-release",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST | G_SIGNAL_DEPRECATED,
0,
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE,
0);
/**
* SpiceMainChannel::main-clipboard-selection-release:
* @main: the #SpiceMainChannel that emitted the signal
* @selection: a VD_AGENT_CLIPBOARD_SELECTION clipboard
*
* Inform when the clipboard is released from the guest, when no
* clipboard data is available from the guest.
*
* Since: 0.6
**/
signals[SPICE_MAIN_CLIPBOARD_SELECTION_RELEASE] =
g_signal_new("main-clipboard-selection-release",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST,
0,
NULL, NULL,
g_cclosure_marshal_VOID__UINT,
G_TYPE_NONE,
1,
G_TYPE_UINT);
/**
* SpiceMainChannel::migration-started:
* @main: the #SpiceMainChannel that emitted the signal
* @session: a migration #SpiceSession
*
* Inform when migration is starting. Application wishing to make
* connections themself can set the #SpiceSession:client-sockets
* to @TRUE, then follow #SpiceSession::channel-new creation, and
* use spice_channel_open_fd() once the socket is created.
*
**/
signals[SPICE_MIGRATION_STARTED] =
g_signal_new("migration-started",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST,
0,
NULL, NULL,
g_cclosure_marshal_VOID__OBJECT,
G_TYPE_NONE,
1,
G_TYPE_OBJECT);
/**
* SpiceMainChannel::new-file-transfer:
* @main: the #SpiceMainChannel that emitted the signal
* @task: a #SpiceFileTransferTask
*
* This signal is emitted when a new file transfer task has been initiated
* on this channel. Client applications may take a reference on the @task
* object and use it to monitor the status of the file transfer task.
*
* Since: 0.31
**/
signals[SPICE_MAIN_NEW_FILE_TRANSFER] =
g_signal_new("new-file-transfer",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_LAST,
0,
NULL, NULL,
g_cclosure_marshal_VOID__OBJECT,
G_TYPE_NONE,
1,
G_TYPE_OBJECT);
g_type_class_add_private(klass, sizeof(SpiceMainChannelPrivate));
channel_set_handlers(SPICE_CHANNEL_CLASS(klass));
}
/* ------------------------------------------------------------------ */
static void agent_free_msg_queue(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c = channel->priv;
SpiceMsgOut *out;
if (!c->agent_msg_queue)
return;
while (!g_queue_is_empty(c->agent_msg_queue)) {
out = g_queue_pop_head(c->agent_msg_queue);
spice_msg_out_unref(out);
}
g_queue_free(c->agent_msg_queue);
c->agent_msg_queue = NULL;
}
static gboolean flush_foreach_remove(gpointer key G_GNUC_UNUSED,
gpointer value, gpointer user_data)
{
gboolean success = GPOINTER_TO_UINT(user_data);
GTask *result = value;
g_task_return_boolean(result, success);
return TRUE;
}
static void file_xfer_flushed(SpiceMainChannel *channel, gboolean success)
{
SpiceMainChannelPrivate *c = channel->priv;
g_hash_table_foreach_remove(c->flushing, flush_foreach_remove,
GUINT_TO_POINTER(success));
}
static void file_xfer_flush_async(SpiceMainChannel *channel, GCancellable *cancellable,
GAsyncReadyCallback callback, gpointer user_data)
{
GTask *task;
SpiceMainChannelPrivate *c = channel->priv;
gboolean was_empty;
task = g_task_new(channel, cancellable, callback, user_data);
was_empty = g_queue_is_empty(c->agent_msg_queue);
if (was_empty) {
g_task_return_boolean(task, TRUE);
g_object_unref(task);
return;
}
/* wait until the last message currently in the queue has been sent */
g_hash_table_insert(c->flushing, g_queue_peek_tail(c->agent_msg_queue), task);
}
static gboolean file_xfer_flush_finish(SpiceMainChannel *channel, GAsyncResult *result,
GError **error)
{
GTask *task = G_TASK(result);
g_return_val_if_fail(g_task_is_valid(result, channel), FALSE);
return g_task_propagate_boolean(task, error);
}
/* coroutine context */
static void agent_send_msg_queue(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c = channel->priv;
SpiceMsgOut *out;
while (c->agent_tokens > 0 &&
!g_queue_is_empty(c->agent_msg_queue)) {
GTask *task;
c->agent_tokens--;
out = g_queue_pop_head(c->agent_msg_queue);
spice_msg_out_send_internal(out);
task = g_hash_table_lookup(c->flushing, out);
if (task) {
/* if there's a flush task waiting for this message, finish it */
g_task_return_boolean(task, TRUE);
g_hash_table_remove(c->flushing, out);
}
}
if (g_queue_is_empty(c->agent_msg_queue) &&
g_hash_table_size(c->flushing) != 0) {
g_warning("unexpected flush task in list, clearing");
file_xfer_flushed(channel, TRUE);
}
}
/* any context: the message is not flushed immediately,
you can wakeup() the channel coroutine or send_msg_queue()
expected arguments, pair of data/data_size to send terminated with NULL:
agent_msg_queue_many(main, VD_AGENT_...,
&foo, sizeof(Foo),
data, data_size, NULL);
*/
G_GNUC_NULL_TERMINATED
static void agent_msg_queue_many(SpiceMainChannel *channel, int type, const void *data, ...)
{
va_list args;
SpiceMainChannelPrivate *c = channel->priv;
SpiceMsgOut *out;
VDAgentMessage msg;
guint8 *payload;
gsize paysize, s, mins, size = 0;
const guint8 *d;
G_STATIC_ASSERT(VD_AGENT_MAX_DATA_SIZE > sizeof(VDAgentMessage));
va_start(args, data);
for (d = data; d != NULL; d = va_arg(args, void*)) {
size += va_arg(args, gsize);
}
va_end(args);
msg.protocol = VD_AGENT_PROTOCOL;
msg.type = type;
msg.opaque = 0;
msg.size = size;
paysize = MIN(VD_AGENT_MAX_DATA_SIZE, size + sizeof(VDAgentMessage));
out = spice_msg_out_new(SPICE_CHANNEL(channel), SPICE_MSGC_MAIN_AGENT_DATA);
payload = spice_marshaller_reserve_space(out->marshaller, paysize);
memcpy(payload, &msg, sizeof(VDAgentMessage));
payload += sizeof(VDAgentMessage);
paysize -= sizeof(VDAgentMessage);
if (paysize == 0) {
g_queue_push_tail(c->agent_msg_queue, out);
out = NULL;
}
va_start(args, data);
for (d = data; size > 0; d = va_arg(args, void*)) {
s = va_arg(args, gsize);
while (s > 0) {
if (out == NULL) {
paysize = MIN(VD_AGENT_MAX_DATA_SIZE, size);
out = spice_msg_out_new(SPICE_CHANNEL(channel), SPICE_MSGC_MAIN_AGENT_DATA);
payload = spice_marshaller_reserve_space(out->marshaller, paysize);
}
mins = MIN(paysize, s);
memcpy(payload, d, mins);
d += mins;
payload += mins;
s -= mins;
size -= mins;
paysize -= mins;
if (paysize == 0) {
g_queue_push_tail(c->agent_msg_queue, out);
out = NULL;
}
}
}
va_end(args);
g_warn_if_fail(out == NULL);
}
static int monitors_cmp(const void *p1, const void *p2, gpointer user_data)
{
const VDAgentMonConfig *m1 = p1;
const VDAgentMonConfig *m2 = p2;
double d1 = sqrt(m1->x * m1->x + m1->y * m1->y);
double d2 = sqrt(m2->x * m2->x + m2->y * m2->y);
int diff = d1 - d2;
return diff == 0 ? (char*)p1 - (char*)p2 : diff;
}
static void monitors_align(VDAgentMonConfig *monitors, int nmonitors)
{
gint i, j, x = 0;
guint32 used = 0;
VDAgentMonConfig *sorted_monitors;
if (nmonitors == 0)
return;
/* sort by distance from origin */
sorted_monitors = g_memdup(monitors, nmonitors * sizeof(VDAgentMonConfig));
g_qsort_with_data(sorted_monitors, nmonitors, sizeof(VDAgentMonConfig), monitors_cmp, NULL);
/* super-KISS ltr alignment, feel free to improve */
for (i = 0; i < nmonitors; i++) {
/* Find where this monitor is in the sorted order */
for (j = 0; j < nmonitors; j++) {
/* Avoid using the same entry twice, this happens with older
virt-viewer versions which always set x and y to 0 */
if (used & (1 << j))
continue;
if (memcmp(&monitors[j], &sorted_monitors[i],
sizeof(VDAgentMonConfig)) == 0)
break;
}
used |= 1 << j;
monitors[j].x = x;
monitors[j].y = 0;
x += monitors[j].width;
if (monitors[j].width || monitors[j].height)
SPICE_DEBUG("#%d +%d+%d-%dx%d", j, monitors[j].x, monitors[j].y,
monitors[j].width, monitors[j].height);
}
g_free(sorted_monitors);
}
#define agent_msg_queue(Channel, Type, Size, Data) \
agent_msg_queue_many((Channel), (Type), (Data), (Size), NULL)
/**
* spice_main_send_monitor_config:
* @channel: a #SpiceMainChannel
*
* Send monitors configuration previously set with
* spice_main_set_display() and spice_main_set_display_enabled()
*
* Returns: %TRUE on success.
**/
gboolean spice_main_send_monitor_config(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c;
VDAgentMonitorsConfig *mon;
int i, j, monitors;
size_t size;
g_return_val_if_fail(SPICE_IS_MAIN_CHANNEL(channel), FALSE);
c = channel->priv;
g_return_val_if_fail(c->agent_connected, FALSE);
if (spice_main_agent_test_capability(channel,
VD_AGENT_CAP_SPARSE_MONITORS_CONFIG)) {
monitors = SPICE_N_ELEMENTS(c->display);
} else {
monitors = 0;
for (i = 0; i < SPICE_N_ELEMENTS(c->display); i++) {
if (c->display[i].display_state == DISPLAY_ENABLED)
monitors += 1;
}
}
size = sizeof(VDAgentMonitorsConfig) + sizeof(VDAgentMonConfig) * monitors;
mon = g_malloc0(size);
mon->num_of_monitors = monitors;
if (c->disable_display_position == FALSE ||
c->disable_display_align == FALSE)
mon->flags |= VD_AGENT_CONFIG_MONITORS_FLAG_USE_POS;
CHANNEL_DEBUG(channel, "sending new monitors config to guest");
j = 0;
for (i = 0; i < SPICE_N_ELEMENTS(c->display); i++) {
if (c->display[i].display_state != DISPLAY_ENABLED) {
if (spice_main_agent_test_capability(channel,
VD_AGENT_CAP_SPARSE_MONITORS_CONFIG))
j++;
continue;
}
mon->monitors[j].depth = c->display_color_depth ? c->display_color_depth : 32;
mon->monitors[j].width = c->display[i].width;
mon->monitors[j].height = c->display[i].height;
mon->monitors[j].x = c->display[i].x;
mon->monitors[j].y = c->display[i].y;
CHANNEL_DEBUG(channel, "monitor #%d: %dx%d+%d+%d @ %d bpp", j,
mon->monitors[j].width, mon->monitors[j].height,
mon->monitors[j].x, mon->monitors[j].y,
mon->monitors[j].depth);
j++;
}
if (c->disable_display_align == FALSE)
monitors_align(mon->monitors, mon->num_of_monitors);
agent_msg_queue(channel, VD_AGENT_MONITORS_CONFIG, size, mon);
g_free(mon);
spice_channel_wakeup(SPICE_CHANNEL(channel), FALSE);
if (c->timer_id != 0) {
g_source_remove(c->timer_id);
c->timer_id = 0;
}
return TRUE;
}
static void audio_playback_volume_info_cb(GObject *object, GAsyncResult *res, gpointer user_data)
{
SpiceMainChannel *main_channel = user_data;
SpiceSession *session = spice_channel_get_session(SPICE_CHANNEL(main_channel));
SpiceAudio *audio = spice_audio_get(session, NULL);
VDAgentAudioVolumeSync *avs;
guint16 *volume;
guint8 nchannels;
gboolean mute, ret;
gsize array_size;
GError *error = NULL;
ret = spice_audio_get_playback_volume_info_finish(audio, res, &mute, &nchannels,
&volume, &error);
if (ret == FALSE || volume == NULL || nchannels == 0) {
if (error != NULL) {
g_warning("Failed to get playback async volume info: %s", error->message);
g_error_free(error);
} else {
SPICE_DEBUG("Failed to get playback async volume info");
}
main_channel->priv->agent_volume_playback_sync = FALSE;
return;
}
array_size = sizeof(uint16_t) * nchannels;
avs = g_malloc0(sizeof(VDAgentAudioVolumeSync) + array_size);
avs->is_playback = TRUE;
avs->mute = mute;
avs->nchannels = nchannels;
memcpy(avs->volume, volume, array_size);
SPICE_DEBUG("%s mute=%s nchannels=%u volume[0]=%u",
__func__, spice_yes_no(mute), nchannels, volume[0]);
g_free(volume);
agent_msg_queue(main_channel, VD_AGENT_AUDIO_VOLUME_SYNC,
sizeof(VDAgentAudioVolumeSync) + array_size, avs);
}
static void agent_sync_audio_playback(SpiceMainChannel *main_channel)
{
SpiceSession *session = spice_channel_get_session(SPICE_CHANNEL(main_channel));
SpiceAudio *audio = spice_audio_get(session, NULL);
SpiceMainChannelPrivate *c = main_channel->priv;
if (audio == NULL ||
!test_agent_cap(main_channel, VD_AGENT_CAP_AUDIO_VOLUME_SYNC) ||
c->agent_volume_playback_sync == TRUE) {
SPICE_DEBUG("%s - is not going to sync audio with guest", __func__);
return;
}
/* only one per connection */
g_cancellable_reset(c->cancellable_volume_info);
c->agent_volume_playback_sync = TRUE;
spice_audio_get_playback_volume_info_async(audio, c->cancellable_volume_info, main_channel,
audio_playback_volume_info_cb, main_channel);
}
static void audio_record_volume_info_cb(GObject *object, GAsyncResult *res, gpointer user_data)
{
SpiceMainChannel *main_channel = user_data;
SpiceSession *session = spice_channel_get_session(SPICE_CHANNEL(main_channel));
SpiceAudio *audio = spice_audio_get(session, NULL);
VDAgentAudioVolumeSync *avs;
guint16 *volume;
guint8 nchannels;
gboolean ret, mute;
gsize array_size;
GError *error = NULL;
ret = spice_audio_get_record_volume_info_finish(audio, res, &mute, &nchannels, &volume, &error);
if (ret == FALSE || volume == NULL || nchannels == 0) {
if (error != NULL) {
g_warning("Failed to get record async volume info: %s", error->message);
g_error_free(error);
} else {
SPICE_DEBUG("Failed to get record async volume info");
}
main_channel->priv->agent_volume_record_sync = FALSE;
return;
}
array_size = sizeof(uint16_t) * nchannels;
avs = g_malloc0(sizeof(VDAgentAudioVolumeSync) + array_size);
avs->is_playback = FALSE;
avs->mute = mute;
avs->nchannels = nchannels;
memcpy(avs->volume, volume, array_size);
SPICE_DEBUG("%s mute=%s nchannels=%u volume[0]=%u",
__func__, spice_yes_no(mute), nchannels, volume[0]);
g_free(volume);
agent_msg_queue(main_channel, VD_AGENT_AUDIO_VOLUME_SYNC,
sizeof(VDAgentAudioVolumeSync) + array_size, avs);
}
static void agent_sync_audio_record(SpiceMainChannel *main_channel)
{
SpiceSession *session = spice_channel_get_session(SPICE_CHANNEL(main_channel));
SpiceAudio *audio = spice_audio_get(session, NULL);
SpiceMainChannelPrivate *c = main_channel->priv;
if (audio == NULL ||
!test_agent_cap(main_channel, VD_AGENT_CAP_AUDIO_VOLUME_SYNC) ||
c->agent_volume_record_sync == TRUE) {
SPICE_DEBUG("%s - is not going to sync audio with guest", __func__);
return;
}
/* only one per connection */
g_cancellable_reset(c->cancellable_volume_info);
c->agent_volume_record_sync = TRUE;
spice_audio_get_record_volume_info_async(audio, c->cancellable_volume_info, main_channel,
audio_record_volume_info_cb, main_channel);
}
/* any context: the message is not flushed immediately,
you can wakeup() the channel coroutine or send_msg_queue() */
static void agent_display_config(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c = channel->priv;
VDAgentDisplayConfig config = { 0, };
if (c->display_disable_wallpaper) {
config.flags |= VD_AGENT_DISPLAY_CONFIG_FLAG_DISABLE_WALLPAPER;
}
if (c->display_disable_font_smooth) {
config.flags |= VD_AGENT_DISPLAY_CONFIG_FLAG_DISABLE_FONT_SMOOTH;
}
if (c->display_disable_animation) {
config.flags |= VD_AGENT_DISPLAY_CONFIG_FLAG_DISABLE_ANIMATION;
}
if (c->display_color_depth != 0) {
config.flags |= VD_AGENT_DISPLAY_CONFIG_FLAG_SET_COLOR_DEPTH;
config.depth = c->display_color_depth;
}
CHANNEL_DEBUG(channel, "display_config: flags: %u, depth: %u", config.flags, config.depth);
agent_msg_queue(channel, VD_AGENT_DISPLAY_CONFIG, sizeof(VDAgentDisplayConfig), &config);
}
/* any context: the message is not flushed immediately,
you can wakeup() the channel coroutine or send_msg_queue() */
static void agent_announce_caps(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c = channel->priv;
VDAgentAnnounceCapabilities *caps;
size_t size;
if (!c->agent_connected)
return;
size = sizeof(VDAgentAnnounceCapabilities) + VD_AGENT_CAPS_BYTES;
caps = g_malloc0(size);
if (!c->agent_caps_received)
caps->request = 1;
VD_AGENT_SET_CAPABILITY(caps->caps, VD_AGENT_CAP_MOUSE_STATE);
VD_AGENT_SET_CAPABILITY(caps->caps, VD_AGENT_CAP_MONITORS_CONFIG);
VD_AGENT_SET_CAPABILITY(caps->caps, VD_AGENT_CAP_REPLY);
VD_AGENT_SET_CAPABILITY(caps->caps, VD_AGENT_CAP_DISPLAY_CONFIG);
VD_AGENT_SET_CAPABILITY(caps->caps, VD_AGENT_CAP_CLIPBOARD_BY_DEMAND);
VD_AGENT_SET_CAPABILITY(caps->caps, VD_AGENT_CAP_CLIPBOARD_SELECTION);
VD_AGENT_SET_CAPABILITY(caps->caps, VD_AGENT_CAP_MONITORS_CONFIG_POSITION);
agent_msg_queue(channel, VD_AGENT_ANNOUNCE_CAPABILITIES, size, caps);
g_free(caps);
}
/* any context: the message is not flushed immediately,
you can wakeup() the channel coroutine or send_msg_queue() */
static void agent_clipboard_grab(SpiceMainChannel *channel, guint selection,
guint32 *types, int ntypes)
{
SpiceMainChannelPrivate *c = channel->priv;
guint8 *msg;
VDAgentClipboardGrab *grab;
size_t size;
int i;
if (!c->agent_connected)
return;
g_return_if_fail(test_agent_cap(channel, VD_AGENT_CAP_CLIPBOARD_BY_DEMAND));
size = sizeof(VDAgentClipboardGrab) + sizeof(uint32_t) * ntypes;
if (test_agent_cap(channel, VD_AGENT_CAP_CLIPBOARD_SELECTION)) {
size += 4;
} else if (selection != VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD) {
CHANNEL_DEBUG(channel, "Ignoring clipboard grab");
return;
}
msg = g_alloca(size);
memset(msg, 0, size);
grab = (VDAgentClipboardGrab *)msg;
if (test_agent_cap(channel, VD_AGENT_CAP_CLIPBOARD_SELECTION)) {
msg[0] = selection;
grab = (VDAgentClipboardGrab *)(msg + 4);
}
for (i = 0; i < ntypes; i++) {
grab->types[i] = types[i];
}
agent_msg_queue(channel, VD_AGENT_CLIPBOARD_GRAB, size, msg);
}
/* any context: the message is not flushed immediately,
you can wakeup() the channel coroutine or send_msg_queue() */
static void agent_clipboard_notify(SpiceMainChannel *self, guint selection,
guint32 type, const guchar *data, size_t size)
{
SpiceMainChannelPrivate *c = self->priv;
VDAgentClipboard *cb;
guint8 *msg;
size_t msgsize;
gint max_clipboard = spice_main_get_max_clipboard(self);
g_return_if_fail(c->agent_connected);
g_return_if_fail(test_agent_cap(self, VD_AGENT_CAP_CLIPBOARD_BY_DEMAND));
g_return_if_fail(max_clipboard == -1 || size < max_clipboard);
msgsize = sizeof(VDAgentClipboard);
if (test_agent_cap(self, VD_AGENT_CAP_CLIPBOARD_SELECTION)) {
msgsize += 4;
} else if (selection != VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD) {
CHANNEL_DEBUG(self, "Ignoring clipboard notify");
return;
}
msg = g_alloca(msgsize);
memset(msg, 0, msgsize);
cb = (VDAgentClipboard *)msg;
if (test_agent_cap(self, VD_AGENT_CAP_CLIPBOARD_SELECTION)) {
msg[0] = selection;
cb = (VDAgentClipboard *)(msg + 4);
}
cb->type = type;
agent_msg_queue_many(self, VD_AGENT_CLIPBOARD, msg, msgsize, data, size, NULL);
}
/* any context: the message is not flushed immediately,
you can wakeup() the channel coroutine or send_msg_queue() */
static void agent_clipboard_request(SpiceMainChannel *channel, guint selection, guint32 type)
{
SpiceMainChannelPrivate *c = channel->priv;
VDAgentClipboardRequest *request;
guint8 *msg;
size_t msgsize;
g_return_if_fail(c->agent_connected);
g_return_if_fail(test_agent_cap(channel, VD_AGENT_CAP_CLIPBOARD_BY_DEMAND));
msgsize = sizeof(VDAgentClipboardRequest);
if (test_agent_cap(channel, VD_AGENT_CAP_CLIPBOARD_SELECTION)) {
msgsize += 4;
} else if (selection != VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD) {
SPICE_DEBUG("Ignoring clipboard request");
return;
}
msg = g_alloca(msgsize);
memset(msg, 0, msgsize);
request = (VDAgentClipboardRequest *)msg;
if (test_agent_cap(channel, VD_AGENT_CAP_CLIPBOARD_SELECTION)) {
msg[0] = selection;
request = (VDAgentClipboardRequest *)(msg + 4);
}
request->type = type;
agent_msg_queue(channel, VD_AGENT_CLIPBOARD_REQUEST, msgsize, msg);
}
/* any context: the message is not flushed immediately,
you can wakeup() the channel coroutine or send_msg_queue() */
static void agent_clipboard_release(SpiceMainChannel *channel, guint selection)
{
SpiceMainChannelPrivate *c = channel->priv;
guint8 msg[4] = { 0, };
guint8 msgsize = 0;
g_return_if_fail(c->agent_connected);
g_return_if_fail(test_agent_cap(channel, VD_AGENT_CAP_CLIPBOARD_BY_DEMAND));
if (test_agent_cap(channel, VD_AGENT_CAP_CLIPBOARD_SELECTION)) {
msg[0] = selection;
msgsize += 4;
} else if (selection != VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD) {
SPICE_DEBUG("Ignoring clipboard release");
return;
}
agent_msg_queue(channel, VD_AGENT_CLIPBOARD_RELEASE, msgsize, msg);
}
static gboolean any_display_has_dimensions(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c;
guint i;
g_return_val_if_fail(SPICE_IS_MAIN_CHANNEL(channel), FALSE);
c = channel->priv;
for (i = 0; i < MAX_DISPLAY; i++) {
if (c->display[i].width > 0 && c->display[i].height > 0)
return TRUE;
}
return FALSE;
}
/* main context*/
static gboolean timer_set_display(gpointer data)
{
SpiceMainChannel *channel = data;
SpiceMainChannelPrivate *c = channel->priv;
SpiceSession *session;
gint i;
c->timer_id = 0;
if (!c->agent_connected)
return FALSE;
if (!any_display_has_dimensions(channel)) {
SPICE_DEBUG("Not sending monitors config, at least one monitor must have dimensions");
return FALSE;
}
session = spice_channel_get_session(SPICE_CHANNEL(channel));
if (!spice_main_agent_test_capability(channel, VD_AGENT_CAP_SPARSE_MONITORS_CONFIG)) {
/* ensure we have an explicit monitor configuration at least for
number of display channels */
for (i = 0; i < spice_session_get_n_display_channels(session); i++)
if (c->display[i].display_state == DISPLAY_UNDEFINED) {
SPICE_DEBUG("Not sending monitors config, missing monitors");
return FALSE;
}
}
spice_main_send_monitor_config(channel);
return FALSE;
}
/* any context */
static void update_display_timer(SpiceMainChannel *channel, guint seconds)
{
SpiceMainChannelPrivate *c = channel->priv;
if (c->timer_id)
g_source_remove(c->timer_id);
c->timer_id = g_timeout_add_seconds(seconds, timer_set_display, channel);
}
/* coroutine context */
static void set_agent_connected(SpiceMainChannel *channel, gboolean connected)
{
SpiceMainChannelPrivate *c = channel->priv;
SPICE_DEBUG("agent connected: %s", spice_yes_no(connected));
if (connected != c->agent_connected) {
c->agent_connected = connected;
g_coroutine_object_notify(G_OBJECT(channel), "agent-connected");
}
if (!connected)
spice_main_channel_reset_agent(SPICE_MAIN_CHANNEL(channel));
g_coroutine_signal_emit(channel, signals[SPICE_MAIN_AGENT_UPDATE], 0);
}
/* coroutine context */
static void agent_start(SpiceMainChannel *channel)
{
SpiceMainChannelPrivate *c = channel->priv;
SpiceMsgcMainAgentStart agent_start = {
.num_tokens = ~0,
};
SpiceMsgOut *out;
c->agent_volume_playback_sync = FALSE;
c->agent_volume_record_sync = FALSE;
c->agent_caps_received = false;
set_agent_connected(channel, TRUE);
out = spice_msg_out_new(SPICE_CHANNEL(channel), SPICE_MSGC_MAIN_AGENT_START);
out->marshallers->msgc_main_agent_start(out->marshaller, &agent_start);
spice_msg_out_send_internal(out);
if (c->agent_connected) {
agent_announce_caps(channel);
agent_send_msg_queue(channel);
}
}
/* coroutine context */
static void agent_stopped(SpiceMainChannel *channel)
{
set_agent_connected(channel, FALSE);
}
/* coroutine context */
static void set_mouse_mode(SpiceMainChannel *channel, uint32_t supported, uint32_t current)
{
SpiceMainChannelPrivate *c = channel->priv;
if (c->mouse_mode != current) {
c->mouse_mode = current;
g_coroutine_signal_emit(channel, signals[SPICE_MAIN_MOUSE_UPDATE], 0);
g_coroutine_object_notify(G_OBJECT(channel), "mouse-mode");
}
/* switch to client mode if possible */
if (!spice_channel_get_read_only(SPICE_CHANNEL(channel)) &&
supported & SPICE_MOUSE_MODE_CLIENT &&
current != SPICE_MOUSE_MODE_CLIENT) {
SpiceMsgcMainMouseModeRequest req = {
.mode = SPICE_MOUSE_MODE_CLIENT,
};
SpiceMsgOut *out;
out = spice_msg_out_new(SPICE_CHANNEL(channel), SPICE_MSGC_MAIN_MOUSE_MODE_REQUEST);
out->marshallers->msgc_main_mouse_mode_request(out->marshaller, &req);
spice_msg_out_send_internal(out);
}
}
/* coroutine context */
static void main_handle_init(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
SpiceMsgMainInit *init = spice_msg_in_parsed(in);
SpiceSession *session;
SpiceMsgOut *out;
session = spice_channel_get_session(channel);
spice_session_set_connection_id(session, init->session_id);
set_mouse_mode(SPICE_MAIN_CHANNEL(channel), init->supported_mouse_modes,
init->current_mouse_mode);
spice_session_set_mm_time(session, init->multi_media_time);
spice_session_set_caches_hints(session, init->ram_hint, init->display_channels_hint);
c->agent_tokens = init->agent_tokens;
if (init->agent_connected)
agent_start(SPICE_MAIN_CHANNEL(channel));
if (spice_session_migrate_after_main_init(session))
return;
out = spice_msg_out_new(SPICE_CHANNEL(channel), SPICE_MSGC_MAIN_ATTACH_CHANNELS);
spice_msg_out_send_internal(out);
}
/* coroutine context */
static void main_handle_name(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMsgMainName *name = spice_msg_in_parsed(in);
SpiceSession *session = spice_channel_get_session(channel);
SPICE_DEBUG("server name: %s", name->name);
spice_session_set_name(session, (const gchar *)name->name);
}
/* coroutine context */
static void main_handle_uuid(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMsgMainUuid *uuid = spice_msg_in_parsed(in);
SpiceSession *session = spice_channel_get_session(channel);
gchar *uuid_str = spice_uuid_to_string(uuid->uuid);
SPICE_DEBUG("server uuid: %s", uuid_str);
spice_session_set_uuid(session, uuid->uuid);
g_free(uuid_str);
}
/* coroutine context */
static void main_handle_mm_time(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceSession *session;
SpiceMsgMainMultiMediaTime *msg = spice_msg_in_parsed(in);
session = spice_channel_get_session(channel);
spice_session_set_mm_time(session, msg->time);
}
typedef struct channel_new {
SpiceSession *session;
int type;
int id;
} channel_new_t;
/* main context */
static gboolean _channel_new(channel_new_t *c)
{
g_return_val_if_fail(c != NULL, FALSE);
spice_channel_new(c->session, c->type, c->id);
g_object_unref(c->session);
g_free(c);
return FALSE;
}
/* coroutine context */
static void main_handle_channels_list(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMsgChannels *msg = spice_msg_in_parsed(in);
SpiceSession *session;
int i;
session = spice_channel_get_session(channel);
/* guarantee that uuid is notified before setting up the channels, even if
* the server is older and doesn't actually send the uuid */
g_coroutine_object_notify(G_OBJECT(session), "uuid");
for (i = 0; i < msg->num_of_channels; i++) {
channel_new_t *c;
c = g_new(channel_new_t, 1);
c->session = g_object_ref(session);
c->type = msg->channels[i].type;
c->id = msg->channels[i].id;
/* no need to explicitely switch to main context, since
synchronous call is not needed. */
/* no need to track idle, session is refed */
g_idle_add((GSourceFunc)_channel_new, c);
}
}
/* coroutine context */
static void main_handle_mouse_mode(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMsgMainMouseMode *msg = spice_msg_in_parsed(in);
set_mouse_mode(SPICE_MAIN_CHANNEL(channel), msg->supported_modes, msg->current_mode);
}
/* coroutine context */
static void main_handle_agent_connected(SpiceChannel *channel, SpiceMsgIn *in)
{
agent_start(SPICE_MAIN_CHANNEL(channel));
}
/* coroutine context */
static void main_handle_agent_connected_tokens(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
SpiceMsgMainAgentConnectedTokens *msg = spice_msg_in_parsed(in);
c->agent_tokens = msg->num_tokens;
agent_start(SPICE_MAIN_CHANNEL(channel));
}
/* coroutine context */
static void main_handle_agent_disconnected(SpiceChannel *channel, SpiceMsgIn *in)
{
agent_stopped(SPICE_MAIN_CHANNEL(channel));
}
/* main context */
static void file_xfer_close_cb(GObject *object,
GAsyncResult *close_res,
gpointer user_data)
{
GTask *task;
SpiceFileTransferTask *self;
GError *error = NULL;
self = user_data;
if (object) {
GInputStream *stream = G_INPUT_STREAM(object);
g_input_stream_close_finish(stream, close_res, &error);
if (error) {
/* This error dont need to report to user, just print a log */
SPICE_DEBUG("close file error: %s", error->message);
g_clear_error(&error);
}
}
/* Notify to user that files have been transferred or something error
happened. */
task = g_task_new(self->priv->channel,
self->priv->cancellable,
self->priv->callback,
self->priv->user_data);
if (self->priv->error) {
g_task_return_error(task, self->priv->error);
} else {
g_task_return_boolean(task, TRUE);
if (spice_util_get_debug()) {
gint64 now = g_get_monotonic_time();
gchar *basename = g_file_get_basename(self->priv->file);
double seconds = (double) (now - self->priv->start_time) / G_TIME_SPAN_SECOND;
gchar *file_size_str = g_format_size(self->priv->file_size);
gchar *transfer_speed_str = g_format_size(self->priv->file_size / seconds);
g_warn_if_fail(self->priv->read_bytes == self->priv->file_size);
SPICE_DEBUG("transferred file %s of %s size in %.1f seconds (%s/s)",
basename, file_size_str, seconds, transfer_speed_str);
g_free(basename);
g_free(file_size_str);
g_free(transfer_speed_str);
}
}
g_object_unref(task);
g_object_unref(self);
}
static void file_xfer_data_flushed_cb(GObject *source_object,
GAsyncResult *res,
gpointer user_data)
{
SpiceFileTransferTask *self = user_data;
SpiceMainChannel *channel = (SpiceMainChannel *)source_object;
GError *error = NULL;
self->priv->pending = FALSE;
file_xfer_flush_finish(channel, res, &error);
if (error || self->priv->error) {
spice_file_transfer_task_completed(self, error);
return;
}
if (spice_util_get_debug()) {
const GTimeSpan interval = 20 * G_TIME_SPAN_SECOND;
gint64 now = g_get_monotonic_time();
if (interval < now - self->priv->last_update) {
gchar *basename = g_file_get_basename(self->priv->file);
self->priv->last_update = now;
SPICE_DEBUG("transferred %.2f%% of the file %s",
100.0 * self->priv->read_bytes / self->priv->file_size, basename);
g_free(basename);
}
}
if (self->priv->progress_callback) {
goffset read = 0;
goffset total = 0;
SpiceMainChannel *main_channel = self->priv->channel;
GHashTableIter iter;
gpointer key, value;
/* since the progress_callback does not have a parameter to indicate
* which file the progress is associated with, report progress on all
* current transfers */
g_hash_table_iter_init(&iter, main_channel->priv->file_xfer_tasks);
while (g_hash_table_iter_next(&iter, &key, &value)) {
SpiceFileTransferTask *t = (SpiceFileTransferTask *)value;
read += t->priv->read_bytes;
total += t->priv->file_size;
}
self->priv->progress_callback(read, total, self->priv->progress_callback_data);
}
/* Read more data */
file_xfer_continue_read(self);
}
static void file_xfer_queue(SpiceFileTransferTask *self, int data_size)
{
VDAgentFileXferDataMessage msg;
SpiceMainChannel *channel = SPICE_MAIN_CHANNEL(self->priv->channel);
msg.id = self->priv->id;
msg.size = data_size;
agent_msg_queue_many(channel, VD_AGENT_FILE_XFER_DATA,
&msg, sizeof(msg),
self->priv->buffer, data_size, NULL);
spice_channel_wakeup(SPICE_CHANNEL(channel), FALSE);
}
/* main context */
static void file_xfer_read_cb(GObject *source_object,
GAsyncResult *res,
gpointer user_data)
{
SpiceFileTransferTask *self = user_data;
SpiceMainChannel *channel = self->priv->channel;
gssize count;
GError *error = NULL;
self->priv->pending = FALSE;
count = g_input_stream_read_finish(G_INPUT_STREAM(self->priv->file_stream),
res, &error);
/* Check for pending earlier errors */
if (self->priv->error) {
spice_file_transfer_task_completed(self, error);
return;
}
if (count > 0 || self->priv->file_size == 0) {
self->priv->read_bytes += count;
g_object_notify(G_OBJECT(self), "progress");
file_xfer_queue(self, count);
if (count == 0)
return;
file_xfer_flush_async(channel, self->priv->cancellable,
file_xfer_data_flushed_cb, self);
self->priv->pending = TRUE;
} else if (error) {
VDAgentFileXferStatusMessage msg = {
.id = self->priv->id,
.result = error->code == G_IO_ERROR_CANCELLED ?
VD_AGENT_FILE_XFER_STATUS_CANCELLED : VD_AGENT_FILE_XFER_STATUS_ERROR,
};
agent_msg_queue_many(self->priv->channel, VD_AGENT_FILE_XFER_STATUS,
&msg, sizeof(msg), NULL);
spice_channel_wakeup(SPICE_CHANNEL(self->priv->channel), FALSE);
spice_file_transfer_task_completed(self, error);
}
/* else EOF, do nothing (wait for VD_AGENT_FILE_XFER_STATUS from agent) */
}
/* coroutine context */
static void file_xfer_continue_read(SpiceFileTransferTask *self)
{
g_input_stream_read_async(G_INPUT_STREAM(self->priv->file_stream),
self->priv->buffer,
FILE_XFER_CHUNK_SIZE,
G_PRIORITY_DEFAULT,
self->priv->cancellable,
file_xfer_read_cb,
self);
self->priv->pending = TRUE;
}
/* coroutine context */
static void file_xfer_handle_status(SpiceMainChannel *channel,
VDAgentFileXferStatusMessage *msg)
{
SpiceMainChannelPrivate *c = channel->priv;
SpiceFileTransferTask *task;
GError *error = NULL;
task = g_hash_table_lookup(c->file_xfer_tasks, GUINT_TO_POINTER(msg->id));
if (task == NULL) {
SPICE_DEBUG("cannot find task %d", msg->id);
return;
}
SPICE_DEBUG("task %d received response %d", msg->id, msg->result);
switch (msg->result) {
case VD_AGENT_FILE_XFER_STATUS_CAN_SEND_DATA:
if (task->priv->pending) {
error = g_error_new(SPICE_CLIENT_ERROR, SPICE_CLIENT_ERROR_FAILED,
"transfer received CAN_SEND_DATA in pending state");
break;
}
file_xfer_continue_read(task);
return;
case VD_AGENT_FILE_XFER_STATUS_CANCELLED:
error = g_error_new(SPICE_CLIENT_ERROR, SPICE_CLIENT_ERROR_FAILED,
"transfer is cancelled by spice agent");
break;
case VD_AGENT_FILE_XFER_STATUS_ERROR:
error = g_error_new(SPICE_CLIENT_ERROR, SPICE_CLIENT_ERROR_FAILED,
"some errors occurred in the spice agent");
break;
case VD_AGENT_FILE_XFER_STATUS_SUCCESS:
if (task->priv->pending)
error = g_error_new(SPICE_CLIENT_ERROR, SPICE_CLIENT_ERROR_FAILED,
"transfer received success in pending state");
break;
default:
g_warn_if_reached();
error = g_error_new(SPICE_CLIENT_ERROR, SPICE_CLIENT_ERROR_FAILED,
"unhandled status type: %u", msg->result);
break;
}
spice_file_transfer_task_completed(task, error);
}
/* any context: the message is not flushed immediately,
you can wakeup() the channel coroutine or send_msg_queue() */
static void agent_max_clipboard(SpiceMainChannel *self)
{
VDAgentMaxClipboard msg = { .max = spice_main_get_max_clipboard(self) };
if (!test_agent_cap(self, VD_AGENT_CAP_MAX_CLIPBOARD))
return;
agent_msg_queue(self, VD_AGENT_MAX_CLIPBOARD, sizeof(VDAgentMaxClipboard), &msg);
}
static void spice_main_set_max_clipboard(SpiceMainChannel *self, gint max)
{
SpiceMainChannelPrivate *c;
g_return_if_fail(SPICE_IS_MAIN_CHANNEL(self));
g_return_if_fail(max >= -1);
c = self->priv;
if (max == spice_main_get_max_clipboard(self))
return;
c->max_clipboard = max;
agent_max_clipboard(self);
spice_channel_wakeup(SPICE_CHANNEL(self), FALSE);
}
/* coroutine context */
static void main_agent_handle_msg(SpiceChannel *channel,
VDAgentMessage *msg, gpointer payload)
{
SpiceMainChannel *self = SPICE_MAIN_CHANNEL(channel);
SpiceMainChannelPrivate *c = self->priv;
guint8 selection = VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD;
g_return_if_fail(msg->protocol == VD_AGENT_PROTOCOL);
switch (msg->type) {
case VD_AGENT_CLIPBOARD_RELEASE:
case VD_AGENT_CLIPBOARD_REQUEST:
case VD_AGENT_CLIPBOARD_GRAB:
case VD_AGENT_CLIPBOARD:
if (test_agent_cap(self, VD_AGENT_CAP_CLIPBOARD_SELECTION)) {
selection = *((guint8*)payload);
payload = ((guint8*)payload) + 4;
msg->size -= 4;
}
break;
default:
break;
}
switch (msg->type) {
case VD_AGENT_ANNOUNCE_CAPABILITIES:
{
VDAgentAnnounceCapabilities *caps = payload;
int i, size;
size = VD_AGENT_CAPS_SIZE_FROM_MSG_SIZE(msg->size);
if (size > VD_AGENT_CAPS_SIZE)
size = VD_AGENT_CAPS_SIZE;
memset(c->agent_caps, 0, sizeof(c->agent_caps));
for (i = 0; i < size * 32; i++) {
if (!VD_AGENT_HAS_CAPABILITY(caps->caps, size, i))
continue;
SPICE_DEBUG("%s: cap: %d (%s)", __FUNCTION__,
i, NAME(agent_caps, i));
VD_AGENT_SET_CAPABILITY(c->agent_caps, i);
}
c->agent_caps_received = true;
g_coroutine_signal_emit(self, signals[SPICE_MAIN_AGENT_UPDATE], 0);
update_display_timer(SPICE_MAIN_CHANNEL(channel), 0);
if (caps->request)
agent_announce_caps(self);
if (test_agent_cap(self, VD_AGENT_CAP_DISPLAY_CONFIG) &&
!c->agent_display_config_sent) {
agent_display_config(self);
c->agent_display_config_sent = true;
}
agent_sync_audio_playback(self);
agent_sync_audio_record(self);
agent_max_clipboard(self);
agent_send_msg_queue(self);
break;
}
case VD_AGENT_CLIPBOARD:
{
VDAgentClipboard *cb = payload;
g_coroutine_signal_emit(self, signals[SPICE_MAIN_CLIPBOARD_SELECTION], 0, selection,
cb->type, cb->data, msg->size - sizeof(VDAgentClipboard));
if (selection == VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD)
g_coroutine_signal_emit(self, signals[SPICE_MAIN_CLIPBOARD], 0,
cb->type, cb->data, msg->size - sizeof(VDAgentClipboard));
break;
}
case VD_AGENT_CLIPBOARD_GRAB:
{
gboolean ret;
g_coroutine_signal_emit(self, signals[SPICE_MAIN_CLIPBOARD_SELECTION_GRAB], 0, selection,
(guint8*)payload, msg->size / sizeof(uint32_t), &ret);
if (selection == VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD)
g_coroutine_signal_emit(self, signals[SPICE_MAIN_CLIPBOARD_GRAB], 0,
payload, msg->size / sizeof(uint32_t), &ret);
break;
}
case VD_AGENT_CLIPBOARD_REQUEST:
{
gboolean ret;
VDAgentClipboardRequest *req = payload;
g_coroutine_signal_emit(self, signals[SPICE_MAIN_CLIPBOARD_SELECTION_REQUEST], 0, selection,
req->type, &ret);
if (selection == VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD)
g_coroutine_signal_emit(self, signals[SPICE_MAIN_CLIPBOARD_REQUEST], 0,
req->type, &ret);
break;
}
case VD_AGENT_CLIPBOARD_RELEASE:
{
g_coroutine_signal_emit(self, signals[SPICE_MAIN_CLIPBOARD_SELECTION_RELEASE], 0, selection);
if (selection == VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD)
g_coroutine_signal_emit(self, signals[SPICE_MAIN_CLIPBOARD_RELEASE], 0);
break;
}
case VD_AGENT_REPLY:
{
VDAgentReply *reply = payload;
SPICE_DEBUG("%s: reply: type %d, %s", __FUNCTION__, reply->type,
reply->error == VD_AGENT_SUCCESS ? "success" : "error");
break;
}
case VD_AGENT_FILE_XFER_STATUS:
file_xfer_handle_status(self, payload);
break;
default:
g_warning("unhandled agent message type: %u (%s), size %u",
msg->type, NAME(agent_msg_types, msg->type), msg->size);
}
}
/* coroutine context */
static void main_handle_agent_data_msg(SpiceChannel* channel, int* msg_size, guchar** msg_pos)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
int n;
if (c->agent_msg_pos < sizeof(VDAgentMessage)) {
n = MIN(sizeof(VDAgentMessage) - c->agent_msg_pos, *msg_size);
memcpy((uint8_t*)&c->agent_msg + c->agent_msg_pos, *msg_pos, n);
c->agent_msg_pos += n;
*msg_size -= n;
*msg_pos += n;
if (c->agent_msg_pos == sizeof(VDAgentMessage)) {
SPICE_DEBUG("agent msg start: msg_size=%d, protocol=%d, type=%d",
c->agent_msg.size, c->agent_msg.protocol, c->agent_msg.type);
g_return_if_fail(c->agent_msg_data == NULL);
c->agent_msg_data = g_malloc0(c->agent_msg.size);
}
}
if (c->agent_msg_pos >= sizeof(VDAgentMessage)) {
n = MIN(sizeof(VDAgentMessage) + c->agent_msg.size - c->agent_msg_pos, *msg_size);
memcpy(c->agent_msg_data + c->agent_msg_pos - sizeof(VDAgentMessage), *msg_pos, n);
c->agent_msg_pos += n;
*msg_size -= n;
*msg_pos += n;
}
if (c->agent_msg_pos == sizeof(VDAgentMessage) + c->agent_msg.size) {
main_agent_handle_msg(channel, &c->agent_msg, c->agent_msg_data);
g_free(c->agent_msg_data);
c->agent_msg_data = NULL;
c->agent_msg_pos = 0;
}
}
/* coroutine context */
static void main_handle_agent_data(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
guint8 *data;
int len;
g_warn_if_fail(c->agent_connected);
/* shortcut to avoid extra message allocation & copy if possible */
if (c->agent_msg_pos == 0) {
VDAgentMessage *msg;
guint msg_size;
msg = spice_msg_in_raw(in, &len);
msg_size = msg->size;
if (msg_size + sizeof(VDAgentMessage) == len) {
main_agent_handle_msg(channel, msg, msg->data);
return;
}
}
data = spice_msg_in_raw(in, &len);
while (len > 0) {
main_handle_agent_data_msg(channel, &len, &data);
}
}
/* coroutine context */
static void main_handle_agent_token(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMsgMainAgentTokens *tokens = spice_msg_in_parsed(in);
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
c->agent_tokens += tokens->num_tokens;
agent_send_msg_queue(SPICE_MAIN_CHANNEL(channel));
}
/* main context */
static void migrate_channel_new_cb(SpiceSession *s, SpiceChannel *channel, gpointer data)
{
g_signal_connect(channel, "channel-event",
G_CALLBACK(migrate_channel_event_cb), data);
}
static SpiceChannel* migrate_channel_connect(spice_migrate *mig, int type, int id)
{
SPICE_DEBUG("migrate_channel_connect %d:%d", type, id);
SpiceChannel *newc = spice_channel_new(mig->session, type, id);
spice_channel_connect(newc);
mig->nchannels++;
return newc;
}
/* coroutine context */
static void spice_main_channel_send_migration_handshake(SpiceChannel *channel)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
if (!spice_channel_test_capability(channel, SPICE_MAIN_CAP_SEAMLESS_MIGRATE)) {
c->migrate_data->do_seamless = false;
g_idle_add(main_migrate_handshake_done, c->migrate_data);
} else {
SpiceMsgcMainMigrateDstDoSeamless msg_data;
SpiceMsgOut *msg_out;
msg_data.src_version = c->migrate_data->src_mig_version;
msg_out = spice_msg_out_new(channel, SPICE_MSGC_MAIN_MIGRATE_DST_DO_SEAMLESS);
msg_out->marshallers->msgc_main_migrate_dst_do_seamless(msg_out->marshaller, &msg_data);
spice_msg_out_send_internal(msg_out);
}
}
/* main context */
static void migrate_channel_event_cb(SpiceChannel *channel, SpiceChannelEvent event,
gpointer data)
{
spice_migrate *mig = data;
SpiceChannelPrivate *c = SPICE_CHANNEL(channel)->priv;
SpiceSession *session;
g_return_if_fail(mig->nchannels > 0);
g_signal_handlers_disconnect_by_func(channel, migrate_channel_event_cb, data);
session = spice_channel_get_session(mig->src_channel);
switch (event) {
case SPICE_CHANNEL_OPENED:
if (c->channel_type == SPICE_CHANNEL_MAIN) {
if (mig->do_seamless) {
SpiceMainChannelPrivate *main_priv = SPICE_MAIN_CHANNEL(channel)->priv;
c->state = SPICE_CHANNEL_STATE_MIGRATION_HANDSHAKE;
mig->dst_channel = channel;
main_priv->migrate_data = mig;
} else {
c->state = SPICE_CHANNEL_STATE_MIGRATING;
mig->nchannels--;
}
/* now connect the rest of the channels */
GList *channels, *l;
l = channels = spice_session_get_channels(session);
while (l != NULL) {
SpiceChannelPrivate *curc = SPICE_CHANNEL(l->data)->priv;
l = l->next;
if (curc->channel_type == SPICE_CHANNEL_MAIN)
continue;
migrate_channel_connect(mig, curc->channel_type, curc->channel_id);
}
g_list_free(channels);
} else {
c->state = SPICE_CHANNEL_STATE_MIGRATING;
mig->nchannels--;
}
SPICE_DEBUG("migration: channel opened chan:%p, left %d", channel, mig->nchannels);
if (mig->nchannels == 0)
coroutine_yieldto(mig->from, NULL);
break;
default:
SPICE_DEBUG("error or unhandled channel event during migration: %d", event);
/* go back to main channel to report error */
coroutine_yieldto(mig->from, NULL);
}
}
/* main context */
static gboolean main_migrate_handshake_done(gpointer data)
{
spice_migrate *mig = data;
SpiceChannelPrivate *c = SPICE_CHANNEL(mig->dst_channel)->priv;
g_return_val_if_fail(c->channel_type == SPICE_CHANNEL_MAIN, FALSE);
g_return_val_if_fail(c->state == SPICE_CHANNEL_STATE_MIGRATION_HANDSHAKE, FALSE);
c->state = SPICE_CHANNEL_STATE_MIGRATING;
mig->nchannels--;
if (mig->nchannels == 0)
coroutine_yieldto(mig->from, NULL);
return FALSE;
}
#ifdef __GNUC__
typedef struct __attribute__ ((__packed__)) OldRedMigrationBegin {
#else
typedef struct __declspec(align(1)) OldRedMigrationBegin {
#endif
uint16_t port;
uint16_t sport;
char host[0];
} OldRedMigrationBegin;
/* main context */
static gboolean migrate_connect(gpointer data)
{
spice_migrate *mig = data;
SpiceChannelPrivate *c;
int port, sport;
const char *host;
g_return_val_if_fail(mig != NULL, FALSE);
g_return_val_if_fail(mig->info != NULL, FALSE);
g_return_val_if_fail(mig->nchannels == 0, FALSE);
c = SPICE_CHANNEL(mig->src_channel)->priv;
g_return_val_if_fail(c != NULL, FALSE);
g_return_val_if_fail(mig->session != NULL, FALSE);
spice_session_set_migration_state(mig->session, SPICE_SESSION_MIGRATION_CONNECTING);
if ((c->peer_hdr.major_version == 1) &&
(c->peer_hdr.minor_version < 1)) {
OldRedMigrationBegin *info = (OldRedMigrationBegin *)mig->info;
SPICE_DEBUG("migrate_begin old %s %d %d",
info->host, info->port, info->sport);
port = info->port;
sport = info->sport;
host = info->host;
} else {
SpiceMigrationDstInfo *info = mig->info;
SPICE_DEBUG("migrate_begin %d %s %d %d",
info->host_size, info->host_data, info->port, info->sport);
port = info->port;
sport = info->sport;
host = (char*)info->host_data;
if ((c->peer_hdr.major_version == 1) ||
(c->peer_hdr.major_version == 2 && c->peer_hdr.minor_version < 1)) {
GByteArray *pubkey = g_byte_array_new();
g_byte_array_append(pubkey, info->pub_key_data, info->pub_key_size);
g_object_set(mig->session,
"pubkey", pubkey,
"verify", SPICE_SESSION_VERIFY_PUBKEY,
NULL);
g_byte_array_unref(pubkey);
} else if (info->cert_subject_size == 0 ||
strlen((const char*)info->cert_subject_data) == 0) {
/* only verify hostname if no cert subject */
g_object_set(mig->session, "verify", SPICE_SESSION_VERIFY_HOSTNAME, NULL);
} else {
gchar *subject = g_alloca(info->cert_subject_size + 1);
strncpy(subject, (const char*)info->cert_subject_data, info->cert_subject_size);
subject[info->cert_subject_size] = '\0';
// session data are already copied
g_object_set(mig->session,
"cert-subject", subject,
"verify", SPICE_SESSION_VERIFY_SUBJECT,
NULL);
}
}
if (g_getenv("SPICE_MIG_HOST"))
host = g_getenv("SPICE_MIG_HOST");
g_object_set(mig->session, "host", host, NULL);
spice_session_set_port(mig->session, port, FALSE);
spice_session_set_port(mig->session, sport, TRUE);
g_signal_connect(mig->session, "channel-new",
G_CALLBACK(migrate_channel_new_cb), mig);
g_signal_emit(mig->src_channel, signals[SPICE_MIGRATION_STARTED], 0,
mig->session);
/* the migration process is in 2 steps, first the main channel and
then the rest of the channels */
migrate_channel_connect(mig, SPICE_CHANNEL_MAIN, 0);
return FALSE;
}
/* coroutine context */
static void main_migrate_connect(SpiceChannel *channel,
SpiceMigrationDstInfo *dst_info, bool do_seamless,
uint32_t src_mig_version)
{
SpiceMainChannelPrivate *main_priv = SPICE_MAIN_CHANNEL(channel)->priv;
int reply_type = SPICE_MSGC_MAIN_MIGRATE_CONNECT_ERROR;
spice_migrate mig = { 0, };
SpiceMsgOut *out;
SpiceSession *session;
mig.src_channel = channel;
mig.info = dst_info;
mig.from = coroutine_self();
mig.do_seamless = do_seamless;
mig.src_mig_version = src_mig_version;
CHANNEL_DEBUG(channel, "migrate connect");
session = spice_channel_get_session(channel);
mig.session = spice_session_new_from_session(session);
if (mig.session == NULL)
goto end;
if (!spice_session_set_migration_session(session, mig.session))
goto end;
main_priv->migrate_data = &mig;
/* no need to track idle, call is sync for this coroutine */
g_idle_add(migrate_connect, &mig);
/* switch to main loop and wait for connections */
coroutine_yield(NULL);
if (mig.nchannels != 0) {
CHANNEL_DEBUG(channel, "migrate failed: some channels failed to connect");
spice_session_abort_migration(session);
} else {
if (mig.do_seamless) {
SPICE_DEBUG("migration (seamless): connections all ok");
reply_type = SPICE_MSGC_MAIN_MIGRATE_CONNECTED_SEAMLESS;
} else {
SPICE_DEBUG("migration (semi-seamless): connections all ok");
reply_type = SPICE_MSGC_MAIN_MIGRATE_CONNECTED;
}
spice_session_start_migrating(spice_channel_get_session(channel),
mig.do_seamless);
}
end:
CHANNEL_DEBUG(channel, "migrate connect reply %d", reply_type);
out = spice_msg_out_new(SPICE_CHANNEL(channel), reply_type);
spice_msg_out_send(out);
}
/* coroutine context */
static void main_handle_migrate_begin(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMsgMainMigrationBegin *msg = spice_msg_in_parsed(in);
main_migrate_connect(channel, &msg->dst_info, false, 0);
}
/* coroutine context */
static void main_handle_migrate_begin_seamless(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMsgMainMigrateBeginSeamless *msg = spice_msg_in_parsed(in);
main_migrate_connect(channel, &msg->dst_info, true, msg->src_mig_version);
}
static void main_handle_migrate_dst_seamless_ack(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceChannelPrivate *c = SPICE_CHANNEL(channel)->priv;
SpiceMainChannelPrivate *main_priv = SPICE_MAIN_CHANNEL(channel)->priv;
g_return_if_fail(c->state == SPICE_CHANNEL_STATE_MIGRATION_HANDSHAKE);
main_priv->migrate_data->do_seamless = true;
g_idle_add(main_migrate_handshake_done, main_priv->migrate_data);
}
static void main_handle_migrate_dst_seamless_nack(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceChannelPrivate *c = SPICE_CHANNEL(channel)->priv;
SpiceMainChannelPrivate *main_priv = SPICE_MAIN_CHANNEL(channel)->priv;
g_return_if_fail(c->state == SPICE_CHANNEL_STATE_MIGRATION_HANDSHAKE);
main_priv->migrate_data->do_seamless = false;
g_idle_add(main_migrate_handshake_done, main_priv->migrate_data);
}
/* main context */
static gboolean migrate_delayed(gpointer data)
{
SpiceChannel *channel = data;
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
g_warn_if_fail(c->migrate_delayed_id != 0);
c->migrate_delayed_id = 0;
spice_session_migrate_end(channel->priv->session);
return FALSE;
}
/* coroutine context */
static void main_handle_migrate_end(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
SPICE_DEBUG("migrate end");
g_return_if_fail(c->migrate_delayed_id == 0);
g_return_if_fail(spice_channel_test_capability(channel, SPICE_MAIN_CAP_SEMI_SEAMLESS_MIGRATE));
c->migrate_delayed_id = g_idle_add(migrate_delayed, channel);
}
/* main context */
static gboolean switch_host_delayed(gpointer data)
{
SpiceChannel *channel = data;
SpiceSession *session;
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
g_warn_if_fail(c->switch_host_delayed_id != 0);
c->switch_host_delayed_id = 0;
session = spice_channel_get_session(channel);
spice_channel_disconnect(channel, SPICE_CHANNEL_SWITCHING);
spice_session_switching_disconnect(session);
return FALSE;
}
/* coroutine context */
static void main_handle_migrate_switch_host(SpiceChannel *channel, SpiceMsgIn *in)
{
SpiceMsgMainMigrationSwitchHost *mig = spice_msg_in_parsed(in);
SpiceSession *session;
char *host = (char *)mig->host_data;
char *subject = NULL;
SpiceMainChannelPrivate *c = SPICE_MAIN_CHANNEL(channel)->priv;
g_return_if_fail(host[mig->host_size - 1] == '\0');
if (mig->cert_subject_size) {
subject = (char *)mig->cert_subject_data;
g_return_if_fail(subject[mig->cert_subject_size - 1] == '\0');
}
SPICE_DEBUG("migrate_switch %s %d %d %s",
host, mig->port, mig->sport, subject);
if (c->switch_host_delayed_id != 0) {
g_warning("Switching host already in progress, aborting it");
g_warn_if_fail(g_source_remove(c->switch_host_delayed_id));
c->switch_host_delayed_id = 0;
}
session = spice_channel_get_session(channel);
spice_session_set_migration_state(session, SPICE_SESSION_MIGRATION_SWITCHING);
g_object_set(session,
"host", host,
"cert-subject", subject,
NULL);
spice_session_set_port(session, mig->port, FALSE);
spice_session_set_port(session, mig->sport, TRUE);
c->switch_host_delayed_id = g_idle_add(switch_host_delayed, channel);
}
/* coroutine context */
static void main_handle_migrate_cancel(SpiceChannel *channel,
SpiceMsgIn *in G_GNUC_UNUSED)
{
SpiceSession *session;
SPICE_DEBUG("migrate_cancel");
session = spice_channel_get_session(channel);
spice_session_abort_migration(session);
}
static void channel_set_handlers(SpiceChannelClass *klass)
{
static const spice_msg_handler handlers[] = {
[ SPICE_MSG_MAIN_INIT ] = main_handle_init,
[ SPICE_MSG_MAIN_NAME ] = main_handle_name,
[ SPICE_MSG_MAIN_UUID ] = main_handle_uuid,
[ SPICE_MSG_MAIN_CHANNELS_LIST ] = main_handle_channels_list,
[ SPICE_MSG_MAIN_MOUSE_MODE ] = main_handle_mouse_mode,
[ SPICE_MSG_MAIN_MULTI_MEDIA_TIME ] = main_handle_mm_time,
[ SPICE_MSG_MAIN_AGENT_CONNECTED ] = main_handle_agent_connected,
[ SPICE_MSG_MAIN_AGENT_DISCONNECTED ] = main_handle_agent_disconnected,
[ SPICE_MSG_MAIN_AGENT_DATA ] = main_handle_agent_data,
[ SPICE_MSG_MAIN_AGENT_TOKEN ] = main_handle_agent_token,
[ SPICE_MSG_MAIN_MIGRATE_BEGIN ] = main_handle_migrate_begin,
[ SPICE_MSG_MAIN_MIGRATE_END ] = main_handle_migrate_end,
[ SPICE_MSG_MAIN_MIGRATE_CANCEL ] = main_handle_migrate_cancel,
[ SPICE_MSG_MAIN_MIGRATE_SWITCH_HOST ] = main_handle_migrate_switch_host,
[ SPICE_MSG_MAIN_AGENT_CONNECTED_TOKENS ] = main_handle_agent_connected_tokens,
[ SPICE_MSG_MAIN_MIGRATE_BEGIN_SEAMLESS ] = main_handle_migrate_begin_seamless,
[ SPICE_MSG_MAIN_MIGRATE_DST_SEAMLESS_ACK] = main_handle_migrate_dst_seamless_ack,
[ SPICE_MSG_MAIN_MIGRATE_DST_SEAMLESS_NACK] = main_handle_migrate_dst_seamless_nack,
};
spice_channel_set_handlers(klass, handlers, G_N_ELEMENTS(handlers));
}
/* coroutine context */
static void spice_main_handle_msg(SpiceChannel *channel, SpiceMsgIn *msg)
{
int type = spice_msg_in_type(msg);
SpiceChannelClass *parent_class;
SpiceChannelPrivate *c = SPICE_CHANNEL(channel)->priv;
parent_class = SPICE_CHANNEL_CLASS(spice_main_channel_parent_class);
if (c->state == SPICE_CHANNEL_STATE_MIGRATION_HANDSHAKE) {
if (type != SPICE_MSG_MAIN_MIGRATE_DST_SEAMLESS_ACK &&
type != SPICE_MSG_MAIN_MIGRATE_DST_SEAMLESS_NACK) {
g_critical("unexpected msg (%d)."
"Only MIGRATE_DST_SEAMLESS_ACK/NACK are allowed", type);
return;
}
}
parent_class->handle_msg(channel, msg);
}
/**
* spice_main_agent_test_capability:
* @channel: a #SpiceMainChannel
* @cap: an agent capability identifier
*
* Test capability of a remote agent.
*
* Returns: %TRUE if @cap (channel kind capability) is available.
**/
gboolean spice_main_agent_test_capability(SpiceMainChannel *channel, guint32 cap)
{
g_return_val_if_fail(SPICE_IS_MAIN_CHANNEL(channel), FALSE);
return test_agent_cap(channel, cap);
}
/**
* spice_main_update_display:
* @channel: a #SpiceMainChannel
* @id: display ID
* @x: x position
* @y: y position
* @width: display width
* @height: display height
* @update: if %TRUE, update guest resolution after 1sec.
*
* Update the display @id resolution.
*
* If @update is %TRUE, the remote configuration will be updated too
* after 1 second without further changes. You can send when you want
* without delay the new configuration to the remote with
* spice_main_send_monitor_config()
**/
void spice_main_update_display(SpiceMainChannel *channel, int id,
int x, int y, int width, int height,
gboolean update)
{
SpiceMainChannelPrivate *c;
g_return_if_fail(channel != NULL);
g_return_if_fail(SPICE_IS_MAIN_CHANNEL(channel));
g_return_if_fail(x >= 0);
g_return_if_fail(y >= 0);
g_return_if_fail(width >= 0);
g_return_if_fail(height >= 0);
c = SPICE_MAIN_CHANNEL(channel)->priv;
g_return_if_fail(id < SPICE_N_ELEMENTS(c->display));
c->display[id].x = x;
c->display[id].y = y;
c->display[id].width = width;
c->display[id].height = height;
if (update)
update_display_timer(channel, 1);
}
/**
* spice_main_set_display:
* @channel: a #SpiceMainChannel
* @id: display ID
* @x: x position
* @y: y position
* @width: display width
* @height: display height
*
* Notify the guest of screen resolution change. The notification is
* sent 1 second later, if no further changes happen.
**/
void spice_main_set_display(SpiceMainChannel *channel, int id,
int x, int y, int width, int height)
{
spice_main_update_display(channel, id, x, y, width, height, TRUE);
}
/**
* spice_main_clipboard_grab:
* @channel: a #SpiceMainChannel
* @types: an array of #VD_AGENT_CLIPBOARD types available in the clipboard
* @ntypes: the number of @types
*
* Grab the guest clipboard, with #VD_AGENT_CLIPBOARD @types.
*
* Deprecated: 0.6: use spice_main_clipboard_selection_grab() instead.
**/
void spice_main_clipboard_grab(SpiceMainChannel *channel, guint32 *types, int ntypes)
{
spice_main_clipboard_selection_grab(channel, VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD, types, ntypes);
}
/**
* spice_main_clipboard_selection_grab:
* @channel: a #SpiceMainChannel
* @selection: one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*
* @types: an array of #VD_AGENT_CLIPBOARD types available in the clipboard
* @ntypes: the number of @types
*
* Grab the guest clipboard, with #VD_AGENT_CLIPBOARD @types.
*
* Since: 0.6
**/
void spice_main_clipboard_selection_grab(SpiceMainChannel *channel, guint selection,
guint32 *types, int ntypes)
{
g_return_if_fail(channel != NULL);
g_return_if_fail(SPICE_IS_MAIN_CHANNEL(channel));
agent_clipboard_grab(channel, selection, types, ntypes);
spice_channel_wakeup(SPICE_CHANNEL(channel), FALSE);
}
/**
* spice_main_clipboard_release:
* @channel: a #SpiceMainChannel
*
* Release the clipboard (for example, when the client loses the
* clipboard grab): Inform the guest no clipboard data is available.
*
* Deprecated: 0.6: use spice_main_clipboard_selection_release() instead.
**/
void spice_main_clipboard_release(SpiceMainChannel *channel)
{
spice_main_clipboard_selection_release(channel, VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD);
}
/**
* spice_main_clipboard_selection_release:
* @channel: a #SpiceMainChannel
* @selection: one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*
*
* Release the clipboard (for example, when the client loses the
* clipboard grab): Inform the guest no clipboard data is available.
*
* Since: 0.6
**/
void spice_main_clipboard_selection_release(SpiceMainChannel *channel, guint selection)
{
g_return_if_fail(channel != NULL);
g_return_if_fail(SPICE_IS_MAIN_CHANNEL(channel));
SpiceMainChannelPrivate *c = channel->priv;
if (!c->agent_connected)
return;
agent_clipboard_release(channel, selection);
spice_channel_wakeup(SPICE_CHANNEL(channel), FALSE);
}
/**
* spice_main_clipboard_notify:
* @channel: a #SpiceMainChannel
* @type: a #VD_AGENT_CLIPBOARD type
* @data: clipboard data
* @size: data length in bytes
*
* Send the clipboard data to the guest.
*
* Deprecated: 0.6: use spice_main_clipboard_selection_notify() instead.
**/
void spice_main_clipboard_notify(SpiceMainChannel *channel,
guint32 type, const guchar *data, size_t size)
{
spice_main_clipboard_selection_notify(channel, VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD,
type, data, size);
}
/**
* spice_main_clipboard_selection_notify:
* @channel: a #SpiceMainChannel
* @selection: one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*
* @type: a #VD_AGENT_CLIPBOARD type
* @data: clipboard data
* @size: data length in bytes
*
* Send the clipboard data to the guest.
*
* Since: 0.6
**/
void spice_main_clipboard_selection_notify(SpiceMainChannel *channel, guint selection,
guint32 type, const guchar *data, size_t size)
{
g_return_if_fail(channel != NULL);
g_return_if_fail(SPICE_IS_MAIN_CHANNEL(channel));
agent_clipboard_notify(channel, selection, type, data, size);
spice_channel_wakeup(SPICE_CHANNEL(channel), FALSE);
}
/**
* spice_main_clipboard_request:
* @channel: a #SpiceMainChannel
* @type: a #VD_AGENT_CLIPBOARD type
*
* Request clipboard data of @type from the guest. The reply is sent
* through the #SpiceMainChannel::main-clipboard signal.
*
* Deprecated: 0.6: use spice_main_clipboard_selection_request() instead.
**/
void spice_main_clipboard_request(SpiceMainChannel *channel, guint32 type)
{
spice_main_clipboard_selection_request(channel, VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD, type);
}
/**
* spice_main_clipboard_selection_request:
* @channel: a #SpiceMainChannel
* @selection: one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*
* @type: a #VD_AGENT_CLIPBOARD type
*
* Request clipboard data of @type from the guest. The reply is sent
* through the #SpiceMainChannel::main-clipboard-selection signal.
*
* Since: 0.6
**/
void spice_main_clipboard_selection_request(SpiceMainChannel *channel, guint selection, guint32 type)
{
g_return_if_fail(channel != NULL);
g_return_if_fail(SPICE_IS_MAIN_CHANNEL(channel));
agent_clipboard_request(channel, selection, type);
spice_channel_wakeup(SPICE_CHANNEL(channel), FALSE);
}
/**
* spice_main_update_display_enabled:
* @channel: a #SpiceMainChannel
* @id: display ID (if -1: set all displays)
* @enabled: wether display @id is enabled
* @update: if %TRUE, update guest display state after 1sec.
*
* When sending monitor configuration to agent guest, if @enabled is %FALSE,
* don't set display @id, which the agent translates to disabling the display
* id. If @enabled is %TRUE, the monitor will be included in the next monitor
* update. Note: this will take effect next time the monitor configuration is
* sent.
*
* If @update is %FALSE, no server update will be triggered by this call, but
* the value will be saved and used in the next configuration update.
*
* Since: 0.30
**/
void spice_main_update_display_enabled(SpiceMainChannel *channel, int id, gboolean enabled, gboolean update)
{
SpiceDisplayState display_state = enabled ? DISPLAY_ENABLED : DISPLAY_DISABLED;
g_return_if_fail(channel != NULL);
g_return_if_fail(SPICE_IS_MAIN_CHANNEL(channel));
g_return_if_fail(id >= -1);
SpiceMainChannelPrivate *c = channel->priv;
if (id == -1) {
gint i;
for (i = 0; i < G_N_ELEMENTS(c->display); i++) {
c->display[i].display_state = display_state;
}
} else {
g_return_if_fail(id < G_N_ELEMENTS(c->display));
if (c->display[id].display_state == display_state)
return;
c->display[id].display_state = display_state;
}
if (update)
update_display_timer(channel, 1);
}
/**
* spice_main_set_display_enabled:
* @channel: a #SpiceMainChannel
* @id: display ID (if -1: set all displays)
* @enabled: wether display @id is enabled
*
* When sending monitor configuration to agent guest, don't set
* display @id, which the agent translates to disabling the display
* id. Note: this will take effect next time the monitor
* configuration is sent.
*
* Since: 0.6
**/
void spice_main_set_display_enabled(SpiceMainChannel *channel, int id, gboolean enabled)
{
spice_main_update_display_enabled(channel, id, enabled, TRUE);
}
static void spice_file_transfer_task_completed(SpiceFileTransferTask *self,
GError *error)
{
/* In case of multiple errors we only report the first error */
if (self->priv->error)
g_clear_error(&error);
if (error) {
SPICE_DEBUG("File %s xfer failed: %s",
g_file_get_path(self->priv->file), error->message);
self->priv->error = error;
}
if (self->priv->pending)
return;
if (!self->priv->file_stream) {
file_xfer_close_cb(NULL, NULL, self);
goto signal;
}
g_input_stream_close_async(G_INPUT_STREAM(self->priv->file_stream),
G_PRIORITY_DEFAULT,
self->priv->cancellable,
file_xfer_close_cb,
self);
self->priv->pending = TRUE;
signal:
g_signal_emit(self, task_signals[SIGNAL_FINISHED], 0, error);
}
static void file_xfer_info_async_cb(GObject *obj, GAsyncResult *res, gpointer data)
{
GFileInfo *info;
GFile *file = G_FILE(obj);
GError *error = NULL;
GKeyFile *keyfile = NULL;
gchar *basename = NULL;
VDAgentFileXferStartMessage msg;
gsize /*msg_size*/ data_len;
gchar *string;
SpiceFileTransferTask *self = SPICE_FILE_TRANSFER_TASK(data);
self->priv->pending = FALSE;
info = g_file_query_info_finish(file, res, &error);
if (error || self->priv->error)
goto failed;
self->priv->file_size =
g_file_info_get_attribute_uint64(info, G_FILE_ATTRIBUTE_STANDARD_SIZE);
g_object_notify(G_OBJECT(self), "progress");
keyfile = g_key_file_new();
/* File name */
basename = g_file_get_basename(file);
g_key_file_set_string(keyfile, "vdagent-file-xfer", "name", basename);
g_free(basename);
/* File size */
g_key_file_set_uint64(keyfile, "vdagent-file-xfer", "size", self->priv->file_size);
/* Save keyfile content to memory. TODO: more file attributions
need to be sent to guest */
string = g_key_file_to_data(keyfile, &data_len, &error);
g_key_file_free(keyfile);
if (error)
goto failed;
/* Create file-xfer start message */
msg.id = self->priv->id;
agent_msg_queue_many(self->priv->channel, VD_AGENT_FILE_XFER_START,
&msg, sizeof(msg),
string, data_len + 1, NULL);
g_free(string);
spice_channel_wakeup(SPICE_CHANNEL(self->priv->channel), FALSE);
return;
failed:
spice_file_transfer_task_completed(self, error);
}
static void file_xfer_read_async_cb(GObject *obj, GAsyncResult *res, gpointer data)
{
GFile *file = G_FILE(obj);
SpiceFileTransferTask *self = SPICE_FILE_TRANSFER_TASK(data);
GError *error = NULL;
self->priv->pending = FALSE;
self->priv->file_stream = g_file_read_finish(file, res, &error);
if (error || self->priv->error) {
spice_file_transfer_task_completed(self, error);
return;
}
g_file_query_info_async(self->priv->file,
G_FILE_ATTRIBUTE_STANDARD_SIZE,
G_FILE_QUERY_INFO_NONE,
G_PRIORITY_DEFAULT,
self->priv->cancellable,
file_xfer_info_async_cb,
self);
self->priv->pending = TRUE;
}
static SpiceFileTransferTask *spice_file_transfer_task_new(SpiceMainChannel *channel,
GFile *file,
GCancellable *cancellable);
static void task_finished(SpiceFileTransferTask *task,
GError *error,
gpointer data)
{
SpiceMainChannel *channel = SPICE_MAIN_CHANNEL(data);
g_hash_table_remove(channel->priv->file_xfer_tasks, GUINT_TO_POINTER(task->priv->id));
}
static void file_xfer_send_start_msg_async(SpiceMainChannel *channel,
GFile **files,
GFileCopyFlags flags,
GCancellable *cancellable,
GFileProgressCallback progress_callback,
gpointer progress_callback_data,
GAsyncReadyCallback callback,
gpointer user_data)
{
SpiceMainChannelPrivate *c = channel->priv;
SpiceFileTransferTask *task;
gint i;
for (i = 0; files[i] != NULL && !g_cancellable_is_cancelled(cancellable); i++) {
GCancellable *task_cancellable = cancellable;
/* if a cancellable object was not provided for the overall operation,
* create a separate object for each file so that they can be cancelled
* separately */
if (!task_cancellable)
task_cancellable = g_cancellable_new();
task = spice_file_transfer_task_new(channel, files[i], task_cancellable);
task->priv->flags = flags;
task->priv->progress_callback = progress_callback;
task->priv->progress_callback_data = progress_callback_data;
task->priv->callback = callback;
task->priv->user_data = user_data;
CHANNEL_DEBUG(channel, "Insert a xfer task:%d to task list",
task->priv->id);
g_hash_table_insert(c->file_xfer_tasks,
GUINT_TO_POINTER(task->priv->id),
task);
g_signal_connect(task, "finished", G_CALLBACK(task_finished), channel);
g_signal_emit(channel, signals[SPICE_MAIN_NEW_FILE_TRANSFER], 0, task);
g_file_read_async(files[i],
G_PRIORITY_DEFAULT,
cancellable,
file_xfer_read_async_cb,
g_object_ref(task));
task->priv->pending = TRUE;
/* if we created a per-task cancellable above, free it */
if (!cancellable)
g_object_unref(task_cancellable);
}
}
/**
* spice_main_file_copy_async:
* @channel: a #SpiceMainChannel
* @sources: a %NULL-terminated array of #GFile objects to be transferred
* @flags: set of #GFileCopyFlags
* @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @progress_callback: (allow-none) (scope call): function to callback with
* progress information, or %NULL if progress information is not needed
* @progress_callback_data: (closure): user data to pass to @progress_callback
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: the data to pass to callback function
*
* Copies the file @sources to guest
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
* If @progress_callback is not %NULL, then the operation can be monitored by
* setting this to a #GFileProgressCallback function. @progress_callback_data
* will be passed to this function. It is guaranteed that this callback will
* be called after all data has been transferred with the total number of bytes
* copied during the operation. Note that before release 0.31, progress_callback
* was broken since it only provided status for a single file transfer, but did
* not provide a way to determine which file it referred to. In release 0.31,
* this behavior was changed so that progress_callback provides the status of
* all ongoing file transfers. If you need to monitor the status of individual
* files, please connect to the #SpiceMainChannel::new-file-transfer signal.
*
* When the operation is finished, callback will be called. You can then call
* spice_main_file_copy_finish() to get the result of the operation.
*
**/
void spice_main_file_copy_async(SpiceMainChannel *channel,
GFile **sources,
GFileCopyFlags flags,
GCancellable *cancellable,
GFileProgressCallback progress_callback,
gpointer progress_callback_data,
GAsyncReadyCallback callback,
gpointer user_data)
{
SpiceMainChannelPrivate *c = channel->priv;
g_return_if_fail(channel != NULL);
g_return_if_fail(SPICE_IS_MAIN_CHANNEL(channel));
g_return_if_fail(sources != NULL);
if (!c->agent_connected) {
g_task_report_new_error(channel,
callback,
user_data,
spice_main_file_copy_async,
SPICE_CLIENT_ERROR,
SPICE_CLIENT_ERROR_FAILED,
"The agent is not connected");
return;
}
file_xfer_send_start_msg_async(channel,
sources,
flags,
cancellable,
progress_callback,
progress_callback_data,
callback,
user_data);
}
/**
* spice_main_file_copy_finish:
* @channel: a #SpiceMainChannel
* @result: a #GAsyncResult.
* @error: a #GError, or %NULL
*
* Finishes copying the file started with
* spice_main_file_copy_async().
*
* Returns: a %TRUE on success, %FALSE on error.
**/
gboolean spice_main_file_copy_finish(SpiceMainChannel *channel,
GAsyncResult *result,
GError **error)
{
GTask *task = G_TASK(result);;
g_return_val_if_fail(SPICE_IS_MAIN_CHANNEL(channel), FALSE);
g_return_val_if_fail(g_task_is_valid(task, channel), FALSE);
return g_task_propagate_boolean(task, error);
}
static void
spice_file_transfer_task_get_property(GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
SpiceFileTransferTask *self = SPICE_FILE_TRANSFER_TASK(object);
switch (property_id)
{
case PROP_TASK_ID:
g_value_set_uint(value, self->priv->id);
break;
case PROP_TASK_FILE:
g_value_set_object(value, self->priv->file);
break;
case PROP_TASK_PROGRESS:
g_value_set_double(value, spice_file_transfer_task_get_progress(self));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec);
}
}
static void
spice_file_transfer_task_set_property(GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
SpiceFileTransferTask *self = SPICE_FILE_TRANSFER_TASK(object);
switch (property_id)
{
case PROP_TASK_ID:
self->priv->id = g_value_get_uint(value);
break;
case PROP_TASK_FILE:
self->priv->file = g_value_dup_object(value);
break;
case PROP_TASK_CHANNEL:
self->priv->channel = g_value_dup_object(value);
break;
case PROP_TASK_CANCELLABLE:
self->priv->cancellable = g_value_dup_object(value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec);
}
}
static void
spice_file_transfer_task_dispose(GObject *object)
{
SpiceFileTransferTask *self = SPICE_FILE_TRANSFER_TASK(object);
g_clear_object(&self->priv->file);
G_OBJECT_CLASS(spice_file_transfer_task_parent_class)->dispose(object);
}
static void
spice_file_transfer_task_finalize(GObject *object)
{
SpiceFileTransferTask *self = SPICE_FILE_TRANSFER_TASK(object);
g_free(self->priv->buffer);
G_OBJECT_CLASS(spice_file_transfer_task_parent_class)->finalize(object);
}
static void
spice_file_transfer_task_constructed(GObject *object)
{
SpiceFileTransferTask *self = SPICE_FILE_TRANSFER_TASK(object);
if (spice_util_get_debug()) {
gchar *basename = g_file_get_basename(self->priv->file);
self->priv->start_time = g_get_monotonic_time();
self->priv->last_update = self->priv->start_time;
SPICE_DEBUG("transfer of file %s has started", basename);
g_free(basename);
}
}
static void
spice_file_transfer_task_class_init(SpiceFileTransferTaskClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS(klass);
g_type_class_add_private(klass, sizeof(SpiceFileTransferTaskPrivate));
object_class->get_property = spice_file_transfer_task_get_property;
object_class->set_property = spice_file_transfer_task_set_property;
object_class->finalize = spice_file_transfer_task_finalize;
object_class->dispose = spice_file_transfer_task_dispose;
object_class->constructed = spice_file_transfer_task_constructed;
/**
* SpiceFileTransferTask:id:
*
* The ID of the file transfer task
*
* Since: 0.31
**/
g_object_class_install_property(object_class, PROP_TASK_ID,
g_param_spec_uint("id",
"id",
"The id of the task",
0, G_MAXUINT, 0,
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* SpiceFileTransferTask:channel:
*
* The main channel that owns the file transfer task
*
* Since: 0.31
**/
g_object_class_install_property(object_class, PROP_TASK_CHANNEL,
g_param_spec_object("channel",
"channel",
"The channel transferring the file",
SPICE_TYPE_MAIN_CHANNEL,
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* SpiceFileTransferTask:cancellable:
*
* A cancellable object used to cancel the file transfer
*
* Since: 0.31
**/
g_object_class_install_property(object_class, PROP_TASK_CANCELLABLE,
g_param_spec_object("cancellable",
"cancellable",
"The object used to cancel the task",
G_TYPE_CANCELLABLE,
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* SpiceFileTransferTask:file:
*
* The file that is being transferred in this file transfer task
*
* Since: 0.31
**/
g_object_class_install_property(object_class, PROP_TASK_FILE,
g_param_spec_object("file",
"File",
"The file being transferred",
G_TYPE_FILE,
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* SpiceFileTransferTask:progress:
*
* The current state of the file transfer. This value indicates a
* percentage, and ranges from 0 to 100. Listen for change notifications on
* this property to be updated whenever the file transfer progress changes.
*
* Since: 0.31
**/
g_object_class_install_property(object_class, PROP_TASK_PROGRESS,
g_param_spec_double("progress",
"Progress",
"The percentage of the file transferred",
0.0, 100.0, 0.0,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
/**
* SpiceFileTransferTask::finished:
* @task: the file transfer task that emitted the signal
* @error: (transfer none): the error state of the transfer. Will be %NULL
* if the file transfer was successful.
*
* The #SpiceFileTransferTask::finished signal is emitted when the file
* transfer has completed transferring to the guest.
*
* Since: 0.31
**/
task_signals[SIGNAL_FINISHED] = g_signal_new("finished", SPICE_TYPE_FILE_TRANSFER_TASK,
G_SIGNAL_RUN_FIRST,
0, NULL, NULL,
g_cclosure_marshal_VOID__BOXED,
G_TYPE_NONE, 1,
G_TYPE_ERROR);
}
static void
spice_file_transfer_task_init(SpiceFileTransferTask *self)
{
self->priv = FILE_TRANSFER_TASK_PRIVATE(self);
self->priv->buffer = g_malloc0(FILE_XFER_CHUNK_SIZE);
}
static SpiceFileTransferTask *
spice_file_transfer_task_new(SpiceMainChannel *channel, GFile *file, GCancellable *cancellable)
{
static uint32_t xfer_id = 0; /* Used to identify task id */
return g_object_new(SPICE_TYPE_FILE_TRANSFER_TASK,
"id", xfer_id++,
"file", file,
"channel", channel,
"cancellable", cancellable,
NULL);
}
/**
* spice_file_transfer_task_get_progress:
* @self: a file transfer task
*
* Convenience function for retrieving the current progress of this file
* transfer task.
*
* Returns: A percentage value between 0 and 100
*
* Since: 0.31
**/
double spice_file_transfer_task_get_progress(SpiceFileTransferTask *self)
{
if (self->priv->file_size == 0)
return 0.0;
return (double)self->priv->read_bytes / self->priv->file_size;
}
/**
* spice_file_transfer_task_cancel:
* @self: a file transfer task
*
* Cancels the file transfer task. Note that depending on how the file transfer
* was initiated, multiple file transfer tasks may share a single
* #SpiceFileTransferTask::cancellable object, so canceling one task may result
* in the cancellation of other tasks.
*
* Since: 0.31
**/
void spice_file_transfer_task_cancel(SpiceFileTransferTask *self)
{
g_cancellable_cancel(self->priv->cancellable);
}
/**
* spice_file_transfer_task_get_filename:
* @self: a file transfer task
*
* Gets the name of the file being transferred in this task
*
* Returns: (transfer none): The basename of the file
*
* Since: 0.31
**/
char* spice_file_transfer_task_get_filename(SpiceFileTransferTask *self)
{
return g_file_get_basename(self->priv->file);
}