diff src/dbus-server.c @ 11067:2eca9ed49469

[gaim-migrate @ 13048] Modified configure.ac so that it rejects dbus builds with the dbus library older than 0.34 Added a simple object registration system to the dbus implementation so that it is possible to query object properties remotely (eg. give me property "name" of buddy with id = 5). committer: Tailor Script <[e-mail]>

--- a/src/dbus-server.c	Thu Jul 07 15:43:05 2005 +0000
+++ b/src/dbus-server.c	Thu Jul 07 15:43:48 2005 +0000
@@ -31,12 +31,17 @@
 #include <glib/gquark.h>
 
 #include "account.h"
+#include "blist.h"
+#include "conversation.h"
 #include "dbus-gaim.h"
 #include "dbus-server.h"
 #include "debug.h"
 #include "core.h"
+#include "value.h"
 
-/* GaimObject, basic definitions*/
+/**************************************************************************/
+/** @name Lots of GObject crap I don't understand                         */
+/**************************************************************************/
 
 typedef struct GaimObject GaimObject;
 typedef struct GaimObjectClass GaimObjectClass;
@@ -72,10 +77,79 @@
 }
 
 static GObject *gaim_object;
+static GQuark gaim_object_error_quark;
+
 
 
-/* Implementations of remote DBUS calls  */
+/**************************************************************************/
+/** @name Utility functions                                               */
+/**************************************************************************/
+
+#define error_unless_1(condition, str, parameter)		\
+	if (!(condition)) {					\
+		    g_set_error(error, gaim_object_error_quark,	\
+				DBUS_ERROR_NOT_FOUND,		\
+				str, parameter);		\
+		    return FALSE;				\
+	    }
+
+#define error_unless_2(condition, str, a,b)			\
+	if (!(condition)) {					\
+		    g_set_error(error, gaim_object_error_quark,	\
+				DBUS_ERROR_NOT_FOUND,		\
+				str, a,b);			\
+		    return FALSE;				\
+	    }
+
+static const char* null_to_empty(const char *s) {
+	if (s)
+		return s;
+	else
+		return "";
+}
+
+typedef gboolean (*GaimNodeFilter)(GaimBlistNode *node, gpointer *user_data);
+
+static gboolean 
+filter_is_buddy(GaimBlistNode *node, gpointer *user_data) 
+{
+	return GAIM_BLIST_NODE_IS_BUDDY(node);
+}
 
+static gboolean 
+filter_is_online_buddy(GaimBlistNode *node, 
+		       gpointer *user_data) 
+{
+	return GAIM_BLIST_NODE_IS_BUDDY(node) && 
+	  GAIM_BUDDY_IS_ONLINE((GaimBuddy *)node);
+}
+
+
+static GList* 
+get_buddy_list (GList *created_list,		/**< can be NULL */
+		GaimBlistNode *gaim_buddy_list, /**< can be NULL */
+		GaimNodeFilter filter, 
+		gpointer user_data) 
+{
+	GaimBlistNode *node;
+
+	for(node = gaim_buddy_list; node; node = node->next) 
+	{
+		if ((*filter)(node, user_data)) 
+			created_list = g_list_prepend(created_list, node);
+
+		created_list = get_buddy_list(created_list, node->child,
+					      filter, user_data);
+	}
+	
+	return created_list;
+}
+
+
+
+/**************************************************************************/
+/** @name Implementations of remote DBUS calls                            */
+/**************************************************************************/
 
 static gboolean 
 gaim_object_ping(GaimObject *obj, GError **error) 
@@ -101,19 +175,269 @@
 	return TRUE;
 }
 
+
+
+static gboolean
+gaim_object_get_buddy_list (GaimObject *obj, GArray **out_buddy_ids, 
+			    GError **error) 
+{
+	GList *node;
+	GList *buddy_list = get_buddy_list(NULL, gaim_get_blist()->root,
+					   &filter_is_buddy, NULL);
+	GArray *buddy_ids  = g_array_new(FALSE, TRUE, sizeof(gint32));;
+  	
+	buddy_list = g_list_reverse(buddy_list);
+
+	for (node = buddy_list; node; node = node->next) {
+		gint32 id = gaim_dbus_pointer_to_id(node->data);
+		g_array_append_val(buddy_ids, id);
+	}
+
+	g_list_free(buddy_list);
+	*out_buddy_ids = buddy_ids;
+
+	return TRUE;
+}
+
+
+
+
+
+static gboolean
+gaim_object_find_account(GaimObject *unused, 
+			 const char *account_name, const char *protocol_name,
+			 gint *account_id, GError **error) 
+{
+	GaimAccount *account = gaim_accounts_find(account_name, protocol_name);
+	
+	error_unless_2(account, "Account '%s' with protocol '%s' not found", 
+			    account_name, protocol_name);
+
+	*account_id = gaim_dbus_pointer_to_id(account);
+	return TRUE;
+}
+
+static gboolean
+gaim_object_find_buddy(GaimObject *unused, gint account_id, const char *buddy_name,
+		       gint *buddy_id, GError **error)
+{
+	GaimAccount *account;
+	GaimBuddy *buddy;
+
+	account = gaim_dbus_id_to_pointer(account_id, DBUS_POINTER_ACCOUNT);
+	error_unless_1(account, "Invalid account id: %i", account_id);	
+
+	buddy = gaim_find_buddy(account, buddy_name);
+	error_unless_1(account, "Buddy '%s' not found.", buddy_name);	
+
+	*buddy_id = gaim_dbus_pointer_to_id(buddy);
+	return TRUE;
+}
+
+static gboolean
+gaim_object_start_im_conversation (GaimObject *obj, gint buddy_id, GError **error)
+{
+	GaimBuddy *buddy = (GaimBuddy*) gaim_dbus_id_to_pointer(buddy_id, 
+								DBUS_POINTER_BUDDY);
+	
+	error_unless_1(buddy, "Invalid buddy id: %i", buddy_id);
+
+	gaim_conversation_new(GAIM_CONV_IM, buddy->account, buddy->name);
+
+	return TRUE;
+}
+
+
+
+/**************************************************************************/
+/** @name Gaim DBUS property handling functions                           */
+/**************************************************************************/
+
+
+typedef struct _GaimDBusProperty {
+	char *name;
+	gint offset;
+	GaimType type;
+} GaimDBusProperty;
+
+/* change GAIM_TYPE into G_TYPE */
+	  
+static gboolean
+gaim_dbus_get_property(GaimDBusProperty *list, int list_len, 
+		       gpointer data, const char *name, 
+		       GValue *value, GError **error)
+{
+	int i;
+
+	for(i=0; i<list_len; i++) {
+		if (!strcmp(list[i].name, name)) {
+			gpointer ptr = G_STRUCT_MEMBER_P(data, list[i].offset);
+			switch(list[i].type) {
+			case GAIM_TYPE_STRING: 
+				g_value_init(value, G_TYPE_STRING);
+				g_value_set_string (value, g_strdup(null_to_empty(*(char **)ptr)));
+				break;
+
+			case GAIM_TYPE_INT: 
+				g_value_init(value, G_TYPE_INT);
+				g_value_set_int (value, *(int*) ptr);
+				break;
+				
+			case GAIM_TYPE_BOOLEAN: 
+				g_value_init(value, G_TYPE_BOOLEAN);
+				g_value_set_int (value, *(gboolean*) ptr);
+				break;
+				
+			case GAIM_TYPE_POINTER: /* registered pointers only! */
+				g_value_init(value, G_TYPE_INT);
+				g_value_set_int (value, 
+						 gaim_dbus_pointer_to_id (*(gpointer *)ptr));
+				break;
+			default:
+				g_assert_not_reached();
+			}
+			return TRUE;
+		}
+	}
+
+	g_value_init(value, G_TYPE_INT);
+	g_value_set_int(value, 0);
+	error_unless_1(FALSE, "Invalid property '%s'", name);	
+}
+
+
+#define DECLARE_PROPERTY(maintype, name, type) {#name, G_STRUCT_OFFSET(maintype, name), type}
+
+GaimDBusProperty buddy_properties [] = {
+	DECLARE_PROPERTY(GaimBuddy, name, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimBuddy, alias, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimBuddy, server_alias, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimBuddy, account, GAIM_TYPE_POINTER) 
+};
+
+GaimDBusProperty account_properties [] = {
+	DECLARE_PROPERTY(GaimAccount, username, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimAccount, alias, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimAccount, user_info, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimAccount, protocol_id, GAIM_TYPE_STRING),
+};
+
+GaimDBusProperty contact_properties [] = {
+	DECLARE_PROPERTY(GaimContact, alias, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimContact, totalsize, GAIM_TYPE_INT),
+	DECLARE_PROPERTY(GaimContact, currentsize, GAIM_TYPE_INT),
+	DECLARE_PROPERTY(GaimContact, online, GAIM_TYPE_INT),
+	DECLARE_PROPERTY(GaimContact, priority, GAIM_TYPE_POINTER),
+	DECLARE_PROPERTY(GaimContact, priority_valid, GAIM_TYPE_BOOLEAN),
+};
+
+GaimDBusProperty group_properties [] = {
+	DECLARE_PROPERTY(GaimGroup, name, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimGroup, totalsize, GAIM_TYPE_INT),
+	DECLARE_PROPERTY(GaimGroup, currentsize, GAIM_TYPE_INT),
+	DECLARE_PROPERTY(GaimGroup, online, GAIM_TYPE_INT),
+};
+
+GaimDBusProperty chat_properties [] = {
+	DECLARE_PROPERTY(GaimChat, alias, GAIM_TYPE_STRING),
+	DECLARE_PROPERTY(GaimChat, account, GAIM_TYPE_POINTER),
+};
+
+
+#define DECLARE_PROPERTY_HANDLER(type, gaim_type)			\
+	static gboolean							\
+	gaim_object_get_##type##_property (GaimObject *unused,		\
+					   gint id, const char *property_name, \
+					   GValue *value, GError **error) \
+	{								\
+		gpointer object = gaim_dbus_id_to_pointer(id, gaim_type); \
+									\
+		error_unless_1(object, "Invalid " #type " id: %i", id);	\
+									\
+		return gaim_dbus_get_property(type##_properties,	\
+					      G_N_ELEMENTS(type##_properties), \
+					      object, property_name, value, error); \
+	}
+
+DECLARE_PROPERTY_HANDLER(buddy, DBUS_POINTER_BUDDY)
+DECLARE_PROPERTY_HANDLER(account, DBUS_POINTER_ACCOUNT)
+DECLARE_PROPERTY_HANDLER(contact, DBUS_POINTER_ACCOUNT)
+DECLARE_PROPERTY_HANDLER(group, DBUS_POINTER_ACCOUNT)
+DECLARE_PROPERTY_HANDLER(chat, DBUS_POINTER_ACCOUNT)
+
 #include "dbus-server-bindings.c"
 
 
+
+/**************************************************************************/
+/** @name Gaim DBUS pointer registration mechanism                        */
+/**************************************************************************/
+
+static GHashTable *map_id_node; 
+static GHashTable *map_id_type; 
+static GHashTable *map_node_id; 
+
+void gaim_dbus_init_ids(void) {
+	map_id_node = g_hash_table_new (g_direct_hash, g_direct_equal);
+	map_id_type = g_hash_table_new (g_direct_hash, g_direct_equal);
+	map_node_id = g_hash_table_new (g_direct_hash, g_direct_equal);
+}
+
+void gaim_dbus_register_pointer(gpointer node, GaimDBusPointerType type) 
+{
+	static gint last_id = 0;
+	g_assert(g_hash_table_lookup(map_node_id, node) == NULL);
+	
+
+	last_id++;
+	g_hash_table_insert(map_node_id, node, GINT_TO_POINTER(last_id));
+	g_hash_table_insert(map_id_node, GINT_TO_POINTER(last_id), node);
+	g_hash_table_insert(map_id_type, GINT_TO_POINTER(last_id), 
+			    GINT_TO_POINTER(type));
+}
+
+
+void gaim_dbus_unregister_pointer(gpointer node) {
+	gpointer id = g_hash_table_lookup(map_node_id, node);
+	
+	g_hash_table_remove(map_node_id, node);
+	g_hash_table_remove(map_id_node, GINT_TO_POINTER(id));
+	g_hash_table_remove(map_id_node, GINT_TO_POINTER(id));
+}
+
+gint gaim_dbus_pointer_to_id(gpointer node) {
+	gint id = GPOINTER_TO_INT(g_hash_table_lookup(map_node_id, node));
+	g_assert(id);
+	return id;
+}
+	
+gpointer gaim_dbus_id_to_pointer(gint id, GaimDBusPointerType type) {
+	if (type != GPOINTER_TO_INT(g_hash_table_lookup(map_id_type, 
+							GINT_TO_POINTER(id))))
+		return NULL;
+	return g_hash_table_lookup(map_id_node, GINT_TO_POINTER(id));
+}
+	
+
+
+/**************************************************************************/
+/** @name Gaim DBUS init function                                         */
+/**************************************************************************/
+
+
 gboolean 
 dbus_server_init(void) 
 {
 	DBusGConnection *connection;
-	GError *error;
+	GError *error = NULL;
 	DBusGProxy *driver_proxy;
 	guint32 request_name_ret;
 
+	gaim_object_error_quark =
+		g_quark_from_static_string("org.gaim.GaimError");
+
 	gaim_debug_misc("dbus", "launching dbus server\n");
-
+					
 	/* Connect to the bus */
 
 	error = NULL;
@@ -121,21 +445,21 @@
 
 	if (connection == NULL) {
 		g_assert(error);
-		gaim_debug_error("dbus", "Failed to open connection to bus: %s\n", 
+		gaim_debug_error("dbus", "Failed to open connection to bus: %s\n",
 				 error->message);
 		g_error_free (error);
 		return FALSE;
 	}
 
-
 	/* Instantiate the gaim dbus object and register it */
 	
 	gaim_object = g_object_new (GAIM_TYPE_OBJECT, NULL);
 
-	dbus_g_object_type_install_info (GAIM_TYPE_OBJECT, 
+
+	dbus_g_object_type_install_info (GAIM_TYPE_OBJECT,
 					 &dbus_glib_gaim_object_object_info);
 
-	dbus_g_connection_register_g_object (connection, DBUS_PATH_GAIM, 
+	dbus_g_connection_register_g_object (connection, DBUS_PATH_GAIM,
 					     gaim_object);
 
 
@@ -146,11 +470,12 @@
 						  DBUS_PATH_DBUS,
 						  DBUS_INTERFACE_DBUS);
 
+	g_assert(driver_proxy);
 
 	/* Test whether the registration was successful */
 
 	org_freedesktop_DBus_request_name(driver_proxy, DBUS_SERVICE_GAIM,
-					  0, &request_name_ret, &error);
+					  DBUS_NAME_FLAG_PROHIBIT_REPLACEMENT, &request_name_ret, &error);
 
 	if (error) {
 		gaim_debug_error("dbus", "Failed to get name: %s\n", error->message);
@@ -160,7 +485,7 @@
 
 	if (request_name_ret != DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER)
 	{
-		gaim_debug_error ("dbus", "Got result code %u from requesting name\n", 
+		gaim_debug_error ("dbus", "Got result code %u from requesting name\n",
 				  request_name_ret);
 		return FALSE;
 	}
@@ -168,6 +493,6 @@
 	gaim_debug_misc ("dbus", "GLib test service has name '%s'\n", 
 			 DBUS_SERVICE_GAIM);
 	gaim_debug_misc ("dbus", "GLib test service entering main loop\n");
-	
+
 	return TRUE;
 }