4 This file is part of avahi.
6 avahi is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as
8 published by the Free Software Foundation; either version 2.1 of the
9 License, or (at your option) any later version.
11 avahi is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
14 Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with avahi; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
30 #include <dbus/dbus.h>
32 #include <avahi-common/dbus.h>
33 #include <avahi-common/llist.h>
34 #include <avahi-common/error.h>
35 #include <avahi-common/dbus.h>
36 #include <avahi-common/malloc.h>
37 #include <avahi-common/dbus-watch-glue.h>
42 static int init_server(AvahiClient *client, int *ret_error);
44 int avahi_client_set_errno (AvahiClient *client, int error) {
47 return client->error = error;
50 int avahi_client_set_dbus_error(AvahiClient *client, DBusError *error) {
54 return avahi_client_set_errno(client, avahi_error_dbus_to_number(error->name));
57 static void client_set_state (AvahiClient *client, AvahiServerState state) {
60 if (client->state == state)
63 client->state = state;
65 switch (client->state) {
66 case AVAHI_CLIENT_FAILURE:
68 dbus_connection_disconnect(client->bus);
69 dbus_connection_unref(client->bus);
75 case AVAHI_CLIENT_S_COLLISION:
76 case AVAHI_CLIENT_S_REGISTERING:
78 /* Clear cached strings */
79 avahi_free(client->host_name);
80 avahi_free(client->host_name_fqdn);
81 avahi_free(client->domain_name);
83 client->host_name = NULL;
84 client->host_name_fqdn = NULL;
85 client->domain_name = NULL;
88 case AVAHI_CLIENT_S_RUNNING:
89 case AVAHI_CLIENT_CONNECTING:
95 client->callback (client, state, client->userdata);
98 static DBusHandlerResult filter_func(DBusConnection *bus, DBusMessage *message, void *userdata) {
99 AvahiClient *client = userdata;
105 dbus_error_init(&error);
107 /* fprintf(stderr, "dbus: interface=%s, path=%s, member=%s\n", */
108 /* dbus_message_get_interface (message), */
109 /* dbus_message_get_path (message), */
110 /* dbus_message_get_member (message)); */
112 if (dbus_message_is_signal(message, DBUS_INTERFACE_LOCAL, "Disconnected")) {
114 /* The DBUS server died or kicked us */
115 avahi_client_set_errno(client, AVAHI_ERR_DISCONNECTED);
118 } if (dbus_message_is_signal(message, DBUS_INTERFACE_DBUS, "NameOwnerChanged")) {
119 char *name, *old, *new;
121 if (!dbus_message_get_args(
123 DBUS_TYPE_STRING, &name,
124 DBUS_TYPE_STRING, &old,
125 DBUS_TYPE_STRING, &new,
126 DBUS_TYPE_INVALID) || dbus_error_is_set(&error)) {
128 fprintf(stderr, "WARNING: Failed to parse NameOwnerChanged signal: %s\n", error.message);
129 avahi_client_set_errno(client, AVAHI_ERR_DBUS_ERROR);
133 if (strcmp(name, AVAHI_DBUS_NAME) == 0) {
135 if (avahi_client_is_connected(client)) {
137 /* Regardless if the server lost or acquired its name or
138 * if the name was transfered: our services are no longer
139 * available, so we disconnect ourselves */
140 avahi_client_set_errno(client, AVAHI_ERR_DISCONNECTED);
143 } else if (client->state == AVAHI_CLIENT_CONNECTING && (!old || *old == 0)) {
146 /* Server appeared */
148 if ((ret = init_server(client, NULL)) < 0) {
149 avahi_client_set_errno(client, ret);
155 } else if (!avahi_client_is_connected(client)) {
157 /* Ignore messages, we get in unconnected state */
159 } else if (dbus_message_is_signal (message, AVAHI_DBUS_INTERFACE_SERVER, "StateChanged")) {
164 if (!dbus_message_get_args(
166 DBUS_TYPE_INT32, &state,
167 DBUS_TYPE_STRING, &e,
168 DBUS_TYPE_INVALID) || dbus_error_is_set (&error)) {
170 fprintf(stderr, "WARNING: Failed to parse Server.StateChanged signal: %s\n", error.message);
171 avahi_client_set_errno(client, AVAHI_ERR_DBUS_ERROR);
175 if ((c = avahi_error_dbus_to_number(e)) != AVAHI_OK)
176 avahi_client_set_errno(client, c);
178 client_set_state(client, (AvahiClientState) state);
180 } else if (dbus_message_is_signal (message, AVAHI_DBUS_INTERFACE_ENTRY_GROUP, "StateChanged")) {
183 path = dbus_message_get_path(message);
185 for (g = client->groups; g; g = g->groups_next)
186 if (strcmp(g->path, path) == 0)
194 if (!dbus_message_get_args(
196 DBUS_TYPE_INT32, &state,
197 DBUS_TYPE_STRING, &e,
198 DBUS_TYPE_INVALID) ||
199 dbus_error_is_set(&error)) {
201 fprintf(stderr, "WARNING: Failed to parse EntryGroup.StateChanged signal: %s\n", error.message);
202 avahi_client_set_errno(client, AVAHI_ERR_DBUS_ERROR);
206 if ((c = avahi_error_dbus_to_number(e)) != AVAHI_OK)
207 avahi_client_set_errno(client, c);
209 avahi_entry_group_set_state(g, state);
212 } else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_DOMAIN_BROWSER, "ItemNew"))
213 return avahi_domain_browser_event(client, AVAHI_BROWSER_NEW, message);
214 else if (dbus_message_is_signal (message, AVAHI_DBUS_INTERFACE_DOMAIN_BROWSER, "ItemRemove"))
215 return avahi_domain_browser_event(client, AVAHI_BROWSER_REMOVE, message);
216 else if (dbus_message_is_signal (message, AVAHI_DBUS_INTERFACE_DOMAIN_BROWSER, "CacheExhausted"))
217 return avahi_domain_browser_event(client, AVAHI_BROWSER_CACHE_EXHAUSTED, message);
218 else if (dbus_message_is_signal (message, AVAHI_DBUS_INTERFACE_DOMAIN_BROWSER, "AllForNow"))
219 return avahi_domain_browser_event(client, AVAHI_BROWSER_ALL_FOR_NOW, message);
220 else if (dbus_message_is_signal (message, AVAHI_DBUS_INTERFACE_DOMAIN_BROWSER, "Failure"))
221 return avahi_domain_browser_event(client, AVAHI_BROWSER_FAILURE, message);
223 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_TYPE_BROWSER, "ItemNew"))
224 return avahi_service_type_browser_event (client, AVAHI_BROWSER_NEW, message);
225 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_TYPE_BROWSER, "ItemRemove"))
226 return avahi_service_type_browser_event (client, AVAHI_BROWSER_REMOVE, message);
227 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_TYPE_BROWSER, "CacheExhausted"))
228 return avahi_service_type_browser_event (client, AVAHI_BROWSER_CACHE_EXHAUSTED, message);
229 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_TYPE_BROWSER, "AllForNow"))
230 return avahi_service_type_browser_event (client, AVAHI_BROWSER_ALL_FOR_NOW, message);
231 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_TYPE_BROWSER, "Failure"))
232 return avahi_service_type_browser_event (client, AVAHI_BROWSER_FAILURE, message);
234 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_BROWSER, "ItemNew"))
235 return avahi_service_browser_event (client, AVAHI_BROWSER_NEW, message);
236 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_BROWSER, "ItemRemove"))
237 return avahi_service_browser_event (client, AVAHI_BROWSER_REMOVE, message);
238 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_BROWSER, "CacheExhausted"))
239 return avahi_service_browser_event (client, AVAHI_BROWSER_CACHE_EXHAUSTED, message);
240 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_BROWSER, "AllForNow"))
241 return avahi_service_browser_event (client, AVAHI_BROWSER_ALL_FOR_NOW, message);
242 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_BROWSER, "Failure"))
243 return avahi_service_browser_event (client, AVAHI_BROWSER_FAILURE, message);
245 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_RESOLVER, "Found"))
246 return avahi_service_resolver_event (client, AVAHI_RESOLVER_FOUND, message);
247 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_SERVICE_RESOLVER, "Failure"))
248 return avahi_service_resolver_event (client, AVAHI_RESOLVER_FAILURE, message);
250 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_HOST_NAME_RESOLVER, "Found"))
251 return avahi_host_name_resolver_event (client, AVAHI_RESOLVER_FOUND, message);
252 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_HOST_NAME_RESOLVER, "Failure"))
253 return avahi_host_name_resolver_event (client, AVAHI_RESOLVER_FAILURE, message);
255 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_ADDRESS_RESOLVER, "Found"))
256 return avahi_address_resolver_event (client, AVAHI_RESOLVER_FOUND, message);
257 else if (dbus_message_is_signal(message, AVAHI_DBUS_INTERFACE_ADDRESS_RESOLVER, "Failure"))
258 return avahi_address_resolver_event (client, AVAHI_RESOLVER_FAILURE, message);
261 fprintf(stderr, "WARNING: Unhandled message: interface=%s, path=%s, member=%s\n",
262 dbus_message_get_interface(message),
263 dbus_message_get_path(message),
264 dbus_message_get_member(message));
266 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
269 return DBUS_HANDLER_RESULT_HANDLED;
273 if (dbus_error_is_set(&error)) {
274 avahi_client_set_errno(client, avahi_error_dbus_to_number(error.name));
275 dbus_error_free(&error);
278 client_set_state(client, AVAHI_CLIENT_FAILURE);
280 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
283 static int get_server_state(AvahiClient *client, int *ret_error) {
284 DBusMessage *message = NULL, *reply = NULL;
287 int e = AVAHI_ERR_NO_MEMORY;
291 dbus_error_init(&error);
293 if (!(message = dbus_message_new_method_call(AVAHI_DBUS_NAME, AVAHI_DBUS_PATH_SERVER, AVAHI_DBUS_INTERFACE_SERVER, "GetState")))
296 reply = dbus_connection_send_with_reply_and_block (client->bus, message, -1, &error);
298 if (!reply || dbus_error_is_set (&error))
301 if (!dbus_message_get_args(reply, &error, DBUS_TYPE_INT32, &state, DBUS_TYPE_INVALID) ||
302 dbus_error_is_set (&error))
305 client_set_state(client, (AvahiServerState) state);
307 dbus_message_unref(message);
308 dbus_message_unref(reply);
313 if (dbus_error_is_set(&error)) {
314 e = avahi_error_dbus_to_number (error.name);
315 dbus_error_free(&error);
322 dbus_message_unref(message);
324 dbus_message_unref(reply);
329 static int check_version(AvahiClient *client, int *ret_error) {
330 DBusMessage *message = NULL, *reply = NULL;
333 int e = AVAHI_ERR_NO_MEMORY;
337 dbus_error_init(&error);
339 if (!(message = dbus_message_new_method_call(AVAHI_DBUS_NAME, AVAHI_DBUS_PATH_SERVER, AVAHI_DBUS_INTERFACE_SERVER, "GetVersionString")))
342 reply = dbus_connection_send_with_reply_and_block (client->bus, message, -1, &error);
344 if (!reply || dbus_error_is_set (&error))
347 if (!dbus_message_get_args (reply, &error, DBUS_TYPE_STRING, &version, DBUS_TYPE_INVALID) ||
348 dbus_error_is_set (&error))
351 if (strcmp(version, PACKAGE_STRING) != 0) {
352 e = AVAHI_ERR_VERSION_MISMATCH;
356 dbus_message_unref(message);
357 dbus_message_unref(reply);
362 if (dbus_error_is_set(&error)) {
363 e = avahi_error_dbus_to_number (error.name);
364 dbus_error_free(&error);
371 dbus_message_unref(message);
373 dbus_message_unref(reply);
378 static int init_server(AvahiClient *client, int *ret_error) {
381 if ((r = check_version(client, ret_error)) < 0)
384 if ((r = get_server_state(client, ret_error)) < 0)
390 /* This function acts like dbus_bus_get but creates a private
391 * connection instead */
392 static DBusConnection* avahi_dbus_bus_get(DBusError *error) {
396 if (!(a = getenv("DBUS_SYSTEM_BUS_ADDRESS")) || !*a)
397 a = DBUS_SYSTEM_BUS_DEFAULT_ADDRESS;
399 if (!(c = dbus_connection_open_private(a, error)))
402 dbus_connection_set_exit_on_disconnect(c, FALSE);
404 if (!dbus_bus_register(c, error)) {
405 dbus_connection_close(c);
406 dbus_connection_unref(c);
413 AvahiClient *avahi_client_new(const AvahiPoll *poll_api, AvahiClientFlags flags, AvahiClientCallback callback, void *userdata, int *ret_error) {
414 AvahiClient *client = NULL;
417 dbus_error_init(&error);
419 if (!(client = avahi_new(AvahiClient, 1))) {
421 *ret_error = AVAHI_ERR_NO_MEMORY;
425 client->poll_api = poll_api;
426 client->error = AVAHI_OK;
427 client->callback = callback;
428 client->userdata = userdata;
429 client->state = (AvahiClientState) -1;
430 client->flags = flags;
432 client->host_name = NULL;
433 client->host_name_fqdn = NULL;
434 client->domain_name = NULL;
435 client->version_string = NULL;
436 client->local_service_cookie_valid = 0;
438 AVAHI_LLIST_HEAD_INIT(AvahiEntryGroup, client->groups);
439 AVAHI_LLIST_HEAD_INIT(AvahiDomainBrowser, client->domain_browsers);
440 AVAHI_LLIST_HEAD_INIT(AvahiServiceBrowser, client->service_browsers);
441 AVAHI_LLIST_HEAD_INIT(AvahiServiceTypeBrowser, client->service_type_browsers);
442 AVAHI_LLIST_HEAD_INIT(AvahiServiceResolver, client->service_resolvers);
443 AVAHI_LLIST_HEAD_INIT(AvahiHostNameResolver, client->host_name_resolvers);
444 AVAHI_LLIST_HEAD_INIT(AvahiAddressResolver, client->address_resolvers);
446 if (!(client->bus = avahi_dbus_bus_get(&error)) || dbus_error_is_set(&error)) {
448 *ret_error = AVAHI_ERR_DBUS_ERROR;
452 if (avahi_dbus_connection_glue(client->bus, poll_api) < 0) {
454 *ret_error = AVAHI_ERR_NO_MEMORY; /* Not optimal */
458 if (!dbus_connection_add_filter (client->bus, filter_func, client, NULL)) {
460 *ret_error = AVAHI_ERR_NO_MEMORY;
467 "interface='" AVAHI_DBUS_INTERFACE_SERVER "', "
468 "sender='" AVAHI_DBUS_NAME "', "
469 "path='" AVAHI_DBUS_PATH_SERVER "'",
472 if (dbus_error_is_set(&error))
478 "interface='" DBUS_INTERFACE_DBUS "', "
479 "sender='" DBUS_SERVICE_DBUS "', "
480 "path='" DBUS_PATH_DBUS "'",
483 if (dbus_error_is_set(&error))
489 "interface='" DBUS_INTERFACE_LOCAL "'",
492 if (dbus_error_is_set(&error))
496 if (!(dbus_bus_name_has_owner(client->bus, AVAHI_DBUS_NAME, &error)) ||
497 dbus_error_is_set(&error)) {
499 /* We free the error so its not set, that way the fail target
500 * will return the NO_DAEMON error rather than a DBUS error */
501 dbus_error_free(&error);
503 if (!(flags & AVAHI_CLIENT_NO_FAIL)) {
506 *ret_error = AVAHI_ERR_NO_DAEMON;
511 /* The user doesn't want this call to fail if the daemon is not
512 * available, so let's return succesfully */
513 client_set_state(client, AVAHI_CLIENT_CONNECTING);
517 if (init_server(client, ret_error) < 0)
526 avahi_client_free(client);
528 if (dbus_error_is_set(&error)) {
531 *ret_error = avahi_error_dbus_to_number(error.name);
533 dbus_error_free(&error);
539 void avahi_client_free(AvahiClient *client) {
542 while (client->groups)
543 avahi_entry_group_free(client->groups);
545 while (client->domain_browsers)
546 avahi_domain_browser_free(client->domain_browsers);
548 while (client->service_browsers)
549 avahi_service_browser_free(client->service_browsers);
551 while (client->service_type_browsers)
552 avahi_service_type_browser_free(client->service_type_browsers);
554 while (client->service_resolvers)
555 avahi_service_resolver_free(client->service_resolvers);
558 dbus_connection_disconnect(client->bus);
559 dbus_connection_unref(client->bus);
562 avahi_free(client->version_string);
563 avahi_free(client->host_name);
564 avahi_free(client->host_name_fqdn);
565 avahi_free(client->domain_name);
570 static char* avahi_client_get_string_reply_and_block (AvahiClient *client, const char *method, const char *param) {
571 DBusMessage *message = NULL, *reply = NULL;
578 dbus_error_init (&error);
580 if (!(message = dbus_message_new_method_call (AVAHI_DBUS_NAME, AVAHI_DBUS_PATH_SERVER, AVAHI_DBUS_INTERFACE_SERVER, method))) {
581 avahi_client_set_errno(client, AVAHI_ERR_NO_MEMORY);
586 if (!dbus_message_append_args (message, DBUS_TYPE_STRING, ¶m, DBUS_TYPE_INVALID)) {
587 avahi_client_set_errno (client, AVAHI_ERR_NO_MEMORY);
592 reply = dbus_connection_send_with_reply_and_block (client->bus, message, -1, &error);
594 if (!reply || dbus_error_is_set (&error))
597 if (!dbus_message_get_args (reply, &error, DBUS_TYPE_STRING, &ret, DBUS_TYPE_INVALID) ||
598 dbus_error_is_set (&error))
601 if (!(n = avahi_strdup(ret))) {
602 avahi_client_set_errno(client, AVAHI_ERR_NO_MEMORY);
606 dbus_message_unref(message);
607 dbus_message_unref(reply);
614 dbus_message_unref(message);
616 dbus_message_unref(reply);
618 if (dbus_error_is_set(&error)) {
619 avahi_client_set_dbus_error(client, &error);
620 dbus_error_free(&error);
626 const char* avahi_client_get_version_string(AvahiClient *client) {
629 if (!avahi_client_is_connected(client)) {
630 avahi_client_set_errno(client, AVAHI_ERR_BAD_STATE);
634 if (!client->version_string)
635 client->version_string = avahi_client_get_string_reply_and_block(client, "GetVersionString", NULL);
637 return client->version_string;
640 const char* avahi_client_get_domain_name(AvahiClient *client) {
643 if (!avahi_client_is_connected(client)) {
644 avahi_client_set_errno(client, AVAHI_ERR_BAD_STATE);
648 if (!client->domain_name)
649 client->domain_name = avahi_client_get_string_reply_and_block(client, "GetDomainName", NULL);
651 return client->domain_name;
654 const char* avahi_client_get_host_name(AvahiClient *client) {
657 if (!avahi_client_is_connected(client)) {
658 avahi_client_set_errno(client, AVAHI_ERR_BAD_STATE);
662 if (!client->host_name)
663 client->host_name = avahi_client_get_string_reply_and_block(client, "GetHostName", NULL);
665 return client->host_name;
668 const char* avahi_client_get_host_name_fqdn (AvahiClient *client) {
671 if (!avahi_client_is_connected(client)) {
672 avahi_client_set_errno(client, AVAHI_ERR_BAD_STATE);
676 if (!client->host_name_fqdn)
677 client->host_name_fqdn = avahi_client_get_string_reply_and_block(client, "GetHostNameFqdn", NULL);
679 return client->host_name_fqdn;
682 AvahiClientState avahi_client_get_state(AvahiClient *client) {
685 return client->state;
688 int avahi_client_errno(AvahiClient *client) {
691 return client->error;
694 /* Just for internal use */
695 int avahi_client_simple_method_call(AvahiClient *client, const char *path, const char *interface, const char *method) {
696 DBusMessage *message = NULL, *reply = NULL;
700 dbus_error_init(&error);
707 if (!(message = dbus_message_new_method_call(AVAHI_DBUS_NAME, path, interface, method))) {
708 r = avahi_client_set_errno(client, AVAHI_ERR_NO_MEMORY);
712 if (!(reply = dbus_connection_send_with_reply_and_block(client->bus, message, -1, &error)) ||
713 dbus_error_is_set (&error)) {
714 r = avahi_client_set_errno(client, AVAHI_ERR_DBUS_ERROR);
718 if (!dbus_message_get_args(reply, &error, DBUS_TYPE_INVALID) ||
719 dbus_error_is_set (&error)) {
720 r = avahi_client_set_errno(client, AVAHI_ERR_DBUS_ERROR);
724 dbus_message_unref(message);
725 dbus_message_unref(reply);
730 if (dbus_error_is_set(&error)) {
731 r = avahi_client_set_dbus_error(client, &error);
732 dbus_error_free(&error);
736 dbus_message_unref(message);
739 dbus_message_unref(reply);
744 uint32_t avahi_client_get_local_service_cookie(AvahiClient *client) {
745 DBusMessage *message = NULL, *reply = NULL;
749 if (!avahi_client_is_connected(client)) {
750 avahi_client_set_errno(client, AVAHI_ERR_BAD_STATE);
751 return AVAHI_SERVICE_COOKIE_INVALID;
754 if (client->local_service_cookie_valid)
755 return client->local_service_cookie;
757 dbus_error_init (&error);
759 if (!(message = dbus_message_new_method_call(AVAHI_DBUS_NAME, AVAHI_DBUS_PATH_SERVER, AVAHI_DBUS_INTERFACE_SERVER, "GetLocalServiceCookie"))) {
760 avahi_client_set_errno(client, AVAHI_ERR_NO_MEMORY);
764 reply = dbus_connection_send_with_reply_and_block (client->bus, message, -1, &error);
766 if (!reply || dbus_error_is_set (&error))
769 if (!dbus_message_get_args (reply, &error, DBUS_TYPE_UINT32, &client->local_service_cookie, DBUS_TYPE_INVALID) ||
770 dbus_error_is_set (&error))
773 dbus_message_unref(message);
774 dbus_message_unref(reply);
776 client->local_service_cookie_valid = 1;
777 return client->local_service_cookie;
782 dbus_message_unref(message);
784 dbus_message_unref(reply);
786 if (dbus_error_is_set(&error)) {
787 avahi_client_set_dbus_error(client, &error);
788 dbus_error_free(&error);
791 return AVAHI_SERVICE_COOKIE_INVALID;
794 int avahi_client_is_connected(AvahiClient *client) {
797 return client->state == AVAHI_CLIENT_S_RUNNING || client->state == AVAHI_CLIENT_S_REGISTERING || client->state == AVAHI_CLIENT_S_COLLISION;