gdbus: Fix wrong signal handler match
[platform/upstream/connman.git] / gdbus / watch.c
1 /*
2  *
3  *  D-Bus helper library
4  *
5  *  Copyright (C) 2004-2011  Marcel Holtmann <marcel@holtmann.org>
6  *
7  *
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.
12  *
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.
17  *
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
21  *
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <stdio.h>
29 #include <string.h>
30
31 #include <glib.h>
32 #include <dbus/dbus.h>
33
34 #include "gdbus.h"
35
36 #define info(fmt...)
37 #define error(fmt...)
38 #define debug(fmt...)
39
40 static DBusHandlerResult message_filter(DBusConnection *connection,
41                                         DBusMessage *message, void *user_data);
42
43 static guint listener_id = 0;
44 static GSList *listeners = NULL;
45
46 struct service_data {
47         DBusConnection *conn;
48         DBusPendingCall *call;
49         char *name;
50         const char *owner;
51         guint id;
52         struct filter_callback *callback;
53 };
54
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;
61         void *user_data;
62         guint id;
63 };
64
65 struct filter_data {
66         DBusConnection *connection;
67         DBusHandleMessageFunction handle_func;
68         char *name;
69         char *owner;
70         char *path;
71         char *interface;
72         char *member;
73         char *argument;
74         GSList *callbacks;
75         GSList *processed;
76         guint name_watch;
77         gboolean lock;
78         gboolean registered;
79 };
80
81 static struct filter_data *filter_data_find_match(DBusConnection *connection,
82                                                         const char *name,
83                                                         const char *owner,
84                                                         const char *path,
85                                                         const char *interface,
86                                                         const char *member,
87                                                         const char *argument)
88 {
89         GSList *current;
90
91         for (current = listeners;
92                         current != NULL; current = current->next) {
93                 struct filter_data *data = current->data;
94
95                 if (connection != data->connection)
96                         continue;
97
98                 if (g_strcmp0(name, data->name) != 0)
99                         continue;
100
101                 if (g_strcmp0(owner, data->owner) != 0)
102                         continue;
103
104                 if (g_strcmp0(path, data->path) != 0)
105                         continue;
106
107                 if (g_strcmp0(interface, data->interface) != 0)
108                         continue;
109
110                 if (g_strcmp0(member, data->member) != 0)
111                         continue;
112
113                 if (g_strcmp0(argument, data->argument) != 0)
114                         continue;
115
116                 return data;
117         }
118
119         return NULL;
120 }
121
122 static struct filter_data *filter_data_find(DBusConnection *connection,
123                                                         const char *name,
124                                                         const char *owner,
125                                                         const char *path,
126                                                         const char *interface,
127                                                         const char *member,
128                                                         const char *argument)
129 {
130         GSList *current;
131
132         for (current = listeners;
133                         current != NULL; current = current->next) {
134                 struct filter_data *data = current->data;
135
136                 if (connection != data->connection)
137                         continue;
138
139                 if (name && data->name &&
140                                 g_str_equal(name, data->name) == FALSE)
141                         continue;
142
143                 if (owner && data->owner &&
144                                 g_str_equal(owner, data->owner) == FALSE)
145                         continue;
146
147                 if (path && data->path &&
148                                 g_str_equal(path, data->path) == FALSE)
149                         continue;
150
151                 if (interface && data->interface &&
152                                 g_str_equal(interface, data->interface) == FALSE)
153                         continue;
154
155                 if (member && data->member &&
156                                 g_str_equal(member, data->member) == FALSE)
157                         continue;
158
159                 if (argument && data->argument &&
160                                 g_str_equal(argument, data->argument) == FALSE)
161                         continue;
162
163                 return data;
164         }
165
166         return NULL;
167 }
168
169 static void format_rule(struct filter_data *data, char *rule, size_t size)
170 {
171         const char *sender;
172         int offset;
173
174         offset = snprintf(rule, size, "type='signal'");
175         sender = data->name ? : data->owner;
176
177         if (sender)
178                 offset += snprintf(rule + offset, size - offset,
179                                 ",sender='%s'", sender);
180         if (data->path)
181                 offset += snprintf(rule + offset, size - offset,
182                                 ",path='%s'", data->path);
183         if (data->interface)
184                 offset += snprintf(rule + offset, size - offset,
185                                 ",interface='%s'", data->interface);
186         if (data->member)
187                 offset += snprintf(rule + offset, size - offset,
188                                 ",member='%s'", data->member);
189         if (data->argument)
190                 snprintf(rule + offset, size - offset,
191                                 ",arg0='%s'", data->argument);
192 }
193
194 static gboolean add_match(struct filter_data *data,
195                                 DBusHandleMessageFunction filter)
196 {
197         DBusError err;
198         char rule[DBUS_MAXIMUM_MATCH_RULE_LENGTH];
199
200         format_rule(data, rule, sizeof(rule));
201         dbus_error_init(&err);
202
203         dbus_bus_add_match(data->connection, rule, &err);
204         if (dbus_error_is_set(&err)) {
205                 error("Adding match rule \"%s\" failed: %s", rule,
206                                 err.message);
207                 dbus_error_free(&err);
208                 return FALSE;
209         }
210
211         data->handle_func = filter;
212         data->registered = TRUE;
213
214         return TRUE;
215 }
216
217 static gboolean remove_match(struct filter_data *data)
218 {
219         DBusError err;
220         char rule[DBUS_MAXIMUM_MATCH_RULE_LENGTH];
221
222         format_rule(data, rule, sizeof(rule));
223
224         dbus_error_init(&err);
225
226         dbus_bus_remove_match(data->connection, rule, &err);
227         if (dbus_error_is_set(&err)) {
228                 error("Removing owner match rule for %s failed: %s",
229                                 rule, err.message);
230                 dbus_error_free(&err);
231                 return FALSE;
232         }
233
234         return TRUE;
235 }
236
237 static struct filter_data *filter_data_get(DBusConnection *connection,
238                                         DBusHandleMessageFunction filter,
239                                         const char *sender,
240                                         const char *path,
241                                         const char *interface,
242                                         const char *member,
243                                         const char *argument)
244 {
245         struct filter_data *data;
246         const char *name = NULL, *owner = NULL;
247
248         if (filter_data_find(connection, NULL, NULL, NULL, NULL, NULL, NULL) == NULL) {
249                 if (!dbus_connection_add_filter(connection,
250                                         message_filter, NULL, NULL)) {
251                         error("dbus_connection_add_filter() failed");
252                         return NULL;
253                 }
254         }
255
256         if (sender == NULL)
257                 goto proceed;
258
259         if (sender[0] == ':')
260                 owner = sender;
261         else
262                 name = sender;
263
264 proceed:
265         data = filter_data_find_match(connection, name, owner, path,
266                                                 interface, member, argument);
267         if (data)
268                 return data;
269
270         data = g_new0(struct filter_data, 1);
271
272         data->connection = dbus_connection_ref(connection);
273         data->name = name ? g_strdup(name) : NULL;
274         data->owner = owner ? g_strdup(owner) : NULL;
275         data->path = g_strdup(path);
276         data->interface = g_strdup(interface);
277         data->member = g_strdup(member);
278         data->argument = g_strdup(argument);
279
280         if (!add_match(data, filter)) {
281                 g_free(data);
282                 return NULL;
283         }
284
285         listeners = g_slist_append(listeners, data);
286
287         return data;
288 }
289
290 static struct filter_callback *filter_data_find_callback(
291                                                 struct filter_data *data,
292                                                 guint id)
293 {
294         GSList *l;
295
296         for (l = data->callbacks; l; l = l->next) {
297                 struct filter_callback *cb = l->data;
298                 if (cb->id == id)
299                         return cb;
300         }
301         for (l = data->processed; l; l = l->next) {
302                 struct filter_callback *cb = l->data;
303                 if (cb->id == id)
304                         return cb;
305         }
306
307         return NULL;
308 }
309
310 static void filter_data_free(struct filter_data *data)
311 {
312         GSList *l;
313
314         for (l = data->callbacks; l != NULL; l = l->next)
315                 g_free(l->data);
316
317         g_slist_free(data->callbacks);
318         g_dbus_remove_watch(data->connection, data->name_watch);
319         g_free(data->name);
320         g_free(data->owner);
321         g_free(data->path);
322         g_free(data->interface);
323         g_free(data->member);
324         g_free(data->argument);
325         dbus_connection_unref(data->connection);
326         g_free(data);
327 }
328
329 static void filter_data_call_and_free(struct filter_data *data)
330 {
331         GSList *l;
332
333         for (l = data->callbacks; l != NULL; l = l->next) {
334                 struct filter_callback *cb = l->data;
335                 if (cb->disc_func)
336                         cb->disc_func(data->connection, cb->user_data);
337                 if (cb->destroy_func)
338                         cb->destroy_func(cb->user_data);
339                 g_free(cb);
340         }
341
342         filter_data_free(data);
343 }
344
345 static struct filter_callback *filter_data_add_callback(
346                                                 struct filter_data *data,
347                                                 GDBusWatchFunction connect,
348                                                 GDBusWatchFunction disconnect,
349                                                 GDBusSignalFunction signal,
350                                                 GDBusDestroyFunction destroy,
351                                                 void *user_data)
352 {
353         struct filter_callback *cb = NULL;
354
355         cb = g_new0(struct filter_callback, 1);
356
357         cb->conn_func = connect;
358         cb->disc_func = disconnect;
359         cb->signal_func = signal;
360         cb->destroy_func = destroy;
361         cb->user_data = user_data;
362         cb->id = ++listener_id;
363
364         if (data->lock)
365                 data->processed = g_slist_append(data->processed, cb);
366         else
367                 data->callbacks = g_slist_append(data->callbacks, cb);
368
369         return cb;
370 }
371
372 static void service_data_free(struct service_data *data)
373 {
374         struct filter_callback *callback = data->callback;
375
376         dbus_connection_unref(data->conn);
377
378         if (data->call)
379                 dbus_pending_call_unref(data->call);
380
381         if (data->id)
382                 g_source_remove(data->id);
383
384         g_free(data->name);
385         g_free(data);
386
387         callback->data = NULL;
388 }
389
390 static gboolean filter_data_remove_callback(struct filter_data *data,
391                                                 struct filter_callback *cb)
392 {
393         DBusConnection *connection;
394
395         data->callbacks = g_slist_remove(data->callbacks, cb);
396         data->processed = g_slist_remove(data->processed, cb);
397
398         /* Cancel pending operations */
399         if (cb->data) {
400                 if (cb->data->call)
401                         dbus_pending_call_cancel(cb->data->call);
402                 service_data_free(cb->data);
403         }
404
405         if (cb->destroy_func)
406                 cb->destroy_func(cb->user_data);
407
408         g_free(cb);
409
410         /* Don't remove the filter if other callbacks exist or data is lock
411          * processing callbacks */
412         if (data->callbacks || data->lock)
413                 return TRUE;
414
415         if (data->registered && !remove_match(data))
416                 return FALSE;
417
418         connection = dbus_connection_ref(data->connection);
419         listeners = g_slist_remove(listeners, data);
420
421         /* Remove filter if there are no listeners left for the connection */
422         if (filter_data_find(connection, NULL, NULL, NULL, NULL, NULL,
423                                                                 NULL) == NULL)
424                 dbus_connection_remove_filter(connection, message_filter,
425                                                 NULL);
426
427         filter_data_free(data);
428         dbus_connection_unref(connection);
429
430         return TRUE;
431 }
432
433 static DBusHandlerResult signal_filter(DBusConnection *connection,
434                                         DBusMessage *message, void *user_data)
435 {
436         struct filter_data *data = user_data;
437         struct filter_callback *cb;
438
439         while (data->callbacks) {
440                 cb = data->callbacks->data;
441
442                 if (cb->signal_func && !cb->signal_func(connection, message,
443                                                         cb->user_data)) {
444                         filter_data_remove_callback(data, cb);
445                         continue;
446                 }
447
448                 /* Check if the watch was removed/freed by the callback
449                  * function */
450                 if (!g_slist_find(data->callbacks, cb))
451                         continue;
452
453                 data->callbacks = g_slist_remove(data->callbacks, cb);
454                 data->processed = g_slist_append(data->processed, cb);
455         }
456
457         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
458 }
459
460 static void update_name_cache(const char *name, const char *owner)
461 {
462         GSList *l;
463
464         for (l = listeners; l != NULL; l = l->next) {
465                 struct filter_data *data = l->data;
466
467                 if (g_strcmp0(data->name, name) != 0)
468                         continue;
469
470                 g_free(data->owner);
471                 data->owner = g_strdup(owner);
472         }
473 }
474
475 static const char *check_name_cache(const char *name)
476 {
477         GSList *l;
478
479         for (l = listeners; l != NULL; l = l->next) {
480                 struct filter_data *data = l->data;
481
482                 if (g_strcmp0(data->name, name) != 0)
483                         continue;
484
485                 return data->owner;
486         }
487
488         return NULL;
489 }
490
491 static DBusHandlerResult service_filter(DBusConnection *connection,
492                                         DBusMessage *message, void *user_data)
493 {
494         struct filter_data *data = user_data;
495         struct filter_callback *cb;
496         char *name, *old, *new;
497
498         if (!dbus_message_get_args(message, NULL,
499                                 DBUS_TYPE_STRING, &name,
500                                 DBUS_TYPE_STRING, &old,
501                                 DBUS_TYPE_STRING, &new,
502                                 DBUS_TYPE_INVALID)) {
503                 error("Invalid arguments for NameOwnerChanged signal");
504                 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
505         }
506
507         update_name_cache(name, new);
508
509         while (data->callbacks) {
510                 cb = data->callbacks->data;
511
512                 if (*new == '\0') {
513                         if (cb->disc_func)
514                                 cb->disc_func(connection, cb->user_data);
515                 } else {
516                         if (cb->conn_func)
517                                 cb->conn_func(connection, cb->user_data);
518                 }
519
520                 /* Check if the watch was removed/freed by the callback
521                  * function */
522                 if (!g_slist_find(data->callbacks, cb))
523                         continue;
524
525                 /* Only auto remove if it is a bus name watch */
526                 if (data->argument[0] == ':' &&
527                                 (cb->conn_func == NULL || cb->disc_func == NULL)) {
528                         filter_data_remove_callback(data, cb);
529                         continue;
530                 }
531
532                 data->callbacks = g_slist_remove(data->callbacks, cb);
533                 data->processed = g_slist_append(data->processed, cb);
534         }
535
536         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
537 }
538
539
540 static DBusHandlerResult message_filter(DBusConnection *connection,
541                                         DBusMessage *message, void *user_data)
542 {
543         struct filter_data *data;
544         const char *sender, *path, *iface, *member, *arg = NULL;
545         GSList *current, *delete_listener = NULL;
546
547         /* Only filter signals */
548         if (dbus_message_get_type(message) != DBUS_MESSAGE_TYPE_SIGNAL)
549                 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
550
551         sender = dbus_message_get_sender(message);
552         path = dbus_message_get_path(message);
553         iface = dbus_message_get_interface(message);
554         member = dbus_message_get_member(message);
555         dbus_message_get_args(message, NULL, DBUS_TYPE_STRING, &arg, DBUS_TYPE_INVALID);
556
557         /* Sender is always the owner */
558
559         for (current = listeners; current != NULL; current = current->next) {
560                 data = current->data;
561
562                 if (connection != data->connection)
563                         continue;
564
565                 if (data->owner && g_str_equal(sender, data->owner) == FALSE)
566                         continue;
567
568                 if (data->path && g_str_equal(path, data->path) == FALSE)
569                         continue;
570
571                 if (data->interface && g_str_equal(iface,
572                                                 data->interface) == FALSE)
573                         continue;
574
575                 if (data->member && g_str_equal(member, data->member) == FALSE)
576                         continue;
577
578                 if (data->argument && g_str_equal(arg,
579                                                 data->argument) == FALSE)
580                         continue;
581
582                 if (data->handle_func) {
583                         data->lock = TRUE;
584
585                         data->handle_func(connection, message, data);
586
587                         data->callbacks = data->processed;
588                         data->processed = NULL;
589                         data->lock = FALSE;
590                 }
591
592                 if (!data->callbacks)
593                         delete_listener = g_slist_prepend(delete_listener,
594                                                                 current);
595         }
596
597         for (current = delete_listener; current != NULL;
598                                         current = delete_listener->next) {
599                 GSList *l = current->data;
600
601                 data = l->data;
602
603                 /* Has any other callback added callbacks back to this data? */
604                 if (data->callbacks != NULL)
605                         continue;
606
607                 remove_match(data);
608                 listeners = g_slist_remove_link(listeners, l);
609
610                 filter_data_free(data);
611         }
612
613         g_slist_free(delete_listener);
614
615         /* Remove filter if there are no listeners left for the connection */
616         if (filter_data_find(connection, NULL, NULL, NULL, NULL, NULL,
617                                                                 NULL) == NULL)
618                 dbus_connection_remove_filter(connection, message_filter,
619                                                 NULL);
620
621         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
622 }
623
624 static gboolean update_service(void *user_data)
625 {
626         struct service_data *data = user_data;
627         struct filter_callback *cb = data->callback;
628
629         update_name_cache(data->name, data->owner);
630         if (cb->conn_func)
631                 cb->conn_func(data->conn, cb->user_data);
632
633         service_data_free(data);
634
635         return FALSE;
636 }
637
638 static void service_reply(DBusPendingCall *call, void *user_data)
639 {
640         struct service_data *data = user_data;
641         DBusMessage *reply;
642         DBusError err;
643
644         reply = dbus_pending_call_steal_reply(call);
645         if (reply == NULL)
646                 return;
647
648         dbus_error_init(&err);
649
650         if (dbus_set_error_from_message(&err, reply))
651                 goto fail;
652
653         if (dbus_message_get_args(reply, &err,
654                                         DBUS_TYPE_STRING, &data->owner,
655                                                 DBUS_TYPE_INVALID) == FALSE)
656                 goto fail;
657
658         update_service(data);
659
660         goto done;
661
662 fail:
663         error("%s", err.message);
664         dbus_error_free(&err);
665         service_data_free(data);
666 done:
667         dbus_message_unref(reply);
668 }
669
670 static void check_service(DBusConnection *connection,
671                                         const char *name,
672                                         struct filter_callback *callback)
673 {
674         DBusMessage *message;
675         struct service_data *data;
676
677         data = g_try_malloc0(sizeof(*data));
678         if (data == NULL) {
679                 error("Can't allocate data structure");
680                 return;
681         }
682
683         data->conn = dbus_connection_ref(connection);
684         data->name = g_strdup(name);
685         data->callback = callback;
686         callback->data = data;
687
688         data->owner = check_name_cache(name);
689         if (data->owner != NULL) {
690                 data->id = g_idle_add(update_service, data);
691                 return;
692         }
693
694         message = dbus_message_new_method_call(DBUS_SERVICE_DBUS,
695                         DBUS_PATH_DBUS, DBUS_INTERFACE_DBUS, "GetNameOwner");
696         if (message == NULL) {
697                 error("Can't allocate new message");
698                 g_free(data);
699                 return;
700         }
701
702         dbus_message_append_args(message, DBUS_TYPE_STRING, &name,
703                                                         DBUS_TYPE_INVALID);
704
705         if (dbus_connection_send_with_reply(connection, message,
706                                                         &data->call, -1) == FALSE) {
707                 error("Failed to execute method call");
708                 g_free(data);
709                 goto done;
710         }
711
712         if (data->call == NULL) {
713                 error("D-Bus connection not available");
714                 g_free(data);
715                 goto done;
716         }
717
718         dbus_pending_call_set_notify(data->call, service_reply, data, NULL);
719
720 done:
721         dbus_message_unref(message);
722 }
723
724 guint g_dbus_add_service_watch(DBusConnection *connection, const char *name,
725                                 GDBusWatchFunction connect,
726                                 GDBusWatchFunction disconnect,
727                                 void *user_data, GDBusDestroyFunction destroy)
728 {
729         struct filter_data *data;
730         struct filter_callback *cb;
731
732         if (name == NULL)
733                 return 0;
734
735         data = filter_data_get(connection, service_filter, NULL, NULL,
736                                 DBUS_INTERFACE_DBUS, "NameOwnerChanged",
737                                 name);
738         if (data == NULL)
739                 return 0;
740
741         cb = filter_data_add_callback(data, connect, disconnect, NULL, destroy,
742                                         user_data);
743         if (cb == NULL)
744                 return 0;
745
746         if (connect)
747                 check_service(connection, name, cb);
748
749         return cb->id;
750 }
751
752 guint g_dbus_add_disconnect_watch(DBusConnection *connection, const char *name,
753                                 GDBusWatchFunction func,
754                                 void *user_data, GDBusDestroyFunction destroy)
755 {
756         return g_dbus_add_service_watch(connection, name, NULL, func,
757                                                         user_data, destroy);
758 }
759
760 guint g_dbus_add_signal_watch(DBusConnection *connection,
761                                 const char *sender, const char *path,
762                                 const char *interface, const char *member,
763                                 GDBusSignalFunction function, void *user_data,
764                                 GDBusDestroyFunction destroy)
765 {
766         struct filter_data *data;
767         struct filter_callback *cb;
768
769         data = filter_data_get(connection, signal_filter, sender, path,
770                                 interface, member, NULL);
771         if (data == NULL)
772                 return 0;
773
774         cb = filter_data_add_callback(data, NULL, NULL, function, destroy,
775                                         user_data);
776         if (cb == NULL)
777                 return 0;
778
779         if (data->name != NULL && data->name_watch == 0)
780                 data->name_watch = g_dbus_add_service_watch(connection,
781                                                         data->name, NULL,
782                                                         NULL, NULL, NULL);
783
784         return cb->id;
785 }
786
787 gboolean g_dbus_remove_watch(DBusConnection *connection, guint id)
788 {
789         struct filter_data *data;
790         struct filter_callback *cb;
791         GSList *ldata;
792
793         if (id == 0)
794                 return FALSE;
795
796         for (ldata = listeners; ldata; ldata = ldata->next) {
797                 data = ldata->data;
798
799                 cb = filter_data_find_callback(data, id);
800                 if (cb) {
801                         filter_data_remove_callback(data, cb);
802                         return TRUE;
803                 }
804         }
805
806         return FALSE;
807 }
808
809 void g_dbus_remove_all_watches(DBusConnection *connection)
810 {
811         struct filter_data *data;
812
813         while ((data = filter_data_find(connection, NULL, NULL, NULL, NULL,
814                                         NULL, NULL))) {
815                 listeners = g_slist_remove(listeners, data);
816                 filter_data_call_and_free(data);
817         }
818
819         dbus_connection_remove_filter(connection, message_filter, NULL);
820 }