5 * Copyright (C) 2004-2011 Marcel Holtmann <marcel@holtmann.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
32 #include <dbus/dbus.h>
40 static DBusHandlerResult message_filter(DBusConnection *connection,
41 DBusMessage *message, void *user_data);
43 static guint listener_id = 0;
44 static GSList *listeners = NULL;
48 DBusPendingCall *call;
52 struct filter_callback *callback;
55 struct filter_callback {
56 GDBusWatchFunction conn_func;
57 GDBusWatchFunction disc_func;
58 GDBusSignalFunction signal_func;
59 GDBusDestroyFunction destroy_func;
60 struct service_data *data;
66 DBusConnection *connection;
67 DBusHandleMessageFunction handle_func;
81 static struct filter_data *filter_data_find_match(DBusConnection *connection,
85 const char *interface,
91 for (current = listeners;
92 current != NULL; current = current->next) {
93 struct filter_data *data = current->data;
95 if (connection != data->connection)
98 if (g_strcmp0(name, data->name) != 0)
101 if (g_strcmp0(owner, data->owner) != 0)
104 if (g_strcmp0(path, data->path) != 0)
107 if (g_strcmp0(interface, data->interface) != 0)
110 if (g_strcmp0(member, data->member) != 0)
113 if (g_strcmp0(argument, data->argument) != 0)
122 static struct filter_data *filter_data_find(DBusConnection *connection)
126 for (current = listeners;
127 current != NULL; current = current->next) {
128 struct filter_data *data = current->data;
130 if (connection != data->connection)
139 static char *format_rule(struct filter_data *data)
144 rule = g_strdup("type='signal'");
145 sender = data->name ? : data->owner;
149 rule = g_strdup_printf("%s,sender='%s'", rule, sender);
155 rule = g_strdup_printf("%s,path='%s'", rule, data->path);
159 if (data->interface){
161 rule = g_strdup_printf("%s,interface='%s'", rule,
168 rule = g_strdup_printf("%s,member='%s'", rule, data->member);
172 if (data->argument) {
174 rule = g_strdup_printf("%s,arg0='%s'", rule, data->argument);
181 static gboolean add_match(struct filter_data *data,
182 DBusHandleMessageFunction filter)
187 rule = format_rule(data);
188 dbus_error_init(&err);
190 dbus_bus_add_match(data->connection, rule, &err);
191 if (dbus_error_is_set(&err)) {
192 error("Adding match rule \"%s\" failed: %s", rule,
194 dbus_error_free(&err);
199 data->handle_func = filter;
200 data->registered = TRUE;
206 static gboolean remove_match(struct filter_data *data)
211 rule = format_rule(data);
213 dbus_error_init(&err);
215 dbus_bus_remove_match(data->connection, rule, &err);
216 if (dbus_error_is_set(&err)) {
217 error("Removing owner match rule for %s failed: %s",
219 dbus_error_free(&err);
228 static void filter_data_free(struct filter_data *data)
232 /* Remove filter if there are no listeners left for the connection */
233 if (filter_data_find(data->connection) == NULL)
234 dbus_connection_remove_filter(data->connection, message_filter,
237 for (l = data->callbacks; l != NULL; l = l->next)
240 g_slist_free(data->callbacks);
241 g_dbus_remove_watch(data->connection, data->name_watch);
245 g_free(data->interface);
246 g_free(data->member);
247 g_free(data->argument);
248 dbus_connection_unref(data->connection);
252 static struct filter_data *filter_data_get(DBusConnection *connection,
253 DBusHandleMessageFunction filter,
256 const char *interface,
258 const char *argument)
260 struct filter_data *data;
261 const char *name = NULL, *owner = NULL;
263 if (filter_data_find(connection) == NULL) {
264 if (!dbus_connection_add_filter(connection,
265 message_filter, NULL, NULL)) {
266 error("dbus_connection_add_filter() failed");
274 if (sender[0] == ':')
280 data = filter_data_find_match(connection, name, owner, path,
281 interface, member, argument);
285 data = g_new0(struct filter_data, 1);
287 data->connection = dbus_connection_ref(connection);
288 data->name = g_strdup(name);
289 data->owner = g_strdup(owner);
290 data->path = g_strdup(path);
291 data->interface = g_strdup(interface);
292 data->member = g_strdup(member);
293 data->argument = g_strdup(argument);
295 if (!add_match(data, filter)) {
296 filter_data_free(data);
300 listeners = g_slist_append(listeners, data);
305 static struct filter_callback *filter_data_find_callback(
306 struct filter_data *data,
311 for (l = data->callbacks; l; l = l->next) {
312 struct filter_callback *cb = l->data;
316 for (l = data->processed; l; l = l->next) {
317 struct filter_callback *cb = l->data;
325 static void filter_data_call_and_free(struct filter_data *data)
329 for (l = data->callbacks; l != NULL; l = l->next) {
330 struct filter_callback *cb = l->data;
332 cb->disc_func(data->connection, cb->user_data);
333 if (cb->destroy_func)
334 cb->destroy_func(cb->user_data);
338 filter_data_free(data);
341 static struct filter_callback *filter_data_add_callback(
342 struct filter_data *data,
343 GDBusWatchFunction connect,
344 GDBusWatchFunction disconnect,
345 GDBusSignalFunction signal,
346 GDBusDestroyFunction destroy,
349 struct filter_callback *cb = NULL;
351 cb = g_new0(struct filter_callback, 1);
353 cb->conn_func = connect;
354 cb->disc_func = disconnect;
355 cb->signal_func = signal;
356 cb->destroy_func = destroy;
357 cb->user_data = user_data;
358 cb->id = ++listener_id;
361 data->processed = g_slist_append(data->processed, cb);
363 data->callbacks = g_slist_append(data->callbacks, cb);
368 static void service_data_free(struct service_data *data)
370 struct filter_callback *callback = data->callback;
372 dbus_connection_unref(data->conn);
375 dbus_pending_call_unref(data->call);
378 g_source_remove(data->id);
383 callback->data = NULL;
386 /* Returns TRUE if data is freed */
387 static gboolean filter_data_remove_callback(struct filter_data *data,
388 struct filter_callback *cb)
390 data->callbacks = g_slist_remove(data->callbacks, cb);
391 data->processed = g_slist_remove(data->processed, cb);
393 /* Cancel pending operations */
396 dbus_pending_call_cancel(cb->data->call);
397 service_data_free(cb->data);
400 if (cb->destroy_func)
401 cb->destroy_func(cb->user_data);
405 /* Don't remove the filter if other callbacks exist or data is lock
406 * processing callbacks */
407 if (data->callbacks || data->lock)
410 if (data->registered && !remove_match(data))
413 listeners = g_slist_remove(listeners, data);
414 filter_data_free(data);
419 static DBusHandlerResult signal_filter(DBusConnection *connection,
420 DBusMessage *message, void *user_data)
422 struct filter_data *data = user_data;
423 struct filter_callback *cb;
425 while (data->callbacks) {
426 cb = data->callbacks->data;
428 if (cb->signal_func && !cb->signal_func(connection, message,
430 if (filter_data_remove_callback(data, cb))
436 /* Check if the watch was removed/freed by the callback
438 if (!g_slist_find(data->callbacks, cb))
441 data->callbacks = g_slist_remove(data->callbacks, cb);
442 data->processed = g_slist_append(data->processed, cb);
445 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
448 static void update_name_cache(const char *name, const char *owner)
452 for (l = listeners; l != NULL; l = l->next) {
453 struct filter_data *data = l->data;
455 if (g_strcmp0(data->name, name) != 0)
459 data->owner = g_strdup(owner);
463 static const char *check_name_cache(const char *name)
467 for (l = listeners; l != NULL; l = l->next) {
468 struct filter_data *data = l->data;
470 if (g_strcmp0(data->name, name) != 0)
479 static DBusHandlerResult service_filter(DBusConnection *connection,
480 DBusMessage *message, void *user_data)
482 struct filter_data *data = user_data;
483 struct filter_callback *cb;
484 char *name, *old, *new;
486 if (!dbus_message_get_args(message, NULL,
487 DBUS_TYPE_STRING, &name,
488 DBUS_TYPE_STRING, &old,
489 DBUS_TYPE_STRING, &new,
490 DBUS_TYPE_INVALID)) {
491 error("Invalid arguments for NameOwnerChanged signal");
492 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
495 update_name_cache(name, new);
497 while (data->callbacks) {
498 cb = data->callbacks->data;
502 cb->disc_func(connection, cb->user_data);
505 cb->conn_func(connection, cb->user_data);
508 /* Check if the watch was removed/freed by the callback
510 if (!g_slist_find(data->callbacks, cb))
513 /* Only auto remove if it is a bus name watch */
514 if (data->argument[0] == ':' &&
515 (cb->conn_func == NULL || cb->disc_func == NULL)) {
516 if (filter_data_remove_callback(data, cb))
522 data->callbacks = g_slist_remove(data->callbacks, cb);
523 data->processed = g_slist_append(data->processed, cb);
526 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
530 static DBusHandlerResult message_filter(DBusConnection *connection,
531 DBusMessage *message, void *user_data)
533 struct filter_data *data;
534 const char *sender, *path, *iface, *member, *arg = NULL;
535 GSList *current, *delete_listener = NULL;
537 /* Only filter signals */
538 if (dbus_message_get_type(message) != DBUS_MESSAGE_TYPE_SIGNAL)
539 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
541 sender = dbus_message_get_sender(message);
542 path = dbus_message_get_path(message);
543 iface = dbus_message_get_interface(message);
544 member = dbus_message_get_member(message);
545 dbus_message_get_args(message, NULL, DBUS_TYPE_STRING, &arg, DBUS_TYPE_INVALID);
547 /* If sender != NULL it is always the owner */
549 for (current = listeners; current != NULL; current = current->next) {
550 data = current->data;
552 if (connection != data->connection)
555 if (!sender && data->owner)
558 if (data->owner && g_str_equal(sender, data->owner) == FALSE)
561 if (data->path && g_str_equal(path, data->path) == FALSE)
564 if (data->interface && g_str_equal(iface,
565 data->interface) == FALSE)
568 if (data->member && g_str_equal(member, data->member) == FALSE)
571 if (data->argument && g_str_equal(arg,
572 data->argument) == FALSE)
575 if (data->handle_func) {
578 data->handle_func(connection, message, data);
580 data->callbacks = data->processed;
581 data->processed = NULL;
585 if (!data->callbacks)
586 delete_listener = g_slist_prepend(delete_listener,
590 if (delete_listener == NULL)
591 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
593 for (current = delete_listener; current != NULL;
594 current = delete_listener->next) {
595 GSList *l = current->data;
599 /* Has any other callback added callbacks back to this data? */
600 if (data->callbacks != NULL)
604 listeners = g_slist_delete_link(listeners, l);
606 filter_data_free(data);
609 g_slist_free(delete_listener);
611 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
614 static gboolean update_service(void *user_data)
616 struct service_data *data = user_data;
617 struct filter_callback *cb = data->callback;
618 DBusConnection *conn;
620 conn = dbus_connection_ref(data->conn);
621 service_data_free(data);
624 cb->conn_func(conn, cb->user_data);
626 dbus_connection_unref(conn);
631 static void service_reply(DBusPendingCall *call, void *user_data)
633 struct service_data *data = user_data;
637 reply = dbus_pending_call_steal_reply(call);
641 dbus_error_init(&err);
643 if (dbus_set_error_from_message(&err, reply))
646 if (dbus_message_get_args(reply, &err,
647 DBUS_TYPE_STRING, &data->owner,
648 DBUS_TYPE_INVALID) == FALSE)
651 update_service(data);
656 error("%s", err.message);
657 dbus_error_free(&err);
658 service_data_free(data);
660 dbus_message_unref(reply);
663 static void check_service(DBusConnection *connection,
665 struct filter_callback *callback)
667 DBusMessage *message;
668 struct service_data *data;
670 data = g_try_malloc0(sizeof(*data));
672 error("Can't allocate data structure");
676 data->conn = dbus_connection_ref(connection);
677 data->name = g_strdup(name);
678 data->callback = callback;
679 callback->data = data;
681 data->owner = check_name_cache(name);
682 if (data->owner != NULL) {
683 data->id = g_idle_add(update_service, data);
687 message = dbus_message_new_method_call(DBUS_SERVICE_DBUS,
688 DBUS_PATH_DBUS, DBUS_INTERFACE_DBUS, "GetNameOwner");
689 if (message == NULL) {
690 error("Can't allocate new message");
695 dbus_message_append_args(message, DBUS_TYPE_STRING, &name,
698 if (dbus_connection_send_with_reply(connection, message,
699 &data->call, -1) == FALSE) {
700 error("Failed to execute method call");
705 if (data->call == NULL) {
706 error("D-Bus connection not available");
711 dbus_pending_call_set_notify(data->call, service_reply, data, NULL);
714 dbus_message_unref(message);
717 guint g_dbus_add_service_watch(DBusConnection *connection, const char *name,
718 GDBusWatchFunction connect,
719 GDBusWatchFunction disconnect,
720 void *user_data, GDBusDestroyFunction destroy)
722 struct filter_data *data;
723 struct filter_callback *cb;
728 data = filter_data_get(connection, service_filter,
729 DBUS_SERVICE_DBUS, DBUS_PATH_DBUS,
730 DBUS_INTERFACE_DBUS, "NameOwnerChanged",
735 cb = filter_data_add_callback(data, connect, disconnect, NULL, destroy,
741 check_service(connection, name, cb);
746 guint g_dbus_add_disconnect_watch(DBusConnection *connection, const char *name,
747 GDBusWatchFunction func,
748 void *user_data, GDBusDestroyFunction destroy)
750 return g_dbus_add_service_watch(connection, name, NULL, func,
754 guint g_dbus_add_signal_watch(DBusConnection *connection,
755 const char *sender, const char *path,
756 const char *interface, const char *member,
757 GDBusSignalFunction function, void *user_data,
758 GDBusDestroyFunction destroy)
760 struct filter_data *data;
761 struct filter_callback *cb;
763 data = filter_data_get(connection, signal_filter, sender, path,
764 interface, member, NULL);
768 cb = filter_data_add_callback(data, NULL, NULL, function, destroy,
773 if (data->name != NULL && data->name_watch == 0)
774 data->name_watch = g_dbus_add_service_watch(connection,
781 guint g_dbus_add_properties_watch(DBusConnection *connection,
782 const char *sender, const char *path,
783 const char *interface,
784 GDBusSignalFunction function, void *user_data,
785 GDBusDestroyFunction destroy)
787 struct filter_data *data;
788 struct filter_callback *cb;
790 data = filter_data_get(connection, signal_filter, sender, path,
791 DBUS_INTERFACE_PROPERTIES, "PropertiesChanged",
796 cb = filter_data_add_callback(data, NULL, NULL, function, destroy,
801 if (data->name != NULL && data->name_watch == 0)
802 data->name_watch = g_dbus_add_service_watch(connection,
809 gboolean g_dbus_remove_watch(DBusConnection *connection, guint id)
811 struct filter_data *data;
812 struct filter_callback *cb;
818 for (ldata = listeners; ldata; ldata = ldata->next) {
821 cb = filter_data_find_callback(data, id);
823 filter_data_remove_callback(data, cb);
831 void g_dbus_remove_all_watches(DBusConnection *connection)
833 struct filter_data *data;
835 while ((data = filter_data_find(connection))) {
836 listeners = g_slist_remove(listeners, data);
837 filter_data_call_and_free(data);