[kdbus] KDBUS_ITEM_PAYLOAD_OFF items are (once again) relative to msg header
[platform/upstream/glib.git] / gio / gdbusproxy.c
1 /* GDBus - GLib D-Bus Library
2  *
3  * Copyright (C) 2008-2010 Red Hat, Inc.
4  *
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.
9  *
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.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17  *
18  * Author: David Zeuthen <davidz@redhat.com>
19  */
20
21 #include "config.h"
22
23 #include <stdlib.h>
24 #include <string.h>
25
26 #include "gdbusutils.h"
27 #include "gdbusproxy.h"
28 #include "gioenumtypes.h"
29 #include "gdbusconnection.h"
30 #include "gdbuserror.h"
31 #include "gdbusprivate.h"
32 #include "ginitable.h"
33 #include "gasyncinitable.h"
34 #include "gioerror.h"
35 #include "gasyncresult.h"
36 #include "gsimpleasyncresult.h"
37 #include "gcancellable.h"
38 #include "gdbusinterface.h"
39
40 #ifdef G_OS_UNIX
41 #include "gunixfdlist.h"
42 #endif
43
44 #include "glibintl.h"
45
46 /**
47  * SECTION:gdbusproxy
48  * @short_description: Client-side D-Bus interface proxy
49  * @include: gio/gio.h
50  *
51  * #GDBusProxy is a base class used for proxies to access a D-Bus
52  * interface on a remote object. A #GDBusProxy can be constructed for
53  * both well-known and unique names.
54  *
55  * By default, #GDBusProxy will cache all properties (and listen to
56  * changes) of the remote object, and proxy all signals that gets
57  * emitted. This behaviour can be changed by passing suitable
58  * #GDBusProxyFlags when the proxy is created. If the proxy is for a
59  * well-known name, the property cache is flushed when the name owner
60  * vanishes and reloaded when a name owner appears.
61  *
62  * If a #GDBusProxy is used for a well-known name, the owner of the
63  * name is tracked and can be read from
64  * #GDBusProxy:g-name-owner. Connect to the #GObject::notify signal to
65  * get notified of changes. Additionally, only signals and property
66  * changes emitted from the current name owner are considered and
67  * calls are always sent to the current name owner. This avoids a
68  * number of race conditions when the name is lost by one owner and
69  * claimed by another. However, if no name owner currently exists,
70  * then calls will be sent to the well-known name which may result in
71  * the message bus launching an owner (unless
72  * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is set).
73  *
74  * The generic #GDBusProxy::g-properties-changed and
75  * #GDBusProxy::g-signal signals are not very convenient to work with.
76  * Therefore, the recommended way of working with proxies is to subclass
77  * #GDBusProxy, and have more natural properties and signals in your derived
78  * class. This [example][gdbus-example-gdbus-codegen] shows how this can
79  * easily be done using the [gdbus-codegen][gdbus-codegen] tool.
80  *
81  * A #GDBusProxy instance can be used from multiple threads but note
82  * that all signals (e.g. #GDBusProxy::g-signal, #GDBusProxy::g-properties-changed
83  * and #GObject::notify) are emitted in the
84  * [thread-default main context][g-main-context-push-thread-default]
85  * of the thread where the instance was constructed.
86  *
87  * An example using a proxy for a well-known name can be found in
88  * [gdbus-example-watch-proxy.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-watch-proxy.c)
89  */
90
91 /* lock protecting the mutable properties: name_owner, timeout_msec,
92  * expected_interface, and the properties hash table
93  */
94 G_LOCK_DEFINE_STATIC (properties_lock);
95
96 /* ---------------------------------------------------------------------------------------------------- */
97
98 G_LOCK_DEFINE_STATIC (signal_subscription_lock);
99
100 typedef struct
101 {
102   volatile gint ref_count;
103   GDBusProxy *proxy;
104 } SignalSubscriptionData;
105
106 static SignalSubscriptionData *
107 signal_subscription_ref (SignalSubscriptionData *data)
108 {
109   g_atomic_int_inc (&data->ref_count);
110   return data;
111 }
112
113 static void
114 signal_subscription_unref (SignalSubscriptionData *data)
115 {
116   if (g_atomic_int_dec_and_test (&data->ref_count))
117     {
118       g_slice_free (SignalSubscriptionData, data);
119     }
120 }
121
122 /* ---------------------------------------------------------------------------------------------------- */
123
124 struct _GDBusProxyPrivate
125 {
126   GBusType bus_type;
127   GDBusProxyFlags flags;
128   GDBusConnection *connection;
129
130   gchar *name;
131   /* mutable, protected by properties_lock */
132   gchar *name_owner;
133   gchar *object_path;
134   gchar *interface_name;
135   /* mutable, protected by properties_lock */
136   gint timeout_msec;
137
138   guint name_owner_changed_subscription_id;
139
140   GCancellable *get_all_cancellable;
141
142   /* gchar* -> GVariant*, protected by properties_lock */
143   GHashTable *properties;
144
145   /* mutable, protected by properties_lock */
146   GDBusInterfaceInfo *expected_interface;
147
148   guint properties_changed_subscription_id;
149   guint signals_subscription_id;
150
151   gboolean initialized;
152
153   /* mutable, protected by properties_lock */
154   GDBusObject *object;
155
156   SignalSubscriptionData *signal_subscription_data;
157 };
158
159 enum
160 {
161   PROP_0,
162   PROP_G_CONNECTION,
163   PROP_G_BUS_TYPE,
164   PROP_G_NAME,
165   PROP_G_NAME_OWNER,
166   PROP_G_FLAGS,
167   PROP_G_OBJECT_PATH,
168   PROP_G_INTERFACE_NAME,
169   PROP_G_DEFAULT_TIMEOUT,
170   PROP_G_INTERFACE_INFO
171 };
172
173 enum
174 {
175   PROPERTIES_CHANGED_SIGNAL,
176   SIGNAL_SIGNAL,
177   LAST_SIGNAL,
178 };
179
180 static guint signals[LAST_SIGNAL] = {0};
181
182 static void dbus_interface_iface_init (GDBusInterfaceIface *dbus_interface_iface);
183 static void initable_iface_init       (GInitableIface *initable_iface);
184 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
185
186 G_DEFINE_TYPE_WITH_CODE (GDBusProxy, g_dbus_proxy, G_TYPE_OBJECT,
187                          G_ADD_PRIVATE (GDBusProxy)
188                          G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_INTERFACE, dbus_interface_iface_init)
189                          G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
190                          G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init))
191
192 static void
193 g_dbus_proxy_dispose (GObject *object)
194 {
195   GDBusProxy *proxy = G_DBUS_PROXY (object);
196   G_LOCK (signal_subscription_lock);
197   if (proxy->priv->signal_subscription_data != NULL)
198     {
199       proxy->priv->signal_subscription_data->proxy = NULL;
200       signal_subscription_unref (proxy->priv->signal_subscription_data);
201       proxy->priv->signal_subscription_data = NULL;
202     }
203   G_UNLOCK (signal_subscription_lock);
204
205   G_OBJECT_CLASS (g_dbus_proxy_parent_class)->dispose (object);
206 }
207
208 static void
209 g_dbus_proxy_finalize (GObject *object)
210 {
211   GDBusProxy *proxy = G_DBUS_PROXY (object);
212
213   g_warn_if_fail (proxy->priv->get_all_cancellable == NULL);
214
215   if (proxy->priv->name_owner_changed_subscription_id > 0)
216     g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
217                                           proxy->priv->name_owner_changed_subscription_id);
218
219   if (proxy->priv->properties_changed_subscription_id > 0)
220     g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
221                                           proxy->priv->properties_changed_subscription_id);
222
223   if (proxy->priv->signals_subscription_id > 0)
224     g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
225                                           proxy->priv->signals_subscription_id);
226
227   if (proxy->priv->connection != NULL)
228     g_object_unref (proxy->priv->connection);
229   g_free (proxy->priv->name);
230   g_free (proxy->priv->name_owner);
231   g_free (proxy->priv->object_path);
232   g_free (proxy->priv->interface_name);
233   if (proxy->priv->properties != NULL)
234     g_hash_table_unref (proxy->priv->properties);
235
236   if (proxy->priv->expected_interface != NULL)
237     {
238       g_dbus_interface_info_cache_release (proxy->priv->expected_interface);
239       g_dbus_interface_info_unref (proxy->priv->expected_interface);
240     }
241
242   if (proxy->priv->object != NULL)
243     g_object_remove_weak_pointer (G_OBJECT (proxy->priv->object), (gpointer *) &proxy->priv->object);
244
245   G_OBJECT_CLASS (g_dbus_proxy_parent_class)->finalize (object);
246 }
247
248 static void
249 g_dbus_proxy_get_property (GObject    *object,
250                            guint       prop_id,
251                            GValue     *value,
252                            GParamSpec *pspec)
253 {
254   GDBusProxy *proxy = G_DBUS_PROXY (object);
255
256   switch (prop_id)
257     {
258     case PROP_G_CONNECTION:
259       g_value_set_object (value, proxy->priv->connection);
260       break;
261
262     case PROP_G_FLAGS:
263       g_value_set_flags (value, proxy->priv->flags);
264       break;
265
266     case PROP_G_NAME:
267       g_value_set_string (value, proxy->priv->name);
268       break;
269
270     case PROP_G_NAME_OWNER:
271       g_value_take_string (value, g_dbus_proxy_get_name_owner (proxy));
272       break;
273
274     case PROP_G_OBJECT_PATH:
275       g_value_set_string (value, proxy->priv->object_path);
276       break;
277
278     case PROP_G_INTERFACE_NAME:
279       g_value_set_string (value, proxy->priv->interface_name);
280       break;
281
282     case PROP_G_DEFAULT_TIMEOUT:
283       g_value_set_int (value, g_dbus_proxy_get_default_timeout (proxy));
284       break;
285
286     case PROP_G_INTERFACE_INFO:
287       g_value_set_boxed (value, g_dbus_proxy_get_interface_info (proxy));
288       break;
289
290     default:
291       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
292       break;
293     }
294 }
295
296 static void
297 g_dbus_proxy_set_property (GObject      *object,
298                            guint         prop_id,
299                            const GValue *value,
300                            GParamSpec   *pspec)
301 {
302   GDBusProxy *proxy = G_DBUS_PROXY (object);
303
304   switch (prop_id)
305     {
306     case PROP_G_CONNECTION:
307       proxy->priv->connection = g_value_dup_object (value);
308       break;
309
310     case PROP_G_FLAGS:
311       proxy->priv->flags = g_value_get_flags (value);
312       break;
313
314     case PROP_G_NAME:
315       proxy->priv->name = g_value_dup_string (value);
316       break;
317
318     case PROP_G_OBJECT_PATH:
319       proxy->priv->object_path = g_value_dup_string (value);
320       break;
321
322     case PROP_G_INTERFACE_NAME:
323       proxy->priv->interface_name = g_value_dup_string (value);
324       break;
325
326     case PROP_G_DEFAULT_TIMEOUT:
327       g_dbus_proxy_set_default_timeout (proxy, g_value_get_int (value));
328       break;
329
330     case PROP_G_INTERFACE_INFO:
331       g_dbus_proxy_set_interface_info (proxy, g_value_get_boxed (value));
332       break;
333
334     case PROP_G_BUS_TYPE:
335       proxy->priv->bus_type = g_value_get_enum (value);
336       break;
337
338     default:
339       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
340       break;
341     }
342 }
343
344 static void
345 g_dbus_proxy_class_init (GDBusProxyClass *klass)
346 {
347   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
348
349   gobject_class->dispose      = g_dbus_proxy_dispose;
350   gobject_class->finalize     = g_dbus_proxy_finalize;
351   gobject_class->set_property = g_dbus_proxy_set_property;
352   gobject_class->get_property = g_dbus_proxy_get_property;
353
354   /* Note that all property names are prefixed to avoid collisions with D-Bus property names
355    * in derived classes */
356
357   /**
358    * GDBusProxy:g-interface-info:
359    *
360    * Ensure that interactions with this proxy conform to the given
361    * interface. This is mainly to ensure that malformed data received
362    * from the other peer is ignored. The given #GDBusInterfaceInfo is
363    * said to be the "expected interface".
364    *
365    * The checks performed are:
366    * - When completing a method call, if the type signature of
367    *   the reply message isn't what's expected, the reply is
368    *   discarded and the #GError is set to %G_IO_ERROR_INVALID_ARGUMENT.
369    *
370    * - Received signals that have a type signature mismatch are dropped and
371    *   a warning is logged via g_warning().
372    *
373    * - Properties received via the initial `GetAll()` call or via the 
374    *   `::PropertiesChanged` signal (on the
375    *   [org.freedesktop.DBus.Properties](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties)
376    *   interface) or set using g_dbus_proxy_set_cached_property()
377    *   with a type signature mismatch are ignored and a warning is
378    *   logged via g_warning().
379    *
380    * Note that these checks are never done on methods, signals and
381    * properties that are not referenced in the given
382    * #GDBusInterfaceInfo, since extending a D-Bus interface on the
383    * service-side is not considered an ABI break.
384    *
385    * Since: 2.26
386    */
387   g_object_class_install_property (gobject_class,
388                                    PROP_G_INTERFACE_INFO,
389                                    g_param_spec_boxed ("g-interface-info",
390                                                        P_("Interface Information"),
391                                                        P_("Interface Information"),
392                                                        G_TYPE_DBUS_INTERFACE_INFO,
393                                                        G_PARAM_READABLE |
394                                                        G_PARAM_WRITABLE |
395                                                        G_PARAM_STATIC_NAME |
396                                                        G_PARAM_STATIC_BLURB |
397                                                        G_PARAM_STATIC_NICK));
398
399   /**
400    * GDBusProxy:g-connection:
401    *
402    * The #GDBusConnection the proxy is for.
403    *
404    * Since: 2.26
405    */
406   g_object_class_install_property (gobject_class,
407                                    PROP_G_CONNECTION,
408                                    g_param_spec_object ("g-connection",
409                                                         P_("g-connection"),
410                                                         P_("The connection the proxy is for"),
411                                                         G_TYPE_DBUS_CONNECTION,
412                                                         G_PARAM_READABLE |
413                                                         G_PARAM_WRITABLE |
414                                                         G_PARAM_CONSTRUCT_ONLY |
415                                                         G_PARAM_STATIC_NAME |
416                                                         G_PARAM_STATIC_BLURB |
417                                                         G_PARAM_STATIC_NICK));
418
419   /**
420    * GDBusProxy:g-bus-type:
421    *
422    * If this property is not %G_BUS_TYPE_NONE, then
423    * #GDBusProxy:g-connection must be %NULL and will be set to the
424    * #GDBusConnection obtained by calling g_bus_get() with the value
425    * of this property.
426    *
427    * Since: 2.26
428    */
429   g_object_class_install_property (gobject_class,
430                                    PROP_G_BUS_TYPE,
431                                    g_param_spec_enum ("g-bus-type",
432                                                       P_("Bus Type"),
433                                                       P_("The bus to connect to, if any"),
434                                                       G_TYPE_BUS_TYPE,
435                                                       G_BUS_TYPE_NONE,
436                                                       G_PARAM_WRITABLE |
437                                                       G_PARAM_CONSTRUCT_ONLY |
438                                                       G_PARAM_STATIC_NAME |
439                                                       G_PARAM_STATIC_BLURB |
440                                                       G_PARAM_STATIC_NICK));
441
442   /**
443    * GDBusProxy:g-flags:
444    *
445    * Flags from the #GDBusProxyFlags enumeration.
446    *
447    * Since: 2.26
448    */
449   g_object_class_install_property (gobject_class,
450                                    PROP_G_FLAGS,
451                                    g_param_spec_flags ("g-flags",
452                                                        P_("g-flags"),
453                                                        P_("Flags for the proxy"),
454                                                        G_TYPE_DBUS_PROXY_FLAGS,
455                                                        G_DBUS_PROXY_FLAGS_NONE,
456                                                        G_PARAM_READABLE |
457                                                        G_PARAM_WRITABLE |
458                                                        G_PARAM_CONSTRUCT_ONLY |
459                                                        G_PARAM_STATIC_NAME |
460                                                        G_PARAM_STATIC_BLURB |
461                                                        G_PARAM_STATIC_NICK));
462
463   /**
464    * GDBusProxy:g-name:
465    *
466    * The well-known or unique name that the proxy is for.
467    *
468    * Since: 2.26
469    */
470   g_object_class_install_property (gobject_class,
471                                    PROP_G_NAME,
472                                    g_param_spec_string ("g-name",
473                                                         P_("g-name"),
474                                                         P_("The well-known or unique name that the proxy is for"),
475                                                         NULL,
476                                                         G_PARAM_READABLE |
477                                                         G_PARAM_WRITABLE |
478                                                         G_PARAM_CONSTRUCT_ONLY |
479                                                         G_PARAM_STATIC_NAME |
480                                                         G_PARAM_STATIC_BLURB |
481                                                         G_PARAM_STATIC_NICK));
482
483   /**
484    * GDBusProxy:g-name-owner:
485    *
486    * The unique name that owns #GDBusProxy:g-name or %NULL if no-one
487    * currently owns that name. You may connect to #GObject::notify signal to
488    * track changes to this property.
489    *
490    * Since: 2.26
491    */
492   g_object_class_install_property (gobject_class,
493                                    PROP_G_NAME_OWNER,
494                                    g_param_spec_string ("g-name-owner",
495                                                         P_("g-name-owner"),
496                                                         P_("The unique name for the owner"),
497                                                         NULL,
498                                                         G_PARAM_READABLE |
499                                                         G_PARAM_STATIC_NAME |
500                                                         G_PARAM_STATIC_BLURB |
501                                                         G_PARAM_STATIC_NICK));
502
503   /**
504    * GDBusProxy:g-object-path:
505    *
506    * The object path the proxy is for.
507    *
508    * Since: 2.26
509    */
510   g_object_class_install_property (gobject_class,
511                                    PROP_G_OBJECT_PATH,
512                                    g_param_spec_string ("g-object-path",
513                                                         P_("g-object-path"),
514                                                         P_("The object path the proxy is for"),
515                                                         NULL,
516                                                         G_PARAM_READABLE |
517                                                         G_PARAM_WRITABLE |
518                                                         G_PARAM_CONSTRUCT_ONLY |
519                                                         G_PARAM_STATIC_NAME |
520                                                         G_PARAM_STATIC_BLURB |
521                                                         G_PARAM_STATIC_NICK));
522
523   /**
524    * GDBusProxy:g-interface-name:
525    *
526    * The D-Bus interface name the proxy is for.
527    *
528    * Since: 2.26
529    */
530   g_object_class_install_property (gobject_class,
531                                    PROP_G_INTERFACE_NAME,
532                                    g_param_spec_string ("g-interface-name",
533                                                         P_("g-interface-name"),
534                                                         P_("The D-Bus interface name the proxy is for"),
535                                                         NULL,
536                                                         G_PARAM_READABLE |
537                                                         G_PARAM_WRITABLE |
538                                                         G_PARAM_CONSTRUCT_ONLY |
539                                                         G_PARAM_STATIC_NAME |
540                                                         G_PARAM_STATIC_BLURB |
541                                                         G_PARAM_STATIC_NICK));
542
543   /**
544    * GDBusProxy:g-default-timeout:
545    *
546    * The timeout to use if -1 (specifying default timeout) is passed
547    * as @timeout_msec in the g_dbus_proxy_call() and
548    * g_dbus_proxy_call_sync() functions.
549    *
550    * This allows applications to set a proxy-wide timeout for all
551    * remote method invocations on the proxy. If this property is -1,
552    * the default timeout (typically 25 seconds) is used. If set to
553    * %G_MAXINT, then no timeout is used.
554    *
555    * Since: 2.26
556    */
557   g_object_class_install_property (gobject_class,
558                                    PROP_G_DEFAULT_TIMEOUT,
559                                    g_param_spec_int ("g-default-timeout",
560                                                      P_("Default Timeout"),
561                                                      P_("Timeout for remote method invocation"),
562                                                      -1,
563                                                      G_MAXINT,
564                                                      -1,
565                                                      G_PARAM_READABLE |
566                                                      G_PARAM_WRITABLE |
567                                                      G_PARAM_CONSTRUCT |
568                                                      G_PARAM_STATIC_NAME |
569                                                      G_PARAM_STATIC_BLURB |
570                                                      G_PARAM_STATIC_NICK));
571
572   /**
573    * GDBusProxy::g-properties-changed:
574    * @proxy: The #GDBusProxy emitting the signal.
575    * @changed_properties: A #GVariant containing the properties that changed
576    * @invalidated_properties: A %NULL terminated array of properties that was invalidated
577    *
578    * Emitted when one or more D-Bus properties on @proxy changes. The
579    * local cache has already been updated when this signal fires. Note
580    * that both @changed_properties and @invalidated_properties are
581    * guaranteed to never be %NULL (either may be empty though).
582    *
583    * If the proxy has the flag
584    * %G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES set, then
585    * @invalidated_properties will always be empty.
586    *
587    * This signal corresponds to the
588    * `PropertiesChanged` D-Bus signal on the
589    * `org.freedesktop.DBus.Properties` interface.
590    *
591    * Since: 2.26
592    */
593   signals[PROPERTIES_CHANGED_SIGNAL] = g_signal_new ("g-properties-changed",
594                                                      G_TYPE_DBUS_PROXY,
595                                                      G_SIGNAL_RUN_LAST | G_SIGNAL_MUST_COLLECT,
596                                                      G_STRUCT_OFFSET (GDBusProxyClass, g_properties_changed),
597                                                      NULL,
598                                                      NULL,
599                                                      NULL,
600                                                      G_TYPE_NONE,
601                                                      2,
602                                                      G_TYPE_VARIANT,
603                                                      G_TYPE_STRV | G_SIGNAL_TYPE_STATIC_SCOPE);
604
605   /**
606    * GDBusProxy::g-signal:
607    * @proxy: The #GDBusProxy emitting the signal.
608    * @sender_name: (allow-none): The sender of the signal or %NULL if the connection is not a bus connection.
609    * @signal_name: The name of the signal.
610    * @parameters: A #GVariant tuple with parameters for the signal.
611    *
612    * Emitted when a signal from the remote object and interface that @proxy is for, has been received.
613    *
614    * Since: 2.26
615    */
616   signals[SIGNAL_SIGNAL] = g_signal_new ("g-signal",
617                                          G_TYPE_DBUS_PROXY,
618                                          G_SIGNAL_RUN_LAST | G_SIGNAL_MUST_COLLECT,
619                                          G_STRUCT_OFFSET (GDBusProxyClass, g_signal),
620                                          NULL,
621                                          NULL,
622                                          NULL,
623                                          G_TYPE_NONE,
624                                          3,
625                                          G_TYPE_STRING,
626                                          G_TYPE_STRING,
627                                          G_TYPE_VARIANT);
628
629 }
630
631 static void
632 g_dbus_proxy_init (GDBusProxy *proxy)
633 {
634   proxy->priv = g_dbus_proxy_get_instance_private (proxy);
635   proxy->priv->signal_subscription_data = g_slice_new0 (SignalSubscriptionData);
636   proxy->priv->signal_subscription_data->ref_count = 1;
637   proxy->priv->signal_subscription_data->proxy = proxy;
638   proxy->priv->properties = g_hash_table_new_full (g_str_hash,
639                                                    g_str_equal,
640                                                    g_free,
641                                                    (GDestroyNotify) g_variant_unref);
642 }
643
644 /* ---------------------------------------------------------------------------------------------------- */
645
646 static gint
647 property_name_sort_func (const gchar **a,
648                          const gchar **b)
649 {
650   return g_strcmp0 (*a, *b);
651 }
652
653 /**
654  * g_dbus_proxy_get_cached_property_names:
655  * @proxy: A #GDBusProxy.
656  *
657  * Gets the names of all cached properties on @proxy.
658  *
659  * Returns: (transfer full): A %NULL-terminated array of strings or %NULL if
660  *          @proxy has no cached properties. Free the returned array with
661  *          g_strfreev().
662  *
663  * Since: 2.26
664  */
665 gchar **
666 g_dbus_proxy_get_cached_property_names (GDBusProxy  *proxy)
667 {
668   gchar **names;
669   GPtrArray *p;
670   GHashTableIter iter;
671   const gchar *key;
672
673   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
674
675   G_LOCK (properties_lock);
676
677   names = NULL;
678   if (g_hash_table_size (proxy->priv->properties) == 0)
679     goto out;
680
681   p = g_ptr_array_new ();
682
683   g_hash_table_iter_init (&iter, proxy->priv->properties);
684   while (g_hash_table_iter_next (&iter, (gpointer) &key, NULL))
685     g_ptr_array_add (p, g_strdup (key));
686   g_ptr_array_sort (p, (GCompareFunc) property_name_sort_func);
687   g_ptr_array_add (p, NULL);
688
689   names = (gchar **) g_ptr_array_free (p, FALSE);
690
691  out:
692   G_UNLOCK (properties_lock);
693   return names;
694 }
695
696 /* properties_lock must be held for as long as you will keep the
697  * returned value
698  */
699 static const GDBusPropertyInfo *
700 lookup_property_info (GDBusProxy  *proxy,
701                       const gchar *property_name)
702 {
703   const GDBusPropertyInfo *info = NULL;
704
705   if (proxy->priv->expected_interface == NULL)
706     goto out;
707
708   info = g_dbus_interface_info_lookup_property (proxy->priv->expected_interface, property_name);
709
710  out:
711   return info;
712 }
713
714 /**
715  * g_dbus_proxy_get_cached_property:
716  * @proxy: A #GDBusProxy.
717  * @property_name: Property name.
718  *
719  * Looks up the value for a property from the cache. This call does no
720  * blocking IO.
721  *
722  * If @proxy has an expected interface (see
723  * #GDBusProxy:g-interface-info) and @property_name is referenced by
724  * it, then @value is checked against the type of the property.
725  *
726  * Returns: A reference to the #GVariant instance that holds the value
727  * for @property_name or %NULL if the value is not in the cache. The
728  * returned reference must be freed with g_variant_unref().
729  *
730  * Since: 2.26
731  */
732 GVariant *
733 g_dbus_proxy_get_cached_property (GDBusProxy   *proxy,
734                                   const gchar  *property_name)
735 {
736   const GDBusPropertyInfo *info;
737   GVariant *value;
738
739   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
740   g_return_val_if_fail (property_name != NULL, NULL);
741
742   G_LOCK (properties_lock);
743
744   value = g_hash_table_lookup (proxy->priv->properties, property_name);
745   if (value == NULL)
746     goto out;
747
748   info = lookup_property_info (proxy, property_name);
749   if (info != NULL)
750     {
751       const gchar *type_string = g_variant_get_type_string (value);
752       if (g_strcmp0 (type_string, info->signature) != 0)
753         {
754           g_warning ("Trying to get property %s with type %s but according to the expected "
755                      "interface the type is %s",
756                      property_name,
757                      type_string,
758                      info->signature);
759           value = NULL;
760           goto out;
761         }
762     }
763
764   g_variant_ref (value);
765
766  out:
767   G_UNLOCK (properties_lock);
768   return value;
769 }
770
771 /**
772  * g_dbus_proxy_set_cached_property:
773  * @proxy: A #GDBusProxy
774  * @property_name: Property name.
775  * @value: (allow-none): Value for the property or %NULL to remove it from the cache.
776  *
777  * If @value is not %NULL, sets the cached value for the property with
778  * name @property_name to the value in @value.
779  *
780  * If @value is %NULL, then the cached value is removed from the
781  * property cache.
782  *
783  * If @proxy has an expected interface (see
784  * #GDBusProxy:g-interface-info) and @property_name is referenced by
785  * it, then @value is checked against the type of the property.
786  *
787  * If the @value #GVariant is floating, it is consumed. This allows
788  * convenient 'inline' use of g_variant_new(), e.g.
789  * |[<!-- language="C" -->
790  *  g_dbus_proxy_set_cached_property (proxy,
791  *                                    "SomeProperty",
792  *                                    g_variant_new ("(si)",
793  *                                                  "A String",
794  *                                                  42));
795  * ]|
796  *
797  * Normally you will not need to use this method since @proxy
798  * is tracking changes using the
799  * `org.freedesktop.DBus.Properties.PropertiesChanged`
800  * D-Bus signal. However, for performance reasons an object may
801  * decide to not use this signal for some properties and instead
802  * use a proprietary out-of-band mechanism to transmit changes.
803  *
804  * As a concrete example, consider an object with a property
805  * `ChatroomParticipants` which is an array of strings. Instead of
806  * transmitting the same (long) array every time the property changes,
807  * it is more efficient to only transmit the delta using e.g. signals
808  * `ChatroomParticipantJoined(String name)` and
809  * `ChatroomParticipantParted(String name)`.
810  *
811  * Since: 2.26
812  */
813 void
814 g_dbus_proxy_set_cached_property (GDBusProxy   *proxy,
815                                   const gchar  *property_name,
816                                   GVariant     *value)
817 {
818   const GDBusPropertyInfo *info;
819
820   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
821   g_return_if_fail (property_name != NULL);
822
823   G_LOCK (properties_lock);
824
825   if (value != NULL)
826     {
827       info = lookup_property_info (proxy, property_name);
828       if (info != NULL)
829         {
830           if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
831             {
832               g_warning ("Trying to set property %s of type %s but according to the expected "
833                          "interface the type is %s",
834                          property_name,
835                          g_variant_get_type_string (value),
836                          info->signature);
837               goto out;
838             }
839         }
840       g_hash_table_insert (proxy->priv->properties,
841                            g_strdup (property_name),
842                            g_variant_ref_sink (value));
843     }
844   else
845     {
846       g_hash_table_remove (proxy->priv->properties, property_name);
847     }
848
849  out:
850   G_UNLOCK (properties_lock);
851 }
852
853 /* ---------------------------------------------------------------------------------------------------- */
854
855 static void
856 on_signal_received (GDBusConnection *connection,
857                     const gchar     *sender_name,
858                     const gchar     *object_path,
859                     const gchar     *interface_name,
860                     const gchar     *signal_name,
861                     GVariant        *parameters,
862                     gpointer         user_data)
863 {
864   SignalSubscriptionData *data = user_data;
865   GDBusProxy *proxy;
866
867   G_LOCK (signal_subscription_lock);
868   proxy = data->proxy;
869   if (proxy == NULL)
870     {
871       G_UNLOCK (signal_subscription_lock);
872       return;
873     }
874   else
875     {
876       g_object_ref (proxy);
877       G_UNLOCK (signal_subscription_lock);
878     }
879
880   if (!proxy->priv->initialized)
881     goto out;
882
883   G_LOCK (properties_lock);
884
885   if (proxy->priv->name_owner != NULL && g_strcmp0 (sender_name, proxy->priv->name_owner) != 0)
886     {
887       G_UNLOCK (properties_lock);
888       goto out;
889     }
890
891   if (proxy->priv->expected_interface != NULL)
892     {
893       const GDBusSignalInfo *info;
894       info = g_dbus_interface_info_lookup_signal (proxy->priv->expected_interface, signal_name);
895       if (info != NULL)
896         {
897           GVariantType *expected_type;
898           expected_type = _g_dbus_compute_complete_signature (info->args);
899           if (!g_variant_type_equal (expected_type, g_variant_get_type (parameters)))
900             {
901               gchar *expected_type_string = g_variant_type_dup_string (expected_type);
902               g_warning ("Dropping signal %s of type %s since the type from the expected interface is %s",
903                          info->name,
904                          g_variant_get_type_string (parameters),
905                          expected_type_string);
906               g_free (expected_type_string);
907               g_variant_type_free (expected_type);
908               G_UNLOCK (properties_lock);
909               goto out;
910             }
911           g_variant_type_free (expected_type);
912         }
913     }
914
915   G_UNLOCK (properties_lock);
916
917   g_signal_emit (proxy,
918                  signals[SIGNAL_SIGNAL],
919                  0,
920                  sender_name,
921                  signal_name,
922                  parameters);
923
924  out:
925   if (proxy != NULL)
926     g_object_unref (proxy);
927 }
928
929 /* ---------------------------------------------------------------------------------------------------- */
930
931 /* must hold properties_lock */
932 static void
933 insert_property_checked (GDBusProxy  *proxy,
934                          gchar *property_name,
935                          GVariant *value)
936 {
937   if (proxy->priv->expected_interface != NULL)
938     {
939       const GDBusPropertyInfo *info;
940       info = g_dbus_interface_info_lookup_property (proxy->priv->expected_interface, property_name);
941       /* Only check known properties */
942       if (info != NULL)
943         {
944           /* Warn about properties with the wrong type */
945           if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
946             {
947               g_warning ("Received property %s with type %s does not match expected type "
948                          "%s in the expected interface",
949                          property_name,
950                          g_variant_get_type_string (value),
951                          info->signature);
952               goto invalid;
953             }
954         }
955     }
956
957   g_hash_table_insert (proxy->priv->properties,
958                        property_name, /* adopts string */
959                        value); /* adopts value */
960
961   return;
962
963  invalid:
964   g_variant_unref (value);
965   g_free (property_name);
966 }
967
968 typedef struct
969 {
970   GDBusProxy *proxy;
971   gchar *prop_name;
972 } InvalidatedPropGetData;
973
974 static void
975 invalidated_property_get_cb (GDBusConnection *connection,
976                              GAsyncResult    *res,
977                              gpointer         user_data)
978 {
979   InvalidatedPropGetData *data = user_data;
980   const gchar *invalidated_properties[] = {NULL};
981   GVariantBuilder builder;
982   GVariant *value = NULL;
983   GVariant *unpacked_value = NULL;
984
985   /* errors are fine, the other end could have disconnected */
986   value = g_dbus_connection_call_finish (connection, res, NULL);
987   if (value == NULL)
988     {
989       goto out;
990     }
991
992   if (!g_variant_is_of_type (value, G_VARIANT_TYPE ("(v)")))
993     {
994       g_warning ("Expected type '(v)' for Get() reply, got '%s'", g_variant_get_type_string (value));
995       goto out;
996     }
997
998   g_variant_get (value, "(v)", &unpacked_value);
999
1000   /* synthesize the a{sv} in the PropertiesChanged signal */
1001   g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));
1002   g_variant_builder_add (&builder, "{sv}", data->prop_name, unpacked_value);
1003
1004   G_LOCK (properties_lock);
1005   insert_property_checked (data->proxy,
1006                            data->prop_name,  /* adopts string */
1007                            unpacked_value);  /* adopts value */
1008   data->prop_name = NULL;
1009   G_UNLOCK (properties_lock);
1010
1011   g_signal_emit (data->proxy,
1012                  signals[PROPERTIES_CHANGED_SIGNAL], 0,
1013                  g_variant_builder_end (&builder), /* consumed */
1014                  invalidated_properties);
1015
1016
1017  out:
1018   if (value != NULL)
1019     g_variant_unref (value);
1020   g_object_unref (data->proxy);
1021   g_free (data->prop_name);
1022   g_slice_free (InvalidatedPropGetData, data);
1023 }
1024
1025 static void
1026 on_properties_changed (GDBusConnection *connection,
1027                        const gchar     *sender_name,
1028                        const gchar     *object_path,
1029                        const gchar     *interface_name,
1030                        const gchar     *signal_name,
1031                        GVariant        *parameters,
1032                        gpointer         user_data)
1033 {
1034   SignalSubscriptionData *data = user_data;
1035   gboolean emit_g_signal = FALSE;
1036   GDBusProxy *proxy;
1037   const gchar *interface_name_for_signal;
1038   GVariant *changed_properties;
1039   gchar **invalidated_properties;
1040   GVariantIter iter;
1041   gchar *key;
1042   GVariant *value;
1043   guint n;
1044
1045   changed_properties = NULL;
1046   invalidated_properties = NULL;
1047
1048   G_LOCK (signal_subscription_lock);
1049   proxy = data->proxy;
1050   if (proxy == NULL)
1051     {
1052       G_UNLOCK (signal_subscription_lock);
1053       goto out;
1054     }
1055   else
1056     {
1057       g_object_ref (proxy);
1058       G_UNLOCK (signal_subscription_lock);
1059     }
1060
1061   if (!proxy->priv->initialized)
1062     goto out;
1063
1064   G_LOCK (properties_lock);
1065
1066   if (proxy->priv->name_owner != NULL && g_strcmp0 (sender_name, proxy->priv->name_owner) != 0)
1067     {
1068       G_UNLOCK (properties_lock);
1069       goto out;
1070     }
1071
1072   if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(sa{sv}as)")))
1073     {
1074       g_warning ("Value for PropertiesChanged signal with type '%s' does not match '(sa{sv}as)'",
1075                  g_variant_get_type_string (parameters));
1076       G_UNLOCK (properties_lock);
1077       goto out;
1078     }
1079
1080   g_variant_get (parameters,
1081                  "(&s@a{sv}^a&s)",
1082                  &interface_name_for_signal,
1083                  &changed_properties,
1084                  &invalidated_properties);
1085
1086   if (g_strcmp0 (interface_name_for_signal, proxy->priv->interface_name) != 0)
1087     {
1088       G_UNLOCK (properties_lock);
1089       goto out;
1090     }
1091
1092   g_variant_iter_init (&iter, changed_properties);
1093   while (g_variant_iter_next (&iter, "{sv}", &key, &value))
1094     {
1095       insert_property_checked (proxy,
1096                                key, /* adopts string */
1097                                value); /* adopts value */
1098       emit_g_signal = TRUE;
1099     }
1100
1101   if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES)
1102     {
1103       if (proxy->priv->name_owner != NULL)
1104         {
1105           for (n = 0; invalidated_properties[n] != NULL; n++)
1106             {
1107               InvalidatedPropGetData *data;
1108               data = g_slice_new0 (InvalidatedPropGetData);
1109               data->proxy = g_object_ref (proxy);
1110               data->prop_name = g_strdup (invalidated_properties[n]);
1111               g_dbus_connection_call (proxy->priv->connection,
1112                                       proxy->priv->name_owner,
1113                                       proxy->priv->object_path,
1114                                       "org.freedesktop.DBus.Properties",
1115                                       "Get",
1116                                       g_variant_new ("(ss)", proxy->priv->interface_name, data->prop_name),
1117                                       G_VARIANT_TYPE ("(v)"),
1118                                       G_DBUS_CALL_FLAGS_NONE,
1119                                       -1,           /* timeout */
1120                                       NULL,         /* GCancellable */
1121                                       (GAsyncReadyCallback) invalidated_property_get_cb,
1122                                       data);
1123             }
1124         }
1125     }
1126   else
1127     {
1128       emit_g_signal = TRUE;
1129       for (n = 0; invalidated_properties[n] != NULL; n++)
1130         {
1131           g_hash_table_remove (proxy->priv->properties, invalidated_properties[n]);
1132         }
1133     }
1134
1135   G_UNLOCK (properties_lock);
1136
1137   if (emit_g_signal)
1138     {
1139       g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
1140                      0,
1141                      changed_properties,
1142                      invalidated_properties);
1143     }
1144
1145  out:
1146   if (changed_properties != NULL)
1147     g_variant_unref (changed_properties);
1148   g_free (invalidated_properties);
1149   if (proxy != NULL)
1150     g_object_unref (proxy);
1151 }
1152
1153 /* ---------------------------------------------------------------------------------------------------- */
1154
1155 static void
1156 process_get_all_reply (GDBusProxy *proxy,
1157                        GVariant   *result)
1158 {
1159   GVariantIter *iter;
1160   gchar *key;
1161   GVariant *value;
1162   guint num_properties;
1163
1164   if (!g_variant_is_of_type (result, G_VARIANT_TYPE ("(a{sv})")))
1165     {
1166       g_warning ("Value for GetAll reply with type '%s' does not match '(a{sv})'",
1167                  g_variant_get_type_string (result));
1168       goto out;
1169     }
1170
1171   G_LOCK (properties_lock);
1172
1173   g_variant_get (result, "(a{sv})", &iter);
1174   while (g_variant_iter_next (iter, "{sv}", &key, &value))
1175     {
1176       insert_property_checked (proxy,
1177                                key, /* adopts string */
1178                                value); /* adopts value */
1179     }
1180   g_variant_iter_free (iter);
1181
1182   num_properties = g_hash_table_size (proxy->priv->properties);
1183   G_UNLOCK (properties_lock);
1184
1185   /* Synthesize ::g-properties-changed changed */
1186   if (num_properties > 0)
1187     {
1188       GVariant *changed_properties;
1189       const gchar *invalidated_properties[1] = {NULL};
1190
1191       g_variant_get (result,
1192                      "(@a{sv})",
1193                      &changed_properties);
1194       g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
1195                      0,
1196                      changed_properties,
1197                      invalidated_properties);
1198       g_variant_unref (changed_properties);
1199     }
1200
1201  out:
1202   ;
1203 }
1204
1205 typedef struct
1206 {
1207   GDBusProxy *proxy;
1208   GCancellable *cancellable;
1209   gchar *name_owner;
1210 } LoadPropertiesOnNameOwnerChangedData;
1211
1212 static void
1213 on_name_owner_changed_get_all_cb (GDBusConnection *connection,
1214                                   GAsyncResult    *res,
1215                                   gpointer         user_data)
1216 {
1217   LoadPropertiesOnNameOwnerChangedData *data = user_data;
1218   GVariant *result;
1219   GError *error;
1220   gboolean cancelled;
1221
1222   cancelled = FALSE;
1223
1224   error = NULL;
1225   result = g_dbus_connection_call_finish (connection,
1226                                           res,
1227                                           &error);
1228   if (result == NULL)
1229     {
1230       if (error->domain == G_IO_ERROR && error->code == G_IO_ERROR_CANCELLED)
1231         cancelled = TRUE;
1232       /* We just ignore if GetAll() is failing. Because this might happen
1233        * if the object has no properties at all. Or if the caller is
1234        * not authorized to see the properties.
1235        *
1236        * Either way, apps can know about this by using
1237        * get_cached_property_names() or get_cached_property().
1238        *
1239        * TODO: handle G_DBUS_DEBUG flag 'proxy' and, if enabled, log the
1240        * fact that GetAll() failed
1241        */
1242       //g_debug ("error: %d %d %s", error->domain, error->code, error->message);
1243       g_error_free (error);
1244     }
1245
1246   /* and finally we can notify */
1247   if (!cancelled)
1248     {
1249       G_LOCK (properties_lock);
1250       g_free (data->proxy->priv->name_owner);
1251       data->proxy->priv->name_owner = data->name_owner;
1252       data->name_owner = NULL; /* to avoid an extra copy, we steal the string */
1253       g_hash_table_remove_all (data->proxy->priv->properties);
1254       G_UNLOCK (properties_lock);
1255       if (result != NULL)
1256         {
1257           process_get_all_reply (data->proxy, result);
1258           g_variant_unref (result);
1259         }
1260
1261       g_object_notify (G_OBJECT (data->proxy), "g-name-owner");
1262     }
1263
1264   if (data->cancellable == data->proxy->priv->get_all_cancellable)
1265     data->proxy->priv->get_all_cancellable = NULL;
1266
1267   g_object_unref (data->proxy);
1268   g_object_unref (data->cancellable);
1269   g_free (data->name_owner);
1270   g_free (data);
1271 }
1272
1273 static void
1274 on_name_owner_changed (GDBusConnection *connection,
1275                        const gchar      *sender_name,
1276                        const gchar      *object_path,
1277                        const gchar      *interface_name,
1278                        const gchar      *signal_name,
1279                        GVariant         *parameters,
1280                        gpointer          user_data)
1281 {
1282   SignalSubscriptionData *data = user_data;
1283   GDBusProxy *proxy;
1284   const gchar *old_owner;
1285   const gchar *new_owner;
1286
1287   G_LOCK (signal_subscription_lock);
1288   proxy = data->proxy;
1289   if (proxy == NULL)
1290     {
1291       G_UNLOCK (signal_subscription_lock);
1292       goto out;
1293     }
1294   else
1295     {
1296       g_object_ref (proxy);
1297       G_UNLOCK (signal_subscription_lock);
1298     }
1299
1300   /* if we are already trying to load properties, cancel that */
1301   if (proxy->priv->get_all_cancellable != NULL)
1302     {
1303       g_cancellable_cancel (proxy->priv->get_all_cancellable);
1304       proxy->priv->get_all_cancellable = NULL;
1305     }
1306
1307   g_variant_get (parameters,
1308                  "(&s&s&s)",
1309                  NULL,
1310                  &old_owner,
1311                  &new_owner);
1312
1313   if (strlen (new_owner) == 0)
1314     {
1315       G_LOCK (properties_lock);
1316       g_free (proxy->priv->name_owner);
1317       proxy->priv->name_owner = NULL;
1318
1319       /* Synthesize ::g-properties-changed changed */
1320       if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES) &&
1321           g_hash_table_size (proxy->priv->properties) > 0)
1322         {
1323           GVariantBuilder builder;
1324           GPtrArray *invalidated_properties;
1325           GHashTableIter iter;
1326           const gchar *key;
1327
1328           /* Build changed_properties (always empty) and invalidated_properties ... */
1329           g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));
1330
1331           invalidated_properties = g_ptr_array_new_with_free_func (g_free);
1332           g_hash_table_iter_init (&iter, proxy->priv->properties);
1333           while (g_hash_table_iter_next (&iter, (gpointer) &key, NULL))
1334             g_ptr_array_add (invalidated_properties, g_strdup (key));
1335           g_ptr_array_add (invalidated_properties, NULL);
1336
1337           /* ... throw out the properties ... */
1338           g_hash_table_remove_all (proxy->priv->properties);
1339
1340           G_UNLOCK (properties_lock);
1341
1342           /* ... and finally emit the ::g-properties-changed signal */
1343           g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
1344                          0,
1345                          g_variant_builder_end (&builder) /* consumed */,
1346                          (const gchar* const *) invalidated_properties->pdata);
1347           g_ptr_array_unref (invalidated_properties);
1348         }
1349       else
1350         {
1351           G_UNLOCK (properties_lock);
1352         }
1353       g_object_notify (G_OBJECT (proxy), "g-name-owner");
1354     }
1355   else
1356     {
1357       G_LOCK (properties_lock);
1358
1359       /* ignore duplicates - this can happen when activating the service */
1360       if (g_strcmp0 (new_owner, proxy->priv->name_owner) == 0)
1361         {
1362           G_UNLOCK (properties_lock);
1363           goto out;
1364         }
1365
1366       if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES)
1367         {
1368           g_free (proxy->priv->name_owner);
1369           proxy->priv->name_owner = g_strdup (new_owner);
1370
1371           g_hash_table_remove_all (proxy->priv->properties);
1372           G_UNLOCK (properties_lock);
1373           g_object_notify (G_OBJECT (proxy), "g-name-owner");
1374         }
1375       else
1376         {
1377           LoadPropertiesOnNameOwnerChangedData *data;
1378
1379           G_UNLOCK (properties_lock);
1380
1381           /* start loading properties.. only then emit notify::g-name-owner .. we
1382            * need to be able to cancel this in the event another NameOwnerChanged
1383            * signal suddenly happens
1384            */
1385
1386           g_assert (proxy->priv->get_all_cancellable == NULL);
1387           proxy->priv->get_all_cancellable = g_cancellable_new ();
1388           data = g_new0 (LoadPropertiesOnNameOwnerChangedData, 1);
1389           data->proxy = g_object_ref (proxy);
1390           data->cancellable = proxy->priv->get_all_cancellable;
1391           data->name_owner = g_strdup (new_owner);
1392           g_dbus_connection_call (proxy->priv->connection,
1393                                   data->name_owner,
1394                                   proxy->priv->object_path,
1395                                   "org.freedesktop.DBus.Properties",
1396                                   "GetAll",
1397                                   g_variant_new ("(s)", proxy->priv->interface_name),
1398                                   G_VARIANT_TYPE ("(a{sv})"),
1399                                   G_DBUS_CALL_FLAGS_NONE,
1400                                   -1,           /* timeout */
1401                                   proxy->priv->get_all_cancellable,
1402                                   (GAsyncReadyCallback) on_name_owner_changed_get_all_cb,
1403                                   data);
1404         }
1405     }
1406
1407  out:
1408   if (proxy != NULL)
1409     g_object_unref (proxy);
1410 }
1411
1412 /* ---------------------------------------------------------------------------------------------------- */
1413
1414 typedef struct
1415 {
1416   GDBusProxy *proxy;
1417   GCancellable *cancellable;
1418   GSimpleAsyncResult *simple;
1419 } AsyncInitData;
1420
1421 static void
1422 async_init_data_free (AsyncInitData *data)
1423 {
1424   g_object_unref (data->proxy);
1425   if (data->cancellable != NULL)
1426     g_object_unref (data->cancellable);
1427   g_object_unref (data->simple);
1428   g_free (data);
1429 }
1430
1431 static void
1432 async_init_get_all_cb (GDBusConnection *connection,
1433                        GAsyncResult    *res,
1434                        gpointer         user_data)
1435 {
1436   AsyncInitData *data = user_data;
1437   GVariant *result;
1438   GError *error;
1439
1440   error = NULL;
1441   result = g_dbus_connection_call_finish (connection,
1442                                           res,
1443                                           &error);
1444   if (result == NULL)
1445     {
1446       /* We just ignore if GetAll() is failing. Because this might happen
1447        * if the object has no properties at all. Or if the caller is
1448        * not authorized to see the properties.
1449        *
1450        * Either way, apps can know about this by using
1451        * get_cached_property_names() or get_cached_property().
1452        *
1453        * TODO: handle G_DBUS_DEBUG flag 'proxy' and, if enabled, log the
1454        * fact that GetAll() failed
1455        */
1456       //g_debug ("error: %d %d %s", error->domain, error->code, error->message);
1457       g_error_free (error);
1458     }
1459   else
1460     {
1461       g_simple_async_result_set_op_res_gpointer (data->simple,
1462                                                  result,
1463                                                  (GDestroyNotify) g_variant_unref);
1464     }
1465
1466   g_simple_async_result_complete_in_idle (data->simple);
1467   async_init_data_free (data);
1468 }
1469
1470 static void
1471 async_init_data_set_name_owner (AsyncInitData *data,
1472                                 const gchar   *name_owner)
1473 {
1474   gboolean get_all;
1475
1476
1477   if (name_owner != NULL)
1478     {
1479       /* it starts as NULL anyway */
1480       G_LOCK (properties_lock);
1481       data->proxy->priv->name_owner = g_strdup (name_owner);
1482       G_UNLOCK (properties_lock);
1483     }
1484
1485   get_all = TRUE;
1486
1487   if (data->proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES)
1488     {
1489       /* Don't load properties if the API user doesn't want them */
1490       get_all = FALSE;
1491     }
1492   else if (name_owner == NULL && data->proxy->priv->name != NULL)
1493     {
1494       /* Don't attempt to load properties if the name_owner is NULL (which
1495        * usually means the name isn't owned), unless name is also NULL (which
1496        * means we actually wanted to talk to the directly-connected process -
1497        * either dbus-daemon or a peer - instead of going via dbus-daemon)
1498        */
1499         get_all = FALSE;
1500     }
1501
1502   if (get_all)
1503     {
1504       /* load all properties asynchronously */
1505       g_dbus_connection_call (data->proxy->priv->connection,
1506                               name_owner,
1507                               data->proxy->priv->object_path,
1508                               "org.freedesktop.DBus.Properties",
1509                               "GetAll",
1510                               g_variant_new ("(s)", data->proxy->priv->interface_name),
1511                               G_VARIANT_TYPE ("(a{sv})"),
1512                               G_DBUS_CALL_FLAGS_NONE,
1513                               -1,           /* timeout */
1514                               data->cancellable,
1515                               (GAsyncReadyCallback) async_init_get_all_cb,
1516                               data);
1517     }
1518   else
1519     {
1520       g_simple_async_result_complete_in_idle (data->simple);
1521       async_init_data_free (data);
1522     }
1523 }
1524
1525 static void
1526 async_init_get_name_owner_cb (GDBusConnection *connection,
1527                               GAsyncResult    *res,
1528                               gpointer         user_data)
1529 {
1530   AsyncInitData *data = user_data;
1531   GError *error;
1532   GVariant *result;
1533
1534   error = NULL;
1535   result = g_dbus_connection_call_finish (connection,
1536                                           res,
1537                                           &error);
1538   if (result == NULL)
1539     {
1540       if (error->domain == G_DBUS_ERROR &&
1541           error->code == G_DBUS_ERROR_NAME_HAS_NO_OWNER)
1542         {
1543           g_error_free (error);
1544           async_init_data_set_name_owner (data, NULL);
1545         }
1546       else
1547         {
1548           g_simple_async_result_take_error (data->simple, error);
1549           g_simple_async_result_complete_in_idle (data->simple);
1550           async_init_data_free (data);
1551         }
1552     }
1553   else
1554     {
1555       /* borrowed from result to avoid an extra copy */
1556       const gchar *name_owner;
1557
1558       g_variant_get (result, "(&s)", &name_owner);
1559       async_init_data_set_name_owner (data, name_owner);
1560       g_variant_unref (result);
1561     }
1562 }
1563
1564 static void
1565 async_init_call_get_name_owner (AsyncInitData *data)
1566 {
1567   g_dbus_connection_call (data->proxy->priv->connection,
1568                           "org.freedesktop.DBus",  /* name */
1569                           "/org/freedesktop/DBus", /* object path */
1570                           "org.freedesktop.DBus",  /* interface */
1571                           "GetNameOwner",
1572                           g_variant_new ("(s)",
1573                                          data->proxy->priv->name),
1574                           G_VARIANT_TYPE ("(s)"),
1575                           G_DBUS_CALL_FLAGS_NONE,
1576                           -1,           /* timeout */
1577                           data->cancellable,
1578                           (GAsyncReadyCallback) async_init_get_name_owner_cb,
1579                           data);
1580 }
1581
1582 static void
1583 async_init_start_service_by_name_cb (GDBusConnection *connection,
1584                                      GAsyncResult    *res,
1585                                      gpointer         user_data)
1586 {
1587   AsyncInitData *data = user_data;
1588   GError *error;
1589   GVariant *result;
1590
1591   error = NULL;
1592   result = g_dbus_connection_call_finish (connection,
1593                                           res,
1594                                           &error);
1595   if (result == NULL)
1596     {
1597       /* Errors are not unexpected; the bus will reply e.g.
1598        *
1599        *   org.freedesktop.DBus.Error.ServiceUnknown: The name org.gnome.Epiphany2
1600        *   was not provided by any .service files
1601        *
1602        * or (see #677718)
1603        *
1604        *   org.freedesktop.systemd1.Masked: Unit polkit.service is masked.
1605        *
1606        * This doesn't mean that the name doesn't have an owner, just
1607        * that it's not provided by a .service file or can't currently
1608        * be started.
1609        *
1610        * In particular, in both cases, it could be that a service
1611        * owner will actually appear later. So instead of erroring out,
1612        * we just proceed to invoke GetNameOwner() if dealing with the
1613        * kind of errors above.
1614        */
1615       if (error->domain == G_DBUS_ERROR && error->code == G_DBUS_ERROR_SERVICE_UNKNOWN)
1616         {
1617           g_error_free (error);
1618         }
1619       else
1620         {
1621           gchar *remote_error = g_dbus_error_get_remote_error (error);
1622           if (g_strcmp0 (remote_error, "org.freedesktop.systemd1.Masked") == 0)
1623             {
1624               g_error_free (error);
1625               g_free (remote_error);
1626             }
1627           else
1628             {
1629               g_prefix_error (&error,
1630                               _("Error calling StartServiceByName for %s: "),
1631                               data->proxy->priv->name);
1632               g_free (remote_error);
1633               goto failed;
1634             }
1635         }
1636     }
1637   else
1638     {
1639       guint32 start_service_result;
1640       g_variant_get (result,
1641                      "(u)",
1642                      &start_service_result);
1643       g_variant_unref (result);
1644       if (start_service_result == 1 ||  /* DBUS_START_REPLY_SUCCESS */
1645           start_service_result == 2)    /* DBUS_START_REPLY_ALREADY_RUNNING */
1646         {
1647           /* continue to invoke GetNameOwner() */
1648         }
1649       else
1650         {
1651           error = g_error_new (G_IO_ERROR,
1652                                G_IO_ERROR_FAILED,
1653                                _("Unexpected reply %d from StartServiceByName(\"%s\") method"),
1654                                start_service_result,
1655                                data->proxy->priv->name);
1656           goto failed;
1657         }
1658     }
1659
1660   async_init_call_get_name_owner (data);
1661   return;
1662
1663  failed:
1664   g_warn_if_fail (error != NULL);
1665   g_simple_async_result_take_error (data->simple, error);
1666   g_simple_async_result_complete_in_idle (data->simple);
1667   async_init_data_free (data);
1668 }
1669
1670 static void
1671 async_init_call_start_service_by_name (AsyncInitData *data)
1672 {
1673   g_dbus_connection_call (data->proxy->priv->connection,
1674                           "org.freedesktop.DBus",  /* name */
1675                           "/org/freedesktop/DBus", /* object path */
1676                           "org.freedesktop.DBus",  /* interface */
1677                           "StartServiceByName",
1678                           g_variant_new ("(su)",
1679                                          data->proxy->priv->name,
1680                                          0),
1681                           G_VARIANT_TYPE ("(u)"),
1682                           G_DBUS_CALL_FLAGS_NONE,
1683                           -1,           /* timeout */
1684                           data->cancellable,
1685                           (GAsyncReadyCallback) async_init_start_service_by_name_cb,
1686                           data);
1687 }
1688
1689 static void
1690 async_initable_init_second_async (GAsyncInitable      *initable,
1691                                   gint                 io_priority,
1692                                   GCancellable        *cancellable,
1693                                   GAsyncReadyCallback  callback,
1694                                   gpointer             user_data)
1695 {
1696   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1697   AsyncInitData *data;
1698
1699   data = g_new0 (AsyncInitData, 1);
1700   data->proxy = g_object_ref (proxy);
1701   data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
1702   data->simple = g_simple_async_result_new (G_OBJECT (proxy),
1703                                             callback,
1704                                             user_data,
1705                                             NULL);
1706   g_simple_async_result_set_check_cancellable (data->simple, cancellable);
1707
1708   /* Check name ownership asynchronously - possibly also start the service */
1709   if (proxy->priv->name == NULL)
1710     {
1711       /* Do nothing */
1712       async_init_data_set_name_owner (data, NULL);
1713     }
1714   else if (g_dbus_is_unique_name (proxy->priv->name))
1715     {
1716       async_init_data_set_name_owner (data, proxy->priv->name);
1717     }
1718   else
1719     {
1720       if ((proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START) ||
1721           (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION))
1722         {
1723           async_init_call_get_name_owner (data);
1724         }
1725       else
1726         {
1727           async_init_call_start_service_by_name (data);
1728         }
1729     }
1730 }
1731
1732 static gboolean
1733 async_initable_init_second_finish (GAsyncInitable  *initable,
1734                                    GAsyncResult    *res,
1735                                    GError         **error)
1736 {
1737   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1738   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1739   GVariant *result;
1740   gboolean ret;
1741
1742   ret = FALSE;
1743
1744   if (g_simple_async_result_propagate_error (simple, error))
1745     goto out;
1746
1747   result = g_simple_async_result_get_op_res_gpointer (simple);
1748   if (result != NULL)
1749     {
1750       process_get_all_reply (proxy, result);
1751     }
1752
1753   ret = TRUE;
1754
1755  out:
1756   proxy->priv->initialized = TRUE;
1757   return ret;
1758 }
1759
1760 /* ---------------------------------------------------------------------------------------------------- */
1761
1762 static void
1763 async_initable_init_first (GAsyncInitable *initable)
1764 {
1765   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1766
1767   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
1768     {
1769       /* subscribe to PropertiesChanged() */
1770       proxy->priv->properties_changed_subscription_id =
1771         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1772                                             proxy->priv->name,
1773                                             "org.freedesktop.DBus.Properties",
1774                                             "PropertiesChanged",
1775                                             proxy->priv->object_path,
1776                                             proxy->priv->interface_name,
1777                                             G_DBUS_SIGNAL_FLAGS_NONE,
1778                                             on_properties_changed,
1779                                             signal_subscription_ref (proxy->priv->signal_subscription_data),
1780                                             (GDestroyNotify) signal_subscription_unref);
1781     }
1782
1783   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS))
1784     {
1785       /* subscribe to all signals for the object */
1786       proxy->priv->signals_subscription_id =
1787         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1788                                             proxy->priv->name,
1789                                             proxy->priv->interface_name,
1790                                             NULL,                        /* member */
1791                                             proxy->priv->object_path,
1792                                             NULL,                        /* arg0 */
1793                                             G_DBUS_SIGNAL_FLAGS_NONE,
1794                                             on_signal_received,
1795                                             signal_subscription_ref (proxy->priv->signal_subscription_data),
1796                                             (GDestroyNotify) signal_subscription_unref);
1797     }
1798
1799   if (proxy->priv->name != NULL && !g_dbus_is_unique_name (proxy->priv->name))
1800     {
1801       proxy->priv->name_owner_changed_subscription_id =
1802         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1803                                             "org.freedesktop.DBus",  /* name */
1804                                             "org.freedesktop.DBus",  /* interface */
1805                                             "NameOwnerChanged",      /* signal name */
1806                                             "/org/freedesktop/DBus", /* path */
1807                                             proxy->priv->name,       /* arg0 */
1808                                             G_DBUS_SIGNAL_FLAGS_NONE,
1809                                             on_name_owner_changed,
1810                                             signal_subscription_ref (proxy->priv->signal_subscription_data),
1811                                             (GDestroyNotify) signal_subscription_unref);
1812     }
1813 }
1814
1815 /* ---------------------------------------------------------------------------------------------------- */
1816
1817 /* initialization is split into two parts - the first is the
1818  * non-blocing part that requires the callers GMainContext - the
1819  * second is a blocking part async part that doesn't require the
1820  * callers GMainContext.. we do this split so the code can be reused
1821  * in the GInitable implementation below.
1822  *
1823  * Note that obtaining a GDBusConnection is not shared between the two
1824  * paths.
1825  */
1826
1827 typedef struct
1828 {
1829   GDBusProxy          *proxy;
1830   gint                 io_priority;
1831   GCancellable        *cancellable;
1832   GAsyncReadyCallback  callback;
1833   gpointer             user_data;
1834 } GetConnectionData;
1835
1836 static void
1837 get_connection_cb (GObject       *source_object,
1838                    GAsyncResult  *res,
1839                    gpointer       user_data)
1840 {
1841   GetConnectionData *data = user_data;
1842   GError *error;
1843
1844   error = NULL;
1845   data->proxy->priv->connection = g_bus_get_finish (res, &error);
1846   if (data->proxy->priv->connection == NULL)
1847     {
1848       GSimpleAsyncResult *simple;
1849       simple = g_simple_async_result_new (G_OBJECT (data->proxy),
1850                                           data->callback,
1851                                           data->user_data,
1852                                           NULL);
1853       g_simple_async_result_set_check_cancellable (simple, data->cancellable);
1854       g_simple_async_result_take_error (simple, error);
1855       g_simple_async_result_complete_in_idle (simple);
1856       g_object_unref (simple);
1857     }
1858   else
1859     {
1860       async_initable_init_first (G_ASYNC_INITABLE (data->proxy));
1861       async_initable_init_second_async (G_ASYNC_INITABLE (data->proxy),
1862                                         data->io_priority,
1863                                         data->cancellable,
1864                                         data->callback,
1865                                         data->user_data);
1866     }
1867
1868   if (data->cancellable != NULL)
1869     g_object_unref (data->cancellable);
1870
1871   g_object_unref (data->proxy);
1872   g_free (data);
1873 }
1874
1875 static void
1876 async_initable_init_async (GAsyncInitable      *initable,
1877                            gint                 io_priority,
1878                            GCancellable        *cancellable,
1879                            GAsyncReadyCallback  callback,
1880                            gpointer             user_data)
1881 {
1882   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1883
1884   if (proxy->priv->bus_type != G_BUS_TYPE_NONE)
1885     {
1886       GetConnectionData *data;
1887
1888       g_assert (proxy->priv->connection == NULL);
1889
1890       data = g_new0 (GetConnectionData, 1);
1891       data->proxy = g_object_ref (proxy);
1892       data->io_priority = io_priority;
1893       data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
1894       data->callback = callback;
1895       data->user_data = user_data;
1896       g_bus_get (proxy->priv->bus_type,
1897                  cancellable,
1898                  get_connection_cb,
1899                  data);
1900     }
1901   else
1902     {
1903       async_initable_init_first (initable);
1904       async_initable_init_second_async (initable, io_priority, cancellable, callback, user_data);
1905     }
1906 }
1907
1908 static gboolean
1909 async_initable_init_finish (GAsyncInitable  *initable,
1910                             GAsyncResult    *res,
1911                             GError         **error)
1912 {
1913   return async_initable_init_second_finish (initable, res, error);
1914 }
1915
1916 static void
1917 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
1918 {
1919   async_initable_iface->init_async = async_initable_init_async;
1920   async_initable_iface->init_finish = async_initable_init_finish;
1921 }
1922
1923 /* ---------------------------------------------------------------------------------------------------- */
1924
1925 typedef struct
1926 {
1927   GMainContext *context;
1928   GMainLoop *loop;
1929   GAsyncResult *res;
1930 } InitableAsyncInitableData;
1931
1932 static void
1933 async_initable_init_async_cb (GObject      *source_object,
1934                               GAsyncResult *res,
1935                               gpointer      user_data)
1936 {
1937   InitableAsyncInitableData *data = user_data;
1938   data->res = g_object_ref (res);
1939   g_main_loop_quit (data->loop);
1940 }
1941
1942 /* Simply reuse the GAsyncInitable implementation but run the first
1943  * part (that is non-blocking and requires the callers GMainContext)
1944  * with the callers GMainContext.. and the second with a private
1945  * GMainContext (bug 621310 is slightly related).
1946  *
1947  * Note that obtaining a GDBusConnection is not shared between the two
1948  * paths.
1949  */
1950 static gboolean
1951 initable_init (GInitable     *initable,
1952                GCancellable  *cancellable,
1953                GError       **error)
1954 {
1955   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1956   InitableAsyncInitableData *data;
1957   gboolean ret;
1958
1959   ret = FALSE;
1960
1961   if (proxy->priv->bus_type != G_BUS_TYPE_NONE)
1962     {
1963       g_assert (proxy->priv->connection == NULL);
1964       proxy->priv->connection = g_bus_get_sync (proxy->priv->bus_type,
1965                                                 cancellable,
1966                                                 error);
1967       if (proxy->priv->connection == NULL)
1968         goto out;
1969     }
1970
1971   async_initable_init_first (G_ASYNC_INITABLE (initable));
1972
1973   data = g_new0 (InitableAsyncInitableData, 1);
1974   data->context = g_main_context_new ();
1975   data->loop = g_main_loop_new (data->context, FALSE);
1976
1977   g_main_context_push_thread_default (data->context);
1978
1979   async_initable_init_second_async (G_ASYNC_INITABLE (initable),
1980                                     G_PRIORITY_DEFAULT,
1981                                     cancellable,
1982                                     async_initable_init_async_cb,
1983                                     data);
1984
1985   g_main_loop_run (data->loop);
1986
1987   ret = async_initable_init_second_finish (G_ASYNC_INITABLE (initable),
1988                                            data->res,
1989                                            error);
1990
1991   g_main_context_pop_thread_default (data->context);
1992
1993   g_main_context_unref (data->context);
1994   g_main_loop_unref (data->loop);
1995   g_object_unref (data->res);
1996   g_free (data);
1997
1998  out:
1999
2000   return ret;
2001 }
2002
2003 static void
2004 initable_iface_init (GInitableIface *initable_iface)
2005 {
2006   initable_iface->init = initable_init;
2007 }
2008
2009 /* ---------------------------------------------------------------------------------------------------- */
2010
2011 /**
2012  * g_dbus_proxy_new:
2013  * @connection: A #GDBusConnection.
2014  * @flags: Flags used when constructing the proxy.
2015  * @info: (allow-none): A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
2016  * @name: (allow-none): A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
2017  * @object_path: An object path.
2018  * @interface_name: A D-Bus interface name.
2019  * @cancellable: (allow-none): A #GCancellable or %NULL.
2020  * @callback: Callback function to invoke when the proxy is ready.
2021  * @user_data: User data to pass to @callback.
2022  *
2023  * Creates a proxy for accessing @interface_name on the remote object
2024  * at @object_path owned by @name at @connection and asynchronously
2025  * loads D-Bus properties unless the
2026  * %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to
2027  * the #GDBusProxy::g-properties-changed signal to get notified about
2028  * property changes.
2029  *
2030  * If the %G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
2031  * match rules for signals. Connect to the #GDBusProxy::g-signal signal
2032  * to handle signals from the remote object.
2033  *
2034  * If @name is a well-known name and the
2035  * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START and %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION
2036  * flags aren't set and no name owner currently exists, the message bus
2037  * will be requested to launch a name owner for the name.
2038  *
2039  * This is a failable asynchronous constructor - when the proxy is
2040  * ready, @callback will be invoked and you can use
2041  * g_dbus_proxy_new_finish() to get the result.
2042  *
2043  * See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
2044  *
2045  * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
2046  *
2047  * Since: 2.26
2048  */
2049 void
2050 g_dbus_proxy_new (GDBusConnection     *connection,
2051                   GDBusProxyFlags      flags,
2052                   GDBusInterfaceInfo  *info,
2053                   const gchar         *name,
2054                   const gchar         *object_path,
2055                   const gchar         *interface_name,
2056                   GCancellable        *cancellable,
2057                   GAsyncReadyCallback  callback,
2058                   gpointer             user_data)
2059 {
2060   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2061   g_return_if_fail ((name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) || g_dbus_is_name (name));
2062   g_return_if_fail (g_variant_is_object_path (object_path));
2063   g_return_if_fail (g_dbus_is_interface_name (interface_name));
2064
2065   g_async_initable_new_async (G_TYPE_DBUS_PROXY,
2066                               G_PRIORITY_DEFAULT,
2067                               cancellable,
2068                               callback,
2069                               user_data,
2070                               "g-flags", flags,
2071                               "g-interface-info", info,
2072                               "g-name", name,
2073                               "g-connection", connection,
2074                               "g-object-path", object_path,
2075                               "g-interface-name", interface_name,
2076                               NULL);
2077 }
2078
2079 /**
2080  * g_dbus_proxy_new_finish:
2081  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new().
2082  * @error: Return location for error or %NULL.
2083  *
2084  * Finishes creating a #GDBusProxy.
2085  *
2086  * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
2087  *
2088  * Since: 2.26
2089  */
2090 GDBusProxy *
2091 g_dbus_proxy_new_finish (GAsyncResult  *res,
2092                          GError       **error)
2093 {
2094   GObject *object;
2095   GObject *source_object;
2096
2097   source_object = g_async_result_get_source_object (res);
2098   g_assert (source_object != NULL);
2099
2100   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2101                                         res,
2102                                         error);
2103   g_object_unref (source_object);
2104
2105   if (object != NULL)
2106     return G_DBUS_PROXY (object);
2107   else
2108     return NULL;
2109 }
2110
2111 /**
2112  * g_dbus_proxy_new_sync:
2113  * @connection: A #GDBusConnection.
2114  * @flags: Flags used when constructing the proxy.
2115  * @info: (allow-none): A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
2116  * @name: (allow-none): A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
2117  * @object_path: An object path.
2118  * @interface_name: A D-Bus interface name.
2119  * @cancellable: (allow-none): A #GCancellable or %NULL.
2120  * @error: (allow-none): Return location for error or %NULL.
2121  *
2122  * Creates a proxy for accessing @interface_name on the remote object
2123  * at @object_path owned by @name at @connection and synchronously
2124  * loads D-Bus properties unless the
2125  * %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used.
2126  *
2127  * If the %G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
2128  * match rules for signals. Connect to the #GDBusProxy::g-signal signal
2129  * to handle signals from the remote object.
2130  *
2131  * If @name is a well-known name and the
2132  * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START and %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION
2133  * flags aren't set and no name owner currently exists, the message bus
2134  * will be requested to launch a name owner for the name.
2135  *
2136  * This is a synchronous failable constructor. See g_dbus_proxy_new()
2137  * and g_dbus_proxy_new_finish() for the asynchronous version.
2138  *
2139  * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
2140  *
2141  * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
2142  *
2143  * Since: 2.26
2144  */
2145 GDBusProxy *
2146 g_dbus_proxy_new_sync (GDBusConnection     *connection,
2147                        GDBusProxyFlags      flags,
2148                        GDBusInterfaceInfo  *info,
2149                        const gchar         *name,
2150                        const gchar         *object_path,
2151                        const gchar         *interface_name,
2152                        GCancellable        *cancellable,
2153                        GError             **error)
2154 {
2155   GInitable *initable;
2156
2157   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2158   g_return_val_if_fail ((name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
2159                         g_dbus_is_name (name), NULL);
2160   g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
2161   g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
2162
2163   initable = g_initable_new (G_TYPE_DBUS_PROXY,
2164                              cancellable,
2165                              error,
2166                              "g-flags", flags,
2167                              "g-interface-info", info,
2168                              "g-name", name,
2169                              "g-connection", connection,
2170                              "g-object-path", object_path,
2171                              "g-interface-name", interface_name,
2172                              NULL);
2173   if (initable != NULL)
2174     return G_DBUS_PROXY (initable);
2175   else
2176     return NULL;
2177 }
2178
2179 /* ---------------------------------------------------------------------------------------------------- */
2180
2181 /**
2182  * g_dbus_proxy_new_for_bus:
2183  * @bus_type: A #GBusType.
2184  * @flags: Flags used when constructing the proxy.
2185  * @info: (allow-none): A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
2186  * @name: A bus name (well-known or unique).
2187  * @object_path: An object path.
2188  * @interface_name: A D-Bus interface name.
2189  * @cancellable: (allow-none): A #GCancellable or %NULL.
2190  * @callback: Callback function to invoke when the proxy is ready.
2191  * @user_data: User data to pass to @callback.
2192  *
2193  * Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection.
2194  *
2195  * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
2196  *
2197  * Since: 2.26
2198  */
2199 void
2200 g_dbus_proxy_new_for_bus (GBusType             bus_type,
2201                           GDBusProxyFlags      flags,
2202                           GDBusInterfaceInfo  *info,
2203                           const gchar         *name,
2204                           const gchar         *object_path,
2205                           const gchar         *interface_name,
2206                           GCancellable        *cancellable,
2207                           GAsyncReadyCallback  callback,
2208                           gpointer             user_data)
2209 {
2210   g_return_if_fail (g_dbus_is_name (name));
2211   g_return_if_fail (g_variant_is_object_path (object_path));
2212   g_return_if_fail (g_dbus_is_interface_name (interface_name));
2213
2214   g_async_initable_new_async (G_TYPE_DBUS_PROXY,
2215                               G_PRIORITY_DEFAULT,
2216                               cancellable,
2217                               callback,
2218                               user_data,
2219                               "g-flags", flags,
2220                               "g-interface-info", info,
2221                               "g-name", name,
2222                               "g-bus-type", bus_type,
2223                               "g-object-path", object_path,
2224                               "g-interface-name", interface_name,
2225                               NULL);
2226 }
2227
2228 /**
2229  * g_dbus_proxy_new_for_bus_finish:
2230  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus().
2231  * @error: Return location for error or %NULL.
2232  *
2233  * Finishes creating a #GDBusProxy.
2234  *
2235  * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
2236  *
2237  * Since: 2.26
2238  */
2239 GDBusProxy *
2240 g_dbus_proxy_new_for_bus_finish (GAsyncResult  *res,
2241                                  GError       **error)
2242 {
2243   return g_dbus_proxy_new_finish (res, error);
2244 }
2245
2246 /**
2247  * g_dbus_proxy_new_for_bus_sync:
2248  * @bus_type: A #GBusType.
2249  * @flags: Flags used when constructing the proxy.
2250  * @info: (allow-none): A #GDBusInterfaceInfo specifying the minimal interface
2251  *        that @proxy conforms to or %NULL.
2252  * @name: A bus name (well-known or unique).
2253  * @object_path: An object path.
2254  * @interface_name: A D-Bus interface name.
2255  * @cancellable: (allow-none): A #GCancellable or %NULL.
2256  * @error: Return location for error or %NULL.
2257  *
2258  * Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.
2259  *
2260  * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
2261  *
2262  * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
2263  *
2264  * Since: 2.26
2265  */
2266 GDBusProxy *
2267 g_dbus_proxy_new_for_bus_sync (GBusType             bus_type,
2268                                GDBusProxyFlags      flags,
2269                                GDBusInterfaceInfo  *info,
2270                                const gchar         *name,
2271                                const gchar         *object_path,
2272                                const gchar         *interface_name,
2273                                GCancellable        *cancellable,
2274                                GError             **error)
2275 {
2276   GInitable *initable;
2277
2278   g_return_val_if_fail (g_dbus_is_name (name), NULL);
2279   g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
2280   g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
2281
2282   initable = g_initable_new (G_TYPE_DBUS_PROXY,
2283                              cancellable,
2284                              error,
2285                              "g-flags", flags,
2286                              "g-interface-info", info,
2287                              "g-name", name,
2288                              "g-bus-type", bus_type,
2289                              "g-object-path", object_path,
2290                              "g-interface-name", interface_name,
2291                              NULL);
2292   if (initable != NULL)
2293     return G_DBUS_PROXY (initable);
2294   else
2295     return NULL;
2296 }
2297
2298 /* ---------------------------------------------------------------------------------------------------- */
2299
2300 /**
2301  * g_dbus_proxy_get_connection:
2302  * @proxy: A #GDBusProxy.
2303  *
2304  * Gets the connection @proxy is for.
2305  *
2306  * Returns: (transfer none): A #GDBusConnection owned by @proxy. Do not free.
2307  *
2308  * Since: 2.26
2309  */
2310 GDBusConnection *
2311 g_dbus_proxy_get_connection (GDBusProxy *proxy)
2312 {
2313   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2314   return proxy->priv->connection;
2315 }
2316
2317 /**
2318  * g_dbus_proxy_get_flags:
2319  * @proxy: A #GDBusProxy.
2320  *
2321  * Gets the flags that @proxy was constructed with.
2322  *
2323  * Returns: Flags from the #GDBusProxyFlags enumeration.
2324  *
2325  * Since: 2.26
2326  */
2327 GDBusProxyFlags
2328 g_dbus_proxy_get_flags (GDBusProxy *proxy)
2329 {
2330   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), 0);
2331   return proxy->priv->flags;
2332 }
2333
2334 /**
2335  * g_dbus_proxy_get_name:
2336  * @proxy: A #GDBusProxy.
2337  *
2338  * Gets the name that @proxy was constructed for.
2339  *
2340  * Returns: A string owned by @proxy. Do not free.
2341  *
2342  * Since: 2.26
2343  */
2344 const gchar *
2345 g_dbus_proxy_get_name (GDBusProxy *proxy)
2346 {
2347   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2348   return proxy->priv->name;
2349 }
2350
2351 /**
2352  * g_dbus_proxy_get_name_owner:
2353  * @proxy: A #GDBusProxy.
2354  *
2355  * The unique name that owns the name that @proxy is for or %NULL if
2356  * no-one currently owns that name. You may connect to the
2357  * #GObject::notify signal to track changes to the
2358  * #GDBusProxy:g-name-owner property.
2359  *
2360  * Returns: The name owner or %NULL if no name owner exists. Free with g_free().
2361  *
2362  * Since: 2.26
2363  */
2364 gchar *
2365 g_dbus_proxy_get_name_owner (GDBusProxy *proxy)
2366 {
2367   gchar *ret;
2368
2369   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2370
2371   G_LOCK (properties_lock);
2372   ret = g_strdup (proxy->priv->name_owner);
2373   G_UNLOCK (properties_lock);
2374   return ret;
2375 }
2376
2377 /**
2378  * g_dbus_proxy_get_object_path:
2379  * @proxy: A #GDBusProxy.
2380  *
2381  * Gets the object path @proxy is for.
2382  *
2383  * Returns: A string owned by @proxy. Do not free.
2384  *
2385  * Since: 2.26
2386  */
2387 const gchar *
2388 g_dbus_proxy_get_object_path (GDBusProxy *proxy)
2389 {
2390   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2391   return proxy->priv->object_path;
2392 }
2393
2394 /**
2395  * g_dbus_proxy_get_interface_name:
2396  * @proxy: A #GDBusProxy.
2397  *
2398  * Gets the D-Bus interface name @proxy is for.
2399  *
2400  * Returns: A string owned by @proxy. Do not free.
2401  *
2402  * Since: 2.26
2403  */
2404 const gchar *
2405 g_dbus_proxy_get_interface_name (GDBusProxy *proxy)
2406 {
2407   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2408   return proxy->priv->interface_name;
2409 }
2410
2411 /**
2412  * g_dbus_proxy_get_default_timeout:
2413  * @proxy: A #GDBusProxy.
2414  *
2415  * Gets the timeout to use if -1 (specifying default timeout) is
2416  * passed as @timeout_msec in the g_dbus_proxy_call() and
2417  * g_dbus_proxy_call_sync() functions.
2418  *
2419  * See the #GDBusProxy:g-default-timeout property for more details.
2420  *
2421  * Returns: Timeout to use for @proxy.
2422  *
2423  * Since: 2.26
2424  */
2425 gint
2426 g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
2427 {
2428   gint ret;
2429
2430   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), -1);
2431
2432   G_LOCK (properties_lock);
2433   ret = proxy->priv->timeout_msec;
2434   G_UNLOCK (properties_lock);
2435   return ret;
2436 }
2437
2438 /**
2439  * g_dbus_proxy_set_default_timeout:
2440  * @proxy: A #GDBusProxy.
2441  * @timeout_msec: Timeout in milliseconds.
2442  *
2443  * Sets the timeout to use if -1 (specifying default timeout) is
2444  * passed as @timeout_msec in the g_dbus_proxy_call() and
2445  * g_dbus_proxy_call_sync() functions.
2446  *
2447  * See the #GDBusProxy:g-default-timeout property for more details.
2448  *
2449  * Since: 2.26
2450  */
2451 void
2452 g_dbus_proxy_set_default_timeout (GDBusProxy *proxy,
2453                                   gint        timeout_msec)
2454 {
2455   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2456   g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
2457
2458   G_LOCK (properties_lock);
2459
2460   if (proxy->priv->timeout_msec != timeout_msec)
2461     {
2462       proxy->priv->timeout_msec = timeout_msec;
2463       G_UNLOCK (properties_lock);
2464
2465       g_object_notify (G_OBJECT (proxy), "g-default-timeout");
2466     }
2467   else
2468     {
2469       G_UNLOCK (properties_lock);
2470     }
2471 }
2472
2473 /**
2474  * g_dbus_proxy_get_interface_info:
2475  * @proxy: A #GDBusProxy
2476  *
2477  * Returns the #GDBusInterfaceInfo, if any, specifying the interface
2478  * that @proxy conforms to. See the #GDBusProxy:g-interface-info
2479  * property for more details.
2480  *
2481  * Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
2482  * object, it is owned by @proxy.
2483  *
2484  * Since: 2.26
2485  */
2486 GDBusInterfaceInfo *
2487 g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
2488 {
2489   GDBusInterfaceInfo *ret;
2490
2491   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2492
2493   G_LOCK (properties_lock);
2494   ret = proxy->priv->expected_interface;
2495   G_UNLOCK (properties_lock);
2496   /* FIXME: returning a borrowed ref with no guarantee that nobody will
2497    * call g_dbus_proxy_set_interface_info() and make it invalid...
2498    */
2499   return ret;
2500 }
2501
2502 /**
2503  * g_dbus_proxy_set_interface_info:
2504  * @proxy: A #GDBusProxy
2505  * @info: (allow-none): Minimum interface this proxy conforms to or %NULL to unset.
2506  *
2507  * Ensure that interactions with @proxy conform to the given
2508  * interface. See the #GDBusProxy:g-interface-info property for more
2509  * details.
2510  *
2511  * Since: 2.26
2512  */
2513 void
2514 g_dbus_proxy_set_interface_info (GDBusProxy         *proxy,
2515                                  GDBusInterfaceInfo *info)
2516 {
2517   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2518   G_LOCK (properties_lock);
2519
2520   if (proxy->priv->expected_interface != NULL)
2521     {
2522       g_dbus_interface_info_cache_release (proxy->priv->expected_interface);
2523       g_dbus_interface_info_unref (proxy->priv->expected_interface);
2524     }
2525   proxy->priv->expected_interface = info != NULL ? g_dbus_interface_info_ref (info) : NULL;
2526   if (proxy->priv->expected_interface != NULL)
2527     g_dbus_interface_info_cache_build (proxy->priv->expected_interface);
2528
2529   G_UNLOCK (properties_lock);
2530 }
2531
2532 /* ---------------------------------------------------------------------------------------------------- */
2533
2534 static gboolean
2535 maybe_split_method_name (const gchar  *method_name,
2536                          gchar       **out_interface_name,
2537                          const gchar **out_method_name)
2538 {
2539   gboolean was_split;
2540
2541   was_split = FALSE;
2542   g_assert (out_interface_name != NULL);
2543   g_assert (out_method_name != NULL);
2544   *out_interface_name = NULL;
2545   *out_method_name = NULL;
2546
2547   if (strchr (method_name, '.') != NULL)
2548     {
2549       gchar *p;
2550       gchar *last_dot;
2551
2552       p = g_strdup (method_name);
2553       last_dot = strrchr (p, '.');
2554       *last_dot = '\0';
2555
2556       *out_interface_name = p;
2557       *out_method_name = last_dot + 1;
2558
2559       was_split = TRUE;
2560     }
2561
2562   return was_split;
2563 }
2564
2565 typedef struct
2566 {
2567   GVariant *value;
2568 #ifdef G_OS_UNIX
2569   GUnixFDList *fd_list;
2570 #endif
2571 } ReplyData;
2572
2573 static void
2574 reply_data_free (ReplyData *data)
2575 {
2576   g_variant_unref (data->value);
2577 #ifdef G_OS_UNIX
2578   if (data->fd_list != NULL)
2579     g_object_unref (data->fd_list);
2580 #endif
2581   g_slice_free (ReplyData, data);
2582 }
2583
2584 static void
2585 reply_cb (GDBusConnection *connection,
2586           GAsyncResult    *res,
2587           gpointer         user_data)
2588 {
2589   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
2590   GVariant *value;
2591   GError *error;
2592 #ifdef G_OS_UNIX
2593   GUnixFDList *fd_list;
2594 #endif
2595
2596   error = NULL;
2597 #ifdef G_OS_UNIX
2598   value = g_dbus_connection_call_with_unix_fd_list_finish (connection,
2599                                                            &fd_list,
2600                                                            res,
2601                                                            &error);
2602 #else
2603   value = g_dbus_connection_call_finish (connection,
2604                                          res,
2605                                          &error);
2606 #endif
2607   if (error != NULL)
2608     {
2609       g_simple_async_result_take_error (simple, error);
2610     }
2611   else
2612     {
2613       ReplyData *data;
2614       data = g_slice_new0 (ReplyData);
2615       data->value = value;
2616 #ifdef G_OS_UNIX
2617       data->fd_list = fd_list;
2618 #endif
2619       g_simple_async_result_set_op_res_gpointer (simple, data, (GDestroyNotify) reply_data_free);
2620     }
2621
2622   /* no need to complete in idle since the method GDBusConnection already does */
2623   g_simple_async_result_complete (simple);
2624   g_object_unref (simple);
2625 }
2626
2627 /* properties_lock must be held for as long as you will keep the
2628  * returned value
2629  */
2630 static const GDBusMethodInfo *
2631 lookup_method_info (GDBusProxy  *proxy,
2632                     const gchar *method_name)
2633 {
2634   const GDBusMethodInfo *info = NULL;
2635
2636   if (proxy->priv->expected_interface == NULL)
2637     goto out;
2638
2639   info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, method_name);
2640
2641 out:
2642   return info;
2643 }
2644
2645 /* properties_lock must be held for as long as you will keep the
2646  * returned value
2647  */
2648 static const gchar *
2649 get_destination_for_call (GDBusProxy *proxy)
2650 {
2651   const gchar *ret;
2652
2653   ret = NULL;
2654
2655   /* If proxy->priv->name is a unique name, then proxy->priv->name_owner
2656    * is never NULL and always the same as proxy->priv->name. We use this
2657    * knowledge to avoid checking if proxy->priv->name is a unique or
2658    * well-known name.
2659    */
2660   ret = proxy->priv->name_owner;
2661   if (ret != NULL)
2662     goto out;
2663
2664   if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START)
2665     goto out;
2666
2667   ret = proxy->priv->name;
2668
2669  out:
2670   return ret;
2671 }
2672
2673 /* ---------------------------------------------------------------------------------------------------- */
2674
2675 static void
2676 g_dbus_proxy_call_internal (GDBusProxy          *proxy,
2677                             const gchar         *method_name,
2678                             GVariant            *parameters,
2679                             GDBusCallFlags       flags,
2680                             gint                 timeout_msec,
2681                             GUnixFDList         *fd_list,
2682                             GCancellable        *cancellable,
2683                             GAsyncReadyCallback  callback,
2684                             gpointer             user_data)
2685 {
2686   GSimpleAsyncResult *simple;
2687   gboolean was_split;
2688   gchar *split_interface_name;
2689   const gchar *split_method_name;
2690   const gchar *target_method_name;
2691   const gchar *target_interface_name;
2692   gchar *destination;
2693   GVariantType *reply_type;
2694   GAsyncReadyCallback my_callback;
2695
2696   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2697   g_return_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name));
2698   g_return_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
2699   g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
2700 #ifdef G_OS_UNIX
2701   g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
2702 #else
2703   g_return_if_fail (fd_list == NULL);
2704 #endif
2705
2706   reply_type = NULL;
2707   split_interface_name = NULL;
2708
2709   /* g_dbus_connection_call() is optimised for the case of a NULL
2710    * callback.  If we get a NULL callback from our user then make sure
2711    * we pass along a NULL callback for ourselves as well.
2712    */
2713   if (callback != NULL)
2714     {
2715       my_callback = (GAsyncReadyCallback) reply_cb;
2716       simple = g_simple_async_result_new (G_OBJECT (proxy),
2717                                           callback,
2718                                           user_data,
2719                                           g_dbus_proxy_call_internal);
2720       g_simple_async_result_set_check_cancellable (simple, cancellable);
2721     }
2722   else
2723     {
2724       my_callback = NULL;
2725       simple = NULL;
2726     }
2727
2728   G_LOCK (properties_lock);
2729
2730   was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
2731   target_method_name = was_split ? split_method_name : method_name;
2732   target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
2733
2734   /* Warn if method is unexpected (cf. :g-interface-info) */
2735   if (!was_split)
2736     {
2737       const GDBusMethodInfo *expected_method_info;
2738       expected_method_info = lookup_method_info (proxy, target_method_name);
2739       if (expected_method_info != NULL)
2740         reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
2741     }
2742
2743   destination = NULL;
2744   if (proxy->priv->name != NULL)
2745     {
2746       destination = g_strdup (get_destination_for_call (proxy));
2747       if (destination == NULL)
2748         {
2749           if (simple != NULL)
2750             {
2751               g_simple_async_result_set_error (simple,
2752                                                G_IO_ERROR,
2753                                                G_IO_ERROR_FAILED,
2754                                                _("Cannot invoke method; proxy is for a well-known name without an owner and proxy was constructed with the G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag"));
2755               g_simple_async_result_complete_in_idle (simple);
2756               g_object_unref (simple);
2757             }
2758           G_UNLOCK (properties_lock);
2759           goto out;
2760         }
2761     }
2762
2763   G_UNLOCK (properties_lock);
2764
2765 #ifdef G_OS_UNIX
2766   g_dbus_connection_call_with_unix_fd_list (proxy->priv->connection,
2767                                             destination,
2768                                             proxy->priv->object_path,
2769                                             target_interface_name,
2770                                             target_method_name,
2771                                             parameters,
2772                                             reply_type,
2773                                             flags,
2774                                             timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
2775                                             fd_list,
2776                                             cancellable,
2777                                             my_callback,
2778                                             simple);
2779 #else
2780   g_dbus_connection_call (proxy->priv->connection,
2781                           destination,
2782                           proxy->priv->object_path,
2783                           target_interface_name,
2784                           target_method_name,
2785                           parameters,
2786                           reply_type,
2787                           flags,
2788                           timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
2789                           cancellable,
2790                           my_callback,
2791                           simple);
2792 #endif
2793
2794  out:
2795   if (reply_type != NULL)
2796     g_variant_type_free (reply_type);
2797
2798   g_free (destination);
2799   g_free (split_interface_name);
2800 }
2801
2802 static GVariant *
2803 g_dbus_proxy_call_finish_internal (GDBusProxy    *proxy,
2804                                    GUnixFDList  **out_fd_list,
2805                                    GAsyncResult  *res,
2806                                    GError       **error)
2807 {
2808   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2809   GVariant *value;
2810   ReplyData *data;
2811
2812   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2813   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2814   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2815
2816   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_proxy_call_internal);
2817
2818   value = NULL;
2819
2820   if (g_simple_async_result_propagate_error (simple, error))
2821     goto out;
2822
2823   data = g_simple_async_result_get_op_res_gpointer (simple);
2824   value = g_variant_ref (data->value);
2825 #ifdef G_OS_UNIX
2826   if (out_fd_list != NULL)
2827     *out_fd_list = data->fd_list != NULL ? g_object_ref (data->fd_list) : NULL;
2828 #endif
2829
2830  out:
2831   return value;
2832 }
2833
2834 static GVariant *
2835 g_dbus_proxy_call_sync_internal (GDBusProxy      *proxy,
2836                                  const gchar     *method_name,
2837                                  GVariant        *parameters,
2838                                  GDBusCallFlags   flags,
2839                                  gint             timeout_msec,
2840                                  GUnixFDList     *fd_list,
2841                                  GUnixFDList    **out_fd_list,
2842                                  GCancellable    *cancellable,
2843                                  GError         **error)
2844 {
2845   GVariant *ret;
2846   gboolean was_split;
2847   gchar *split_interface_name;
2848   const gchar *split_method_name;
2849   const gchar *target_method_name;
2850   const gchar *target_interface_name;
2851   gchar *destination;
2852   GVariantType *reply_type;
2853
2854   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2855   g_return_val_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name), NULL);
2856   g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
2857   g_return_val_if_fail (timeout_msec == -1 || timeout_msec >= 0, NULL);
2858 #ifdef G_OS_UNIX
2859   g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
2860 #else
2861   g_return_val_if_fail (fd_list == NULL, NULL);
2862 #endif
2863   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2864
2865   reply_type = NULL;
2866
2867   G_LOCK (properties_lock);
2868
2869   was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
2870   target_method_name = was_split ? split_method_name : method_name;
2871   target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
2872
2873   /* Warn if method is unexpected (cf. :g-interface-info) */
2874   if (!was_split)
2875     {
2876       const GDBusMethodInfo *expected_method_info;
2877       expected_method_info = lookup_method_info (proxy, target_method_name);
2878       if (expected_method_info != NULL)
2879         reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
2880     }
2881
2882   destination = NULL;
2883   if (proxy->priv->name != NULL)
2884     {
2885       destination = g_strdup (get_destination_for_call (proxy));
2886       if (destination == NULL)
2887         {
2888           g_set_error_literal (error,
2889                                G_IO_ERROR,
2890                                G_IO_ERROR_FAILED,
2891                                _("Cannot invoke method; proxy is for a well-known name without an owner and proxy was constructed with the G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag"));
2892           ret = NULL;
2893           G_UNLOCK (properties_lock);
2894           goto out;
2895         }
2896     }
2897
2898   G_UNLOCK (properties_lock);
2899
2900 #ifdef G_OS_UNIX
2901   ret = g_dbus_connection_call_with_unix_fd_list_sync (proxy->priv->connection,
2902                                                        destination,
2903                                                        proxy->priv->object_path,
2904                                                        target_interface_name,
2905                                                        target_method_name,
2906                                                        parameters,
2907                                                        reply_type,
2908                                                        flags,
2909                                                        timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
2910                                                        fd_list,
2911                                                        out_fd_list,
2912                                                        cancellable,
2913                                                        error);
2914 #else
2915   ret = g_dbus_connection_call_sync (proxy->priv->connection,
2916                                      destination,
2917                                      proxy->priv->object_path,
2918                                      target_interface_name,
2919                                      target_method_name,
2920                                      parameters,
2921                                      reply_type,
2922                                      flags,
2923                                      timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
2924                                      cancellable,
2925                                      error);
2926 #endif
2927
2928  out:
2929   if (reply_type != NULL)
2930     g_variant_type_free (reply_type);
2931
2932   g_free (destination);
2933   g_free (split_interface_name);
2934
2935   return ret;
2936 }
2937
2938 /* ---------------------------------------------------------------------------------------------------- */
2939
2940 /**
2941  * g_dbus_proxy_call:
2942  * @proxy: A #GDBusProxy.
2943  * @method_name: Name of method to invoke.
2944  * @parameters: (allow-none): A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
2945  * @flags: Flags from the #GDBusCallFlags enumeration.
2946  * @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
2947  *                "infinite") or -1 to use the proxy default timeout.
2948  * @cancellable: (allow-none): A #GCancellable or %NULL.
2949  * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
2950  * care about the result of the method invocation.
2951  * @user_data: The data to pass to @callback.
2952  *
2953  * Asynchronously invokes the @method_name method on @proxy.
2954  *
2955  * If @method_name contains any dots, then @name is split into interface and
2956  * method name parts. This allows using @proxy for invoking methods on
2957  * other interfaces.
2958  *
2959  * If the #GDBusConnection associated with @proxy is closed then
2960  * the operation will fail with %G_IO_ERROR_CLOSED. If
2961  * @cancellable is canceled, the operation will fail with
2962  * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
2963  * compatible with the D-Bus protocol, the operation fails with
2964  * %G_IO_ERROR_INVALID_ARGUMENT.
2965  *
2966  * If the @parameters #GVariant is floating, it is consumed. This allows
2967  * convenient 'inline' use of g_variant_new(), e.g.:
2968  * |[<!-- language="C" -->
2969  *  g_dbus_proxy_call (proxy,
2970  *                     "TwoStrings",
2971  *                     g_variant_new ("(ss)",
2972  *                                    "Thing One",
2973  *                                    "Thing Two"),
2974  *                     G_DBUS_CALL_FLAGS_NONE,
2975  *                     -1,
2976  *                     NULL,
2977  *                     (GAsyncReadyCallback) two_strings_done,
2978  *                     &data);
2979  * ]|
2980  *
2981  * If @proxy has an expected interface (see
2982  * #GDBusProxy:g-interface-info) and @method_name is referenced by it,
2983  * then the return value is checked against the return type.
2984  *
2985  * This is an asynchronous method. When the operation is finished,
2986  * @callback will be invoked in the
2987  * [thread-default main context][g-main-context-push-thread-default]
2988  * of the thread you are calling this method from.
2989  * You can then call g_dbus_proxy_call_finish() to get the result of
2990  * the operation. See g_dbus_proxy_call_sync() for the synchronous
2991  * version of this method.
2992  *
2993  * If @callback is %NULL then the D-Bus method call message will be sent with
2994  * the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
2995  *
2996  * Since: 2.26
2997  */
2998 void
2999 g_dbus_proxy_call (GDBusProxy          *proxy,
3000                    const gchar         *method_name,
3001                    GVariant            *parameters,
3002                    GDBusCallFlags       flags,
3003                    gint                 timeout_msec,
3004                    GCancellable        *cancellable,
3005                    GAsyncReadyCallback  callback,
3006                    gpointer             user_data)
3007 {
3008   g_dbus_proxy_call_internal (proxy, method_name, parameters, flags, timeout_msec, NULL, cancellable, callback, user_data);
3009 }
3010
3011 /**
3012  * g_dbus_proxy_call_finish:
3013  * @proxy: A #GDBusProxy.
3014  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call().
3015  * @error: Return location for error or %NULL.
3016  *
3017  * Finishes an operation started with g_dbus_proxy_call().
3018  *
3019  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
3020  * return values. Free with g_variant_unref().
3021  *
3022  * Since: 2.26
3023  */
3024 GVariant *
3025 g_dbus_proxy_call_finish (GDBusProxy    *proxy,
3026                           GAsyncResult  *res,
3027                           GError       **error)
3028 {
3029   return g_dbus_proxy_call_finish_internal (proxy, NULL, res, error);
3030 }
3031
3032 /**
3033  * g_dbus_proxy_call_sync:
3034  * @proxy: A #GDBusProxy.
3035  * @method_name: Name of method to invoke.
3036  * @parameters: (allow-none): A #GVariant tuple with parameters for the signal
3037  *              or %NULL if not passing parameters.
3038  * @flags: Flags from the #GDBusCallFlags enumeration.
3039  * @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
3040  *                "infinite") or -1 to use the proxy default timeout.
3041  * @cancellable: (allow-none): A #GCancellable or %NULL.
3042  * @error: Return location for error or %NULL.
3043  *
3044  * Synchronously invokes the @method_name method on @proxy.
3045  *
3046  * If @method_name contains any dots, then @name is split into interface and
3047  * method name parts. This allows using @proxy for invoking methods on
3048  * other interfaces.
3049  *
3050  * If the #GDBusConnection associated with @proxy is disconnected then
3051  * the operation will fail with %G_IO_ERROR_CLOSED. If
3052  * @cancellable is canceled, the operation will fail with
3053  * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
3054  * compatible with the D-Bus protocol, the operation fails with
3055  * %G_IO_ERROR_INVALID_ARGUMENT.
3056  *
3057  * If the @parameters #GVariant is floating, it is consumed. This allows
3058  * convenient 'inline' use of g_variant_new(), e.g.:
3059  * |[<!-- language="C" -->
3060  *  g_dbus_proxy_call_sync (proxy,
3061  *                          "TwoStrings",
3062  *                          g_variant_new ("(ss)",
3063  *                                         "Thing One",
3064  *                                         "Thing Two"),
3065  *                          G_DBUS_CALL_FLAGS_NONE,
3066  *                          -1,
3067  *                          NULL,
3068  *                          &error);
3069  * ]|
3070  *
3071  * The calling thread is blocked until a reply is received. See
3072  * g_dbus_proxy_call() for the asynchronous version of this
3073  * method.
3074  *
3075  * If @proxy has an expected interface (see
3076  * #GDBusProxy:g-interface-info) and @method_name is referenced by it,
3077  * then the return value is checked against the return type.
3078  *
3079  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
3080  * return values. Free with g_variant_unref().
3081  *
3082  * Since: 2.26
3083  */
3084 GVariant *
3085 g_dbus_proxy_call_sync (GDBusProxy      *proxy,
3086                         const gchar     *method_name,
3087                         GVariant        *parameters,
3088                         GDBusCallFlags   flags,
3089                         gint             timeout_msec,
3090                         GCancellable    *cancellable,
3091                         GError         **error)
3092 {
3093   return g_dbus_proxy_call_sync_internal (proxy, method_name, parameters, flags, timeout_msec, NULL, NULL, cancellable, error);
3094 }
3095
3096 /* ---------------------------------------------------------------------------------------------------- */
3097
3098 #ifdef G_OS_UNIX
3099
3100 /**
3101  * g_dbus_proxy_call_with_unix_fd_list:
3102  * @proxy: A #GDBusProxy.
3103  * @method_name: Name of method to invoke.
3104  * @parameters: (allow-none): A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
3105  * @flags: Flags from the #GDBusCallFlags enumeration.
3106  * @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
3107  *                "infinite") or -1 to use the proxy default timeout.
3108  * @fd_list: (allow-none): A #GUnixFDList or %NULL.
3109  * @cancellable: (allow-none): A #GCancellable or %NULL.
3110  * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
3111  * care about the result of the method invocation.
3112  * @user_data: The data to pass to @callback.
3113  *
3114  * Like g_dbus_proxy_call() but also takes a #GUnixFDList object.
3115  *
3116  * This method is only available on UNIX.
3117  *
3118  * Since: 2.30
3119  */
3120 void
3121 g_dbus_proxy_call_with_unix_fd_list (GDBusProxy          *proxy,
3122                                      const gchar         *method_name,
3123                                      GVariant            *parameters,
3124                                      GDBusCallFlags       flags,
3125                                      gint                 timeout_msec,
3126                                      GUnixFDList         *fd_list,
3127                                      GCancellable        *cancellable,
3128                                      GAsyncReadyCallback  callback,
3129                                      gpointer             user_data)
3130 {
3131   g_dbus_proxy_call_internal (proxy, method_name, parameters, flags, timeout_msec, fd_list, cancellable, callback, user_data);
3132 }
3133
3134 /**
3135  * g_dbus_proxy_call_with_unix_fd_list_finish:
3136  * @proxy: A #GDBusProxy.
3137  * @out_fd_list: (out) (allow-none): Return location for a #GUnixFDList or %NULL.
3138  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list().
3139  * @error: Return location for error or %NULL.
3140  *
3141  * Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list().
3142  *
3143  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
3144  * return values. Free with g_variant_unref().
3145  *
3146  * Since: 2.30
3147  */
3148 GVariant *
3149 g_dbus_proxy_call_with_unix_fd_list_finish (GDBusProxy    *proxy,
3150                                             GUnixFDList  **out_fd_list,
3151                                             GAsyncResult  *res,
3152                                             GError       **error)
3153 {
3154   return g_dbus_proxy_call_finish_internal (proxy, out_fd_list, res, error);
3155 }
3156
3157 /**
3158  * g_dbus_proxy_call_with_unix_fd_list_sync:
3159  * @proxy: A #GDBusProxy.
3160  * @method_name: Name of method to invoke.
3161  * @parameters: (allow-none): A #GVariant tuple with parameters for the signal
3162  *              or %NULL if not passing parameters.
3163  * @flags: Flags from the #GDBusCallFlags enumeration.
3164  * @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
3165  *                "infinite") or -1 to use the proxy default timeout.
3166  * @fd_list: (allow-none): A #GUnixFDList or %NULL.
3167  * @out_fd_list: (out) (allow-none): Return location for a #GUnixFDList or %NULL.
3168  * @cancellable: (allow-none): A #GCancellable or %NULL.
3169  * @error: Return location for error or %NULL.
3170  *
3171  * Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects.
3172  *
3173  * This method is only available on UNIX.
3174  *
3175  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
3176  * return values. Free with g_variant_unref().
3177  *
3178  * Since: 2.30
3179  */
3180 GVariant *
3181 g_dbus_proxy_call_with_unix_fd_list_sync (GDBusProxy      *proxy,
3182                                           const gchar     *method_name,
3183                                           GVariant        *parameters,
3184                                           GDBusCallFlags   flags,
3185                                           gint             timeout_msec,
3186                                           GUnixFDList     *fd_list,
3187                                           GUnixFDList    **out_fd_list,
3188                                           GCancellable    *cancellable,
3189                                           GError         **error)
3190 {
3191   return g_dbus_proxy_call_sync_internal (proxy, method_name, parameters, flags, timeout_msec, fd_list, out_fd_list, cancellable, error);
3192 }
3193
3194 #endif /* G_OS_UNIX */
3195
3196 /* ---------------------------------------------------------------------------------------------------- */
3197
3198 static GDBusInterfaceInfo *
3199 _g_dbus_proxy_get_info (GDBusInterface *interface)
3200 {
3201   GDBusProxy *proxy = G_DBUS_PROXY (interface);
3202   return g_dbus_proxy_get_interface_info (proxy);
3203 }
3204
3205 static GDBusObject *
3206 _g_dbus_proxy_get_object (GDBusInterface *interface)
3207 {
3208   GDBusProxy *proxy = G_DBUS_PROXY (interface);
3209   return proxy->priv->object;
3210 }
3211
3212 static GDBusObject *
3213 _g_dbus_proxy_dup_object (GDBusInterface *interface)
3214 {
3215   GDBusProxy *proxy = G_DBUS_PROXY (interface);
3216   GDBusObject *ret = NULL;
3217
3218   G_LOCK (properties_lock);
3219   if (proxy->priv->object != NULL)
3220     ret = g_object_ref (proxy->priv->object);
3221   G_UNLOCK (properties_lock);
3222   return ret;
3223 }
3224
3225 static void
3226 _g_dbus_proxy_set_object (GDBusInterface *interface,
3227                           GDBusObject    *object)
3228 {
3229   GDBusProxy *proxy = G_DBUS_PROXY (interface);
3230   G_LOCK (properties_lock);
3231   if (proxy->priv->object != NULL)
3232     g_object_remove_weak_pointer (G_OBJECT (proxy->priv->object), (gpointer *) &proxy->priv->object);
3233   proxy->priv->object = object;
3234   if (proxy->priv->object != NULL)
3235     g_object_add_weak_pointer (G_OBJECT (proxy->priv->object), (gpointer *) &proxy->priv->object);
3236   G_UNLOCK (properties_lock);
3237 }
3238
3239 static void
3240 dbus_interface_iface_init (GDBusInterfaceIface *dbus_interface_iface)
3241 {
3242   dbus_interface_iface->get_info   = _g_dbus_proxy_get_info;
3243   dbus_interface_iface->get_object = _g_dbus_proxy_get_object;
3244   dbus_interface_iface->dup_object = _g_dbus_proxy_dup_object;
3245   dbus_interface_iface->set_object = _g_dbus_proxy_set_object;
3246 }
3247
3248 /* ---------------------------------------------------------------------------------------------------- */