efl/legacy/edbus/src/lib/edbus_service.c

586 lines
19 KiB
C

#include "edbus_private_types.h"
#include "edbus_private.h"
#define DBUS_ANNOTATION(name, value) \
"<annotation" \
" name=\"org.freedesktop.DBus." name "\"" \
" value=\"" value "\"" \
"/>"
#define DBUS_ANNOTATION_DEPRECATED DBUS_ANNOTATION("Deprecated", "true")
#define DBUS_ANNOTATION_NOREPLY DBUS_ANNOTATION("Method.NoReply", "true")
#define EDBUS_SERVICE_INTERFACE_CHECK(obj) \
do \
{ \
EINA_SAFETY_ON_NULL_RETURN(obj); \
if (!EINA_MAGIC_CHECK(obj, EDBUS_SERVICE_INTERFACE_MAGIC)) \
{ \
EINA_MAGIC_FAIL(obj, EDBUS_SERVICE_INTERFACE_MAGIC); \
return; \
} \
} \
while (0)
#define EDBUS_SERVICE_INTERFACE_CHECK_RETVAL(obj, retval) \
do \
{ \
EINA_SAFETY_ON_NULL_RETURN_VAL(obj, retval); \
if (!EINA_MAGIC_CHECK(obj, EDBUS_SERVICE_INTERFACE_MAGIC)) \
{ \
EINA_MAGIC_FAIL(obj, EDBUS_SERVICE_INTERFACE_MAGIC); \
return retval; \
} \
} \
while (0)
static void _object_unregister(DBusConnection *conn, void *user_data);
static DBusHandlerResult _object_handler(DBusConnection *conn, DBusMessage *message, void *user_data);
static void _object_free(EDBus_Service_Object *obj);
static void _interface_free(EDBus_Service_Interface *interface);
static void _on_connection_free(void *data, const void *dead_pointer);
static DBusObjectPathVTable vtable = {
_object_unregister,
_object_handler,
NULL,
NULL,
NULL,
NULL
};
EDBus_Service_Interface *introspectable;
static void
_instrospect_append_signal(Eina_Strbuf *buf, const EDBus_Signal *sig)
{
int i;
const char *part, *name;
eina_strbuf_append_printf(buf, "<signal name=\"%s\">", sig->name);
if (sig->flags & EDBUS_SIGNAL_FLAG_DEPRECATED)
eina_strbuf_append(buf, DBUS_ANNOTATION_DEPRECATED);
for (i = 0; &sig->args[i] && sig->args[i].signature; i++)
{
part = sig->args[i].signature;
name = sig->args[i].name;
if (name && name[0])
eina_strbuf_append_printf(buf, "<arg type=\"%s\" name=\"%s\"/>",
part, name);
else
eina_strbuf_append_printf(buf, "<arg type=\"%s\"/>", part);
}
eina_strbuf_append(buf, "</signal>");
}
static void
_introspect_append_method(Eina_Strbuf *buf, const EDBus_Method *method)
{
int i;
const char *part, *name;
eina_strbuf_append_printf(buf, "<method name=\"%s\">", method->member);
if (method->flags & EDBUS_METHOD_FLAG_DEPRECATED)
eina_strbuf_append(buf, DBUS_ANNOTATION_DEPRECATED);
if (method->flags & EDBUS_METHOD_FLAG_NOREPLY)
eina_strbuf_append(buf, DBUS_ANNOTATION_NOREPLY);
for (i = 0; &method->in[i] && method->in[i].signature; i++)
{
part = method->in[i].signature;
name = method->in[i].name;
if (name && name[0])
eina_strbuf_append_printf(buf,
"<arg type=\"%s\" name=\"%s\" direction=\"in\"/>",
part, name);
else
eina_strbuf_append_printf(buf, "<arg type=\"%s\" direction=\"in\"/>",
part);
}
for (i = 0; &method->out[i] && method->out[i].signature; i++)
{
part = method->out[i].signature;
name = method->out[i].name;
if (name && name[0])
eina_strbuf_append_printf(buf,
"<arg type=\"%s\" name=\"%s\" direction=\"out\"/>",
part, name);
else
eina_strbuf_append_printf(buf, "<arg type=\"%s\" direction=\"out\"/>",
part);
}
eina_strbuf_append(buf, "</method>");
}
static void
_introspect_append_interface(Eina_Strbuf *buf, EDBus_Service_Interface *iface)
{
EDBus_Method *method;
Eina_Iterator *iterator;
unsigned short i;
unsigned int size;
eina_strbuf_append_printf(buf, "<interface name=\"%s\">", iface->name);
iterator = eina_hash_iterator_data_new(iface->methods);
EINA_ITERATOR_FOREACH(iterator, method)
_introspect_append_method(buf, method);
eina_iterator_free(iterator);
size = eina_array_count(iface->sign_of_signals);
for (i = 0; i < size; i++)
_instrospect_append_signal(buf, &iface->signals[i]);
eina_strbuf_append(buf, "</interface>");
}
static EDBus_Message *
cb_introspect(const EDBus_Service_Interface *_iface, const EDBus_Message *message)
{
EDBus_Service_Object *obj = _iface->obj;
EDBus_Message *reply = edbus_message_method_return_new(message);
if (obj->introspection_dirty || !obj->introspection_data)
{
Eina_Iterator *iterator;
EDBus_Service_Interface *iface;
if (obj->introspection_data)
eina_strbuf_reset(obj->introspection_data);
else
obj->introspection_data = eina_strbuf_new();
EINA_SAFETY_ON_NULL_RETURN_VAL(obj->introspection_data, NULL);
eina_strbuf_append(obj->introspection_data, "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\" \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">");
eina_strbuf_append_printf(obj->introspection_data,
"<node name=\"%s\">", obj->path);
iterator = eina_hash_iterator_data_new(obj->interfaces);
EINA_ITERATOR_FOREACH(iterator, iface)
_introspect_append_interface(obj->introspection_data, iface);
eina_iterator_free(iterator);
eina_strbuf_append(obj->introspection_data, "</node>");
obj->introspection_dirty = EINA_FALSE;
}
edbus_message_arguments_set(reply, "s", eina_strbuf_string_get(obj->introspection_data));
return reply;
}
static const EDBus_Method instrospect = { "Introspect", EDBUS_ARGS({ "", "" }),
EDBUS_ARGS({ "s", "xml" }),
cb_introspect, 0
};
static void
_introspectable_create(void)
{
introspectable = calloc(1, sizeof(EDBus_Service_Interface));
EINA_SAFETY_ON_NULL_RETURN(introspectable);
EINA_MAGIC_SET(introspectable, EDBUS_SERVICE_INTERFACE_MAGIC);
introspectable->sign_of_signals = eina_array_new(1);
introspectable->name = eina_stringshare_add("org.freedesktop.DBus.Introspectable");
introspectable->methods = eina_hash_string_small_new(NULL);
eina_hash_add(introspectable->methods, instrospect.member, &instrospect);
}
static void
_instrospectable_free(void)
{
eina_hash_free(introspectable->methods);
eina_stringshare_del(introspectable->name);
eina_array_free(introspectable->sign_of_signals);
free(introspectable);
}
Eina_Bool
edbus_service_init(void)
{
_introspectable_create();
EINA_SAFETY_ON_NULL_RETURN_VAL(introspectable, EINA_FALSE);
return EINA_TRUE;
}
void
edbus_service_shutdown(void)
{
_instrospectable_free();
}
static EDBus_Service_Object *
_edbus_service_object_add(EDBus_Connection *conn, const char *path)
{
EDBus_Service_Object *obj;
obj = calloc(1, sizeof(EDBus_Service_Object));
EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
if (!dbus_connection_register_object_path(conn->dbus_conn, path, &vtable,
obj))
{
free(obj);
return NULL;
}
obj->conn = conn;
obj->path = eina_stringshare_add(path);
obj->interfaces = eina_hash_string_superfast_new(NULL);
edbus_connection_cb_free_add(conn, _on_connection_free, obj);
eina_hash_add(obj->interfaces, introspectable->name, introspectable);
return obj;
}
static EDBus_Service_Interface *
_edbus_service_interface_add(EDBus_Service_Object *obj, const char *interface)
{
EDBus_Service_Interface *iface;
iface = eina_hash_find(obj->interfaces, interface);
if (iface) return iface;
iface = calloc(1, sizeof(EDBus_Service_Interface));
EINA_SAFETY_ON_NULL_RETURN_VAL(iface, NULL);
EINA_MAGIC_SET(iface, EDBUS_SERVICE_INTERFACE_MAGIC);
iface->name = eina_stringshare_add(interface);
iface->methods = eina_hash_string_superfast_new(NULL);
iface->obj = obj;
eina_hash_add(obj->interfaces, iface->name, iface);
return iface;
}
static Eina_Bool
_have_signature(const EDBus_Arg_Info *args, EDBus_Message *msg)
{
const char *sig = dbus_message_get_signature(msg->dbus_msg);
const char *p = NULL;
for (; args->signature && *args->signature && *sig; args++)
{
p = args->signature;
for (; *sig && *p; sig++, p++)
{
if (*p != *sig)
return EINA_FALSE;
}
}
if (*sig || (p && *p) || (args->signature && *args->signature))
return EINA_FALSE;
return EINA_TRUE;
}
static Eina_Bool
_edbus_service_method_add(EDBus_Service_Interface *interface, EDBus_Method *method)
{
EINA_SAFETY_ON_TRUE_RETURN_VAL(!!eina_hash_find(interface->methods,
method->member), EINA_FALSE);
EINA_SAFETY_ON_NULL_RETURN_VAL(method->member, EINA_FALSE);
EINA_SAFETY_ON_NULL_RETURN_VAL(method->cb, EINA_FALSE);
eina_hash_add(interface->methods, method->member, method);
return EINA_TRUE;
}
EAPI EDBus_Service_Interface *
edbus_service_interface_register(EDBus_Connection *conn, const char *path, const char *interface, const EDBus_Method methods[], const EDBus_Signal signals[])
{
EDBus_Service_Object *obj;
EDBus_Service_Interface *iface;
EDBus_Method *method;
unsigned short i, z;
Eina_Strbuf *buf = NULL;
EINA_SAFETY_ON_NULL_RETURN_VAL(conn, EINA_FALSE);
EINA_SAFETY_ON_NULL_RETURN_VAL(path, EINA_FALSE);
EINA_SAFETY_ON_NULL_RETURN_VAL(interface, EINA_FALSE);
if (!dbus_connection_get_object_path_data(conn->dbus_conn, path,
(void*)&obj))
{
ERR("Invalid object path");
return NULL;
}
if (obj == NULL)
obj = _edbus_service_object_add(conn, path);
EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
iface = _edbus_service_interface_add(obj, interface);
if (!iface)
{
if (eina_hash_population(obj->interfaces) < 2)
_object_free(obj);
return NULL;
}
for (method = (EDBus_Method *)methods; method && method->member; method++)
_edbus_service_method_add(iface, method);
if (!iface->sign_of_signals)
iface->sign_of_signals = eina_array_new(1);
for (i = 0; &signals[i] && signals[i].name; i++)
{
buf = eina_strbuf_new();
for (z = 0; &signals[i].args[z] && signals[i].args[z].signature; z++)
eina_strbuf_append(buf, signals[i].args[z].signature);
if (!dbus_signature_validate(eina_strbuf_string_get(buf), NULL))
{
ERR("Signal with invalid signature: interface=%s signal=%s",
iface->name, signals[i].name);
eina_strbuf_free(buf);
continue;
}
eina_array_push(iface->sign_of_signals,
eina_stringshare_add(eina_strbuf_string_get(buf)));
eina_strbuf_free(buf);
}
iface->signals = signals;
return iface;
}
static void
_interface_free(EDBus_Service_Interface *interface)
{
unsigned size, i;
if (interface == introspectable) return;
eina_hash_free(interface->methods);
eina_stringshare_del(interface->name);
size = eina_array_count(interface->sign_of_signals);
for (i = 0; i < size; i++)
eina_stringshare_del(eina_array_data_get(interface->sign_of_signals, i));
eina_array_free(interface->sign_of_signals);
free(interface);
}
static void
_object_free(EDBus_Service_Object *obj)
{
Eina_Iterator *iterator;
EDBus_Service_Interface *iface;
iterator = eina_hash_iterator_data_new(obj->interfaces);
EINA_ITERATOR_FOREACH(iterator, iface)
_interface_free(iface);
edbus_data_del_all(&obj->data);
eina_hash_free(obj->interfaces);
eina_iterator_free(iterator);
if (obj->introspection_data)
eina_strbuf_free(obj->introspection_data);
eina_stringshare_del(obj->path);
free(obj);
}
static void
_on_connection_free(void *data, const void *dead_pointer)
{
EDBus_Service_Object *obj = data;
dbus_connection_unregister_object_path(obj->conn->dbus_conn, obj->path);
}
EAPI void
edbus_service_interface_unregister(EDBus_Service_Interface *iface)
{
EDBUS_SERVICE_INTERFACE_CHECK(iface);
eina_hash_del(iface->obj->interfaces, NULL, iface);
if (eina_hash_population(iface->obj->interfaces) < 2)
edbus_service_object_unregister(iface);
_interface_free(iface);
}
EAPI void
edbus_service_object_unregister(EDBus_Service_Interface *iface)
{
EDBUS_SERVICE_INTERFACE_CHECK(iface);
/*
* It will be freed when _object_unregister() is called
* by libdbus.
*/
edbus_connection_cb_free_del(iface->obj->conn, _on_connection_free, iface->obj);
dbus_connection_unregister_object_path(iface->obj->conn->dbus_conn, iface->obj->path);
}
static void
_object_unregister(DBusConnection *conn, void *user_data)
{
EDBus_Service_Object *obj = user_data;
_object_free(obj);
}
static DBusHandlerResult
_object_handler(DBusConnection *conn, DBusMessage *msg, void *user_data)
{
EDBus_Service_Object *obj;
EDBus_Service_Interface *iface;
EDBus_Method *method;
EDBus_Message *edbus_msg;
EDBus_Message *reply;
obj = user_data;
if (!obj) return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
DBG("Connection@%p Got message:\n"
" Type: %s\n"
" Path: %s\n"
" Interface: %s\n"
" Member: %s\n"
" Sender: %s", obj->conn,
dbus_message_type_to_string(dbus_message_get_type(msg)),
dbus_message_get_path(msg),
dbus_message_get_interface(msg),
dbus_message_get_member(msg),
dbus_message_get_sender(msg));
iface = eina_hash_find(obj->interfaces, dbus_message_get_interface(msg));
if (!iface) return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
method = eina_hash_find(iface->methods, dbus_message_get_member(msg));
if (!method) return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
edbus_msg = edbus_message_new(EINA_FALSE);
EINA_SAFETY_ON_NULL_RETURN_VAL(edbus_msg, DBUS_HANDLER_RESULT_NEED_MEMORY);
edbus_msg->dbus_msg = msg;
dbus_message_iter_init(edbus_msg->dbus_msg, &edbus_msg->iterator->dbus_iterator);
if (!_have_signature(method->in, edbus_msg))
{
reply = edbus_message_error_new(edbus_msg,
DBUS_ERROR_INVALID_SIGNATURE,
"See introspectable to know the expected signature");
}
else
{
if (iface->obj)
reply = method->cb(iface, edbus_msg);
else
{
//if iface does have obj it is some of FreeDesktop interfaces:
//Introspectable, Properties...
EDBus_Service_Interface *cpy;
cpy = calloc(1, sizeof(EDBus_Service_Interface));
if (!cpy)
{
dbus_message_ref(edbus_msg->dbus_msg);
edbus_message_unref(edbus_msg);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
cpy->obj = obj;
reply = method->cb(cpy, edbus_msg);
free(cpy);
}
}
dbus_message_ref(edbus_msg->dbus_msg);
edbus_message_unref(edbus_msg);
if (!reply) return DBUS_HANDLER_RESULT_HANDLED;
_edbus_connection_send(obj->conn, reply, NULL, NULL, -1);
edbus_message_unref(reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
EAPI EDBus_Connection *
edbus_service_connection_get(const EDBus_Service_Interface *iface)
{
EDBUS_SERVICE_INTERFACE_CHECK_RETVAL(iface, NULL);
return iface->obj->conn;
}
EAPI const char *
edbus_service_object_path_get(const EDBus_Service_Interface *iface)
{
EDBUS_SERVICE_INTERFACE_CHECK_RETVAL(iface, NULL);
return iface->obj->path;
}
EAPI EDBus_Message *
edbus_service_signal_new(EDBus_Service_Interface *iface, unsigned int signal_id)
{
unsigned size;
EDBUS_SERVICE_INTERFACE_CHECK_RETVAL(iface, EINA_FALSE);
size = eina_array_count(iface->sign_of_signals);
EINA_SAFETY_ON_FALSE_RETURN_VAL(signal_id < size, EINA_FALSE);
return edbus_message_signal_new(iface->obj->path, iface->name,
iface->signals[signal_id].name);
}
EAPI Eina_Bool
edbus_service_signal_emit(EDBus_Service_Interface *iface, unsigned int signal_id, ...)
{
EDBus_Message *sig;
va_list ap;
Eina_Bool r;
const char *signature;
unsigned size;
EDBUS_SERVICE_INTERFACE_CHECK_RETVAL(iface, EINA_FALSE);
size = eina_array_count(iface->sign_of_signals);
EINA_SAFETY_ON_FALSE_RETURN_VAL(signal_id < size, EINA_FALSE);
sig = edbus_service_signal_new(iface, signal_id);
EINA_SAFETY_ON_NULL_RETURN_VAL(sig, EINA_FALSE);
signature = eina_array_data_get(iface->sign_of_signals, signal_id);
va_start(ap, signal_id);
r = edbus_message_arguments_vset(sig, signature, ap);
va_end(ap);
EINA_SAFETY_ON_FALSE_RETURN_VAL(r, EINA_FALSE);
edbus_service_signal_send(iface, sig);
edbus_message_unref(sig);
return EINA_TRUE;
}
EAPI Eina_Bool
edbus_service_signal_send(EDBus_Service_Interface *iface, EDBus_Message *signal_msg)
{
EDBUS_SERVICE_INTERFACE_CHECK_RETVAL(iface, EINA_FALSE);
EINA_SAFETY_ON_NULL_RETURN_VAL(signal_msg, EINA_FALSE);
_edbus_connection_send(iface->obj->conn, signal_msg, NULL, NULL, -1);
return EINA_TRUE;
}
EAPI void
edbus_service_object_data_set(EDBus_Service_Interface *iface, const char *key, const void *data)
{
EDBUS_SERVICE_INTERFACE_CHECK(iface);
EINA_SAFETY_ON_NULL_RETURN(key);
EINA_SAFETY_ON_NULL_RETURN(data);
edbus_data_set(&(iface->obj->data), key, data);
}
EAPI void *
edbus_service_object_data_get(const EDBus_Service_Interface *iface, const char *key)
{
EDBUS_SERVICE_INTERFACE_CHECK_RETVAL(iface, NULL);
EINA_SAFETY_ON_NULL_RETURN_VAL(key, NULL);
return edbus_data_get(&(((EDBus_Service_Object *)iface->obj)->data), key);
}
EAPI void *
edbus_service_object_data_del(EDBus_Service_Interface *iface, const char *key)
{
EDBUS_SERVICE_INTERFACE_CHECK_RETVAL(iface, NULL);
EINA_SAFETY_ON_NULL_RETURN_VAL(key, NULL);
return edbus_data_del(&(((EDBus_Service_Object *)iface->obj)->data), key);
}