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