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, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 #include "gdbusutils.h"
  29 #include "gdbusproxy.h"
  30 #include "gioenumtypes.h"
  31 #include "gdbusconnection.h"
  32 #include "gdbuserror.h"
  33 #include "gdbusprivate.h"
  34 #include "gio-marshal.h"
  35 #include "ginitable.h"
  36 #include "gasyncinitable.h"
  37 #include "gioerror.h"
  38 #include "gasyncresult.h"
  39 #include "gsimpleasyncresult.h"
  40 #include "gcancellable.h"
  41
  42 #include "glibintl.h"
  43
  44 /**
  45  * SECTION:gdbusproxy
  46  * @short_description: Client-side proxies
  47  * @include: gio/gio.h
  48  *
  49  * #GDBusProxy is a base class used for proxies to access a D-Bus
  50  * interface on a remote object. A #GDBusProxy can be constructed for
  51  * both well-known and unique names.
  52  *
  53  * By default, #GDBusProxy will cache all properties (and listen to
  54  * changes) of the remote object, and proxy all signals that gets
  55  * emitted. This behaviour can be changed by passing suitable
  56  * #GDBusProxyFlags when the proxy is created. If the proxy is for a
  57  * well-known name, the property cache is flushed when the name owner
  58  * vanishes and reloaded when a name owner appears.
  59  *
  60  * If a #GDBusProxy is used for a well-known name, the owner of the
  61  * name is tracked and can be read from
  62  * #GDBusProxy:g-name-owner. Connect to the #GObject::notify signal to
  63  * get notified of changes. Additionally, only signals and property
  64  * changes emitted from the current name owner are considered. This
  65  * avoids a number of race conditions when the name is lost by one
  66  * owner and claimed by another.
  67  *
  68  * The generic #GDBusProxy::g-properties-changed and #GDBusProxy::g-signal
  69  * signals are not very convenient to work with. Therefore, the recommended
  70  * way of working with proxies is to subclass #GDBusProxy, and have
  71  * more natural properties and signals in your derived class.
  72  *
  73  * See <xref linkend="gdbus-example-proxy-subclass"/> for an example.
  74  *
  75  * <example id="gdbus-wellknown-proxy"><title>GDBusProxy for a well-known-name</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-watch-proxy.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
  76  */
  77
  78 struct _GDBusProxyPrivate
  79 {
  80   GBusType bus_type;
  81   GDBusConnection *connection;
  82
  83   GDBusProxyFlags flags;
  84   gchar *name;
  85   gchar *name_owner;
  86   gchar *object_path;
  87   gchar *interface_name;
  88   gint timeout_msec;
  89
  90   guint name_owner_changed_subscription_id;
  91
  92   GCancellable *get_all_cancellable;
  93
  94   /* gchar* -> GVariant* */
  95   GHashTable *properties;
  96
  97   GDBusInterfaceInfo *expected_interface;
  98
  99   guint properties_changed_subscriber_id;
 100   guint signals_subscriber_id;
 101
 102   gboolean initialized;
 103 };
 104
 105 enum
 106 {
 107   PROP_0,
 108   PROP_G_CONNECTION,
 109   PROP_G_BUS_TYPE,
 110   PROP_G_NAME,
 111   PROP_G_NAME_OWNER,
 112   PROP_G_FLAGS,
 113   PROP_G_OBJECT_PATH,
 114   PROP_G_INTERFACE_NAME,
 115   PROP_G_DEFAULT_TIMEOUT,
 116   PROP_G_INTERFACE_INFO
 117 };
 118
 119 enum
 120 {
 121   PROPERTIES_CHANGED_SIGNAL,
 122   SIGNAL_SIGNAL,
 123   LAST_SIGNAL,
 124 };
 125
 126 guint signals[LAST_SIGNAL] = {0};
 127
 128 static void initable_iface_init       (GInitableIface *initable_iface);
 129 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
 130
 131 G_DEFINE_TYPE_WITH_CODE (GDBusProxy, g_dbus_proxy, G_TYPE_OBJECT,
 132                          G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
 133                          G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
 134                          );
 135
 136 static void
 137 g_dbus_proxy_finalize (GObject *object)
 138 {
 139   GDBusProxy *proxy = G_DBUS_PROXY (object);
 140
 141   g_warn_if_fail (proxy->priv->get_all_cancellable == NULL);
 142
 143   if (proxy->priv->name_owner_changed_subscription_id > 0)
 144     g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
 145                                           proxy->priv->name_owner_changed_subscription_id);
 146
 147   if (proxy->priv->properties_changed_subscriber_id > 0)
 148     g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
 149                                           proxy->priv->properties_changed_subscriber_id);
 150
 151   if (proxy->priv->signals_subscriber_id > 0)
 152     g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
 153                                           proxy->priv->signals_subscriber_id);
 154
 155   g_object_unref (proxy->priv->connection);
 156   g_free (proxy->priv->name);
 157   g_free (proxy->priv->name_owner);
 158   g_free (proxy->priv->object_path);
 159   g_free (proxy->priv->interface_name);
 160   if (proxy->priv->properties != NULL)
 161     g_hash_table_unref (proxy->priv->properties);
 162
 163   if (proxy->priv->expected_interface != NULL)
 164     g_dbus_interface_info_unref (proxy->priv->expected_interface);
 165
 166   G_OBJECT_CLASS (g_dbus_proxy_parent_class)->finalize (object);
 167 }
 168
 169 static void
 170 g_dbus_proxy_get_property (GObject    *object,
 171                            guint       prop_id,
 172                            GValue     *value,
 173                            GParamSpec *pspec)
 174 {
 175   GDBusProxy *proxy = G_DBUS_PROXY (object);
 176
 177   switch (prop_id)
 178     {
 179     case PROP_G_CONNECTION:
 180       g_value_set_object (value, proxy->priv->connection);
 181       break;
 182
 183     case PROP_G_FLAGS:
 184       g_value_set_flags (value, proxy->priv->flags);
 185       break;
 186
 187     case PROP_G_NAME:
 188       g_value_set_string (value, proxy->priv->name);
 189       break;
 190
 191     case PROP_G_NAME_OWNER:
 192       g_value_set_string (value, proxy->priv->name_owner);
 193       break;
 194
 195     case PROP_G_OBJECT_PATH:
 196       g_value_set_string (value, proxy->priv->object_path);
 197       break;
 198
 199     case PROP_G_INTERFACE_NAME:
 200       g_value_set_string (value, proxy->priv->interface_name);
 201       break;
 202
 203     case PROP_G_DEFAULT_TIMEOUT:
 204       g_value_set_int (value, proxy->priv->timeout_msec);
 205       break;
 206
 207     case PROP_G_INTERFACE_INFO:
 208       g_value_set_boxed (value, g_dbus_proxy_get_interface_info (proxy));
 209       break;
 210
 211     default:
 212       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 213       break;
 214     }
 215 }
 216
 217 static void
 218 g_dbus_proxy_set_property (GObject      *object,
 219                            guint         prop_id,
 220                            const GValue *value,
 221                            GParamSpec   *pspec)
 222 {
 223   GDBusProxy *proxy = G_DBUS_PROXY (object);
 224
 225   switch (prop_id)
 226     {
 227     case PROP_G_CONNECTION:
 228       proxy->priv->connection = g_value_dup_object (value);
 229       break;
 230
 231     case PROP_G_FLAGS:
 232       proxy->priv->flags = g_value_get_flags (value);
 233       break;
 234
 235     case PROP_G_NAME:
 236       proxy->priv->name = g_value_dup_string (value);
 237       break;
 238
 239     case PROP_G_OBJECT_PATH:
 240       proxy->priv->object_path = g_value_dup_string (value);
 241       break;
 242
 243     case PROP_G_INTERFACE_NAME:
 244       proxy->priv->interface_name = g_value_dup_string (value);
 245       break;
 246
 247     case PROP_G_DEFAULT_TIMEOUT:
 248       g_dbus_proxy_set_default_timeout (proxy, g_value_get_int (value));
 249       break;
 250
 251     case PROP_G_INTERFACE_INFO:
 252       g_dbus_proxy_set_interface_info (proxy, g_value_get_boxed (value));
 253       break;
 254
 255     case PROP_G_BUS_TYPE:
 256       proxy->priv->bus_type = g_value_get_enum (value);
 257       break;
 258
 259     default:
 260       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 261       break;
 262     }
 263 }
 264
 265 static void
 266 g_dbus_proxy_class_init (GDBusProxyClass *klass)
 267 {
 268   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 269
 270   gobject_class->finalize     = g_dbus_proxy_finalize;
 271   gobject_class->set_property = g_dbus_proxy_set_property;
 272   gobject_class->get_property = g_dbus_proxy_get_property;
 273
 274   /* Note that all property names are prefixed to avoid collisions with D-Bus property names
 275    * in derived classes */
 276
 277   /**
 278    * GDBusProxy:g-interface-info:
 279    *
 280    * Ensure that interactions with this proxy conform to the given
 281    * interface.  For example, when completing a method call, if the
 282    * type signature of the message isn't what's expected, the given
 283    * #GError is set.  Signals that have a type signature mismatch are
 284    * simply dropped.
 285    *
 286    * Since: 2.26
 287    */
 288   g_object_class_install_property (gobject_class,
 289                                    PROP_G_INTERFACE_INFO,
 290                                    g_param_spec_boxed ("g-interface-info",
 291                                                        P_("Interface Information"),
 292                                                        P_("Interface Information"),
 293                                                        G_TYPE_DBUS_INTERFACE_INFO,
 294                                                        G_PARAM_READABLE |
 295                                                        G_PARAM_WRITABLE |
 296                                                        G_PARAM_STATIC_NAME |
 297                                                        G_PARAM_STATIC_BLURB |
 298                                                        G_PARAM_STATIC_NICK));
 299
 300   /**
 301    * GDBusProxy:g-connection:
 302    *
 303    * The #GDBusConnection the proxy is for.
 304    *
 305    * Since: 2.26
 306    */
 307   g_object_class_install_property (gobject_class,
 308                                    PROP_G_CONNECTION,
 309                                    g_param_spec_object ("g-connection",
 310                                                         P_("g-connection"),
 311                                                         P_("The connection the proxy is for"),
 312                                                         G_TYPE_DBUS_CONNECTION,
 313                                                         G_PARAM_READABLE |
 314                                                         G_PARAM_WRITABLE |
 315                                                         G_PARAM_CONSTRUCT_ONLY |
 316                                                         G_PARAM_STATIC_NAME |
 317                                                         G_PARAM_STATIC_BLURB |
 318                                                         G_PARAM_STATIC_NICK));
 319
 320   /**
 321    * GDBusProxy:g-bus-type:
 322    *
 323    * If this property is not %G_BUS_TYPE_NONE, then
 324    * #GDBusProxy:g-connection must be %NULL and will be set to the
 325    * #GDBusConnection obtained by calling g_bus_get() with the value
 326    * of this property.
 327    *
 328    * Since: 2.26
 329    */
 330   g_object_class_install_property (gobject_class,
 331                                    PROP_G_BUS_TYPE,
 332                                    g_param_spec_enum ("g-bus-type",
 333                                                       P_("Bus Type"),
 334                                                       P_("The bus to connect to, if any"),
 335                                                       G_TYPE_BUS_TYPE,
 336                                                       G_BUS_TYPE_NONE,
 337                                                       G_PARAM_WRITABLE |
 338                                                       G_PARAM_CONSTRUCT_ONLY |
 339                                                       G_PARAM_STATIC_NAME |
 340                                                       G_PARAM_STATIC_BLURB |
 341                                                       G_PARAM_STATIC_NICK));
 342
 343   /**
 344    * GDBusProxy:g-flags:
 345    *
 346    * Flags from the #GDBusProxyFlags enumeration.
 347    *
 348    * Since: 2.26
 349    */
 350   g_object_class_install_property (gobject_class,
 351                                    PROP_G_FLAGS,
 352                                    g_param_spec_flags ("g-flags",
 353                                                        P_("g-flags"),
 354                                                        P_("Flags for the proxy"),
 355                                                        G_TYPE_DBUS_PROXY_FLAGS,
 356                                                        G_DBUS_PROXY_FLAGS_NONE,
 357                                                        G_PARAM_READABLE |
 358                                                        G_PARAM_WRITABLE |
 359                                                        G_PARAM_CONSTRUCT_ONLY |
 360                                                        G_PARAM_STATIC_NAME |
 361                                                        G_PARAM_STATIC_BLURB |
 362                                                        G_PARAM_STATIC_NICK));
 363
 364   /**
 365    * GDBusProxy:g-name:
 366    *
 367    * The well-known or unique name that the proxy is for.
 368    *
 369    * Since: 2.26
 370    */
 371   g_object_class_install_property (gobject_class,
 372                                    PROP_G_NAME,
 373                                    g_param_spec_string ("g-name",
 374                                                         P_("g-name"),
 375                                                         P_("The well-known or unique name that the proxy is for"),
 376                                                         NULL,
 377                                                         G_PARAM_READABLE |
 378                                                         G_PARAM_WRITABLE |
 379                                                         G_PARAM_CONSTRUCT_ONLY |
 380                                                         G_PARAM_STATIC_NAME |
 381                                                         G_PARAM_STATIC_BLURB |
 382                                                         G_PARAM_STATIC_NICK));
 383
 384   /**
 385    * GDBusProxy:g-name-owner:
 386    *
 387    * The unique name that owns #GDBusProxy:name or %NULL if no-one
 388    * currently owns that name. You may connect to #GObject::notify signal to
 389    * track changes to this property.
 390    *
 391    * Since: 2.26
 392    */
 393   g_object_class_install_property (gobject_class,
 394                                    PROP_G_NAME_OWNER,
 395                                    g_param_spec_string ("g-name-owner",
 396                                                         P_("g-name-owner"),
 397                                                         P_("The unique name for the owner"),
 398                                                         NULL,
 399                                                         G_PARAM_READABLE |
 400                                                         G_PARAM_STATIC_NAME |
 401                                                         G_PARAM_STATIC_BLURB |
 402                                                         G_PARAM_STATIC_NICK));
 403
 404   /**
 405    * GDBusProxy:g-object-path:
 406    *
 407    * The object path the proxy is for.
 408    *
 409    * Since: 2.26
 410    */
 411   g_object_class_install_property (gobject_class,
 412                                    PROP_G_OBJECT_PATH,
 413                                    g_param_spec_string ("g-object-path",
 414                                                         P_("g-object-path"),
 415                                                         P_("The object path the proxy is for"),
 416                                                         NULL,
 417                                                         G_PARAM_READABLE |
 418                                                         G_PARAM_WRITABLE |
 419                                                         G_PARAM_CONSTRUCT_ONLY |
 420                                                         G_PARAM_STATIC_NAME |
 421                                                         G_PARAM_STATIC_BLURB |
 422                                                         G_PARAM_STATIC_NICK));
 423
 424   /**
 425    * GDBusProxy:g-interface-name:
 426    *
 427    * The D-Bus interface name the proxy is for.
 428    *
 429    * Since: 2.26
 430    */
 431   g_object_class_install_property (gobject_class,
 432                                    PROP_G_INTERFACE_NAME,
 433                                    g_param_spec_string ("g-interface-name",
 434                                                         P_("g-interface-name"),
 435                                                         P_("The D-Bus interface name the proxy is for"),
 436                                                         NULL,
 437                                                         G_PARAM_READABLE |
 438                                                         G_PARAM_WRITABLE |
 439                                                         G_PARAM_CONSTRUCT_ONLY |
 440                                                         G_PARAM_STATIC_NAME |
 441                                                         G_PARAM_STATIC_BLURB |
 442                                                         G_PARAM_STATIC_NICK));
 443
 444   /**
 445    * GDBusProxy:g-default-timeout:
 446    *
 447    * The timeout to use if -1 (specifying default timeout) is passed
 448    * as @timeout_msec in the g_dbus_proxy_call() and
 449    * g_dbus_proxy_call_sync() functions.
 450    *
 451    * This allows applications to set a proxy-wide timeout for all
 452    * remote method invocations on the proxy. If this property is -1,
 453    * the default timeout (typically 25 seconds) is used. If set to
 454    * %G_MAXINT, then no timeout is used.
 455    *
 456    * Since: 2.26
 457    */
 458   g_object_class_install_property (gobject_class,
 459                                    PROP_G_DEFAULT_TIMEOUT,
 460                                    g_param_spec_int ("g-default-timeout",
 461                                                      P_("Default Timeout"),
 462                                                      P_("Timeout for remote method invocation"),
 463                                                      -1,
 464                                                      G_MAXINT,
 465                                                      -1,
 466                                                      G_PARAM_READABLE |
 467                                                      G_PARAM_WRITABLE |
 468                                                      G_PARAM_CONSTRUCT |
 469                                                      G_PARAM_STATIC_NAME |
 470                                                      G_PARAM_STATIC_BLURB |
 471                                                      G_PARAM_STATIC_NICK));
 472
 473   /**
 474    * GDBusProxy::g-properties-changed:
 475    * @proxy: The #GDBusProxy emitting the signal.
 476    * @changed_properties: A #GVariant containing the properties that changed
 477    * @invalidated_properties: A %NULL terminated array of properties that was invalidated
 478    *
 479    * Emitted when one or more D-Bus properties on @proxy changes. The
 480    * local cache has already been updated when this signal fires. Note
 481    * that both @changed_properties and @invalidated_properties are
 482    * guaranteed to never be %NULL (either may be empty though).
 483    *
 484    * This signal corresponds to the
 485    * <literal>PropertiesChanged</literal> D-Bus signal on the
 486    * <literal>org.freedesktop.DBus.Properties</literal> interface.
 487    *
 488    * Since: 2.26
 489    */
 490   signals[PROPERTIES_CHANGED_SIGNAL] = g_signal_new ("g-properties-changed",
 491                                                      G_TYPE_DBUS_PROXY,
 492                                                      G_SIGNAL_RUN_LAST,
 493                                                      G_STRUCT_OFFSET (GDBusProxyClass, g_properties_changed),
 494                                                      NULL,
 495                                                      NULL,
 496                                                      _gio_marshal_VOID__VARIANT_BOXED,
 497                                                      G_TYPE_NONE,
 498                                                      2,
 499                                                      G_TYPE_VARIANT,
 500                                                      G_TYPE_STRV | G_SIGNAL_TYPE_STATIC_SCOPE);
 501
 502   /**
 503    * GDBusProxy::g-signal:
 504    * @proxy: The #GDBusProxy emitting the signal.
 505    * @sender_name: The sender of the signal or %NULL if the connection is not a bus connection.
 506    * @signal_name: The name of the signal.
 507    * @parameters: A #GVariant tuple with parameters for the signal.
 508    *
 509    * Emitted when a signal from the remote object and interface that @proxy is for, has been received.
 510    *
 511    * Since: 2.26
 512    */
 513   signals[SIGNAL_SIGNAL] = g_signal_new ("g-signal",
 514                                          G_TYPE_DBUS_PROXY,
 515                                          G_SIGNAL_RUN_LAST,
 516                                          G_STRUCT_OFFSET (GDBusProxyClass, g_signal),
 517                                          NULL,
 518                                          NULL,
 519                                          _gio_marshal_VOID__STRING_STRING_VARIANT,
 520                                          G_TYPE_NONE,
 521                                          3,
 522                                          G_TYPE_STRING,
 523                                          G_TYPE_STRING,
 524                                          G_TYPE_VARIANT);
 525
 526
 527   g_type_class_add_private (klass, sizeof (GDBusProxyPrivate));
 528 }
 529
 530 static void
 531 g_dbus_proxy_init (GDBusProxy *proxy)
 532 {
 533   proxy->priv = G_TYPE_INSTANCE_GET_PRIVATE (proxy, G_TYPE_DBUS_PROXY, GDBusProxyPrivate);
 534   proxy->priv->properties = g_hash_table_new_full (g_str_hash,
 535                                                    g_str_equal,
 536                                                    g_free,
 537                                                    (GDestroyNotify) g_variant_unref);
 538 }
 539
 540 /* ---------------------------------------------------------------------------------------------------- */
 541
 542 static gint
 543 property_name_sort_func (const gchar **a,
 544                          const gchar **b)
 545 {
 546   return g_strcmp0 (*a, *b);
 547 }
 548
 549 /**
 550  * g_dbus_proxy_get_cached_property_names:
 551  * @proxy: A #GDBusProxy.
 552  *
 553  * Gets the names of all cached properties on @proxy.
 554  *
 555  * Returns: A %NULL-terminated array of strings or %NULL if @proxy has
 556  * no cached properties. Free the returned array with g_strfreev().
 557  *
 558  * Since: 2.26
 559  */
 560 gchar **
 561 g_dbus_proxy_get_cached_property_names (GDBusProxy  *proxy)
 562 {
 563   gchar **names;
 564   GPtrArray *p;
 565   GHashTableIter iter;
 566   const gchar *key;
 567
 568   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
 569
 570   names = NULL;
 571   if (g_hash_table_size (proxy->priv->properties) == 0)
 572     goto out;
 573
 574   p = g_ptr_array_new ();
 575
 576   g_hash_table_iter_init (&iter, proxy->priv->properties);
 577   while (g_hash_table_iter_next (&iter, (gpointer) &key, NULL))
 578     g_ptr_array_add (p, g_strdup (key));
 579   g_ptr_array_sort (p, (GCompareFunc) property_name_sort_func);
 580   g_ptr_array_add (p, NULL);
 581
 582   names = (gchar **) g_ptr_array_free (p, FALSE);
 583
 584  out:
 585   return names;
 586 }
 587
 588 static const GDBusPropertyInfo *
 589 lookup_property_info_or_warn (GDBusProxy  *proxy,
 590                               const gchar *property_name)
 591 {
 592   const GDBusPropertyInfo *info;
 593
 594   if (proxy->priv->expected_interface == NULL)
 595     return NULL;
 596
 597   info = g_dbus_interface_info_lookup_property (proxy->priv->expected_interface, property_name);
 598   if (info == NULL)
 599     {
 600       g_warning ("Trying to lookup property %s which isn't in expected interface %s",
 601                  property_name,
 602                  proxy->priv->expected_interface->name);
 603     }
 604
 605   return info;
 606 }
 607
 608 /**
 609  * g_dbus_proxy_get_cached_property:
 610  * @proxy: A #GDBusProxy.
 611  * @property_name: Property name.
 612  *
 613  * Looks up the value for a property from the cache. This call does no
 614  * blocking IO.
 615  *
 616  * If @proxy has an expected interface (see
 617  * #GDBusProxy:g-interface-info), then @property_name (for existence)
 618  * is checked against it.
 619  *
 620  * Returns: A reference to the #GVariant instance that holds the value
 621  * for @property_name or %NULL if the value is not in the cache. The
 622  * returned reference must be freed with g_variant_unref().
 623  *
 624  * Since: 2.26
 625  */
 626 GVariant *
 627 g_dbus_proxy_get_cached_property (GDBusProxy   *proxy,
 628                                   const gchar  *property_name)
 629 {
 630   GVariant *value;
 631
 632   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
 633   g_return_val_if_fail (property_name != NULL, NULL);
 634
 635   value = g_hash_table_lookup (proxy->priv->properties, property_name);
 636   if (value == NULL)
 637     {
 638       const GDBusPropertyInfo *info;
 639       info = lookup_property_info_or_warn (proxy, property_name);
 640       /* no difference */
 641       goto out;
 642     }
 643
 644   g_variant_ref (value);
 645
 646  out:
 647   return value;
 648 }
 649
 650 /**
 651  * g_dbus_proxy_set_cached_property:
 652  * @proxy: A #GDBusProxy
 653  * @property_name: Property name.
 654  * @value: Value for the property or %NULL to remove it from the cache.
 655  *
 656  * If @value is not %NULL, sets the cached value for the property with
 657  * name @property_name to the value in @value.
 658  *
 659  * If @value is %NULL, then the cached value is removed from the
 660  * property cache.
 661  *
 662  * If @proxy has an expected interface (see
 663  * #GDBusProxy:g-interface-info), then @property_name (for existence)
 664  * and @value (for the type) is checked against it.
 665  *
 666  * If the @value #GVariant is floating, it is consumed. This allows
 667  * convenient 'inline' use of g_variant_new(), e.g.
 668  * |[
 669  *  g_dbus_proxy_set_cached_property (proxy,
 670  *                                    "SomeProperty",
 671  *                                    g_variant_new ("(si)",
 672  *                                                  "A String",
 673  *                                                  42));
 674  * ]|
 675  *
 676  * Normally you will not need to use this method since @proxy is
 677  * tracking changes using the
 678  * <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
 679  * D-Bus signal. However, for performance reasons an object may decide
 680  * to not use this signal for some properties and instead use a
 681  * proprietary out-of-band mechanism to transmit changes.
 682  *
 683  * As a concrete example, consider an object with a property
 684  * <literal>ChatroomParticipants</literal> which is an array of
 685  * strings. Instead of transmitting the same (long) array every time
 686  * the property changes, it is more efficient to only transmit the
 687  * delta using e.g. signals <literal>ChatroomParticipantJoined(String
 688  * name)</literal> and <literal>ChatroomParticipantParted(String
 689  * name)</literal>.
 690  *
 691  * Since: 2.26
 692  */
 693 void
 694 g_dbus_proxy_set_cached_property (GDBusProxy   *proxy,
 695                                   const gchar  *property_name,
 696                                   GVariant     *value)
 697 {
 698   const GDBusPropertyInfo *info;
 699
 700   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
 701   g_return_if_fail (property_name != NULL);
 702
 703   if (value != NULL)
 704     {
 705       info = lookup_property_info_or_warn (proxy, property_name);
 706       if (info != NULL)
 707         {
 708           if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
 709             {
 710               g_warning (_("Trying to set property %s of type %s but according to the expected "
 711                            "interface the type is %s"),
 712                          property_name,
 713                          g_variant_get_type_string (value),
 714                          info->signature);
 715               goto out;
 716             }
 717         }
 718       g_hash_table_insert (proxy->priv->properties,
 719                            g_strdup (property_name),
 720                            g_variant_ref_sink (value));
 721     }
 722   else
 723     {
 724       g_hash_table_remove (proxy->priv->properties, property_name);
 725     }
 726
 727  out:
 728   ;
 729 }
 730
 731 /* ---------------------------------------------------------------------------------------------------- */
 732
 733 static void
 734 on_signal_received (GDBusConnection *connection,
 735                     const gchar     *sender_name,
 736                     const gchar     *object_path,
 737                     const gchar     *interface_name,
 738                     const gchar     *signal_name,
 739                     GVariant        *parameters,
 740                     gpointer         user_data)
 741 {
 742   GDBusProxy *proxy = G_DBUS_PROXY (user_data);
 743
 744   if (!proxy->priv->initialized)
 745     goto out;
 746
 747   if (proxy->priv->name_owner != NULL && g_strcmp0 (sender_name, proxy->priv->name_owner) != 0)
 748     goto out;
 749
 750   g_signal_emit (proxy,
 751                  signals[SIGNAL_SIGNAL],
 752                  0,
 753                  sender_name,
 754                  signal_name,
 755                  parameters);
 756  out:
 757   ;
 758 }
 759
 760 /* ---------------------------------------------------------------------------------------------------- */
 761
 762 static void
 763 on_properties_changed (GDBusConnection *connection,
 764                        const gchar     *sender_name,
 765                        const gchar     *object_path,
 766                        const gchar     *interface_name,
 767                        const gchar     *signal_name,
 768                        GVariant        *parameters,
 769                        gpointer         user_data)
 770 {
 771   GDBusProxy *proxy = G_DBUS_PROXY (user_data);
 772   GError *error;
 773   const gchar *interface_name_for_signal;
 774   GVariant *changed_properties;
 775   gchar **invalidated_properties;
 776   GVariantIter iter;
 777   gchar *key;
 778   GVariant *value;
 779   guint n;
 780
 781   error = NULL;
 782   changed_properties = NULL;
 783   invalidated_properties = NULL;
 784
 785   if (!proxy->priv->initialized)
 786     goto out;
 787
 788   if (proxy->priv->name_owner != NULL && g_strcmp0 (sender_name, proxy->priv->name_owner) != 0)
 789     goto out;
 790
 791   if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(sa{sv}as)")))
 792     {
 793       g_warning ("Value for PropertiesChanged signal with type `%s' does not match `(sa{sv}as)'",
 794                  g_variant_get_type_string (parameters));
 795       goto out;
 796     }
 797
 798   g_variant_get (parameters,
 799                  "(&s@a{sv}^a&s)",
 800                  &interface_name_for_signal,
 801                  &changed_properties,
 802                  &invalidated_properties);
 803
 804   if (g_strcmp0 (interface_name_for_signal, proxy->priv->interface_name) != 0)
 805     goto out;
 806
 807   g_variant_iter_init (&iter, changed_properties);
 808   while (g_variant_iter_next (&iter, "{sv}", &key, &value))
 809     {
 810       g_hash_table_insert (proxy->priv->properties,
 811                            key, /* adopts string */
 812                            value); /* adopts value */
 813     }
 814
 815   for (n = 0; invalidated_properties[n] != NULL; n++)
 816     {
 817       g_hash_table_remove (proxy->priv->properties, invalidated_properties[n]);
 818     }
 819
 820   /* emit signal */
 821   g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
 822                  0,
 823                  changed_properties,
 824                  invalidated_properties);
 825
 826  out:
 827   if (changed_properties != NULL)
 828     g_variant_unref (changed_properties);
 829   g_free (invalidated_properties);
 830 }
 831
 832 /* ---------------------------------------------------------------------------------------------------- */
 833
 834 static void
 835 process_get_all_reply (GDBusProxy *proxy,
 836                        GVariant   *result)
 837 {
 838   GVariantIter *iter;
 839   gchar *key;
 840   GVariant *value;
 841
 842   if (!g_variant_is_of_type (result, G_VARIANT_TYPE ("(a{sv})")))
 843     {
 844       g_warning ("Value for GetAll reply with type `%s' does not match `(a{sv})'",
 845                  g_variant_get_type_string (result));
 846       goto out;
 847     }
 848
 849   g_variant_get (result, "(a{sv})", &iter);
 850   while (g_variant_iter_next (iter, "{sv}", &key, &value))
 851     {
 852       g_hash_table_insert (proxy->priv->properties,
 853                            key, /* adopts string */
 854                            value); /* adopts value */
 855     }
 856   g_variant_iter_free (iter);
 857
 858   /* Synthesize ::g-properties-changed changed */
 859   if (g_hash_table_size (proxy->priv->properties) > 0)
 860     {
 861       GVariant *changed_properties;
 862       const gchar *invalidated_properties[1] = {NULL};
 863
 864       g_variant_get (result,
 865                      "(@a{sv})",
 866                      &changed_properties);
 867       g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
 868                      0,
 869                      changed_properties,
 870                      invalidated_properties);
 871       g_variant_unref (changed_properties);
 872     }
 873
 874  out:
 875   ;
 876 }
 877
 878 typedef struct
 879 {
 880   GDBusProxy *proxy;
 881   GCancellable *cancellable;
 882   gchar *name_owner;
 883 } LoadPropertiesOnNameOwnerChangedData;
 884
 885 static void
 886 on_name_owner_changed_get_all_cb (GDBusConnection *connection,
 887                                   GAsyncResult    *res,
 888                                   gpointer         user_data)
 889 {
 890   LoadPropertiesOnNameOwnerChangedData *data = user_data;
 891   GVariant *result;
 892   GError *error;
 893   gboolean cancelled;
 894
 895   cancelled = FALSE;
 896
 897   error = NULL;
 898   result = g_dbus_connection_call_finish (connection,
 899                                           res,
 900                                           &error);
 901   if (result == NULL)
 902     {
 903       if (error->domain == G_IO_ERROR && error->code == G_IO_ERROR_CANCELLED)
 904         cancelled = TRUE;
 905       /* We just ignore if GetAll() is failing. Because this might happen
 906        * if the object has no properties at all. Or if the caller is
 907        * not authorized to see the properties.
 908        *
 909        * Either way, apps can know about this by using
 910        * get_cached_property_names() or get_cached_property().
 911        *
 912        * TODO: handle G_DBUS_DEBUG flag 'proxy' and, if enabled, log the
 913        * fact that GetAll() failed
 914        */
 915       //g_debug ("error: %d %d %s", error->domain, error->code, error->message);
 916       g_error_free (error);
 917     }
 918
 919   /* and finally we can notify */
 920   if (!cancelled)
 921     {
 922       g_free (data->proxy->priv->name_owner);
 923       data->proxy->priv->name_owner = data->name_owner;
 924       data->name_owner = NULL; /* to avoid an extra copy, we steal the string */
 925
 926       g_hash_table_remove_all (data->proxy->priv->properties);
 927       if (result != NULL)
 928         {
 929           process_get_all_reply (data->proxy, result);
 930           g_variant_unref (result);
 931         }
 932
 933       g_object_notify (G_OBJECT (data->proxy), "g-name-owner");
 934     }
 935
 936   if (data->cancellable == data->proxy->priv->get_all_cancellable)
 937     data->proxy->priv->get_all_cancellable = NULL;
 938
 939   g_object_unref (data->proxy);
 940   g_object_unref (data->cancellable);
 941   g_free (data->name_owner);
 942   g_free (data);
 943 }
 944
 945 static void
 946 on_name_owner_changed (GDBusConnection *connection,
 947                        const gchar      *sender_name,
 948                        const gchar      *object_path,
 949                        const gchar      *interface_name,
 950                        const gchar      *signal_name,
 951                        GVariant         *parameters,
 952                        gpointer          user_data)
 953 {
 954   GDBusProxy *proxy = G_DBUS_PROXY (user_data);
 955   const gchar *old_owner;
 956   const gchar *new_owner;
 957
 958   /* if we are already trying to load properties, cancel that */
 959   if (proxy->priv->get_all_cancellable != NULL)
 960     {
 961       g_cancellable_cancel (proxy->priv->get_all_cancellable);
 962       proxy->priv->get_all_cancellable = NULL;
 963     }
 964
 965   g_variant_get (parameters,
 966                  "(&s&s&s)",
 967                  NULL,
 968                  &old_owner,
 969                  &new_owner);
 970
 971   if (strlen (new_owner) == 0)
 972     {
 973       g_free (proxy->priv->name_owner);
 974       proxy->priv->name_owner = NULL;
 975
 976       /* Synthesize ::g-properties-changed changed */
 977       if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES) &&
 978           g_hash_table_size (proxy->priv->properties) > 0)
 979         {
 980           GVariantBuilder builder;
 981           GVariant *changed_properties;
 982           GPtrArray *invalidated_properties;
 983           GHashTableIter iter;
 984           const gchar *key;
 985
 986           /* Build changed_properties (always empty) and invalidated_properties ... */
 987           g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));
 988           changed_properties = g_variant_builder_end (&builder);
 989           invalidated_properties = g_ptr_array_new_with_free_func (g_free);
 990           g_hash_table_iter_init (&iter, proxy->priv->properties);
 991           while (g_hash_table_iter_next (&iter, (gpointer) &key, NULL))
 992             g_ptr_array_add (invalidated_properties, g_strdup (key));
 993           g_ptr_array_add (invalidated_properties, NULL);
 994
 995           /* ... throw out the properties ... */
 996           g_hash_table_remove_all (proxy->priv->properties);
 997
 998           /* ... and finally emit the ::g-properties-changed signal */
 999           g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
1000                          0,
1001                          changed_properties,
1002                          (const gchar* const *) invalidated_properties->pdata);
1003           g_variant_unref (changed_properties);
1004           g_ptr_array_unref (invalidated_properties);
1005         }
1006       g_object_notify (G_OBJECT (proxy), "g-name-owner");
1007     }
1008   else
1009     {
1010       /* ignore duplicates - this can happen when activating the service */
1011       if (g_strcmp0 (new_owner, proxy->priv->name_owner) == 0)
1012         goto out;
1013
1014       if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES)
1015         {
1016           g_free (proxy->priv->name_owner);
1017           proxy->priv->name_owner = g_strdup (new_owner);
1018           g_hash_table_remove_all (proxy->priv->properties);
1019           g_object_notify (G_OBJECT (proxy), "g-name-owner");
1020         }
1021       else
1022         {
1023           LoadPropertiesOnNameOwnerChangedData *data;
1024
1025           /* start loading properties.. only then emit notify::g-name-owner .. we
1026            * need to be able to cancel this in the event another NameOwnerChanged
1027            * signal suddenly happens
1028            */
1029
1030           g_assert (proxy->priv->get_all_cancellable == NULL);
1031           proxy->priv->get_all_cancellable = g_cancellable_new ();
1032           data = g_new0 (LoadPropertiesOnNameOwnerChangedData, 1);
1033           data->proxy = g_object_ref (proxy);
1034           data->cancellable = proxy->priv->get_all_cancellable;
1035           data->name_owner = g_strdup (new_owner);
1036           g_dbus_connection_call (proxy->priv->connection,
1037                                   data->name_owner,
1038                                   proxy->priv->object_path,
1039                                   "org.freedesktop.DBus.Properties",
1040                                   "GetAll",
1041                                   g_variant_new ("(s)", proxy->priv->interface_name),
1042                                   G_VARIANT_TYPE ("(a{sv})"),
1043                                   G_DBUS_CALL_FLAGS_NONE,
1044                                   -1,           /* timeout */
1045                                   proxy->priv->get_all_cancellable,
1046                                   (GAsyncReadyCallback) on_name_owner_changed_get_all_cb,
1047                                   data);
1048         }
1049     }
1050
1051  out:
1052   ;
1053 }
1054
1055 /* ---------------------------------------------------------------------------------------------------- */
1056
1057 typedef struct
1058 {
1059   GDBusProxy *proxy;
1060   GCancellable *cancellable;
1061   GSimpleAsyncResult *simple;
1062 } AsyncInitData;
1063
1064 static void
1065 async_init_data_free (AsyncInitData *data)
1066 {
1067   g_object_unref (data->proxy);
1068   if (data->cancellable != NULL)
1069     g_object_unref (data->cancellable);
1070   g_object_unref (data->simple);
1071   g_free (data);
1072 }
1073
1074 static void
1075 async_init_get_all_cb (GDBusConnection *connection,
1076                        GAsyncResult    *res,
1077                        gpointer         user_data)
1078 {
1079   AsyncInitData *data = user_data;
1080   GVariant *result;
1081   GError *error;
1082
1083   error = NULL;
1084   result = g_dbus_connection_call_finish (connection,
1085                                           res,
1086                                           &error);
1087   if (result == NULL)
1088     {
1089       /* We just ignore if GetAll() is failing. Because this might happen
1090        * if the object has no properties at all. Or if the caller is
1091        * not authorized to see the properties.
1092        *
1093        * Either way, apps can know about this by using
1094        * get_cached_property_names() or get_cached_property().
1095        *
1096        * TODO: handle G_DBUS_DEBUG flag 'proxy' and, if enabled, log the
1097        * fact that GetAll() failed
1098        */
1099       //g_debug ("error: %d %d %s", error->domain, error->code, error->message);
1100       g_error_free (error);
1101     }
1102   else
1103     {
1104       g_simple_async_result_set_op_res_gpointer (data->simple,
1105                                                  result,
1106                                                  (GDestroyNotify) g_variant_unref);
1107     }
1108
1109   g_simple_async_result_complete_in_idle (data->simple);
1110   async_init_data_free (data);
1111 }
1112
1113
1114 static void
1115 async_init_get_name_owner_cb (GDBusConnection *connection,
1116                               GAsyncResult    *res,
1117                               gpointer         user_data)
1118 {
1119   AsyncInitData *data = user_data;
1120
1121   if (res != NULL)
1122     {
1123       GError *error;
1124       GVariant *result;
1125
1126       error = NULL;
1127       result = g_dbus_connection_call_finish (connection,
1128                                               res,
1129                                               &error);
1130       if (result == NULL)
1131         {
1132           if (error->domain == G_DBUS_ERROR &&
1133               error->code == G_DBUS_ERROR_NAME_HAS_NO_OWNER)
1134             {
1135               g_error_free (error);
1136             }
1137           else
1138             {
1139               g_simple_async_result_set_from_error (data->simple, error);
1140               g_error_free (error);
1141               g_simple_async_result_complete_in_idle (data->simple);
1142               async_init_data_free (data);
1143               goto out;
1144             }
1145         }
1146       else
1147         {
1148           g_variant_get (result,
1149                          "(s)",
1150                          &data->proxy->priv->name_owner);
1151           g_variant_unref (result);
1152         }
1153     }
1154
1155   if (!(data->proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
1156     {
1157       /* load all properties asynchronously */
1158       g_dbus_connection_call (data->proxy->priv->connection,
1159                               data->proxy->priv->name_owner,
1160                               data->proxy->priv->object_path,
1161                               "org.freedesktop.DBus.Properties",
1162                               "GetAll",
1163                               g_variant_new ("(s)", data->proxy->priv->interface_name),
1164                               G_VARIANT_TYPE ("(a{sv})"),
1165                               G_DBUS_CALL_FLAGS_NONE,
1166                               -1,           /* timeout */
1167                               data->cancellable,
1168                               (GAsyncReadyCallback) async_init_get_all_cb,
1169                               data);
1170     }
1171   else
1172     {
1173       g_simple_async_result_complete_in_idle (data->simple);
1174       async_init_data_free (data);
1175     }
1176
1177  out:
1178   ;
1179 }
1180
1181 static void
1182 async_init_call_get_name_owner (AsyncInitData *data)
1183 {
1184   g_dbus_connection_call (data->proxy->priv->connection,
1185                           "org.freedesktop.DBus",  /* name */
1186                           "/org/freedesktop/DBus", /* object path */
1187                           "org.freedesktop.DBus",  /* interface */
1188                           "GetNameOwner",
1189                           g_variant_new ("(s)",
1190                                          data->proxy->priv->name),
1191                           G_VARIANT_TYPE ("(s)"),
1192                           G_DBUS_CALL_FLAGS_NONE,
1193                           -1,           /* timeout */
1194                           data->cancellable,
1195                           (GAsyncReadyCallback) async_init_get_name_owner_cb,
1196                           data);
1197 }
1198
1199 static void
1200 async_init_start_service_by_name_cb (GDBusConnection *connection,
1201                                      GAsyncResult    *res,
1202                                      gpointer         user_data)
1203 {
1204   AsyncInitData *data = user_data;
1205   GError *error;
1206   GVariant *result;
1207
1208   error = NULL;
1209   result = g_dbus_connection_call_finish (connection,
1210                                           res,
1211                                           &error);
1212   if (result == NULL)
1213     {
1214       /* Errors are not unexpected; the bus will reply e.g.
1215        *
1216        *   org.freedesktop.DBus.Error.ServiceUnknown: The name org.gnome.Epiphany2
1217        *   was not provided by any .service files
1218        *
1219        * This doesn't mean that the name doesn't have an owner, just
1220        * that it's not provided by a .service file. So just proceed to
1221        * invoke GetNameOwner() if dealing with that error.
1222        */
1223       if (error->domain == G_DBUS_ERROR &&
1224           error->code == G_DBUS_ERROR_SERVICE_UNKNOWN)
1225         {
1226           g_error_free (error);
1227         }
1228       else
1229         {
1230           g_prefix_error (&error,
1231                           _("Error calling StartServiceByName for %s: "),
1232                           data->proxy->priv->name);
1233           goto failed;
1234         }
1235     }
1236   else
1237     {
1238       guint32 start_service_result;
1239       g_variant_get (result,
1240                      "(u)",
1241                      &start_service_result);
1242       g_variant_unref (result);
1243       if (start_service_result == 1 ||  /* DBUS_START_REPLY_SUCCESS */
1244           start_service_result == 2)    /* DBUS_START_REPLY_ALREADY_RUNNING */
1245         {
1246           /* continue to invoke GetNameOwner() */
1247         }
1248       else
1249         {
1250           error = g_error_new (G_IO_ERROR,
1251                                G_IO_ERROR_FAILED,
1252                                _("Unexpected reply %d from StartServiceByName(\"%s\") method"),
1253                                start_service_result,
1254                                data->proxy->priv->name);
1255           goto failed;
1256         }
1257     }
1258
1259   async_init_call_get_name_owner (data);
1260   return;
1261
1262  failed:
1263   g_warn_if_fail (error != NULL);
1264   g_simple_async_result_set_from_error (data->simple, error);
1265   g_error_free (error);
1266   g_simple_async_result_complete_in_idle (data->simple);
1267   async_init_data_free (data);
1268 }
1269
1270 static void
1271 async_init_call_start_service_by_name (AsyncInitData *data)
1272 {
1273   g_dbus_connection_call (data->proxy->priv->connection,
1274                           "org.freedesktop.DBus",  /* name */
1275                           "/org/freedesktop/DBus", /* object path */
1276                           "org.freedesktop.DBus",  /* interface */
1277                           "StartServiceByName",
1278                           g_variant_new ("(su)",
1279                                          data->proxy->priv->name,
1280                                          0),
1281                           G_VARIANT_TYPE ("(u)"),
1282                           G_DBUS_CALL_FLAGS_NONE,
1283                           -1,           /* timeout */
1284                           data->cancellable,
1285                           (GAsyncReadyCallback) async_init_start_service_by_name_cb,
1286                           data);
1287 }
1288
1289 static void
1290 async_initable_init_second_async (GAsyncInitable      *initable,
1291                                   gint                 io_priority,
1292                                   GCancellable        *cancellable,
1293                                   GAsyncReadyCallback  callback,
1294                                   gpointer             user_data)
1295 {
1296   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1297   AsyncInitData *data;
1298
1299   data = g_new0 (AsyncInitData, 1);
1300   data->proxy = g_object_ref (proxy);
1301   data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
1302   data->simple = g_simple_async_result_new (G_OBJECT (proxy),
1303                                             callback,
1304                                             user_data,
1305                                             NULL);
1306
1307   /* Check name ownership asynchronously - possibly also start the service */
1308   if (proxy->priv->name == NULL)
1309     {
1310       /* Do nothing */
1311       async_init_get_name_owner_cb (proxy->priv->connection, NULL, data);
1312     }
1313   else if (g_dbus_is_unique_name (proxy->priv->name))
1314     {
1315       proxy->priv->name_owner = g_strdup (proxy->priv->name);
1316       async_init_get_name_owner_cb (proxy->priv->connection, NULL, data);
1317     }
1318   else
1319     {
1320       if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START)
1321         {
1322           async_init_call_get_name_owner (data);
1323         }
1324       else
1325         {
1326           async_init_call_start_service_by_name (data);
1327         }
1328     }
1329 }
1330
1331 static gboolean
1332 async_initable_init_second_finish (GAsyncInitable  *initable,
1333                                    GAsyncResult    *res,
1334                                    GError         **error)
1335 {
1336   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1337   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1338   GVariant *result;
1339   gboolean ret;
1340
1341   ret = FALSE;
1342
1343   if (g_simple_async_result_propagate_error (simple, error))
1344     goto out;
1345
1346   result = g_simple_async_result_get_op_res_gpointer (simple);
1347   if (result != NULL)
1348     {
1349       process_get_all_reply (proxy, result);
1350     }
1351
1352   ret = TRUE;
1353
1354  out:
1355   proxy->priv->initialized = TRUE;
1356   return ret;
1357 }
1358
1359 /* ---------------------------------------------------------------------------------------------------- */
1360
1361 static void
1362 async_initable_init_first (GAsyncInitable *initable)
1363 {
1364   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1365
1366   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
1367     {
1368       /* subscribe to PropertiesChanged() */
1369       proxy->priv->properties_changed_subscriber_id =
1370         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1371                                             proxy->priv->name,
1372                                             "org.freedesktop.DBus.Properties",
1373                                             "PropertiesChanged",
1374                                             proxy->priv->object_path,
1375                                             proxy->priv->interface_name,
1376                                             G_DBUS_SIGNAL_FLAGS_NONE,
1377                                             on_properties_changed,
1378                                             proxy,
1379                                             NULL);
1380     }
1381
1382   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS))
1383     {
1384       /* subscribe to all signals for the object */
1385       proxy->priv->signals_subscriber_id =
1386         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1387                                             proxy->priv->name,
1388                                             proxy->priv->interface_name,
1389                                             NULL,                        /* member */
1390                                             proxy->priv->object_path,
1391                                             NULL,                        /* arg0 */
1392                                             G_DBUS_SIGNAL_FLAGS_NONE,
1393                                             on_signal_received,
1394                                             proxy,
1395                                             NULL);
1396     }
1397
1398   if (proxy->priv->name != NULL && !g_dbus_is_unique_name (proxy->priv->name))
1399     {
1400       proxy->priv->name_owner_changed_subscription_id =
1401         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1402                                             "org.freedesktop.DBus",  /* name */
1403                                             "org.freedesktop.DBus",  /* interface */
1404                                             "NameOwnerChanged",      /* signal name */
1405                                             "/org/freedesktop/DBus", /* path */
1406                                             proxy->priv->name,       /* arg0 */
1407                                             G_DBUS_SIGNAL_FLAGS_NONE,
1408                                             on_name_owner_changed,
1409                                             proxy,
1410                                             NULL);
1411     }
1412 }
1413
1414 /* ---------------------------------------------------------------------------------------------------- */
1415
1416 /* initialization is split into two parts - the first is the
1417  * non-blocing part that requires the callers GMainContext - the
1418  * second is a blocking part async part that doesn't require the
1419  * callers GMainContext.. we do this split so the code can be reused
1420  * in the GInitable implementation below.
1421  *
1422  * Note that obtaining a GDBusConnection is not shared between the two
1423  * paths.
1424  */
1425
1426 typedef struct
1427 {
1428   GDBusProxy          *proxy;
1429   gint                 io_priority;
1430   GCancellable        *cancellable;
1431   GAsyncReadyCallback  callback;
1432   gpointer             user_data;
1433 } GetConnectionData;
1434
1435 static void
1436 get_connection_cb (GObject       *source_object,
1437                    GAsyncResult  *res,
1438                    gpointer       user_data)
1439 {
1440   GetConnectionData *data = user_data;
1441   GError *error;
1442
1443   error = NULL;
1444   data->proxy->priv->connection = g_bus_get_finish (res, &error);
1445   if (data->proxy->priv->connection == NULL)
1446     {
1447       GSimpleAsyncResult *simple;
1448       simple = g_simple_async_result_new (G_OBJECT (data->proxy),
1449                                           data->callback,
1450                                           data->user_data,
1451                                           NULL);
1452       g_simple_async_result_set_from_error (simple, error);
1453       g_error_free (error);
1454       g_simple_async_result_complete_in_idle (simple);
1455       g_object_unref (simple);
1456     }
1457   else
1458     {
1459       async_initable_init_first (G_ASYNC_INITABLE (data->proxy));
1460       async_initable_init_second_async (G_ASYNC_INITABLE (data->proxy),
1461                                         data->io_priority,
1462                                         data->cancellable,
1463                                         data->callback,
1464                                         data->user_data);
1465     }
1466
1467   if (data->cancellable != NULL)
1468     g_object_unref (data->cancellable);
1469   if (data->proxy != NULL)
1470     g_object_unref (data->proxy);
1471   g_free (data);
1472 }
1473
1474 static void
1475 async_initable_init_async (GAsyncInitable      *initable,
1476                            gint                 io_priority,
1477                            GCancellable        *cancellable,
1478                            GAsyncReadyCallback  callback,
1479                            gpointer             user_data)
1480 {
1481   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1482
1483   if (proxy->priv->bus_type != G_BUS_TYPE_NONE)
1484     {
1485       GetConnectionData *data;
1486
1487       g_assert (proxy->priv->connection == NULL);
1488
1489       data = g_new0 (GetConnectionData, 1);
1490       data->proxy = g_object_ref (proxy);
1491       data->io_priority = io_priority;
1492       data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
1493       data->callback = callback;
1494       data->user_data = user_data;
1495       g_bus_get (proxy->priv->bus_type,
1496                  cancellable,
1497                  get_connection_cb,
1498                  data);
1499     }
1500   else
1501     {
1502       async_initable_init_first (initable);
1503       async_initable_init_second_async (initable, io_priority, cancellable, callback, user_data);
1504     }
1505 }
1506
1507 static gboolean
1508 async_initable_init_finish (GAsyncInitable  *initable,
1509                             GAsyncResult    *res,
1510                             GError         **error)
1511 {
1512   return async_initable_init_second_finish (initable, res, error);
1513 }
1514
1515 static void
1516 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
1517 {
1518   async_initable_iface->init_async = async_initable_init_async;
1519   async_initable_iface->init_finish = async_initable_init_finish;
1520 }
1521
1522 /* ---------------------------------------------------------------------------------------------------- */
1523
1524 typedef struct
1525 {
1526   GMainContext *context;
1527   GMainLoop *loop;
1528   GAsyncResult *res;
1529 } InitableAsyncInitableData;
1530
1531 static void
1532 async_initable_init_async_cb (GObject      *source_object,
1533                               GAsyncResult *res,
1534                               gpointer      user_data)
1535 {
1536   InitableAsyncInitableData *data = user_data;
1537   data->res = g_object_ref (res);
1538   g_main_loop_quit (data->loop);
1539 }
1540
1541 /* Simply reuse the GAsyncInitable implementation but run the first
1542  * part (that is non-blocking and requires the callers GMainContext)
1543  * with the callers GMainContext.. and the second with a private
1544  * GMainContext (bug 621310 is slightly related).
1545  *
1546  * Note that obtaining a GDBusConnection is not shared between the two
1547  * paths.
1548  */
1549 static gboolean
1550 initable_init (GInitable     *initable,
1551                GCancellable  *cancellable,
1552                GError       **error)
1553 {
1554   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1555   InitableAsyncInitableData *data;
1556   gboolean ret;
1557
1558   ret = FALSE;
1559
1560   if (proxy->priv->bus_type != G_BUS_TYPE_NONE)
1561     {
1562       g_assert (proxy->priv->connection == NULL);
1563       proxy->priv->connection = g_bus_get_sync (proxy->priv->bus_type,
1564                                                 cancellable,
1565                                                 error);
1566       if (proxy->priv->connection == NULL)
1567         goto out;
1568     }
1569
1570   async_initable_init_first (G_ASYNC_INITABLE (initable));
1571
1572   data = g_new0 (InitableAsyncInitableData, 1);
1573   data->context = g_main_context_new ();
1574   data->loop = g_main_loop_new (data->context, FALSE);
1575
1576   g_main_context_push_thread_default (data->context);
1577
1578   async_initable_init_second_async (G_ASYNC_INITABLE (initable),
1579                                     G_PRIORITY_DEFAULT,
1580                                     cancellable,
1581                                     async_initable_init_async_cb,
1582                                     data);
1583
1584   g_main_loop_run (data->loop);
1585
1586   ret = async_initable_init_second_finish (G_ASYNC_INITABLE (initable),
1587                                            data->res,
1588                                            error);
1589
1590   g_main_context_pop_thread_default (data->context);
1591
1592   g_main_context_unref (data->context);
1593   g_main_loop_unref (data->loop);
1594   g_object_unref (data->res);
1595   g_free (data);
1596
1597  out:
1598
1599   return ret;
1600 }
1601
1602 static void
1603 initable_iface_init (GInitableIface *initable_iface)
1604 {
1605   initable_iface->init = initable_init;
1606 }
1607
1608 /* ---------------------------------------------------------------------------------------------------- */
1609
1610 /**
1611  * g_dbus_proxy_new:
1612  * @connection: A #GDBusConnection.
1613  * @flags: Flags used when constructing the proxy.
1614  * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1615  * @name: A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
1616  * @object_path: An object path.
1617  * @interface_name: A D-Bus interface name.
1618  * @cancellable: A #GCancellable or %NULL.
1619  * @callback: Callback function to invoke when the proxy is ready.
1620  * @user_data: User data to pass to @callback.
1621  *
1622  * Creates a proxy for accessing @interface_name on the remote object
1623  * at @object_path owned by @name at @connection and asynchronously
1624  * loads D-Bus properties unless the
1625  * #G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to
1626  * the #GDBusProxy::g-properties-changed signal to get notified about
1627  * property changes.
1628  *
1629  * If the #G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
1630  * match rules for signals. Connect to the #GDBusProxy::g-signal signal
1631  * to handle signals from the remote object.
1632  *
1633  * If @name is a well-known name and the
1634  * #G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
1635  * owner currently exists, the message bus will be requested to launch
1636  * a name owner for the name.
1637  *
1638  * This is a failable asynchronous constructor - when the proxy is
1639  * ready, @callback will be invoked and you can use
1640  * g_dbus_proxy_new_finish() to get the result.
1641  *
1642  * See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
1643  *
1644  * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
1645  *
1646  * Since: 2.26
1647  */
1648 void
1649 g_dbus_proxy_new (GDBusConnection     *connection,
1650                   GDBusProxyFlags      flags,
1651                   GDBusInterfaceInfo  *info,
1652                   const gchar         *name,
1653                   const gchar         *object_path,
1654                   const gchar         *interface_name,
1655                   GCancellable        *cancellable,
1656                   GAsyncReadyCallback  callback,
1657                   gpointer             user_data)
1658 {
1659   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1660   g_return_if_fail ((name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) || g_dbus_is_name (name));
1661   g_return_if_fail (g_variant_is_object_path (object_path));
1662   g_return_if_fail (g_dbus_is_interface_name (interface_name));
1663
1664   g_async_initable_new_async (G_TYPE_DBUS_PROXY,
1665                               G_PRIORITY_DEFAULT,
1666                               cancellable,
1667                               callback,
1668                               user_data,
1669                               "g-flags", flags,
1670                               "g-interface-info", info,
1671                               "g-name", name,
1672                               "g-connection", connection,
1673                               "g-object-path", object_path,
1674                               "g-interface-name", interface_name,
1675                               NULL);
1676 }
1677
1678 /**
1679  * g_dbus_proxy_new_finish:
1680  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new().
1681  * @error: Return location for error or %NULL.
1682  *
1683  * Finishes creating a #GDBusProxy.
1684  *
1685  * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
1686  *
1687  * Since: 2.26
1688  */
1689 GDBusProxy *
1690 g_dbus_proxy_new_finish (GAsyncResult  *res,
1691                          GError       **error)
1692 {
1693   GObject *object;
1694   GObject *source_object;
1695
1696   source_object = g_async_result_get_source_object (res);
1697   g_assert (source_object != NULL);
1698
1699   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
1700                                         res,
1701                                         error);
1702   g_object_unref (source_object);
1703
1704   if (object != NULL)
1705     return G_DBUS_PROXY (object);
1706   else
1707     return NULL;
1708 }
1709
1710 /**
1711  * g_dbus_proxy_new_sync:
1712  * @connection: A #GDBusConnection.
1713  * @flags: Flags used when constructing the proxy.
1714  * @info: (allow-none): A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1715  * @name: (allow-none): A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
1716  * @object_path: An object path.
1717  * @interface_name: A D-Bus interface name.
1718  * @cancellable: (allow-none): A #GCancellable or %NULL.
1719  * @error: (allow-none): Return location for error or %NULL.
1720  *
1721  * Creates a proxy for accessing @interface_name on the remote object
1722  * at @object_path owned by @name at @connection and synchronously
1723  * loads D-Bus properties unless the
1724  * #G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used.
1725  *
1726  * If the #G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
1727  * match rules for signals. Connect to the #GDBusProxy::g-signal signal
1728  * to handle signals from the remote object.
1729  *
1730  * If @name is a well-known name and the
1731  * #G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
1732  * owner currently exists, the message bus will be requested to launch
1733  * a name owner for the name.
1734  *
1735  * This is a synchronous failable constructor. See g_dbus_proxy_new()
1736  * and g_dbus_proxy_new_finish() for the asynchronous version.
1737  *
1738  * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
1739  *
1740  * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
1741  *
1742  * Since: 2.26
1743  */
1744 GDBusProxy *
1745 g_dbus_proxy_new_sync (GDBusConnection     *connection,
1746                        GDBusProxyFlags      flags,
1747                        GDBusInterfaceInfo  *info,
1748                        const gchar         *name,
1749                        const gchar         *object_path,
1750                        const gchar         *interface_name,
1751                        GCancellable        *cancellable,
1752                        GError             **error)
1753 {
1754   GInitable *initable;
1755
1756   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1757   g_return_val_if_fail ((name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
1758                         g_dbus_is_name (name), NULL);
1759   g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
1760   g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
1761
1762   initable = g_initable_new (G_TYPE_DBUS_PROXY,
1763                              cancellable,
1764                              error,
1765                              "g-flags", flags,
1766                              "g-interface-info", info,
1767                              "g-name", name,
1768                              "g-connection", connection,
1769                              "g-object-path", object_path,
1770                              "g-interface-name", interface_name,
1771                              NULL);
1772   if (initable != NULL)
1773     return G_DBUS_PROXY (initable);
1774   else
1775     return NULL;
1776 }
1777
1778 /* ---------------------------------------------------------------------------------------------------- */
1779
1780 /**
1781  * g_dbus_proxy_new_for_bus:
1782  * @bus_type: A #GBusType.
1783  * @flags: Flags used when constructing the proxy.
1784  * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1785  * @name: A bus name (well-known or unique).
1786  * @object_path: An object path.
1787  * @interface_name: A D-Bus interface name.
1788  * @cancellable: A #GCancellable or %NULL.
1789  * @callback: Callback function to invoke when the proxy is ready.
1790  * @user_data: User data to pass to @callback.
1791  *
1792  * Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection.
1793  *
1794  * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
1795  *
1796  * Since: 2.26
1797  */
1798 void
1799 g_dbus_proxy_new_for_bus (GBusType             bus_type,
1800                           GDBusProxyFlags      flags,
1801                           GDBusInterfaceInfo  *info,
1802                           const gchar         *name,
1803                           const gchar         *object_path,
1804                           const gchar         *interface_name,
1805                           GCancellable        *cancellable,
1806                           GAsyncReadyCallback  callback,
1807                           gpointer             user_data)
1808 {
1809   g_return_if_fail (g_dbus_is_name (name));
1810   g_return_if_fail (g_variant_is_object_path (object_path));
1811   g_return_if_fail (g_dbus_is_interface_name (interface_name));
1812
1813   g_async_initable_new_async (G_TYPE_DBUS_PROXY,
1814                               G_PRIORITY_DEFAULT,
1815                               cancellable,
1816                               callback,
1817                               user_data,
1818                               "g-flags", flags,
1819                               "g-interface-info", info,
1820                               "g-name", name,
1821                               "g-bus-type", bus_type,
1822                               "g-object-path", object_path,
1823                               "g-interface-name", interface_name,
1824                               NULL);
1825 }
1826
1827 /**
1828  * g_dbus_proxy_new_for_bus_finish:
1829  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus().
1830  * @error: Return location for error or %NULL.
1831  *
1832  * Finishes creating a #GDBusProxy.
1833  *
1834  * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
1835  *
1836  * Since: 2.26
1837  */
1838 GDBusProxy *
1839 g_dbus_proxy_new_for_bus_finish (GAsyncResult  *res,
1840                                  GError       **error)
1841 {
1842   return g_dbus_proxy_new_finish (res, error);
1843 }
1844
1845 /**
1846  * g_dbus_proxy_new_for_bus_sync:
1847  * @bus_type: A #GBusType.
1848  * @flags: Flags used when constructing the proxy.
1849  * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1850  * @name: A bus name (well-known or unique).
1851  * @object_path: An object path.
1852  * @interface_name: A D-Bus interface name.
1853  * @cancellable: A #GCancellable or %NULL.
1854  * @error: Return location for error or %NULL.
1855  *
1856  * Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.
1857  *
1858  * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
1859  *
1860  * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
1861  *
1862  * Since: 2.26
1863  */
1864 GDBusProxy *
1865 g_dbus_proxy_new_for_bus_sync (GBusType             bus_type,
1866                                GDBusProxyFlags      flags,
1867                                GDBusInterfaceInfo  *info,
1868                                const gchar         *name,
1869                                const gchar         *object_path,
1870                                const gchar         *interface_name,
1871                                GCancellable        *cancellable,
1872                                GError             **error)
1873 {
1874   GInitable *initable;
1875
1876   g_return_val_if_fail (g_dbus_is_name (name), NULL);
1877   g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
1878   g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
1879
1880   initable = g_initable_new (G_TYPE_DBUS_PROXY,
1881                              cancellable,
1882                              error,
1883                              "g-flags", flags,
1884                              "g-interface-info", info,
1885                              "g-name", name,
1886                              "g-bus-type", bus_type,
1887                              "g-object-path", object_path,
1888                              "g-interface-name", interface_name,
1889                              NULL);
1890   if (initable != NULL)
1891     return G_DBUS_PROXY (initable);
1892   else
1893     return NULL;
1894 }
1895
1896 /* ---------------------------------------------------------------------------------------------------- */
1897
1898 /**
1899  * g_dbus_proxy_get_connection:
1900  * @proxy: A #GDBusProxy.
1901  *
1902  * Gets the connection @proxy is for.
1903  *
1904  * Returns: A #GDBusConnection owned by @proxy. Do not free.
1905  *
1906  * Since: 2.26
1907  */
1908 GDBusConnection *
1909 g_dbus_proxy_get_connection (GDBusProxy *proxy)
1910 {
1911   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1912   return proxy->priv->connection;
1913 }
1914
1915 /**
1916  * g_dbus_proxy_get_flags:
1917  * @proxy: A #GDBusProxy.
1918  *
1919  * Gets the flags that @proxy was constructed with.
1920  *
1921  * Returns: Flags from the #GDBusProxyFlags enumeration.
1922  *
1923  * Since: 2.26
1924  */
1925 GDBusProxyFlags
1926 g_dbus_proxy_get_flags (GDBusProxy *proxy)
1927 {
1928   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), 0);
1929   return proxy->priv->flags;
1930 }
1931
1932 /**
1933  * g_dbus_proxy_get_name:
1934  * @proxy: A #GDBusProxy.
1935  *
1936  * Gets the name that @proxy was constructed for.
1937  *
1938  * Returns: A string owned by @proxy. Do not free.
1939  *
1940  * Since: 2.26
1941  */
1942 const gchar *
1943 g_dbus_proxy_get_name (GDBusProxy *proxy)
1944 {
1945   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1946   return proxy->priv->name;
1947 }
1948
1949 /**
1950  * g_dbus_proxy_get_name_owner:
1951  * @proxy: A #GDBusProxy.
1952  *
1953  * The unique name that owns the name that @proxy is for or %NULL if
1954  * no-one currently owns that name. You may connect to the
1955  * #GObject::notify signal to track changes to the
1956  * #GDBusProxy:g-name-owner property.
1957  *
1958  * Returns: The name owner or %NULL if no name owner exists. Free with g_free().
1959  *
1960  * Since: 2.26
1961  */
1962 gchar *
1963 g_dbus_proxy_get_name_owner (GDBusProxy *proxy)
1964 {
1965   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1966   return g_strdup (proxy->priv->name_owner);
1967 }
1968
1969 /**
1970  * g_dbus_proxy_get_object_path:
1971  * @proxy: A #GDBusProxy.
1972  *
1973  * Gets the object path @proxy is for.
1974  *
1975  * Returns: A string owned by @proxy. Do not free.
1976  *
1977  * Since: 2.26
1978  */
1979 const gchar *
1980 g_dbus_proxy_get_object_path (GDBusProxy *proxy)
1981 {
1982   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1983   return proxy->priv->object_path;
1984 }
1985
1986 /**
1987  * g_dbus_proxy_get_interface_name:
1988  * @proxy: A #GDBusProxy.
1989  *
1990  * Gets the D-Bus interface name @proxy is for.
1991  *
1992  * Returns: A string owned by @proxy. Do not free.
1993  *
1994  * Since: 2.26
1995  */
1996 const gchar *
1997 g_dbus_proxy_get_interface_name (GDBusProxy *proxy)
1998 {
1999   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2000   return proxy->priv->interface_name;
2001 }
2002
2003 /**
2004  * g_dbus_proxy_get_default_timeout:
2005  * @proxy: A #GDBusProxy.
2006  *
2007  * Gets the timeout to use if -1 (specifying default timeout) is
2008  * passed as @timeout_msec in the g_dbus_proxy_call() and
2009  * g_dbus_proxy_call_sync() functions.
2010  *
2011  * See the #GDBusProxy:g-default-timeout property for more details.
2012  *
2013  * Returns: Timeout to use for @proxy.
2014  *
2015  * Since: 2.26
2016  */
2017 gint
2018 g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
2019 {
2020   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), -1);
2021   return proxy->priv->timeout_msec;
2022 }
2023
2024 /**
2025  * g_dbus_proxy_set_default_timeout:
2026  * @proxy: A #GDBusProxy.
2027  * @timeout_msec: Timeout in milliseconds.
2028  *
2029  * Sets the timeout to use if -1 (specifying default timeout) is
2030  * passed as @timeout_msec in the g_dbus_proxy_call() and
2031  * g_dbus_proxy_call_sync() functions.
2032  *
2033  * See the #GDBusProxy:g-default-timeout property for more details.
2034  *
2035  * Since: 2.26
2036  */
2037 void
2038 g_dbus_proxy_set_default_timeout (GDBusProxy *proxy,
2039                                   gint        timeout_msec)
2040 {
2041   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2042   g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
2043
2044   /* TODO: locking? */
2045   if (proxy->priv->timeout_msec != timeout_msec)
2046     {
2047       proxy->priv->timeout_msec = timeout_msec;
2048       g_object_notify (G_OBJECT (proxy), "g-default-timeout");
2049     }
2050 }
2051
2052 /**
2053  * g_dbus_proxy_get_interface_info:
2054  * @proxy: A #GDBusProxy
2055  *
2056  * Returns the #GDBusInterfaceInfo, if any, specifying the minimal
2057  * interface that @proxy conforms to.
2058  *
2059  * See the #GDBusProxy:g-interface-info property for more details.
2060  *
2061  * Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
2062  * object, it is owned by @proxy.
2063  *
2064  * Since: 2.26
2065  */
2066 GDBusInterfaceInfo *
2067 g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
2068 {
2069   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2070   return proxy->priv->expected_interface;
2071 }
2072
2073 /**
2074  * g_dbus_proxy_set_interface_info:
2075  * @proxy: A #GDBusProxy
2076  * @info: Minimum interface this proxy conforms to or %NULL to unset.
2077  *
2078  * Ensure that interactions with @proxy conform to the given
2079  * interface.  For example, when completing a method call, if the type
2080  * signature of the message isn't what's expected, the given #GError
2081  * is set.  Signals that have a type signature mismatch are simply
2082  * dropped.
2083  *
2084  * See the #GDBusProxy:g-interface-info property for more details.
2085  *
2086  * Since: 2.26
2087  */
2088 void
2089 g_dbus_proxy_set_interface_info (GDBusProxy         *proxy,
2090                                  GDBusInterfaceInfo *info)
2091 {
2092   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2093   if (proxy->priv->expected_interface != NULL)
2094     g_dbus_interface_info_unref (proxy->priv->expected_interface);
2095   proxy->priv->expected_interface = info != NULL ? g_dbus_interface_info_ref (info) : NULL;
2096 }
2097
2098 /* ---------------------------------------------------------------------------------------------------- */
2099
2100 static gboolean
2101 maybe_split_method_name (const gchar  *method_name,
2102                          gchar       **out_interface_name,
2103                          const gchar **out_method_name)
2104 {
2105   gboolean was_split;
2106
2107   was_split = FALSE;
2108   g_assert (out_interface_name != NULL);
2109   g_assert (out_method_name != NULL);
2110   *out_interface_name = NULL;
2111   *out_method_name = NULL;
2112
2113   if (strchr (method_name, '.') != NULL)
2114     {
2115       gchar *p;
2116       gchar *last_dot;
2117
2118       p = g_strdup (method_name);
2119       last_dot = strrchr (p, '.');
2120       *last_dot = '\0';
2121
2122       *out_interface_name = p;
2123       *out_method_name = last_dot + 1;
2124
2125       was_split = TRUE;
2126     }
2127
2128   return was_split;
2129 }
2130
2131
2132 static void
2133 reply_cb (GDBusConnection *connection,
2134           GAsyncResult    *res,
2135           gpointer         user_data)
2136 {
2137   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
2138   GVariant *value;
2139   GError *error;
2140
2141   error = NULL;
2142   value = g_dbus_connection_call_finish (connection,
2143                                          res,
2144                                          &error);
2145   if (error != NULL)
2146     {
2147       g_simple_async_result_set_from_error (simple,
2148                                             error);
2149       g_error_free (error);
2150     }
2151   else
2152     {
2153       g_simple_async_result_set_op_res_gpointer (simple,
2154                                                  value,
2155                                                  (GDestroyNotify) g_variant_unref);
2156     }
2157
2158   /* no need to complete in idle since the method GDBusConnection already does */
2159   g_simple_async_result_complete (simple);
2160   g_object_unref (simple);
2161 }
2162
2163 static const GDBusMethodInfo *
2164 lookup_method_info_or_warn (GDBusProxy  *proxy,
2165                             const gchar *method_name)
2166 {
2167   const GDBusMethodInfo *info;
2168
2169   if (proxy->priv->expected_interface == NULL)
2170     return NULL;
2171
2172   info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, method_name);
2173   if (info == NULL)
2174     {
2175       g_warning ("Trying to invoke method %s which isn't in expected interface %s",
2176                  method_name, proxy->priv->expected_interface->name);
2177     }
2178
2179   return info;
2180 }
2181
2182 /**
2183  * g_dbus_proxy_call:
2184  * @proxy: A #GDBusProxy.
2185  * @method_name: Name of method to invoke.
2186  * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
2187  * @flags: Flags from the #GDBusCallFlags enumeration.
2188  * @timeout_msec: The timeout in milliseconds or -1 to use the proxy default timeout.
2189  * @cancellable: A #GCancellable or %NULL.
2190  * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
2191  * care about the result of the method invocation.
2192  * @user_data: The data to pass to @callback.
2193  *
2194  * Asynchronously invokes the @method_name method on @proxy.
2195  *
2196  * If @method_name contains any dots, then @name is split into interface and
2197  * method name parts. This allows using @proxy for invoking methods on
2198  * other interfaces.
2199  *
2200  * If the #GDBusConnection associated with @proxy is closed then
2201  * the operation will fail with %G_IO_ERROR_CLOSED. If
2202  * @cancellable is canceled, the operation will fail with
2203  * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
2204  * compatible with the D-Bus protocol, the operation fails with
2205  * %G_IO_ERROR_INVALID_ARGUMENT.
2206  *
2207  * If the @parameters #GVariant is floating, it is consumed. This allows
2208  * convenient 'inline' use of g_variant_new(), e.g.:
2209  * |[
2210  *  g_dbus_proxy_call (proxy,
2211  *                     "TwoStrings",
2212  *                     g_variant_new ("(ss)",
2213  *                                    "Thing One",
2214  *                                    "Thing Two"),
2215  *                     G_DBUS_CALL_FLAGS_NONE,
2216  *                     -1,
2217  *                     NULL,
2218  *                     (GAsyncReadyCallback) two_strings_done,
2219  *                     &amp;data);
2220  * ]|
2221  *
2222  * This is an asynchronous method. When the operation is finished,
2223  * @callback will be invoked in the
2224  * <link linkend="g-main-context-push-thread-default">thread-default
2225  * main loop</link> of the thread you are calling this method from.
2226  * You can then call g_dbus_proxy_call_finish() to get the result of
2227  * the operation. See g_dbus_proxy_call_sync() for the synchronous
2228  * version of this method.
2229  *
2230  * Since: 2.26
2231  */
2232 void
2233 g_dbus_proxy_call (GDBusProxy          *proxy,
2234                    const gchar         *method_name,
2235                    GVariant            *parameters,
2236                    GDBusCallFlags       flags,
2237                    gint                 timeout_msec,
2238                    GCancellable        *cancellable,
2239                    GAsyncReadyCallback  callback,
2240                    gpointer             user_data)
2241 {
2242   GSimpleAsyncResult *simple;
2243   gboolean was_split;
2244   gchar *split_interface_name;
2245   const gchar *split_method_name;
2246   const GDBusMethodInfo *expected_method_info;
2247   const gchar *target_method_name;
2248   const gchar *target_interface_name;
2249   GVariantType *reply_type;
2250
2251   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2252   g_return_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name));
2253   g_return_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
2254   g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
2255
2256   simple = g_simple_async_result_new (G_OBJECT (proxy),
2257                                       callback,
2258                                       user_data,
2259                                       g_dbus_proxy_call);
2260
2261   was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
2262   target_method_name = was_split ? split_method_name : method_name;
2263   target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
2264
2265   g_object_set_data_full (G_OBJECT (simple), "-gdbus-proxy-method-name", g_strdup (target_method_name), g_free);
2266
2267   /* Warn if method is unexpected (cf. :g-interface-info) */
2268   expected_method_info = NULL;
2269   if (!was_split)
2270     expected_method_info = lookup_method_info_or_warn (proxy, target_method_name);
2271
2272   if (expected_method_info)
2273     reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
2274   else
2275     reply_type = NULL;
2276
2277   g_dbus_connection_call (proxy->priv->connection,
2278                           proxy->priv->name_owner,
2279                           proxy->priv->object_path,
2280                           target_interface_name,
2281                           target_method_name,
2282                           parameters,
2283                           reply_type,
2284                           flags,
2285                           timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
2286                           cancellable,
2287                           (GAsyncReadyCallback) reply_cb,
2288                           simple);
2289
2290   if (reply_type != NULL)
2291     g_variant_type_free (reply_type);
2292
2293   g_free (split_interface_name);
2294 }
2295
2296 /**
2297  * g_dbus_proxy_call_finish:
2298  * @proxy: A #GDBusProxy.
2299  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call().
2300  * @error: Return location for error or %NULL.
2301  *
2302  * Finishes an operation started with g_dbus_proxy_call().
2303  *
2304  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
2305  * return values. Free with g_variant_unref().
2306  *
2307  * Since: 2.26
2308  */
2309 GVariant *
2310 g_dbus_proxy_call_finish (GDBusProxy    *proxy,
2311                           GAsyncResult  *res,
2312                           GError       **error)
2313 {
2314   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2315   GVariant *value;
2316   const char *method_name;
2317
2318   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2319   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2320   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2321
2322   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_proxy_call);
2323
2324   value = NULL;
2325
2326   if (g_simple_async_result_propagate_error (simple, error))
2327     goto out;
2328
2329   value = g_simple_async_result_get_op_res_gpointer (simple);
2330   method_name = g_object_get_data (G_OBJECT (simple), "-gdbus-proxy-method-name");
2331
2332  out:
2333   return value;
2334 }
2335
2336 /**
2337  * g_dbus_proxy_call_sync:
2338  * @proxy: A #GDBusProxy.
2339  * @method_name: Name of method to invoke.
2340  * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
2341  * @flags: Flags from the #GDBusCallFlags enumeration.
2342  * @timeout_msec: The timeout in milliseconds or -1 to use the proxy default timeout.
2343  * @cancellable: A #GCancellable or %NULL.
2344  * @error: Return location for error or %NULL.
2345  *
2346  * Synchronously invokes the @method_name method on @proxy.
2347  *
2348  * If @method_name contains any dots, then @name is split into interface and
2349  * method name parts. This allows using @proxy for invoking methods on
2350  * other interfaces.
2351  *
2352  * If the #GDBusConnection associated with @proxy is disconnected then
2353  * the operation will fail with %G_IO_ERROR_CLOSED. If
2354  * @cancellable is canceled, the operation will fail with
2355  * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
2356  * compatible with the D-Bus protocol, the operation fails with
2357  * %G_IO_ERROR_INVALID_ARGUMENT.
2358  *
2359  * If the @parameters #GVariant is floating, it is consumed. This allows
2360  * convenient 'inline' use of g_variant_new(), e.g.:
2361  * |[
2362  *  g_dbus_proxy_call_sync (proxy,
2363  *                          "TwoStrings",
2364  *                          g_variant_new ("(ss)",
2365  *                                         "Thing One",
2366  *                                         "Thing Two"),
2367  *                          G_DBUS_CALL_FLAGS_NONE,
2368  *                          -1,
2369  *                          NULL,
2370  *                          &amp;error);
2371  * ]|
2372  *
2373  * The calling thread is blocked until a reply is received. See
2374  * g_dbus_proxy_call() for the asynchronous version of this
2375  * method.
2376  *
2377  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
2378  * return values. Free with g_variant_unref().
2379  *
2380  * Since: 2.26
2381  */
2382 GVariant *
2383 g_dbus_proxy_call_sync (GDBusProxy      *proxy,
2384                         const gchar     *method_name,
2385                         GVariant        *parameters,
2386                         GDBusCallFlags   flags,
2387                         gint             timeout_msec,
2388                         GCancellable    *cancellable,
2389                         GError         **error)
2390 {
2391   GVariant *ret;
2392   gboolean was_split;
2393   gchar *split_interface_name;
2394   const gchar *split_method_name;
2395   const GDBusMethodInfo *expected_method_info;
2396   const gchar *target_method_name;
2397   const gchar *target_interface_name;
2398   GVariantType *reply_type;
2399
2400   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2401   g_return_val_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name), NULL);
2402   g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
2403   g_return_val_if_fail (timeout_msec == -1 || timeout_msec >= 0, NULL);
2404   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2405
2406   was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
2407   target_method_name = was_split ? split_method_name : method_name;
2408   target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
2409
2410   if (proxy->priv->expected_interface)
2411     {
2412       expected_method_info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, target_method_name);
2413       if (expected_method_info == NULL)
2414         {
2415           g_warning ("Trying to invoke method `%s' which isn't in expected interface `%s'",
2416                      target_method_name,
2417                      target_interface_name);
2418         }
2419     }
2420   else
2421     {
2422       expected_method_info = NULL;
2423     }
2424
2425   if (expected_method_info)
2426     reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
2427   else
2428     reply_type = NULL;
2429
2430   ret = g_dbus_connection_call_sync (proxy->priv->connection,
2431                                      proxy->priv->name_owner,
2432                                      proxy->priv->object_path,
2433                                      target_interface_name,
2434                                      target_method_name,
2435                                      parameters,
2436                                      reply_type,
2437                                      flags,
2438                                      timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
2439                                      cancellable,
2440                                      error);
2441
2442   if (reply_type != NULL)
2443     g_variant_type_free (reply_type);
2444
2445   g_free (split_interface_name);
2446
2447   return ret;
2448 }
2449
2450 /* ---------------------------------------------------------------------------------------------------- */