GSettings: small internal refactor
[glib.git] / gio / gdbusobjectmanagerclient.c
blobd9ccf716044d5b7ec799372ac8655d6a61e57108
1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: David Zeuthen <davidz@redhat.com>
23 #include "config.h"
25 #include "gdbusobjectmanager.h"
26 #include "gdbusobjectmanagerclient.h"
27 #include "gdbusobject.h"
28 #include "gdbusprivate.h"
29 #include "gioenumtypes.h"
30 #include "ginitable.h"
31 #include "gasyncresult.h"
32 #include "gsimpleasyncresult.h"
33 #include "gasyncinitable.h"
34 #include "gdbusconnection.h"
35 #include "gdbusutils.h"
36 #include "gdbusobject.h"
37 #include "gdbusobjectproxy.h"
38 #include "gdbusproxy.h"
39 #include "gdbusinterface.h"
41 #include "glibintl.h"
43 /**
44 * SECTION:gdbusobjectmanagerclient
45 * @short_description: Client-side object manager
46 * @include: gio/gio.h
48 * #GDBusObjectManagerClient is used to create, monitor and delete object
49 * proxies for remote objects exported by a #GDBusObjectManagerServer (or any
50 * code implementing the <ulink
51 * url="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager">org.freedesktop.DBus.ObjectManager</ulink>
52 * interface).
54 * Once an instance of this type has been created, you can connect to
55 * the #GDBusObjectManager::object-added and
56 * #GDBusObjectManager::object-removed signals and inspect the
57 * #GDBusObjectProxy objects returned by
58 * g_dbus_object_manager_get_objects().
60 * If the name for a #GDBusObjectManagerClient is not owned by anyone at
61 * object construction time, the default behavior is to request the
62 * message bus to launch an owner for the name. This behavior can be
63 * disabled using the %G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START
64 * flag. It's also worth noting that this only works if the name of
65 * interest is activatable in the first place. E.g. in some cases it
66 * is not possible to launch an owner for the requested name. In this
67 * case, #GDBusObjectManagerClient object construction still succeeds but
68 * there will be no object proxies
69 * (e.g. g_dbus_object_manager_get_objects() returns the empty list) and
70 * the #GDBusObjectManagerClient:name-owner property is %NULL.
72 * The owner of the requested name can come and go (for example
73 * consider a system service being restarted) – #GDBusObjectManagerClient
74 * handles this case too; simply connect to the #GObject::notify
75 * signal to watch for changes on the #GDBusObjectManagerClient:name-owner
76 * property. When the name owner vanishes, the behavior is that
77 * #GDBusObjectManagerClient:name-owner is set to %NULL (this includes
78 * emission of the #GObject::notify signal) and then
79 * #GDBusObjectManager::object-removed signals are synthesized
80 * for all currently existing object proxies. Since
81 * #GDBusObjectManagerClient:name-owner is %NULL when this happens, you can
82 * use this information to disambiguate a synthesized signal from a
83 * genuine signal caused by object removal on the remote
84 * #GDBusObjectManager. Similarly, when a new name owner appears,
85 * #GDBusObjectManager::object-added signals are synthesized
86 * while #GDBusObjectManagerClient:name-owner is still %NULL. Only when all
87 * object proxies have been added, the #GDBusObjectManagerClient:name-owner
88 * is set to the new name owner (this includes emission of the
89 * #GObject::notify signal). Furthermore, you are guaranteed that
90 * #GDBusObjectManagerClient:name-owner will alternate between a name owner
91 * (e.g. <literal>:1.42</literal>) and %NULL even in the case where
92 * the name of interest is atomically replaced
94 * Ultimately, #GDBusObjectManagerClient is used to obtain #GDBusProxy
95 * instances. All signals (including the
96 * <literal>org.freedesktop.DBus.Properties::PropertiesChanged</literal>
97 * signal) delivered to #GDBusProxy instances are guaranteed to
98 * originate from the name owner. This guarantee along with the
99 * behavior described above, means that certain race conditions
100 * including the <emphasis><quote>half the proxy is from the old owner
101 * and the other half is from the new owner</quote></emphasis> problem
102 * cannot happen.
104 * To avoid having the application connect to signals on the returned
105 * #GDBusObjectProxy and #GDBusProxy objects, the
106 * #GDBusObject::interface-added,
107 * #GDBusObject::interface-removed,
108 * #GDBusProxy::g-properties-changed and
109 * #GDBusProxy::g-signal signals
110 * are also emitted on the #GDBusObjectManagerClient instance managing these
111 * objects. The signals emitted are
112 * #GDBusObjectManager::interface-added,
113 * #GDBusObjectManager::interface-removed,
114 * #GDBusObjectManagerClient::interface-proxy-properties-changed and
115 * #GDBusObjectManagerClient::interface-proxy-signal.
117 * Note that all callbacks and signals are emitted in the
118 * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
119 * that the #GDBusObjectManagerClient object was constructed
120 * in. Additionally, the #GDBusObjectProxy and #GDBusProxy objects
121 * originating from the #GDBusObjectManagerClient object will be created in
122 * the same context and, consequently, will deliver signals in the
123 * same main loop.
126 struct _GDBusObjectManagerClientPrivate
128 GMutex lock;
130 GBusType bus_type;
131 GDBusConnection *connection;
132 gchar *object_path;
133 gchar *name;
134 gchar *name_owner;
135 GDBusObjectManagerClientFlags flags;
137 GDBusProxy *control_proxy;
139 GHashTable *map_object_path_to_object_proxy;
141 guint signal_subscription_id;
142 gchar *match_rule;
144 GDBusProxyTypeFunc get_proxy_type_func;
145 gpointer get_proxy_type_user_data;
146 GDestroyNotify get_proxy_type_destroy_notify;
149 enum
151 PROP_0,
152 PROP_BUS_TYPE,
153 PROP_CONNECTION,
154 PROP_FLAGS,
155 PROP_OBJECT_PATH,
156 PROP_NAME,
157 PROP_NAME_OWNER,
158 PROP_GET_PROXY_TYPE_FUNC,
159 PROP_GET_PROXY_TYPE_USER_DATA,
160 PROP_GET_PROXY_TYPE_DESTROY_NOTIFY
163 enum
165 INTERFACE_PROXY_SIGNAL_SIGNAL,
166 INTERFACE_PROXY_PROPERTIES_CHANGED_SIGNAL,
167 LAST_SIGNAL
170 static guint signals[LAST_SIGNAL] = { 0 };
172 static void initable_iface_init (GInitableIface *initable_iface);
173 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
174 static void dbus_object_manager_interface_init (GDBusObjectManagerIface *iface);
176 G_DEFINE_TYPE_WITH_CODE (GDBusObjectManagerClient, g_dbus_object_manager_client, G_TYPE_OBJECT,
177 G_ADD_PRIVATE (GDBusObjectManagerClient)
178 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
179 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
180 G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT_MANAGER, dbus_object_manager_interface_init));
182 static void maybe_unsubscribe_signals (GDBusObjectManagerClient *manager);
184 static void on_control_proxy_g_signal (GDBusProxy *proxy,
185 const gchar *sender_name,
186 const gchar *signal_name,
187 GVariant *parameters,
188 gpointer user_data);
190 static void process_get_all_result (GDBusObjectManagerClient *manager,
191 GVariant *value,
192 const gchar *name_owner);
194 static void
195 g_dbus_object_manager_client_finalize (GObject *object)
197 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (object);
199 maybe_unsubscribe_signals (manager);
201 g_hash_table_unref (manager->priv->map_object_path_to_object_proxy);
203 if (manager->priv->control_proxy != NULL)
205 g_signal_handlers_disconnect_by_func (manager->priv->control_proxy,
206 on_control_proxy_g_signal,
207 manager);
208 g_object_unref (manager->priv->control_proxy);
210 g_object_unref (manager->priv->connection);
211 g_free (manager->priv->object_path);
212 g_free (manager->priv->name);
213 g_free (manager->priv->name_owner);
215 if (manager->priv->get_proxy_type_destroy_notify != NULL)
216 manager->priv->get_proxy_type_destroy_notify (manager->priv->get_proxy_type_user_data);
218 g_mutex_clear (&manager->priv->lock);
220 if (G_OBJECT_CLASS (g_dbus_object_manager_client_parent_class)->finalize != NULL)
221 G_OBJECT_CLASS (g_dbus_object_manager_client_parent_class)->finalize (object);
224 static void
225 g_dbus_object_manager_client_get_property (GObject *_object,
226 guint prop_id,
227 GValue *value,
228 GParamSpec *pspec)
230 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (_object);
232 switch (prop_id)
234 case PROP_CONNECTION:
235 g_value_set_object (value, g_dbus_object_manager_client_get_connection (manager));
236 break;
238 case PROP_OBJECT_PATH:
239 g_value_set_string (value, g_dbus_object_manager_get_object_path (G_DBUS_OBJECT_MANAGER (manager)));
240 break;
242 case PROP_NAME:
243 g_value_set_string (value, g_dbus_object_manager_client_get_name (manager));
244 break;
246 case PROP_FLAGS:
247 g_value_set_flags (value, g_dbus_object_manager_client_get_flags (manager));
248 break;
250 case PROP_NAME_OWNER:
251 g_value_take_string (value, g_dbus_object_manager_client_get_name_owner (manager));
252 break;
254 default:
255 G_OBJECT_WARN_INVALID_PROPERTY_ID (manager, prop_id, pspec);
256 break;
260 static void
261 g_dbus_object_manager_client_set_property (GObject *_object,
262 guint prop_id,
263 const GValue *value,
264 GParamSpec *pspec)
266 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (_object);
267 const gchar *name;
269 switch (prop_id)
271 case PROP_BUS_TYPE:
272 manager->priv->bus_type = g_value_get_enum (value);
273 break;
275 case PROP_CONNECTION:
276 if (g_value_get_object (value) != NULL)
278 g_assert (manager->priv->connection == NULL);
279 g_assert (G_IS_DBUS_CONNECTION (g_value_get_object (value)));
280 manager->priv->connection = g_value_dup_object (value);
282 break;
284 case PROP_OBJECT_PATH:
285 g_assert (manager->priv->object_path == NULL);
286 g_assert (g_variant_is_object_path (g_value_get_string (value)));
287 manager->priv->object_path = g_value_dup_string (value);
288 break;
290 case PROP_NAME:
291 g_assert (manager->priv->name == NULL);
292 name = g_value_get_string (value);
293 g_assert (name == NULL || g_dbus_is_name (name));
294 manager->priv->name = g_strdup (name);
295 break;
297 case PROP_FLAGS:
298 manager->priv->flags = g_value_get_flags (value);
299 break;
301 case PROP_GET_PROXY_TYPE_FUNC:
302 manager->priv->get_proxy_type_func = g_value_get_pointer (value);
303 break;
305 case PROP_GET_PROXY_TYPE_USER_DATA:
306 manager->priv->get_proxy_type_user_data = g_value_get_pointer (value);
307 break;
309 case PROP_GET_PROXY_TYPE_DESTROY_NOTIFY:
310 manager->priv->get_proxy_type_destroy_notify = g_value_get_pointer (value);
311 break;
313 default:
314 G_OBJECT_WARN_INVALID_PROPERTY_ID (manager, prop_id, pspec);
315 break;
319 static void
320 g_dbus_object_manager_client_class_init (GDBusObjectManagerClientClass *klass)
322 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
324 gobject_class->finalize = g_dbus_object_manager_client_finalize;
325 gobject_class->set_property = g_dbus_object_manager_client_set_property;
326 gobject_class->get_property = g_dbus_object_manager_client_get_property;
329 * GDBusObjectManagerClient:connection:
331 * The #GDBusConnection to use.
333 * Since: 2.30
335 g_object_class_install_property (gobject_class,
336 PROP_CONNECTION,
337 g_param_spec_object ("connection",
338 "Connection",
339 "The connection to use",
340 G_TYPE_DBUS_CONNECTION,
341 G_PARAM_READABLE |
342 G_PARAM_WRITABLE |
343 G_PARAM_CONSTRUCT_ONLY |
344 G_PARAM_STATIC_STRINGS));
347 * GDBusObjectManagerClient:bus-type:
349 * If this property is not %G_BUS_TYPE_NONE, then
350 * #GDBusObjectManagerClient:connection must be %NULL and will be set to the
351 * #GDBusConnection obtained by calling g_bus_get() with the value
352 * of this property.
354 * Since: 2.30
356 g_object_class_install_property (gobject_class,
357 PROP_BUS_TYPE,
358 g_param_spec_enum ("bus-type",
359 "Bus Type",
360 "The bus to connect to, if any",
361 G_TYPE_BUS_TYPE,
362 G_BUS_TYPE_NONE,
363 G_PARAM_WRITABLE |
364 G_PARAM_CONSTRUCT_ONLY |
365 G_PARAM_STATIC_NAME |
366 G_PARAM_STATIC_BLURB |
367 G_PARAM_STATIC_NICK));
370 * GDBusObjectManagerClient:flags:
372 * Flags from the #GDBusObjectManagerClientFlags enumeration.
374 * Since: 2.30
376 g_object_class_install_property (gobject_class,
377 PROP_FLAGS,
378 g_param_spec_flags ("flags",
379 "Flags",
380 "Flags for the proxy manager",
381 G_TYPE_DBUS_OBJECT_MANAGER_CLIENT_FLAGS,
382 G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_NONE,
383 G_PARAM_READABLE |
384 G_PARAM_WRITABLE |
385 G_PARAM_CONSTRUCT_ONLY |
386 G_PARAM_STATIC_NAME |
387 G_PARAM_STATIC_BLURB |
388 G_PARAM_STATIC_NICK));
391 * GDBusObjectManagerClient:object-path:
393 * The object path the manager is for.
395 * Since: 2.30
397 g_object_class_install_property (gobject_class,
398 PROP_OBJECT_PATH,
399 g_param_spec_string ("object-path",
400 "Object Path",
401 "The object path of the control object",
402 NULL,
403 G_PARAM_READABLE |
404 G_PARAM_WRITABLE |
405 G_PARAM_CONSTRUCT_ONLY |
406 G_PARAM_STATIC_STRINGS));
409 * GDBusObjectManagerClient:name:
411 * The well-known name or unique name that the manager is for.
413 * Since: 2.30
415 g_object_class_install_property (gobject_class,
416 PROP_NAME,
417 g_param_spec_string ("name",
418 "Name",
419 "Name that the manager is for",
420 NULL,
421 G_PARAM_READABLE |
422 G_PARAM_WRITABLE |
423 G_PARAM_CONSTRUCT_ONLY |
424 G_PARAM_STATIC_STRINGS));
427 * GDBusObjectManagerClient:name-owner:
429 * The unique name that owns #GDBusObjectManagerClient:name or %NULL if
430 * no-one is currently owning the name. Connect to the
431 * #GObject::notify signal to track changes to this property.
433 * Since: 2.30
435 g_object_class_install_property (gobject_class,
436 PROP_NAME_OWNER,
437 g_param_spec_string ("name-owner",
438 "Name Owner",
439 "The owner of the name we are watching",
440 NULL,
441 G_PARAM_READABLE |
442 G_PARAM_STATIC_STRINGS));
445 * GDBusObjectManagerClient:get-proxy-type-func:
447 * The #GDBusProxyTypeFunc to use when determining what #GType to
448 * use for interface proxies or %NULL.
450 * Since: 2.30
452 g_object_class_install_property (gobject_class,
453 PROP_GET_PROXY_TYPE_FUNC,
454 g_param_spec_pointer ("get-proxy-type-func",
455 "GDBusProxyTypeFunc Function Pointer",
456 "The GDBusProxyTypeFunc pointer to use",
457 G_PARAM_READABLE |
458 G_PARAM_WRITABLE |
459 G_PARAM_CONSTRUCT_ONLY |
460 G_PARAM_STATIC_STRINGS));
463 * GDBusObjectManagerClient:get-proxy-type-user-data:
465 * The #gpointer user_data to pass to #GDBusObjectManagerClient:get-proxy-type-func.
467 * Since: 2.30
469 g_object_class_install_property (gobject_class,
470 PROP_GET_PROXY_TYPE_USER_DATA,
471 g_param_spec_pointer ("get-proxy-type-user-data",
472 "GDBusProxyTypeFunc User Data",
473 "The GDBusProxyTypeFunc user_data",
474 G_PARAM_READABLE |
475 G_PARAM_WRITABLE |
476 G_PARAM_CONSTRUCT_ONLY |
477 G_PARAM_STATIC_STRINGS));
480 * GDBusObjectManagerClient:get-proxy-type-destroy-notify:
482 * A #GDestroyNotify for the #gpointer user_data in #GDBusObjectManagerClient:get-proxy-type-user-data.
484 * Since: 2.30
486 g_object_class_install_property (gobject_class,
487 PROP_GET_PROXY_TYPE_DESTROY_NOTIFY,
488 g_param_spec_pointer ("get-proxy-type-destroy-notify",
489 "GDBusProxyTypeFunc user data free function",
490 "The GDBusProxyTypeFunc user data free function",
491 G_PARAM_READABLE |
492 G_PARAM_WRITABLE |
493 G_PARAM_CONSTRUCT_ONLY |
494 G_PARAM_STATIC_STRINGS));
497 * GDBusObjectManagerClient::interface-proxy-signal:
498 * @manager: The #GDBusObjectManagerClient emitting the signal.
499 * @object_proxy: The #GDBusObjectProxy on which an interface is emitting a D-Bus signal.
500 * @interface_proxy: The #GDBusProxy that is emitting a D-Bus signal.
501 * @sender_name: The sender of the signal or NULL if the connection is not a bus connection.
502 * @signal_name: The signal name.
503 * @parameters: A #GVariant tuple with parameters for the signal.
505 * Emitted when a D-Bus signal is received on @interface_proxy.
507 * This signal exists purely as a convenience to avoid having to
508 * connect signals to all interface proxies managed by @manager.
510 * This signal is emitted in the
511 * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
512 * that @manager was constructed in.
514 * Since: 2.30
516 signals[INTERFACE_PROXY_SIGNAL_SIGNAL] =
517 g_signal_new ("interface-proxy-signal",
518 G_TYPE_DBUS_OBJECT_MANAGER_CLIENT,
519 G_SIGNAL_RUN_LAST,
520 G_STRUCT_OFFSET (GDBusObjectManagerClientClass, interface_proxy_signal),
521 NULL,
522 NULL,
523 NULL,
524 G_TYPE_NONE,
526 G_TYPE_DBUS_OBJECT_PROXY,
527 G_TYPE_DBUS_PROXY,
528 G_TYPE_STRING,
529 G_TYPE_STRING,
530 G_TYPE_VARIANT);
533 * GDBusObjectManagerClient::interface-proxy-properties-changed:
534 * @manager: The #GDBusObjectManagerClient emitting the signal.
535 * @object_proxy: The #GDBusObjectProxy on which an interface has properties that are changing.
536 * @interface_proxy: The #GDBusProxy that has properties that are changing.
537 * @changed_properties: A #GVariant containing the properties that changed.
538 * @invalidated_properties: A %NULL terminated array of properties that was invalidated.
540 * Emitted when one or more D-Bus properties on proxy changes. The
541 * local cache has already been updated when this signal fires. Note
542 * that both @changed_properties and @invalidated_properties are
543 * guaranteed to never be %NULL (either may be empty though).
545 * This signal exists purely as a convenience to avoid having to
546 * connect signals to all interface proxies managed by @manager.
548 * This signal is emitted in the
549 * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
550 * that @manager was constructed in.
552 * Since: 2.30
554 signals[INTERFACE_PROXY_PROPERTIES_CHANGED_SIGNAL] =
555 g_signal_new ("interface-proxy-properties-changed",
556 G_TYPE_DBUS_OBJECT_MANAGER_CLIENT,
557 G_SIGNAL_RUN_LAST,
558 G_STRUCT_OFFSET (GDBusObjectManagerClientClass, interface_proxy_properties_changed),
559 NULL,
560 NULL,
561 NULL,
562 G_TYPE_NONE,
564 G_TYPE_DBUS_OBJECT_PROXY,
565 G_TYPE_DBUS_PROXY,
566 G_TYPE_VARIANT,
567 G_TYPE_STRV);
570 static void
571 g_dbus_object_manager_client_init (GDBusObjectManagerClient *manager)
573 manager->priv = g_dbus_object_manager_client_get_instance_private (manager);
574 g_mutex_init (&manager->priv->lock);
575 manager->priv->map_object_path_to_object_proxy = g_hash_table_new_full (g_str_hash,
576 g_str_equal,
577 g_free,
578 (GDestroyNotify) g_object_unref);
581 /* ---------------------------------------------------------------------------------------------------- */
584 * g_dbus_object_manager_client_new_sync:
585 * @connection: A #GDBusConnection.
586 * @flags: Zero or more flags from the #GDBusObjectManagerClientFlags enumeration.
587 * @name: (allow-none): The owner of the control object (unique or well-known name), or %NULL when not using a message bus connection.
588 * @object_path: The object path of the control object.
589 * @get_proxy_type_func: (allow-none): A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies.
590 * @get_proxy_type_user_data: User data to pass to @get_proxy_type_func.
591 * @get_proxy_type_destroy_notify: (allow-none): Free function for @get_proxy_type_user_data or %NULL.
592 * @cancellable: (allow-none): A #GCancellable or %NULL
593 * @error: Return location for error or %NULL.
595 * Creates a new #GDBusObjectManagerClient object.
597 * This is a synchronous failable constructor - the calling thread is
598 * blocked until a reply is received. See g_dbus_object_manager_client_new()
599 * for the asynchronous version.
601 * Returns: (transfer full) (type GDBusObjectManagerClient): A
602 * #GDBusObjectManagerClient object or %NULL if @error is set. Free
603 * with g_object_unref().
605 * Since: 2.30
607 GDBusObjectManager *
608 g_dbus_object_manager_client_new_sync (GDBusConnection *connection,
609 GDBusObjectManagerClientFlags flags,
610 const gchar *name,
611 const gchar *object_path,
612 GDBusProxyTypeFunc get_proxy_type_func,
613 gpointer get_proxy_type_user_data,
614 GDestroyNotify get_proxy_type_destroy_notify,
615 GCancellable *cancellable,
616 GError **error)
618 GInitable *initable;
620 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
621 g_return_val_if_fail ((name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
622 g_dbus_is_name (name), NULL);
623 g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
624 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
626 initable = g_initable_new (G_TYPE_DBUS_OBJECT_MANAGER_CLIENT,
627 cancellable,
628 error,
629 "connection", connection,
630 "flags", flags,
631 "name", name,
632 "object-path", object_path,
633 "get-proxy-type-func", get_proxy_type_func,
634 "get-proxy-type-user-data", get_proxy_type_user_data,
635 "get-proxy-type-destroy-notify", get_proxy_type_destroy_notify,
636 NULL);
637 if (initable != NULL)
638 return G_DBUS_OBJECT_MANAGER (initable);
639 else
640 return NULL;
644 * g_dbus_object_manager_client_new:
645 * @connection: A #GDBusConnection.
646 * @flags: Zero or more flags from the #GDBusObjectManagerClientFlags enumeration.
647 * @name: The owner of the control object (unique or well-known name).
648 * @object_path: The object path of the control object.
649 * @get_proxy_type_func: (allow-none): A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies.
650 * @get_proxy_type_user_data: User data to pass to @get_proxy_type_func.
651 * @get_proxy_type_destroy_notify: (allow-none): Free function for @get_proxy_type_user_data or %NULL.
652 * @cancellable: (allow-none): A #GCancellable or %NULL
653 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
654 * @user_data: The data to pass to @callback.
656 * Asynchronously creates a new #GDBusObjectManagerClient object.
658 * This is an asynchronous failable constructor. When the result is
659 * ready, @callback will be invoked in the
660 * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
661 * of the thread you are calling this method from. You can
662 * then call g_dbus_object_manager_client_new_finish() to get the result. See
663 * g_dbus_object_manager_client_new_sync() for the synchronous version.
665 * Since: 2.30
667 void
668 g_dbus_object_manager_client_new (GDBusConnection *connection,
669 GDBusObjectManagerClientFlags flags,
670 const gchar *name,
671 const gchar *object_path,
672 GDBusProxyTypeFunc get_proxy_type_func,
673 gpointer get_proxy_type_user_data,
674 GDestroyNotify get_proxy_type_destroy_notify,
675 GCancellable *cancellable,
676 GAsyncReadyCallback callback,
677 gpointer user_data)
679 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
680 g_return_if_fail ((name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
681 g_dbus_is_name (name));
682 g_return_if_fail (g_variant_is_object_path (object_path));
684 g_async_initable_new_async (G_TYPE_DBUS_OBJECT_MANAGER_CLIENT,
685 G_PRIORITY_DEFAULT,
686 cancellable,
687 callback,
688 user_data,
689 "connection", connection,
690 "flags", flags,
691 "name", name,
692 "object-path", object_path,
693 "get-proxy-type-func", get_proxy_type_func,
694 "get-proxy-type-user-data", get_proxy_type_user_data,
695 "get-proxy-type-destroy-notify", get_proxy_type_destroy_notify,
696 NULL);
700 * g_dbus_object_manager_client_new_finish:
701 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new().
702 * @error: Return location for error or %NULL.
704 * Finishes an operation started with g_dbus_object_manager_client_new().
706 * Returns: (transfer full) (type GDBusObjectManagerClient): A
707 * #GDBusObjectManagerClient object or %NULL if @error is set. Free
708 * with g_object_unref().
710 * Since: 2.30
712 GDBusObjectManager *
713 g_dbus_object_manager_client_new_finish (GAsyncResult *res,
714 GError **error)
716 GObject *object;
717 GObject *source_object;
719 source_object = g_async_result_get_source_object (res);
720 g_assert (source_object != NULL);
722 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
723 res,
724 error);
725 g_object_unref (source_object);
727 if (object != NULL)
728 return G_DBUS_OBJECT_MANAGER (object);
729 else
730 return NULL;
733 /* ---------------------------------------------------------------------------------------------------- */
736 * g_dbus_object_manager_client_new_for_bus_sync:
737 * @bus_type: A #GBusType.
738 * @flags: Zero or more flags from the #GDBusObjectManagerClientFlags enumeration.
739 * @name: The owner of the control object (unique or well-known name).
740 * @object_path: The object path of the control object.
741 * @get_proxy_type_func: (allow-none): A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies.
742 * @get_proxy_type_user_data: User data to pass to @get_proxy_type_func.
743 * @get_proxy_type_destroy_notify: (allow-none): Free function for @get_proxy_type_user_data or %NULL.
744 * @cancellable: (allow-none): A #GCancellable or %NULL
745 * @error: Return location for error or %NULL.
747 * Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead
748 * of a #GDBusConnection.
750 * This is a synchronous failable constructor - the calling thread is
751 * blocked until a reply is received. See g_dbus_object_manager_client_new_for_bus()
752 * for the asynchronous version.
754 * Returns: (transfer full) (type GDBusObjectManagerClient): A
755 * #GDBusObjectManagerClient object or %NULL if @error is set. Free
756 * with g_object_unref().
758 * Since: 2.30
760 GDBusObjectManager *
761 g_dbus_object_manager_client_new_for_bus_sync (GBusType bus_type,
762 GDBusObjectManagerClientFlags flags,
763 const gchar *name,
764 const gchar *object_path,
765 GDBusProxyTypeFunc get_proxy_type_func,
766 gpointer get_proxy_type_user_data,
767 GDestroyNotify get_proxy_type_destroy_notify,
768 GCancellable *cancellable,
769 GError **error)
771 GInitable *initable;
773 g_return_val_if_fail (bus_type != G_BUS_TYPE_NONE, NULL);
774 g_return_val_if_fail (g_dbus_is_name (name), NULL);
775 g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
776 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
778 initable = g_initable_new (G_TYPE_DBUS_OBJECT_MANAGER_CLIENT,
779 cancellable,
780 error,
781 "bus-type", bus_type,
782 "flags", flags,
783 "name", name,
784 "object-path", object_path,
785 "get-proxy-type-func", get_proxy_type_func,
786 "get-proxy-type-user-data", get_proxy_type_user_data,
787 "get-proxy-type-destroy-notify", get_proxy_type_destroy_notify,
788 NULL);
789 if (initable != NULL)
790 return G_DBUS_OBJECT_MANAGER (initable);
791 else
792 return NULL;
796 * g_dbus_object_manager_client_new_for_bus:
797 * @bus_type: A #GBusType.
798 * @flags: Zero or more flags from the #GDBusObjectManagerClientFlags enumeration.
799 * @name: The owner of the control object (unique or well-known name).
800 * @object_path: The object path of the control object.
801 * @get_proxy_type_func: (allow-none): A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies.
802 * @get_proxy_type_user_data: User data to pass to @get_proxy_type_func.
803 * @get_proxy_type_destroy_notify: (allow-none): Free function for @get_proxy_type_user_data or %NULL.
804 * @cancellable: (allow-none): A #GCancellable or %NULL
805 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
806 * @user_data: The data to pass to @callback.
808 * Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a
809 * #GDBusConnection.
811 * This is an asynchronous failable constructor. When the result is
812 * ready, @callback will be invoked in the
813 * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
814 * of the thread you are calling this method from. You can
815 * then call g_dbus_object_manager_client_new_for_bus_finish() to get the result. See
816 * g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version.
818 * Since: 2.30
820 void
821 g_dbus_object_manager_client_new_for_bus (GBusType bus_type,
822 GDBusObjectManagerClientFlags flags,
823 const gchar *name,
824 const gchar *object_path,
825 GDBusProxyTypeFunc get_proxy_type_func,
826 gpointer get_proxy_type_user_data,
827 GDestroyNotify get_proxy_type_destroy_notify,
828 GCancellable *cancellable,
829 GAsyncReadyCallback callback,
830 gpointer user_data)
832 g_return_if_fail (bus_type != G_BUS_TYPE_NONE);
833 g_return_if_fail (g_dbus_is_name (name));
834 g_return_if_fail (g_variant_is_object_path (object_path));
836 g_async_initable_new_async (G_TYPE_DBUS_OBJECT_MANAGER_CLIENT,
837 G_PRIORITY_DEFAULT,
838 cancellable,
839 callback,
840 user_data,
841 "bus-type", bus_type,
842 "flags", flags,
843 "name", name,
844 "object-path", object_path,
845 "get-proxy-type-func", get_proxy_type_func,
846 "get-proxy-type-user-data", get_proxy_type_user_data,
847 "get-proxy-type-destroy-notify", get_proxy_type_destroy_notify,
848 NULL);
852 * g_dbus_object_manager_client_new_for_bus_finish:
853 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new_for_bus().
854 * @error: Return location for error or %NULL.
856 * Finishes an operation started with g_dbus_object_manager_client_new_for_bus().
858 * Returns: (transfer full) (type GDBusObjectManagerClient): A
859 * #GDBusObjectManagerClient object or %NULL if @error is set. Free
860 * with g_object_unref().
862 * Since: 2.30
864 GDBusObjectManager *
865 g_dbus_object_manager_client_new_for_bus_finish (GAsyncResult *res,
866 GError **error)
868 GObject *object;
869 GObject *source_object;
871 source_object = g_async_result_get_source_object (res);
872 g_assert (source_object != NULL);
874 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
875 res,
876 error);
877 g_object_unref (source_object);
879 if (object != NULL)
880 return G_DBUS_OBJECT_MANAGER (object);
881 else
882 return NULL;
885 /* ---------------------------------------------------------------------------------------------------- */
888 * g_dbus_object_manager_client_get_connection:
889 * @manager: A #GDBusObjectManagerClient
891 * Gets the #GDBusConnection used by @manager.
893 * Returns: (transfer none): A #GDBusConnection object. Do not free,
894 * the object belongs to @manager.
896 * Since: 2.30
898 GDBusConnection *
899 g_dbus_object_manager_client_get_connection (GDBusObjectManagerClient *manager)
901 GDBusConnection *ret;
902 g_return_val_if_fail (G_IS_DBUS_OBJECT_MANAGER_CLIENT (manager), NULL);
903 g_mutex_lock (&manager->priv->lock);
904 ret = manager->priv->connection;
905 g_mutex_unlock (&manager->priv->lock);
906 return ret;
910 * g_dbus_object_manager_client_get_name:
911 * @manager: A #GDBusObjectManagerClient
913 * Gets the name that @manager is for, or %NULL if not a message bus
914 * connection.
916 * Returns: A unique or well-known name. Do not free, the string
917 * belongs to @manager.
919 * Since: 2.30
921 const gchar *
922 g_dbus_object_manager_client_get_name (GDBusObjectManagerClient *manager)
924 const gchar *ret;
925 g_return_val_if_fail (G_IS_DBUS_OBJECT_MANAGER_CLIENT (manager), NULL);
926 g_mutex_lock (&manager->priv->lock);
927 ret = manager->priv->name;
928 g_mutex_unlock (&manager->priv->lock);
929 return ret;
933 * g_dbus_object_manager_client_get_flags:
934 * @manager: A #GDBusObjectManagerClient
936 * Gets the flags that @manager was constructed with.
938 * Returns: Zero of more flags from the #GDBusObjectManagerClientFlags
939 * enumeration.
941 * Since: 2.30
943 GDBusObjectManagerClientFlags
944 g_dbus_object_manager_client_get_flags (GDBusObjectManagerClient *manager)
946 GDBusObjectManagerClientFlags ret;
947 g_return_val_if_fail (G_IS_DBUS_OBJECT_MANAGER_CLIENT (manager), G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_NONE);
948 g_mutex_lock (&manager->priv->lock);
949 ret = manager->priv->flags;
950 g_mutex_unlock (&manager->priv->lock);
951 return ret;
955 * g_dbus_object_manager_client_get_name_owner:
956 * @manager: A #GDBusObjectManagerClient.
958 * The unique name that owns the name that @manager is for or %NULL if
959 * no-one currently owns that name. You can connect to the
960 * #GObject::notify signal to track changes to the
961 * #GDBusObjectManagerClient:name-owner property.
963 * Returns: The name owner or %NULL if no name owner exists. Free with
964 * g_free().
966 * Since: 2.30
968 gchar *
969 g_dbus_object_manager_client_get_name_owner (GDBusObjectManagerClient *manager)
971 gchar *ret;
972 g_return_val_if_fail (G_IS_DBUS_OBJECT_MANAGER_CLIENT (manager), NULL);
973 g_mutex_lock (&manager->priv->lock);
974 ret = g_strdup (manager->priv->name_owner);
975 g_mutex_unlock (&manager->priv->lock);
976 return ret;
979 /* ---------------------------------------------------------------------------------------------------- */
981 /* signal handler for all objects we manage - we dispatch signals
982 * from here to the objects
984 static void
985 signal_cb (GDBusConnection *connection,
986 const gchar *sender_name,
987 const gchar *object_path,
988 const gchar *interface_name,
989 const gchar *signal_name,
990 GVariant *parameters,
991 gpointer user_data)
993 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (user_data);
994 GDBusObjectProxy *object_proxy;
995 GDBusInterface *interface;
997 g_mutex_lock (&manager->priv->lock);
998 object_proxy = g_hash_table_lookup (manager->priv->map_object_path_to_object_proxy, object_path);
999 if (object_proxy == NULL)
1001 g_mutex_unlock (&manager->priv->lock);
1002 goto out;
1004 g_object_ref (object_proxy);
1005 g_mutex_unlock (&manager->priv->lock);
1007 //g_debug ("yay, signal_cb %s %s: %s\n", signal_name, object_path, g_variant_print (parameters, TRUE));
1009 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
1011 if (g_strcmp0 (signal_name, "PropertiesChanged") == 0)
1013 const gchar *interface_name;
1014 GVariant *changed_properties;
1015 const gchar **invalidated_properties;
1017 g_variant_get (parameters,
1018 "(&s@a{sv}^a&s)",
1019 &interface_name,
1020 &changed_properties,
1021 &invalidated_properties);
1023 interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object_proxy), interface_name);
1024 if (interface != NULL)
1026 GVariantIter property_iter;
1027 const gchar *property_name;
1028 GVariant *property_value;
1029 guint n;
1031 /* update caches... */
1032 g_variant_iter_init (&property_iter, changed_properties);
1033 while (g_variant_iter_next (&property_iter,
1034 "{&sv}",
1035 &property_name,
1036 &property_value))
1038 g_dbus_proxy_set_cached_property (G_DBUS_PROXY (interface),
1039 property_name,
1040 property_value);
1041 g_variant_unref (property_value);
1044 for (n = 0; invalidated_properties[n] != NULL; n++)
1046 g_dbus_proxy_set_cached_property (G_DBUS_PROXY (interface),
1047 invalidated_properties[n],
1048 NULL);
1050 /* ... and then synthesize the signal */
1051 g_signal_emit_by_name (interface,
1052 "g-properties-changed",
1053 changed_properties,
1054 invalidated_properties);
1055 g_signal_emit (manager,
1056 signals[INTERFACE_PROXY_PROPERTIES_CHANGED_SIGNAL],
1058 object_proxy,
1059 interface,
1060 changed_properties,
1061 invalidated_properties);
1062 g_object_unref (interface);
1064 g_variant_unref (changed_properties);
1065 g_free (invalidated_properties);
1068 else
1070 /* regular signal - just dispatch it */
1071 interface = g_dbus_object_get_interface (G_DBUS_OBJECT (object_proxy), interface_name);
1072 if (interface != NULL)
1074 g_signal_emit_by_name (interface,
1075 "g-signal",
1076 sender_name,
1077 signal_name,
1078 parameters);
1079 g_signal_emit (manager,
1080 signals[INTERFACE_PROXY_SIGNAL_SIGNAL],
1082 object_proxy,
1083 interface,
1084 sender_name,
1085 signal_name,
1086 parameters);
1087 g_object_unref (interface);
1091 out:
1092 g_clear_object (&object_proxy);
1095 static void
1096 subscribe_signals (GDBusObjectManagerClient *manager,
1097 const gchar *name_owner)
1099 GError *error = NULL;
1100 GVariant *ret;
1102 g_return_if_fail (G_IS_DBUS_OBJECT_MANAGER_CLIENT (manager));
1103 g_return_if_fail (manager->priv->signal_subscription_id == 0);
1104 g_return_if_fail (name_owner == NULL || g_dbus_is_unique_name (name_owner));
1106 if (name_owner != NULL)
1108 /* Only add path_namespace if it's non-'/'. This removes a no-op key from
1109 * the match rule, and also works around a D-Bus bug where
1110 * path_namespace='/' matches nothing in D-Bus versions < 1.6.18.
1112 * See: https://bugs.freedesktop.org/show_bug.cgi?id=70799 */
1113 if (g_str_equal (manager->priv->object_path, "/"))
1115 manager->priv->match_rule = g_strdup_printf ("type='signal',sender='%s'",
1116 name_owner);
1118 else
1120 manager->priv->match_rule = g_strdup_printf ("type='signal',sender='%s',path_namespace='%s'",
1121 name_owner, manager->priv->object_path);
1124 /* The bus daemon may not implement path_namespace so gracefully
1125 * handle this by using a fallback triggered if @error is set. */
1126 ret = g_dbus_connection_call_sync (manager->priv->connection,
1127 "org.freedesktop.DBus",
1128 "/org/freedesktop/DBus",
1129 "org.freedesktop.DBus",
1130 "AddMatch",
1131 g_variant_new ("(s)",
1132 manager->priv->match_rule),
1133 NULL, /* reply_type */
1134 G_DBUS_CALL_FLAGS_NONE,
1135 -1, /* default timeout */
1136 NULL, /* TODO: Cancellable */
1137 &error);
1139 /* yay, bus daemon supports path_namespace */
1140 if (ret != NULL)
1141 g_variant_unref (ret);
1144 if (error == NULL)
1146 /* still need to ask GDBusConnection for the callbacks */
1147 manager->priv->signal_subscription_id =
1148 g_dbus_connection_signal_subscribe (manager->priv->connection,
1149 name_owner,
1150 NULL, /* interface */
1151 NULL, /* member */
1152 NULL, /* path - TODO: really want wilcard support here */
1153 NULL, /* arg0 */
1154 G_DBUS_SIGNAL_FLAGS_NONE |
1155 G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE,
1156 signal_cb,
1157 manager,
1158 NULL); /* user_data_free_func */
1161 else
1163 /* TODO: we could report this to the user
1164 g_warning ("Message bus daemon does not support path_namespace: %s (%s %d)",
1165 error->message,
1166 g_quark_to_string (error->domain),
1167 error->code);
1170 g_error_free (error);
1172 /* no need to call RemoveMatch when done since it didn't work */
1173 g_free (manager->priv->match_rule);
1174 manager->priv->match_rule = NULL;
1176 /* Fallback is to subscribe to *all* signals from the name owner which
1177 * is rather wasteful. It's probably not a big practical problem because
1178 * users typically want all objects that the name owner supplies.
1180 manager->priv->signal_subscription_id =
1181 g_dbus_connection_signal_subscribe (manager->priv->connection,
1182 name_owner,
1183 NULL, /* interface */
1184 NULL, /* member */
1185 NULL, /* path - TODO: really want wilcard support here */
1186 NULL, /* arg0 */
1187 G_DBUS_SIGNAL_FLAGS_NONE,
1188 signal_cb,
1189 manager,
1190 NULL); /* user_data_free_func */
1194 static void
1195 maybe_unsubscribe_signals (GDBusObjectManagerClient *manager)
1197 g_return_if_fail (G_IS_DBUS_OBJECT_MANAGER_CLIENT (manager));
1199 if (manager->priv->signal_subscription_id > 0)
1201 g_dbus_connection_signal_unsubscribe (manager->priv->connection,
1202 manager->priv->signal_subscription_id);
1203 manager->priv->signal_subscription_id = 0;
1206 if (manager->priv->match_rule != NULL)
1208 /* Since the AddMatch call succeeded this is guaranteed to not
1209 * fail - therefore, don't bother checking the return value
1211 g_dbus_connection_call (manager->priv->connection,
1212 "org.freedesktop.DBus",
1213 "/org/freedesktop/DBus",
1214 "org.freedesktop.DBus",
1215 "RemoveMatch",
1216 g_variant_new ("(s)",
1217 manager->priv->match_rule),
1218 NULL, /* reply_type */
1219 G_DBUS_CALL_FLAGS_NONE,
1220 -1, /* default timeout */
1221 NULL, /* GCancellable */
1222 NULL, /* GAsyncReadyCallback */
1223 NULL); /* user data */
1224 g_free (manager->priv->match_rule);
1225 manager->priv->match_rule = NULL;
1230 /* ---------------------------------------------------------------------------------------------------- */
1232 static void
1233 on_notify_g_name_owner (GObject *object,
1234 GParamSpec *pspec,
1235 gpointer user_data)
1237 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (user_data);
1238 gchar *old_name_owner;
1239 gchar *new_name_owner;
1241 g_mutex_lock (&manager->priv->lock);
1242 old_name_owner = manager->priv->name_owner;
1243 new_name_owner = g_dbus_proxy_get_name_owner (manager->priv->control_proxy);
1244 manager->priv->name_owner = NULL;
1246 if (g_strcmp0 (old_name_owner, new_name_owner) != 0)
1248 GList *l;
1249 GList *proxies;
1251 /* remote manager changed; nuke all local proxies */
1252 proxies = g_hash_table_get_values (manager->priv->map_object_path_to_object_proxy);
1253 g_list_foreach (proxies, (GFunc) g_object_ref, NULL);
1254 g_hash_table_remove_all (manager->priv->map_object_path_to_object_proxy);
1256 g_mutex_unlock (&manager->priv->lock);
1258 /* do the :name-owner notify with a NULL name - this way the user knows
1259 * the ::object-proxy-removed following is because the name owner went
1260 * away
1262 g_object_notify (G_OBJECT (manager), "name-owner");
1264 for (l = proxies; l != NULL; l = l->next)
1266 GDBusObjectProxy *object_proxy = G_DBUS_OBJECT_PROXY (l->data);
1267 g_signal_emit_by_name (manager, "object-removed", object_proxy);
1269 g_list_free_full (proxies, g_object_unref);
1271 /* nuke local filter */
1272 maybe_unsubscribe_signals (manager);
1274 else
1276 g_mutex_unlock (&manager->priv->lock);
1279 if (new_name_owner != NULL)
1281 GError *error;
1282 GVariant *value;
1284 //g_debug ("repopulating for %s", new_name_owner);
1286 /* TODO: do this async! */
1287 subscribe_signals (manager,
1288 new_name_owner);
1289 error = NULL;
1290 value = g_dbus_proxy_call_sync (manager->priv->control_proxy,
1291 "GetManagedObjects",
1292 NULL, /* parameters */
1293 G_DBUS_CALL_FLAGS_NONE,
1295 NULL,
1296 &error);
1297 if (value == NULL)
1299 maybe_unsubscribe_signals (manager);
1300 g_warning ("Error calling GetManagedObjects() when name owner %s for name %s came back: %s",
1301 new_name_owner,
1302 manager->priv->name,
1303 error->message);
1304 g_error_free (error);
1306 else
1308 process_get_all_result (manager, value, new_name_owner);
1309 g_variant_unref (value);
1312 /* do the :name-owner notify *AFTER* emitting ::object-proxy-added signals - this
1313 * way the user knows that the signals were emitted because the name owner came back
1315 g_mutex_lock (&manager->priv->lock);
1316 manager->priv->name_owner = new_name_owner;
1317 g_mutex_unlock (&manager->priv->lock);
1318 g_object_notify (G_OBJECT (manager), "name-owner");
1321 g_free (old_name_owner);
1324 static gboolean
1325 initable_init (GInitable *initable,
1326 GCancellable *cancellable,
1327 GError **error)
1329 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (initable);
1330 gboolean ret;
1331 GVariant *value;
1332 GDBusProxyFlags proxy_flags;
1334 ret = FALSE;
1336 if (manager->priv->bus_type != G_BUS_TYPE_NONE)
1338 g_assert (manager->priv->connection == NULL);
1339 manager->priv->connection = g_bus_get_sync (manager->priv->bus_type, cancellable, error);
1340 if (manager->priv->connection == NULL)
1341 goto out;
1344 proxy_flags = G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES;
1345 if (manager->priv->flags & G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START)
1346 proxy_flags |= G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START;
1348 manager->priv->control_proxy = g_dbus_proxy_new_sync (manager->priv->connection,
1349 proxy_flags,
1350 NULL, /* GDBusInterfaceInfo* */
1351 manager->priv->name,
1352 manager->priv->object_path,
1353 "org.freedesktop.DBus.ObjectManager",
1354 cancellable,
1355 error);
1356 if (manager->priv->control_proxy == NULL)
1357 goto out;
1359 g_signal_connect (G_OBJECT (manager->priv->control_proxy),
1360 "notify::g-name-owner",
1361 G_CALLBACK (on_notify_g_name_owner),
1362 manager);
1364 g_signal_connect (manager->priv->control_proxy,
1365 "g-signal",
1366 G_CALLBACK (on_control_proxy_g_signal),
1367 manager);
1369 manager->priv->name_owner = g_dbus_proxy_get_name_owner (manager->priv->control_proxy);
1370 if (manager->priv->name_owner == NULL && manager->priv->name != NULL)
1372 /* it's perfectly fine if there's no name owner.. we're just going to
1373 * wait until one is ready
1376 else
1378 /* yay, we can get the objects */
1379 subscribe_signals (manager,
1380 manager->priv->name_owner);
1381 value = g_dbus_proxy_call_sync (manager->priv->control_proxy,
1382 "GetManagedObjects",
1383 NULL, /* parameters */
1384 G_DBUS_CALL_FLAGS_NONE,
1386 cancellable,
1387 error);
1388 if (value == NULL)
1390 maybe_unsubscribe_signals (manager);
1391 g_warn_if_fail (g_signal_handlers_disconnect_by_func (manager->priv->control_proxy,
1392 on_control_proxy_g_signal,
1393 manager) == 1);
1394 g_object_unref (manager->priv->control_proxy);
1395 manager->priv->control_proxy = NULL;
1396 goto out;
1399 process_get_all_result (manager, value, manager->priv->name_owner);
1400 g_variant_unref (value);
1403 ret = TRUE;
1405 out:
1406 return ret;
1409 static void
1410 initable_iface_init (GInitableIface *initable_iface)
1412 initable_iface->init = initable_init;
1415 static void
1416 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
1418 /* for now, just use default: run GInitable code in thread */
1421 /* ---------------------------------------------------------------------------------------------------- */
1423 static void
1424 add_interfaces (GDBusObjectManagerClient *manager,
1425 const gchar *object_path,
1426 GVariant *ifaces_and_properties,
1427 const gchar *name_owner)
1429 GDBusObjectProxy *op;
1430 gboolean added;
1431 GVariantIter iter;
1432 const gchar *interface_name;
1433 GVariant *properties;
1434 GList *interface_added_signals, *l;
1435 GDBusProxy *interface_proxy;
1437 g_return_if_fail (name_owner == NULL || g_dbus_is_unique_name (name_owner));
1439 g_mutex_lock (&manager->priv->lock);
1441 interface_added_signals = NULL;
1442 added = FALSE;
1444 op = g_hash_table_lookup (manager->priv->map_object_path_to_object_proxy, object_path);
1445 if (op == NULL)
1447 GType object_proxy_type;
1448 if (manager->priv->get_proxy_type_func != NULL)
1450 object_proxy_type = manager->priv->get_proxy_type_func (manager,
1451 object_path,
1452 NULL,
1453 manager->priv->get_proxy_type_user_data);
1454 g_warn_if_fail (g_type_is_a (object_proxy_type, G_TYPE_DBUS_OBJECT_PROXY));
1456 else
1458 object_proxy_type = G_TYPE_DBUS_OBJECT_PROXY;
1460 op = g_object_new (object_proxy_type,
1461 "g-connection", manager->priv->connection,
1462 "g-object-path", object_path,
1463 NULL);
1464 added = TRUE;
1466 g_object_ref (op);
1468 g_variant_iter_init (&iter, ifaces_and_properties);
1469 while (g_variant_iter_next (&iter,
1470 "{&s@a{sv}}",
1471 &interface_name,
1472 &properties))
1474 GError *error;
1475 GType interface_proxy_type;
1477 if (manager->priv->get_proxy_type_func != NULL)
1479 interface_proxy_type = manager->priv->get_proxy_type_func (manager,
1480 object_path,
1481 interface_name,
1482 manager->priv->get_proxy_type_user_data);
1483 g_warn_if_fail (g_type_is_a (interface_proxy_type, G_TYPE_DBUS_PROXY));
1485 else
1487 interface_proxy_type = G_TYPE_DBUS_PROXY;
1490 /* this is fine - there is no blocking IO because we pass DO_NOT_LOAD_PROPERTIES and
1491 * DO_NOT_CONNECT_SIGNALS and use a unique name
1493 error = NULL;
1494 interface_proxy = g_initable_new (interface_proxy_type,
1495 NULL, /* GCancellable */
1496 &error,
1497 "g-connection", manager->priv->connection,
1498 "g-flags", G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
1499 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
1500 "g-name", name_owner,
1501 "g-object-path", object_path,
1502 "g-interface-name", interface_name,
1503 NULL);
1504 if (interface_proxy == NULL)
1506 g_warning ("%s: Error constructing proxy for path %s and interface %s: %s",
1507 G_STRLOC,
1508 object_path,
1509 interface_name,
1510 error->message);
1511 g_error_free (error);
1513 else
1515 GVariantIter property_iter;
1516 const gchar *property_name;
1517 GVariant *property_value;
1519 /* associate the interface proxy with the object */
1520 g_dbus_interface_set_object (G_DBUS_INTERFACE (interface_proxy),
1521 G_DBUS_OBJECT (op));
1523 g_variant_iter_init (&property_iter, properties);
1524 while (g_variant_iter_next (&property_iter,
1525 "{&sv}",
1526 &property_name,
1527 &property_value))
1529 g_dbus_proxy_set_cached_property (interface_proxy,
1530 property_name,
1531 property_value);
1532 g_variant_unref (property_value);
1535 _g_dbus_object_proxy_add_interface (op, interface_proxy);
1536 if (!added)
1537 interface_added_signals = g_list_append (interface_added_signals, g_object_ref (interface_proxy));
1538 g_object_unref (interface_proxy);
1540 g_variant_unref (properties);
1543 g_mutex_unlock (&manager->priv->lock);
1545 /* now that we don't hold the lock any more, emit signals */
1546 for (l = interface_added_signals; l != NULL; l = l->next)
1548 interface_proxy = G_DBUS_PROXY (l->data);
1549 g_signal_emit_by_name (manager, "interface-added", op, interface_proxy);
1550 g_object_unref (interface_proxy);
1552 g_list_free (interface_added_signals);
1554 if (added)
1556 g_hash_table_insert (manager->priv->map_object_path_to_object_proxy,
1557 g_strdup (object_path),
1558 op);
1559 g_signal_emit_by_name (manager, "object-added", op);
1561 g_object_unref (op);
1565 static void
1566 remove_interfaces (GDBusObjectManagerClient *manager,
1567 const gchar *object_path,
1568 const gchar *const *interface_names)
1570 GDBusObjectProxy *op;
1571 GList *interfaces;
1572 guint n;
1573 guint num_interfaces;
1574 guint num_interfaces_to_remove;
1576 g_mutex_lock (&manager->priv->lock);
1578 op = g_hash_table_lookup (manager->priv->map_object_path_to_object_proxy, object_path);
1579 if (op == NULL)
1581 g_warning ("%s: Processing InterfaceRemoved signal for path %s but no object proxy exists",
1582 G_STRLOC,
1583 object_path);
1584 g_mutex_unlock (&manager->priv->lock);
1585 goto out;
1588 interfaces = g_dbus_object_get_interfaces (G_DBUS_OBJECT (op));
1589 num_interfaces = g_list_length (interfaces);
1590 g_list_free_full (interfaces, g_object_unref);
1592 num_interfaces_to_remove = g_strv_length ((gchar **) interface_names);
1594 /* see if we are going to completety remove the object */
1595 if (num_interfaces_to_remove == num_interfaces)
1597 g_object_ref (op);
1598 g_warn_if_fail (g_hash_table_remove (manager->priv->map_object_path_to_object_proxy, object_path));
1599 g_mutex_unlock (&manager->priv->lock);
1600 g_signal_emit_by_name (manager, "object-removed", op);
1601 g_object_unref (op);
1603 else
1605 g_object_ref (op);
1606 g_mutex_unlock (&manager->priv->lock);
1607 for (n = 0; interface_names != NULL && interface_names[n] != NULL; n++)
1609 GDBusInterface *interface;
1610 interface = g_dbus_object_get_interface (G_DBUS_OBJECT (op), interface_names[n]);
1611 _g_dbus_object_proxy_remove_interface (op, interface_names[n]);
1612 if (interface != NULL)
1614 g_signal_emit_by_name (manager, "interface-removed", op, interface);
1615 g_object_unref (interface);
1618 g_object_unref (op);
1620 out:
1624 static void
1625 process_get_all_result (GDBusObjectManagerClient *manager,
1626 GVariant *value,
1627 const gchar *name_owner)
1629 GVariant *arg0;
1630 const gchar *object_path;
1631 GVariant *ifaces_and_properties;
1632 GVariantIter iter;
1634 g_return_if_fail (name_owner == NULL || g_dbus_is_unique_name (name_owner));
1636 arg0 = g_variant_get_child_value (value, 0);
1637 g_variant_iter_init (&iter, arg0);
1638 while (g_variant_iter_next (&iter,
1639 "{&o@a{sa{sv}}}",
1640 &object_path,
1641 &ifaces_and_properties))
1643 add_interfaces (manager, object_path, ifaces_and_properties, name_owner);
1644 g_variant_unref (ifaces_and_properties);
1646 g_variant_unref (arg0);
1649 static void
1650 on_control_proxy_g_signal (GDBusProxy *proxy,
1651 const gchar *sender_name,
1652 const gchar *signal_name,
1653 GVariant *parameters,
1654 gpointer user_data)
1656 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (user_data);
1657 const gchar *object_path;
1659 //g_debug ("yay, g_signal %s: %s\n", signal_name, g_variant_print (parameters, TRUE));
1661 if (g_strcmp0 (signal_name, "InterfacesAdded") == 0)
1663 GVariant *ifaces_and_properties;
1664 g_variant_get (parameters,
1665 "(&o@a{sa{sv}})",
1666 &object_path,
1667 &ifaces_and_properties);
1668 add_interfaces (manager, object_path, ifaces_and_properties, manager->priv->name_owner);
1669 g_variant_unref (ifaces_and_properties);
1671 else if (g_strcmp0 (signal_name, "InterfacesRemoved") == 0)
1673 const gchar **ifaces;
1674 g_variant_get (parameters,
1675 "(&o^a&s)",
1676 &object_path,
1677 &ifaces);
1678 remove_interfaces (manager, object_path, ifaces);
1679 g_free (ifaces);
1683 /* ---------------------------------------------------------------------------------------------------- */
1685 static const gchar *
1686 g_dbus_object_manager_client_get_object_path (GDBusObjectManager *_manager)
1688 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (_manager);
1689 return manager->priv->object_path;
1692 static GDBusObject *
1693 g_dbus_object_manager_client_get_object (GDBusObjectManager *_manager,
1694 const gchar *object_path)
1696 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (_manager);
1697 GDBusObject *ret;
1699 g_mutex_lock (&manager->priv->lock);
1700 ret = g_hash_table_lookup (manager->priv->map_object_path_to_object_proxy, object_path);
1701 if (ret != NULL)
1702 g_object_ref (ret);
1703 g_mutex_unlock (&manager->priv->lock);
1704 return ret;
1707 static GDBusInterface *
1708 g_dbus_object_manager_client_get_interface (GDBusObjectManager *_manager,
1709 const gchar *object_path,
1710 const gchar *interface_name)
1712 GDBusInterface *ret;
1713 GDBusObject *object;
1715 ret = NULL;
1717 object = g_dbus_object_manager_get_object (_manager, object_path);
1718 if (object == NULL)
1719 goto out;
1721 ret = g_dbus_object_get_interface (object, interface_name);
1722 g_object_unref (object);
1724 out:
1725 return ret;
1728 static GList *
1729 g_dbus_object_manager_client_get_objects (GDBusObjectManager *_manager)
1731 GDBusObjectManagerClient *manager = G_DBUS_OBJECT_MANAGER_CLIENT (_manager);
1732 GList *ret;
1734 g_return_val_if_fail (G_IS_DBUS_OBJECT_MANAGER_CLIENT (manager), NULL);
1736 g_mutex_lock (&manager->priv->lock);
1737 ret = g_hash_table_get_values (manager->priv->map_object_path_to_object_proxy);
1738 g_list_foreach (ret, (GFunc) g_object_ref, NULL);
1739 g_mutex_unlock (&manager->priv->lock);
1741 return ret;
1745 static void
1746 dbus_object_manager_interface_init (GDBusObjectManagerIface *iface)
1748 iface->get_object_path = g_dbus_object_manager_client_get_object_path;
1749 iface->get_objects = g_dbus_object_manager_client_get_objects;
1750 iface->get_object = g_dbus_object_manager_client_get_object;
1751 iface->get_interface = g_dbus_object_manager_client_get_interface;
1754 /* ---------------------------------------------------------------------------------------------------- */