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   g_signal_emit (proxy,
 759                  signals[SIGNAL_SIGNAL],
 760                  0,
 761                  sender_name,
 762                  signal_name,
 763                  parameters);
 764  out:
 765   ;
 766 }
 767
 768 /* ---------------------------------------------------------------------------------------------------- */
 769
 770 static void
 771 insert_property_checked (GDBusProxy  *proxy,
 772                          gchar *property_name,
 773                          GVariant *value)
 774 {
 775   if (proxy->priv->expected_interface != NULL)
 776     {
 777       const GDBusPropertyInfo *info;
 778
 779       info = g_dbus_interface_info_lookup_property (proxy->priv->expected_interface, property_name);
 780       /* Ignore unknown properties */
 781       if (info == NULL)
 782         goto invalid;
 783
 784       /* Ignore properties with the wrong type */
 785       if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
 786         goto invalid;
 787     }
 788
 789   g_hash_table_insert (proxy->priv->properties,
 790                        property_name, /* adopts string */
 791                        value); /* adopts value */
 792
 793   return;
 794
 795  invalid:
 796   g_variant_unref (value);
 797   g_free (property_name);
 798 }
 799
 800 static void
 801 on_properties_changed (GDBusConnection *connection,
 802                        const gchar     *sender_name,
 803                        const gchar     *object_path,
 804                        const gchar     *interface_name,
 805                        const gchar     *signal_name,
 806                        GVariant        *parameters,
 807                        gpointer         user_data)
 808 {
 809   GDBusProxy *proxy = G_DBUS_PROXY (user_data);
 810   GError *error;
 811   const gchar *interface_name_for_signal;
 812   GVariant *changed_properties;
 813   gchar **invalidated_properties;
 814   GVariantIter iter;
 815   gchar *key;
 816   GVariant *value;
 817   guint n;
 818
 819   error = NULL;
 820   changed_properties = NULL;
 821   invalidated_properties = NULL;
 822
 823   if (!proxy->priv->initialized)
 824     goto out;
 825
 826   if (proxy->priv->name_owner != NULL && g_strcmp0 (sender_name, proxy->priv->name_owner) != 0)
 827     goto out;
 828
 829   if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(sa{sv}as)")))
 830     {
 831       g_warning ("Value for PropertiesChanged signal with type `%s' does not match `(sa{sv}as)'",
 832                  g_variant_get_type_string (parameters));
 833       goto out;
 834     }
 835
 836   g_variant_get (parameters,
 837                  "(&s@a{sv}^a&s)",
 838                  &interface_name_for_signal,
 839                  &changed_properties,
 840                  &invalidated_properties);
 841
 842   if (g_strcmp0 (interface_name_for_signal, proxy->priv->interface_name) != 0)
 843     goto out;
 844
 845   g_variant_iter_init (&iter, changed_properties);
 846   while (g_variant_iter_next (&iter, "{sv}", &key, &value))
 847     {
 848       insert_property_checked (proxy,
 849                                key, /* adopts string */
 850                                value); /* adopts value */
 851     }
 852
 853   for (n = 0; invalidated_properties[n] != NULL; n++)
 854     {
 855       g_hash_table_remove (proxy->priv->properties, invalidated_properties[n]);
 856     }
 857
 858   /* emit signal */
 859   g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
 860                  0,
 861                  changed_properties,
 862                  invalidated_properties);
 863
 864  out:
 865   if (changed_properties != NULL)
 866     g_variant_unref (changed_properties);
 867   g_free (invalidated_properties);
 868 }
 869
 870 /* ---------------------------------------------------------------------------------------------------- */
 871
 872 static void
 873 process_get_all_reply (GDBusProxy *proxy,
 874                        GVariant   *result)
 875 {
 876   GVariantIter *iter;
 877   gchar *key;
 878   GVariant *value;
 879
 880   if (!g_variant_is_of_type (result, G_VARIANT_TYPE ("(a{sv})")))
 881     {
 882       g_warning ("Value for GetAll reply with type `%s' does not match `(a{sv})'",
 883                  g_variant_get_type_string (result));
 884       goto out;
 885     }
 886
 887   g_variant_get (result, "(a{sv})", &iter);
 888   while (g_variant_iter_next (iter, "{sv}", &key, &value))
 889     {
 890       insert_property_checked (proxy,
 891                                key, /* adopts string */
 892                                value); /* adopts value */
 893     }
 894   g_variant_iter_free (iter);
 895
 896   /* Synthesize ::g-properties-changed changed */
 897   if (g_hash_table_size (proxy->priv->properties) > 0)
 898     {
 899       GVariant *changed_properties;
 900       const gchar *invalidated_properties[1] = {NULL};
 901
 902       g_variant_get (result,
 903                      "(@a{sv})",
 904                      &changed_properties);
 905       g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
 906                      0,
 907                      changed_properties,
 908                      invalidated_properties);
 909       g_variant_unref (changed_properties);
 910     }
 911
 912  out:
 913   ;
 914 }
 915
 916 typedef struct
 917 {
 918   GDBusProxy *proxy;
 919   GCancellable *cancellable;
 920   gchar *name_owner;
 921 } LoadPropertiesOnNameOwnerChangedData;
 922
 923 static void
 924 on_name_owner_changed_get_all_cb (GDBusConnection *connection,
 925                                   GAsyncResult    *res,
 926                                   gpointer         user_data)
 927 {
 928   LoadPropertiesOnNameOwnerChangedData *data = user_data;
 929   GVariant *result;
 930   GError *error;
 931   gboolean cancelled;
 932
 933   cancelled = FALSE;
 934
 935   error = NULL;
 936   result = g_dbus_connection_call_finish (connection,
 937                                           res,
 938                                           &error);
 939   if (result == NULL)
 940     {
 941       if (error->domain == G_IO_ERROR && error->code == G_IO_ERROR_CANCELLED)
 942         cancelled = TRUE;
 943       /* We just ignore if GetAll() is failing. Because this might happen
 944        * if the object has no properties at all. Or if the caller is
 945        * not authorized to see the properties.
 946        *
 947        * Either way, apps can know about this by using
 948        * get_cached_property_names() or get_cached_property().
 949        *
 950        * TODO: handle G_DBUS_DEBUG flag 'proxy' and, if enabled, log the
 951        * fact that GetAll() failed
 952        */
 953       //g_debug ("error: %d %d %s", error->domain, error->code, error->message);
 954       g_error_free (error);
 955     }
 956
 957   /* and finally we can notify */
 958   if (!cancelled)
 959     {
 960       g_free (data->proxy->priv->name_owner);
 961       data->proxy->priv->name_owner = data->name_owner;
 962       data->name_owner = NULL; /* to avoid an extra copy, we steal the string */
 963
 964       g_hash_table_remove_all (data->proxy->priv->properties);
 965       if (result != NULL)
 966         {
 967           process_get_all_reply (data->proxy, result);
 968           g_variant_unref (result);
 969         }
 970
 971       g_object_notify (G_OBJECT (data->proxy), "g-name-owner");
 972     }
 973
 974   if (data->cancellable == data->proxy->priv->get_all_cancellable)
 975     data->proxy->priv->get_all_cancellable = NULL;
 976
 977   g_object_unref (data->proxy);
 978   g_object_unref (data->cancellable);
 979   g_free (data->name_owner);
 980   g_free (data);
 981 }
 982
 983 static void
 984 on_name_owner_changed (GDBusConnection *connection,
 985                        const gchar      *sender_name,
 986                        const gchar      *object_path,
 987                        const gchar      *interface_name,
 988                        const gchar      *signal_name,
 989                        GVariant         *parameters,
 990                        gpointer          user_data)
 991 {
 992   GDBusProxy *proxy = G_DBUS_PROXY (user_data);
 993   const gchar *old_owner;
 994   const gchar *new_owner;
 995
 996   /* if we are already trying to load properties, cancel that */
 997   if (proxy->priv->get_all_cancellable != NULL)
 998     {
 999       g_cancellable_cancel (proxy->priv->get_all_cancellable);
1000       proxy->priv->get_all_cancellable = NULL;
1001     }
1002
1003   g_variant_get (parameters,
1004                  "(&s&s&s)",
1005                  NULL,
1006                  &old_owner,
1007                  &new_owner);
1008
1009   if (strlen (new_owner) == 0)
1010     {
1011       g_free (proxy->priv->name_owner);
1012       proxy->priv->name_owner = NULL;
1013
1014       /* Synthesize ::g-properties-changed changed */
1015       if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES) &&
1016           g_hash_table_size (proxy->priv->properties) > 0)
1017         {
1018           GVariantBuilder builder;
1019           GVariant *changed_properties;
1020           GPtrArray *invalidated_properties;
1021           GHashTableIter iter;
1022           const gchar *key;
1023
1024           /* Build changed_properties (always empty) and invalidated_properties ... */
1025           g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{sv}"));
1026           changed_properties = g_variant_builder_end (&builder);
1027           invalidated_properties = g_ptr_array_new_with_free_func (g_free);
1028           g_hash_table_iter_init (&iter, proxy->priv->properties);
1029           while (g_hash_table_iter_next (&iter, (gpointer) &key, NULL))
1030             g_ptr_array_add (invalidated_properties, g_strdup (key));
1031           g_ptr_array_add (invalidated_properties, NULL);
1032
1033           /* ... throw out the properties ... */
1034           g_hash_table_remove_all (proxy->priv->properties);
1035
1036           /* ... and finally emit the ::g-properties-changed signal */
1037           g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
1038                          0,
1039                          changed_properties,
1040                          (const gchar* const *) invalidated_properties->pdata);
1041           g_variant_unref (changed_properties);
1042           g_ptr_array_unref (invalidated_properties);
1043         }
1044       g_object_notify (G_OBJECT (proxy), "g-name-owner");
1045     }
1046   else
1047     {
1048       /* ignore duplicates - this can happen when activating the service */
1049       if (g_strcmp0 (new_owner, proxy->priv->name_owner) == 0)
1050         goto out;
1051
1052       if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES)
1053         {
1054           g_free (proxy->priv->name_owner);
1055           proxy->priv->name_owner = g_strdup (new_owner);
1056           g_hash_table_remove_all (proxy->priv->properties);
1057           g_object_notify (G_OBJECT (proxy), "g-name-owner");
1058         }
1059       else
1060         {
1061           LoadPropertiesOnNameOwnerChangedData *data;
1062
1063           /* start loading properties.. only then emit notify::g-name-owner .. we
1064            * need to be able to cancel this in the event another NameOwnerChanged
1065            * signal suddenly happens
1066            */
1067
1068           g_assert (proxy->priv->get_all_cancellable == NULL);
1069           proxy->priv->get_all_cancellable = g_cancellable_new ();
1070           data = g_new0 (LoadPropertiesOnNameOwnerChangedData, 1);
1071           data->proxy = g_object_ref (proxy);
1072           data->cancellable = proxy->priv->get_all_cancellable;
1073           data->name_owner = g_strdup (new_owner);
1074           g_dbus_connection_call (proxy->priv->connection,
1075                                   data->name_owner,
1076                                   proxy->priv->object_path,
1077                                   "org.freedesktop.DBus.Properties",
1078                                   "GetAll",
1079                                   g_variant_new ("(s)", proxy->priv->interface_name),
1080                                   G_VARIANT_TYPE ("(a{sv})"),
1081                                   G_DBUS_CALL_FLAGS_NONE,
1082                                   -1,           /* timeout */
1083                                   proxy->priv->get_all_cancellable,
1084                                   (GAsyncReadyCallback) on_name_owner_changed_get_all_cb,
1085                                   data);
1086         }
1087     }
1088
1089  out:
1090   ;
1091 }
1092
1093 /* ---------------------------------------------------------------------------------------------------- */
1094
1095 typedef struct
1096 {
1097   GDBusProxy *proxy;
1098   GCancellable *cancellable;
1099   GSimpleAsyncResult *simple;
1100 } AsyncInitData;
1101
1102 static void
1103 async_init_data_free (AsyncInitData *data)
1104 {
1105   g_object_unref (data->proxy);
1106   if (data->cancellable != NULL)
1107     g_object_unref (data->cancellable);
1108   g_object_unref (data->simple);
1109   g_free (data);
1110 }
1111
1112 static void
1113 async_init_get_all_cb (GDBusConnection *connection,
1114                        GAsyncResult    *res,
1115                        gpointer         user_data)
1116 {
1117   AsyncInitData *data = user_data;
1118   GVariant *result;
1119   GError *error;
1120
1121   error = NULL;
1122   result = g_dbus_connection_call_finish (connection,
1123                                           res,
1124                                           &error);
1125   if (result == NULL)
1126     {
1127       /* We just ignore if GetAll() is failing. Because this might happen
1128        * if the object has no properties at all. Or if the caller is
1129        * not authorized to see the properties.
1130        *
1131        * Either way, apps can know about this by using
1132        * get_cached_property_names() or get_cached_property().
1133        *
1134        * TODO: handle G_DBUS_DEBUG flag 'proxy' and, if enabled, log the
1135        * fact that GetAll() failed
1136        */
1137       //g_debug ("error: %d %d %s", error->domain, error->code, error->message);
1138       g_error_free (error);
1139     }
1140   else
1141     {
1142       g_simple_async_result_set_op_res_gpointer (data->simple,
1143                                                  result,
1144                                                  (GDestroyNotify) g_variant_unref);
1145     }
1146
1147   g_simple_async_result_complete_in_idle (data->simple);
1148   async_init_data_free (data);
1149 }
1150
1151
1152 static void
1153 async_init_get_name_owner_cb (GDBusConnection *connection,
1154                               GAsyncResult    *res,
1155                               gpointer         user_data)
1156 {
1157   AsyncInitData *data = user_data;
1158
1159   if (res != NULL)
1160     {
1161       GError *error;
1162       GVariant *result;
1163
1164       error = NULL;
1165       result = g_dbus_connection_call_finish (connection,
1166                                               res,
1167                                               &error);
1168       if (result == NULL)
1169         {
1170           if (error->domain == G_DBUS_ERROR &&
1171               error->code == G_DBUS_ERROR_NAME_HAS_NO_OWNER)
1172             {
1173               g_error_free (error);
1174             }
1175           else
1176             {
1177               g_simple_async_result_take_error (data->simple, error);
1178               g_simple_async_result_complete_in_idle (data->simple);
1179               async_init_data_free (data);
1180               goto out;
1181             }
1182         }
1183       else
1184         {
1185           g_variant_get (result,
1186                          "(s)",
1187                          &data->proxy->priv->name_owner);
1188           g_variant_unref (result);
1189         }
1190     }
1191
1192   if (!(data->proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
1193     {
1194       /* load all properties asynchronously */
1195       g_dbus_connection_call (data->proxy->priv->connection,
1196                               data->proxy->priv->name_owner,
1197                               data->proxy->priv->object_path,
1198                               "org.freedesktop.DBus.Properties",
1199                               "GetAll",
1200                               g_variant_new ("(s)", data->proxy->priv->interface_name),
1201                               G_VARIANT_TYPE ("(a{sv})"),
1202                               G_DBUS_CALL_FLAGS_NONE,
1203                               -1,           /* timeout */
1204                               data->cancellable,
1205                               (GAsyncReadyCallback) async_init_get_all_cb,
1206                               data);
1207     }
1208   else
1209     {
1210       g_simple_async_result_complete_in_idle (data->simple);
1211       async_init_data_free (data);
1212     }
1213
1214  out:
1215   ;
1216 }
1217
1218 static void
1219 async_init_call_get_name_owner (AsyncInitData *data)
1220 {
1221   g_dbus_connection_call (data->proxy->priv->connection,
1222                           "org.freedesktop.DBus",  /* name */
1223                           "/org/freedesktop/DBus", /* object path */
1224                           "org.freedesktop.DBus",  /* interface */
1225                           "GetNameOwner",
1226                           g_variant_new ("(s)",
1227                                          data->proxy->priv->name),
1228                           G_VARIANT_TYPE ("(s)"),
1229                           G_DBUS_CALL_FLAGS_NONE,
1230                           -1,           /* timeout */
1231                           data->cancellable,
1232                           (GAsyncReadyCallback) async_init_get_name_owner_cb,
1233                           data);
1234 }
1235
1236 static void
1237 async_init_start_service_by_name_cb (GDBusConnection *connection,
1238                                      GAsyncResult    *res,
1239                                      gpointer         user_data)
1240 {
1241   AsyncInitData *data = user_data;
1242   GError *error;
1243   GVariant *result;
1244
1245   error = NULL;
1246   result = g_dbus_connection_call_finish (connection,
1247                                           res,
1248                                           &error);
1249   if (result == NULL)
1250     {
1251       /* Errors are not unexpected; the bus will reply e.g.
1252        *
1253        *   org.freedesktop.DBus.Error.ServiceUnknown: The name org.gnome.Epiphany2
1254        *   was not provided by any .service files
1255        *
1256        * This doesn't mean that the name doesn't have an owner, just
1257        * that it's not provided by a .service file. So just proceed to
1258        * invoke GetNameOwner() if dealing with that error.
1259        */
1260       if (error->domain == G_DBUS_ERROR &&
1261           error->code == G_DBUS_ERROR_SERVICE_UNKNOWN)
1262         {
1263           g_error_free (error);
1264         }
1265       else
1266         {
1267           g_prefix_error (&error,
1268                           _("Error calling StartServiceByName for %s: "),
1269                           data->proxy->priv->name);
1270           goto failed;
1271         }
1272     }
1273   else
1274     {
1275       guint32 start_service_result;
1276       g_variant_get (result,
1277                      "(u)",
1278                      &start_service_result);
1279       g_variant_unref (result);
1280       if (start_service_result == 1 ||  /* DBUS_START_REPLY_SUCCESS */
1281           start_service_result == 2)    /* DBUS_START_REPLY_ALREADY_RUNNING */
1282         {
1283           /* continue to invoke GetNameOwner() */
1284         }
1285       else
1286         {
1287           error = g_error_new (G_IO_ERROR,
1288                                G_IO_ERROR_FAILED,
1289                                _("Unexpected reply %d from StartServiceByName(\"%s\") method"),
1290                                start_service_result,
1291                                data->proxy->priv->name);
1292           goto failed;
1293         }
1294     }
1295
1296   async_init_call_get_name_owner (data);
1297   return;
1298
1299  failed:
1300   g_warn_if_fail (error != NULL);
1301   g_simple_async_result_take_error (data->simple, error);
1302   g_simple_async_result_complete_in_idle (data->simple);
1303   async_init_data_free (data);
1304 }
1305
1306 static void
1307 async_init_call_start_service_by_name (AsyncInitData *data)
1308 {
1309   g_dbus_connection_call (data->proxy->priv->connection,
1310                           "org.freedesktop.DBus",  /* name */
1311                           "/org/freedesktop/DBus", /* object path */
1312                           "org.freedesktop.DBus",  /* interface */
1313                           "StartServiceByName",
1314                           g_variant_new ("(su)",
1315                                          data->proxy->priv->name,
1316                                          0),
1317                           G_VARIANT_TYPE ("(u)"),
1318                           G_DBUS_CALL_FLAGS_NONE,
1319                           -1,           /* timeout */
1320                           data->cancellable,
1321                           (GAsyncReadyCallback) async_init_start_service_by_name_cb,
1322                           data);
1323 }
1324
1325 static void
1326 async_initable_init_second_async (GAsyncInitable      *initable,
1327                                   gint                 io_priority,
1328                                   GCancellable        *cancellable,
1329                                   GAsyncReadyCallback  callback,
1330                                   gpointer             user_data)
1331 {
1332   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1333   AsyncInitData *data;
1334
1335   data = g_new0 (AsyncInitData, 1);
1336   data->proxy = g_object_ref (proxy);
1337   data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
1338   data->simple = g_simple_async_result_new (G_OBJECT (proxy),
1339                                             callback,
1340                                             user_data,
1341                                             NULL);
1342
1343   /* Check name ownership asynchronously - possibly also start the service */
1344   if (proxy->priv->name == NULL)
1345     {
1346       /* Do nothing */
1347       async_init_get_name_owner_cb (proxy->priv->connection, NULL, data);
1348     }
1349   else if (g_dbus_is_unique_name (proxy->priv->name))
1350     {
1351       proxy->priv->name_owner = g_strdup (proxy->priv->name);
1352       async_init_get_name_owner_cb (proxy->priv->connection, NULL, data);
1353     }
1354   else
1355     {
1356       if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START)
1357         {
1358           async_init_call_get_name_owner (data);
1359         }
1360       else
1361         {
1362           async_init_call_start_service_by_name (data);
1363         }
1364     }
1365 }
1366
1367 static gboolean
1368 async_initable_init_second_finish (GAsyncInitable  *initable,
1369                                    GAsyncResult    *res,
1370                                    GError         **error)
1371 {
1372   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1373   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1374   GVariant *result;
1375   gboolean ret;
1376
1377   ret = FALSE;
1378
1379   if (g_simple_async_result_propagate_error (simple, error))
1380     goto out;
1381
1382   result = g_simple_async_result_get_op_res_gpointer (simple);
1383   if (result != NULL)
1384     {
1385       process_get_all_reply (proxy, result);
1386     }
1387
1388   ret = TRUE;
1389
1390  out:
1391   proxy->priv->initialized = TRUE;
1392   return ret;
1393 }
1394
1395 /* ---------------------------------------------------------------------------------------------------- */
1396
1397 static void
1398 async_initable_init_first (GAsyncInitable *initable)
1399 {
1400   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1401
1402   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
1403     {
1404       /* subscribe to PropertiesChanged() */
1405       proxy->priv->properties_changed_subscriber_id =
1406         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1407                                             proxy->priv->name,
1408                                             "org.freedesktop.DBus.Properties",
1409                                             "PropertiesChanged",
1410                                             proxy->priv->object_path,
1411                                             proxy->priv->interface_name,
1412                                             G_DBUS_SIGNAL_FLAGS_NONE,
1413                                             on_properties_changed,
1414                                             proxy,
1415                                             NULL);
1416     }
1417
1418   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS))
1419     {
1420       /* subscribe to all signals for the object */
1421       proxy->priv->signals_subscriber_id =
1422         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1423                                             proxy->priv->name,
1424                                             proxy->priv->interface_name,
1425                                             NULL,                        /* member */
1426                                             proxy->priv->object_path,
1427                                             NULL,                        /* arg0 */
1428                                             G_DBUS_SIGNAL_FLAGS_NONE,
1429                                             on_signal_received,
1430                                             proxy,
1431                                             NULL);
1432     }
1433
1434   if (proxy->priv->name != NULL && !g_dbus_is_unique_name (proxy->priv->name))
1435     {
1436       proxy->priv->name_owner_changed_subscription_id =
1437         g_dbus_connection_signal_subscribe (proxy->priv->connection,
1438                                             "org.freedesktop.DBus",  /* name */
1439                                             "org.freedesktop.DBus",  /* interface */
1440                                             "NameOwnerChanged",      /* signal name */
1441                                             "/org/freedesktop/DBus", /* path */
1442                                             proxy->priv->name,       /* arg0 */
1443                                             G_DBUS_SIGNAL_FLAGS_NONE,
1444                                             on_name_owner_changed,
1445                                             proxy,
1446                                             NULL);
1447     }
1448 }
1449
1450 /* ---------------------------------------------------------------------------------------------------- */
1451
1452 /* initialization is split into two parts - the first is the
1453  * non-blocing part that requires the callers GMainContext - the
1454  * second is a blocking part async part that doesn't require the
1455  * callers GMainContext.. we do this split so the code can be reused
1456  * in the GInitable implementation below.
1457  *
1458  * Note that obtaining a GDBusConnection is not shared between the two
1459  * paths.
1460  */
1461
1462 typedef struct
1463 {
1464   GDBusProxy          *proxy;
1465   gint                 io_priority;
1466   GCancellable        *cancellable;
1467   GAsyncReadyCallback  callback;
1468   gpointer             user_data;
1469 } GetConnectionData;
1470
1471 static void
1472 get_connection_cb (GObject       *source_object,
1473                    GAsyncResult  *res,
1474                    gpointer       user_data)
1475 {
1476   GetConnectionData *data = user_data;
1477   GError *error;
1478
1479   error = NULL;
1480   data->proxy->priv->connection = g_bus_get_finish (res, &error);
1481   if (data->proxy->priv->connection == NULL)
1482     {
1483       GSimpleAsyncResult *simple;
1484       simple = g_simple_async_result_new (G_OBJECT (data->proxy),
1485                                           data->callback,
1486                                           data->user_data,
1487                                           NULL);
1488       g_simple_async_result_take_error (simple, error);
1489       g_simple_async_result_complete_in_idle (simple);
1490       g_object_unref (simple);
1491     }
1492   else
1493     {
1494       async_initable_init_first (G_ASYNC_INITABLE (data->proxy));
1495       async_initable_init_second_async (G_ASYNC_INITABLE (data->proxy),
1496                                         data->io_priority,
1497                                         data->cancellable,
1498                                         data->callback,
1499                                         data->user_data);
1500     }
1501
1502   if (data->cancellable != NULL)
1503     g_object_unref (data->cancellable);
1504   if (data->proxy != NULL)
1505     g_object_unref (data->proxy);
1506   g_free (data);
1507 }
1508
1509 static void
1510 async_initable_init_async (GAsyncInitable      *initable,
1511                            gint                 io_priority,
1512                            GCancellable        *cancellable,
1513                            GAsyncReadyCallback  callback,
1514                            gpointer             user_data)
1515 {
1516   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1517
1518   if (proxy->priv->bus_type != G_BUS_TYPE_NONE)
1519     {
1520       GetConnectionData *data;
1521
1522       g_assert (proxy->priv->connection == NULL);
1523
1524       data = g_new0 (GetConnectionData, 1);
1525       data->proxy = g_object_ref (proxy);
1526       data->io_priority = io_priority;
1527       data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
1528       data->callback = callback;
1529       data->user_data = user_data;
1530       g_bus_get (proxy->priv->bus_type,
1531                  cancellable,
1532                  get_connection_cb,
1533                  data);
1534     }
1535   else
1536     {
1537       async_initable_init_first (initable);
1538       async_initable_init_second_async (initable, io_priority, cancellable, callback, user_data);
1539     }
1540 }
1541
1542 static gboolean
1543 async_initable_init_finish (GAsyncInitable  *initable,
1544                             GAsyncResult    *res,
1545                             GError         **error)
1546 {
1547   return async_initable_init_second_finish (initable, res, error);
1548 }
1549
1550 static void
1551 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
1552 {
1553   async_initable_iface->init_async = async_initable_init_async;
1554   async_initable_iface->init_finish = async_initable_init_finish;
1555 }
1556
1557 /* ---------------------------------------------------------------------------------------------------- */
1558
1559 typedef struct
1560 {
1561   GMainContext *context;
1562   GMainLoop *loop;
1563   GAsyncResult *res;
1564 } InitableAsyncInitableData;
1565
1566 static void
1567 async_initable_init_async_cb (GObject      *source_object,
1568                               GAsyncResult *res,
1569                               gpointer      user_data)
1570 {
1571   InitableAsyncInitableData *data = user_data;
1572   data->res = g_object_ref (res);
1573   g_main_loop_quit (data->loop);
1574 }
1575
1576 /* Simply reuse the GAsyncInitable implementation but run the first
1577  * part (that is non-blocking and requires the callers GMainContext)
1578  * with the callers GMainContext.. and the second with a private
1579  * GMainContext (bug 621310 is slightly related).
1580  *
1581  * Note that obtaining a GDBusConnection is not shared between the two
1582  * paths.
1583  */
1584 static gboolean
1585 initable_init (GInitable     *initable,
1586                GCancellable  *cancellable,
1587                GError       **error)
1588 {
1589   GDBusProxy *proxy = G_DBUS_PROXY (initable);
1590   InitableAsyncInitableData *data;
1591   gboolean ret;
1592
1593   ret = FALSE;
1594
1595   if (proxy->priv->bus_type != G_BUS_TYPE_NONE)
1596     {
1597       g_assert (proxy->priv->connection == NULL);
1598       proxy->priv->connection = g_bus_get_sync (proxy->priv->bus_type,
1599                                                 cancellable,
1600                                                 error);
1601       if (proxy->priv->connection == NULL)
1602         goto out;
1603     }
1604
1605   async_initable_init_first (G_ASYNC_INITABLE (initable));
1606
1607   data = g_new0 (InitableAsyncInitableData, 1);
1608   data->context = g_main_context_new ();
1609   data->loop = g_main_loop_new (data->context, FALSE);
1610
1611   g_main_context_push_thread_default (data->context);
1612
1613   async_initable_init_second_async (G_ASYNC_INITABLE (initable),
1614                                     G_PRIORITY_DEFAULT,
1615                                     cancellable,
1616                                     async_initable_init_async_cb,
1617                                     data);
1618
1619   g_main_loop_run (data->loop);
1620
1621   ret = async_initable_init_second_finish (G_ASYNC_INITABLE (initable),
1622                                            data->res,
1623                                            error);
1624
1625   g_main_context_pop_thread_default (data->context);
1626
1627   g_main_context_unref (data->context);
1628   g_main_loop_unref (data->loop);
1629   g_object_unref (data->res);
1630   g_free (data);
1631
1632  out:
1633
1634   return ret;
1635 }
1636
1637 static void
1638 initable_iface_init (GInitableIface *initable_iface)
1639 {
1640   initable_iface->init = initable_init;
1641 }
1642
1643 /* ---------------------------------------------------------------------------------------------------- */
1644
1645 /**
1646  * g_dbus_proxy_new:
1647  * @connection: A #GDBusConnection.
1648  * @flags: Flags used when constructing the proxy.
1649  * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1650  * @name: A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
1651  * @object_path: An object path.
1652  * @interface_name: A D-Bus interface name.
1653  * @cancellable: A #GCancellable or %NULL.
1654  * @callback: Callback function to invoke when the proxy is ready.
1655  * @user_data: User data to pass to @callback.
1656  *
1657  * Creates a proxy for accessing @interface_name on the remote object
1658  * at @object_path owned by @name at @connection and asynchronously
1659  * loads D-Bus properties unless the
1660  * %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to
1661  * the #GDBusProxy::g-properties-changed signal to get notified about
1662  * property changes.
1663  *
1664  * If the %G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
1665  * match rules for signals. Connect to the #GDBusProxy::g-signal signal
1666  * to handle signals from the remote object.
1667  *
1668  * If @name is a well-known name and the
1669  * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
1670  * owner currently exists, the message bus will be requested to launch
1671  * a name owner for the name.
1672  *
1673  * This is a failable asynchronous constructor - when the proxy is
1674  * ready, @callback will be invoked and you can use
1675  * g_dbus_proxy_new_finish() to get the result.
1676  *
1677  * See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
1678  *
1679  * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
1680  *
1681  * Since: 2.26
1682  */
1683 void
1684 g_dbus_proxy_new (GDBusConnection     *connection,
1685                   GDBusProxyFlags      flags,
1686                   GDBusInterfaceInfo  *info,
1687                   const gchar         *name,
1688                   const gchar         *object_path,
1689                   const gchar         *interface_name,
1690                   GCancellable        *cancellable,
1691                   GAsyncReadyCallback  callback,
1692                   gpointer             user_data)
1693 {
1694   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1695   g_return_if_fail ((name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) || g_dbus_is_name (name));
1696   g_return_if_fail (g_variant_is_object_path (object_path));
1697   g_return_if_fail (g_dbus_is_interface_name (interface_name));
1698
1699   g_async_initable_new_async (G_TYPE_DBUS_PROXY,
1700                               G_PRIORITY_DEFAULT,
1701                               cancellable,
1702                               callback,
1703                               user_data,
1704                               "g-flags", flags,
1705                               "g-interface-info", info,
1706                               "g-name", name,
1707                               "g-connection", connection,
1708                               "g-object-path", object_path,
1709                               "g-interface-name", interface_name,
1710                               NULL);
1711 }
1712
1713 /**
1714  * g_dbus_proxy_new_finish:
1715  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new().
1716  * @error: Return location for error or %NULL.
1717  *
1718  * Finishes creating a #GDBusProxy.
1719  *
1720  * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
1721  *
1722  * Since: 2.26
1723  */
1724 GDBusProxy *
1725 g_dbus_proxy_new_finish (GAsyncResult  *res,
1726                          GError       **error)
1727 {
1728   GObject *object;
1729   GObject *source_object;
1730
1731   source_object = g_async_result_get_source_object (res);
1732   g_assert (source_object != NULL);
1733
1734   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
1735                                         res,
1736                                         error);
1737   g_object_unref (source_object);
1738
1739   if (object != NULL)
1740     return G_DBUS_PROXY (object);
1741   else
1742     return NULL;
1743 }
1744
1745 /**
1746  * g_dbus_proxy_new_sync:
1747  * @connection: A #GDBusConnection.
1748  * @flags: Flags used when constructing the proxy.
1749  * @info: (allow-none): A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1750  * @name: (allow-none): A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
1751  * @object_path: An object path.
1752  * @interface_name: A D-Bus interface name.
1753  * @cancellable: (allow-none): A #GCancellable or %NULL.
1754  * @error: (allow-none): Return location for error or %NULL.
1755  *
1756  * Creates a proxy for accessing @interface_name on the remote object
1757  * at @object_path owned by @name at @connection and synchronously
1758  * loads D-Bus properties unless the
1759  * %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used.
1760  *
1761  * If the %G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
1762  * match rules for signals. Connect to the #GDBusProxy::g-signal signal
1763  * to handle signals from the remote object.
1764  *
1765  * If @name is a well-known name and the
1766  * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
1767  * owner currently exists, the message bus will be requested to launch
1768  * a name owner for the name.
1769  *
1770  * This is a synchronous failable constructor. See g_dbus_proxy_new()
1771  * and g_dbus_proxy_new_finish() for the asynchronous version.
1772  *
1773  * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
1774  *
1775  * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
1776  *
1777  * Since: 2.26
1778  */
1779 GDBusProxy *
1780 g_dbus_proxy_new_sync (GDBusConnection     *connection,
1781                        GDBusProxyFlags      flags,
1782                        GDBusInterfaceInfo  *info,
1783                        const gchar         *name,
1784                        const gchar         *object_path,
1785                        const gchar         *interface_name,
1786                        GCancellable        *cancellable,
1787                        GError             **error)
1788 {
1789   GInitable *initable;
1790
1791   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1792   g_return_val_if_fail ((name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
1793                         g_dbus_is_name (name), NULL);
1794   g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
1795   g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
1796
1797   initable = g_initable_new (G_TYPE_DBUS_PROXY,
1798                              cancellable,
1799                              error,
1800                              "g-flags", flags,
1801                              "g-interface-info", info,
1802                              "g-name", name,
1803                              "g-connection", connection,
1804                              "g-object-path", object_path,
1805                              "g-interface-name", interface_name,
1806                              NULL);
1807   if (initable != NULL)
1808     return G_DBUS_PROXY (initable);
1809   else
1810     return NULL;
1811 }
1812
1813 /* ---------------------------------------------------------------------------------------------------- */
1814
1815 /**
1816  * g_dbus_proxy_new_for_bus:
1817  * @bus_type: A #GBusType.
1818  * @flags: Flags used when constructing the proxy.
1819  * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1820  * @name: A bus name (well-known or unique).
1821  * @object_path: An object path.
1822  * @interface_name: A D-Bus interface name.
1823  * @cancellable: A #GCancellable or %NULL.
1824  * @callback: Callback function to invoke when the proxy is ready.
1825  * @user_data: User data to pass to @callback.
1826  *
1827  * Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection.
1828  *
1829  * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
1830  *
1831  * Since: 2.26
1832  */
1833 void
1834 g_dbus_proxy_new_for_bus (GBusType             bus_type,
1835                           GDBusProxyFlags      flags,
1836                           GDBusInterfaceInfo  *info,
1837                           const gchar         *name,
1838                           const gchar         *object_path,
1839                           const gchar         *interface_name,
1840                           GCancellable        *cancellable,
1841                           GAsyncReadyCallback  callback,
1842                           gpointer             user_data)
1843 {
1844   g_return_if_fail (g_dbus_is_name (name));
1845   g_return_if_fail (g_variant_is_object_path (object_path));
1846   g_return_if_fail (g_dbus_is_interface_name (interface_name));
1847
1848   g_async_initable_new_async (G_TYPE_DBUS_PROXY,
1849                               G_PRIORITY_DEFAULT,
1850                               cancellable,
1851                               callback,
1852                               user_data,
1853                               "g-flags", flags,
1854                               "g-interface-info", info,
1855                               "g-name", name,
1856                               "g-bus-type", bus_type,
1857                               "g-object-path", object_path,
1858                               "g-interface-name", interface_name,
1859                               NULL);
1860 }
1861
1862 /**
1863  * g_dbus_proxy_new_for_bus_finish:
1864  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus().
1865  * @error: Return location for error or %NULL.
1866  *
1867  * Finishes creating a #GDBusProxy.
1868  *
1869  * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
1870  *
1871  * Since: 2.26
1872  */
1873 GDBusProxy *
1874 g_dbus_proxy_new_for_bus_finish (GAsyncResult  *res,
1875                                  GError       **error)
1876 {
1877   return g_dbus_proxy_new_finish (res, error);
1878 }
1879
1880 /**
1881  * g_dbus_proxy_new_for_bus_sync:
1882  * @bus_type: A #GBusType.
1883  * @flags: Flags used when constructing the proxy.
1884  * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1885  * @name: A bus name (well-known or unique).
1886  * @object_path: An object path.
1887  * @interface_name: A D-Bus interface name.
1888  * @cancellable: A #GCancellable or %NULL.
1889  * @error: Return location for error or %NULL.
1890  *
1891  * Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.
1892  *
1893  * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
1894  *
1895  * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
1896  *
1897  * Since: 2.26
1898  */
1899 GDBusProxy *
1900 g_dbus_proxy_new_for_bus_sync (GBusType             bus_type,
1901                                GDBusProxyFlags      flags,
1902                                GDBusInterfaceInfo  *info,
1903                                const gchar         *name,
1904                                const gchar         *object_path,
1905                                const gchar         *interface_name,
1906                                GCancellable        *cancellable,
1907                                GError             **error)
1908 {
1909   GInitable *initable;
1910
1911   g_return_val_if_fail (g_dbus_is_name (name), NULL);
1912   g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
1913   g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
1914
1915   initable = g_initable_new (G_TYPE_DBUS_PROXY,
1916                              cancellable,
1917                              error,
1918                              "g-flags", flags,
1919                              "g-interface-info", info,
1920                              "g-name", name,
1921                              "g-bus-type", bus_type,
1922                              "g-object-path", object_path,
1923                              "g-interface-name", interface_name,
1924                              NULL);
1925   if (initable != NULL)
1926     return G_DBUS_PROXY (initable);
1927   else
1928     return NULL;
1929 }
1930
1931 /* ---------------------------------------------------------------------------------------------------- */
1932
1933 /**
1934  * g_dbus_proxy_get_connection:
1935  * @proxy: A #GDBusProxy.
1936  *
1937  * Gets the connection @proxy is for.
1938  *
1939  * Returns: (transfer none): A #GDBusConnection owned by @proxy. Do not free.
1940  *
1941  * Since: 2.26
1942  */
1943 GDBusConnection *
1944 g_dbus_proxy_get_connection (GDBusProxy *proxy)
1945 {
1946   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1947   return proxy->priv->connection;
1948 }
1949
1950 /**
1951  * g_dbus_proxy_get_flags:
1952  * @proxy: A #GDBusProxy.
1953  *
1954  * Gets the flags that @proxy was constructed with.
1955  *
1956  * Returns: Flags from the #GDBusProxyFlags enumeration.
1957  *
1958  * Since: 2.26
1959  */
1960 GDBusProxyFlags
1961 g_dbus_proxy_get_flags (GDBusProxy *proxy)
1962 {
1963   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), 0);
1964   return proxy->priv->flags;
1965 }
1966
1967 /**
1968  * g_dbus_proxy_get_name:
1969  * @proxy: A #GDBusProxy.
1970  *
1971  * Gets the name that @proxy was constructed for.
1972  *
1973  * Returns: A string owned by @proxy. Do not free.
1974  *
1975  * Since: 2.26
1976  */
1977 const gchar *
1978 g_dbus_proxy_get_name (GDBusProxy *proxy)
1979 {
1980   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1981   return proxy->priv->name;
1982 }
1983
1984 /**
1985  * g_dbus_proxy_get_name_owner:
1986  * @proxy: A #GDBusProxy.
1987  *
1988  * The unique name that owns the name that @proxy is for or %NULL if
1989  * no-one currently owns that name. You may connect to the
1990  * #GObject::notify signal to track changes to the
1991  * #GDBusProxy:g-name-owner property.
1992  *
1993  * Returns: The name owner or %NULL if no name owner exists. Free with g_free().
1994  *
1995  * Since: 2.26
1996  */
1997 gchar *
1998 g_dbus_proxy_get_name_owner (GDBusProxy *proxy)
1999 {
2000   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2001   return g_strdup (proxy->priv->name_owner);
2002 }
2003
2004 /**
2005  * g_dbus_proxy_get_object_path:
2006  * @proxy: A #GDBusProxy.
2007  *
2008  * Gets the object path @proxy is for.
2009  *
2010  * Returns: A string owned by @proxy. Do not free.
2011  *
2012  * Since: 2.26
2013  */
2014 const gchar *
2015 g_dbus_proxy_get_object_path (GDBusProxy *proxy)
2016 {
2017   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2018   return proxy->priv->object_path;
2019 }
2020
2021 /**
2022  * g_dbus_proxy_get_interface_name:
2023  * @proxy: A #GDBusProxy.
2024  *
2025  * Gets the D-Bus interface name @proxy is for.
2026  *
2027  * Returns: A string owned by @proxy. Do not free.
2028  *
2029  * Since: 2.26
2030  */
2031 const gchar *
2032 g_dbus_proxy_get_interface_name (GDBusProxy *proxy)
2033 {
2034   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2035   return proxy->priv->interface_name;
2036 }
2037
2038 /**
2039  * g_dbus_proxy_get_default_timeout:
2040  * @proxy: A #GDBusProxy.
2041  *
2042  * Gets the timeout to use if -1 (specifying default timeout) is
2043  * passed as @timeout_msec in the g_dbus_proxy_call() and
2044  * g_dbus_proxy_call_sync() functions.
2045  *
2046  * See the #GDBusProxy:g-default-timeout property for more details.
2047  *
2048  * Returns: Timeout to use for @proxy.
2049  *
2050  * Since: 2.26
2051  */
2052 gint
2053 g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
2054 {
2055   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), -1);
2056   return proxy->priv->timeout_msec;
2057 }
2058
2059 /**
2060  * g_dbus_proxy_set_default_timeout:
2061  * @proxy: A #GDBusProxy.
2062  * @timeout_msec: Timeout in milliseconds.
2063  *
2064  * Sets the timeout to use if -1 (specifying default timeout) is
2065  * passed as @timeout_msec in the g_dbus_proxy_call() and
2066  * g_dbus_proxy_call_sync() functions.
2067  *
2068  * See the #GDBusProxy:g-default-timeout property for more details.
2069  *
2070  * Since: 2.26
2071  */
2072 void
2073 g_dbus_proxy_set_default_timeout (GDBusProxy *proxy,
2074                                   gint        timeout_msec)
2075 {
2076   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2077   g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
2078
2079   /* TODO: locking? */
2080   if (proxy->priv->timeout_msec != timeout_msec)
2081     {
2082       proxy->priv->timeout_msec = timeout_msec;
2083       g_object_notify (G_OBJECT (proxy), "g-default-timeout");
2084     }
2085 }
2086
2087 /**
2088  * g_dbus_proxy_get_interface_info:
2089  * @proxy: A #GDBusProxy
2090  *
2091  * Returns the #GDBusInterfaceInfo, if any, specifying the minimal
2092  * interface that @proxy conforms to.
2093  *
2094  * See the #GDBusProxy:g-interface-info property for more details.
2095  *
2096  * Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
2097  * object, it is owned by @proxy.
2098  *
2099  * Since: 2.26
2100  */
2101 GDBusInterfaceInfo *
2102 g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
2103 {
2104   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2105   return proxy->priv->expected_interface;
2106 }
2107
2108 /**
2109  * g_dbus_proxy_set_interface_info:
2110  * @proxy: A #GDBusProxy
2111  * @info: Minimum interface this proxy conforms to or %NULL to unset.
2112  *
2113  * Ensure that interactions with @proxy conform to the given
2114  * interface.  For example, when completing a method call, if the type
2115  * signature of the message isn't what's expected, the given #GError
2116  * is set.  Signals that have a type signature mismatch are simply
2117  * dropped.
2118  *
2119  * See the #GDBusProxy:g-interface-info property for more details.
2120  *
2121  * Since: 2.26
2122  */
2123 void
2124 g_dbus_proxy_set_interface_info (GDBusProxy         *proxy,
2125                                  GDBusInterfaceInfo *info)
2126 {
2127   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2128   if (proxy->priv->expected_interface != NULL)
2129     {
2130       g_dbus_interface_info_cache_release (proxy->priv->expected_interface);
2131       g_dbus_interface_info_unref (proxy->priv->expected_interface);
2132     }
2133   proxy->priv->expected_interface = info != NULL ? g_dbus_interface_info_ref (info) : NULL;
2134   if (proxy->priv->expected_interface != NULL)
2135     g_dbus_interface_info_cache_build (proxy->priv->expected_interface);
2136 }
2137
2138 /* ---------------------------------------------------------------------------------------------------- */
2139
2140 static gboolean
2141 maybe_split_method_name (const gchar  *method_name,
2142                          gchar       **out_interface_name,
2143                          const gchar **out_method_name)
2144 {
2145   gboolean was_split;
2146
2147   was_split = FALSE;
2148   g_assert (out_interface_name != NULL);
2149   g_assert (out_method_name != NULL);
2150   *out_interface_name = NULL;
2151   *out_method_name = NULL;
2152
2153   if (strchr (method_name, '.') != NULL)
2154     {
2155       gchar *p;
2156       gchar *last_dot;
2157
2158       p = g_strdup (method_name);
2159       last_dot = strrchr (p, '.');
2160       *last_dot = '\0';
2161
2162       *out_interface_name = p;
2163       *out_method_name = last_dot + 1;
2164
2165       was_split = TRUE;
2166     }
2167
2168   return was_split;
2169 }
2170
2171
2172 static void
2173 reply_cb (GDBusConnection *connection,
2174           GAsyncResult    *res,
2175           gpointer         user_data)
2176 {
2177   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
2178   GVariant *value;
2179   GError *error;
2180
2181   error = NULL;
2182   value = g_dbus_connection_call_finish (connection,
2183                                          res,
2184                                          &error);
2185   if (error != NULL)
2186     {
2187       g_simple_async_result_take_error (simple, error);
2188     }
2189   else
2190     {
2191       g_simple_async_result_set_op_res_gpointer (simple,
2192                                                  value,
2193                                                  (GDestroyNotify) g_variant_unref);
2194     }
2195
2196   /* no need to complete in idle since the method GDBusConnection already does */
2197   g_simple_async_result_complete (simple);
2198   g_object_unref (simple);
2199 }
2200
2201 static const GDBusMethodInfo *
2202 lookup_method_info_or_warn (GDBusProxy  *proxy,
2203                             const gchar *method_name)
2204 {
2205   const GDBusMethodInfo *info;
2206
2207   if (proxy->priv->expected_interface == NULL)
2208     return NULL;
2209
2210   info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, method_name);
2211   if (info == NULL)
2212     {
2213       g_warning ("Trying to invoke method %s which isn't in expected interface %s",
2214                  method_name, proxy->priv->expected_interface->name);
2215     }
2216
2217   return info;
2218 }
2219
2220 static const gchar *
2221 get_destination_for_call (GDBusProxy *proxy)
2222 {
2223   const gchar *ret;
2224
2225   ret = NULL;
2226
2227   /* If proxy->priv->name is a unique name, then proxy->priv->name_owner
2228    * is never NULL and always the same as proxy->priv->name. We use this
2229    * knowledge to avoid checking if proxy->priv->name is a unique or
2230    * well-known name.
2231    */
2232   ret = proxy->priv->name_owner;
2233   if (ret != NULL)
2234     goto out;
2235
2236   if (proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START)
2237     goto out;
2238
2239   ret = proxy->priv->name;
2240
2241  out:
2242   return ret;
2243 }
2244
2245 /**
2246  * g_dbus_proxy_call:
2247  * @proxy: A #GDBusProxy.
2248  * @method_name: Name of method to invoke.
2249  * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
2250  * @flags: Flags from the #GDBusCallFlags enumeration.
2251  * @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
2252  *                "infinite") or -1 to use the proxy default timeout.
2253  * @cancellable: A #GCancellable or %NULL.
2254  * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
2255  * care about the result of the method invocation.
2256  * @user_data: The data to pass to @callback.
2257  *
2258  * Asynchronously invokes the @method_name method on @proxy.
2259  *
2260  * If @method_name contains any dots, then @name is split into interface and
2261  * method name parts. This allows using @proxy for invoking methods on
2262  * other interfaces.
2263  *
2264  * If the #GDBusConnection associated with @proxy is closed then
2265  * the operation will fail with %G_IO_ERROR_CLOSED. If
2266  * @cancellable is canceled, the operation will fail with
2267  * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
2268  * compatible with the D-Bus protocol, the operation fails with
2269  * %G_IO_ERROR_INVALID_ARGUMENT.
2270  *
2271  * If the @parameters #GVariant is floating, it is consumed. This allows
2272  * convenient 'inline' use of g_variant_new(), e.g.:
2273  * |[
2274  *  g_dbus_proxy_call (proxy,
2275  *                     "TwoStrings",
2276  *                     g_variant_new ("(ss)",
2277  *                                    "Thing One",
2278  *                                    "Thing Two"),
2279  *                     G_DBUS_CALL_FLAGS_NONE,
2280  *                     -1,
2281  *                     NULL,
2282  *                     (GAsyncReadyCallback) two_strings_done,
2283  *                     &amp;data);
2284  * ]|
2285  *
2286  * This is an asynchronous method. When the operation is finished,
2287  * @callback will be invoked in the
2288  * <link linkend="g-main-context-push-thread-default">thread-default
2289  * main loop</link> of the thread you are calling this method from.
2290  * You can then call g_dbus_proxy_call_finish() to get the result of
2291  * the operation. See g_dbus_proxy_call_sync() for the synchronous
2292  * version of this method.
2293  *
2294  * Since: 2.26
2295  */
2296 void
2297 g_dbus_proxy_call (GDBusProxy          *proxy,
2298                    const gchar         *method_name,
2299                    GVariant            *parameters,
2300                    GDBusCallFlags       flags,
2301                    gint                 timeout_msec,
2302                    GCancellable        *cancellable,
2303                    GAsyncReadyCallback  callback,
2304                    gpointer             user_data)
2305 {
2306   GSimpleAsyncResult *simple;
2307   gboolean was_split;
2308   gchar *split_interface_name;
2309   const gchar *split_method_name;
2310   const gchar *target_method_name;
2311   const gchar *target_interface_name;
2312   const gchar *destination;
2313   GVariantType *reply_type;
2314
2315   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
2316   g_return_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name));
2317   g_return_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
2318   g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
2319
2320   reply_type = NULL;
2321   split_interface_name = NULL;
2322
2323   simple = g_simple_async_result_new (G_OBJECT (proxy),
2324                                       callback,
2325                                       user_data,
2326                                       g_dbus_proxy_call);
2327
2328   was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
2329   target_method_name = was_split ? split_method_name : method_name;
2330   target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
2331
2332   /* Warn if method is unexpected (cf. :g-interface-info) */
2333   if (!was_split)
2334     {
2335       const GDBusMethodInfo *expected_method_info;
2336       expected_method_info = lookup_method_info_or_warn (proxy, target_method_name);
2337       if (expected_method_info != NULL)
2338         reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
2339     }
2340
2341   destination = NULL;
2342   if (proxy->priv->name != NULL)
2343     {
2344       destination = get_destination_for_call (proxy);
2345       if (destination == NULL)
2346         {
2347           g_simple_async_result_set_error (simple,
2348                                            G_IO_ERROR,
2349                                            G_IO_ERROR_FAILED,
2350                                            _("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"));
2351           goto out;
2352         }
2353     }
2354
2355   g_dbus_connection_call (proxy->priv->connection,
2356                           destination,
2357                           proxy->priv->object_path,
2358                           target_interface_name,
2359                           target_method_name,
2360                           parameters,
2361                           reply_type,
2362                           flags,
2363                           timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
2364                           cancellable,
2365                           (GAsyncReadyCallback) reply_cb,
2366                           simple);
2367
2368  out:
2369   if (reply_type != NULL)
2370     g_variant_type_free (reply_type);
2371
2372   g_free (split_interface_name);
2373 }
2374
2375 /**
2376  * g_dbus_proxy_call_finish:
2377  * @proxy: A #GDBusProxy.
2378  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call().
2379  * @error: Return location for error or %NULL.
2380  *
2381  * Finishes an operation started with g_dbus_proxy_call().
2382  *
2383  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
2384  * return values. Free with g_variant_unref().
2385  *
2386  * Since: 2.26
2387  */
2388 GVariant *
2389 g_dbus_proxy_call_finish (GDBusProxy    *proxy,
2390                           GAsyncResult  *res,
2391                           GError       **error)
2392 {
2393   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2394   GVariant *value;
2395
2396   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2397   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2398   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2399
2400   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_proxy_call);
2401
2402   value = NULL;
2403
2404   if (g_simple_async_result_propagate_error (simple, error))
2405     goto out;
2406
2407   value = g_variant_ref (g_simple_async_result_get_op_res_gpointer (simple));
2408
2409  out:
2410   return value;
2411 }
2412
2413 /**
2414  * g_dbus_proxy_call_sync:
2415  * @proxy: A #GDBusProxy.
2416  * @method_name: Name of method to invoke.
2417  * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
2418  * @flags: Flags from the #GDBusCallFlags enumeration.
2419  * @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning
2420  *                "infinite") or -1 to use the proxy default timeout.
2421  * @cancellable: A #GCancellable or %NULL.
2422  * @error: Return location for error or %NULL.
2423  *
2424  * Synchronously invokes the @method_name method on @proxy.
2425  *
2426  * If @method_name contains any dots, then @name is split into interface and
2427  * method name parts. This allows using @proxy for invoking methods on
2428  * other interfaces.
2429  *
2430  * If the #GDBusConnection associated with @proxy is disconnected then
2431  * the operation will fail with %G_IO_ERROR_CLOSED. If
2432  * @cancellable is canceled, the operation will fail with
2433  * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
2434  * compatible with the D-Bus protocol, the operation fails with
2435  * %G_IO_ERROR_INVALID_ARGUMENT.
2436  *
2437  * If the @parameters #GVariant is floating, it is consumed. This allows
2438  * convenient 'inline' use of g_variant_new(), e.g.:
2439  * |[
2440  *  g_dbus_proxy_call_sync (proxy,
2441  *                          "TwoStrings",
2442  *                          g_variant_new ("(ss)",
2443  *                                         "Thing One",
2444  *                                         "Thing Two"),
2445  *                          G_DBUS_CALL_FLAGS_NONE,
2446  *                          -1,
2447  *                          NULL,
2448  *                          &amp;error);
2449  * ]|
2450  *
2451  * The calling thread is blocked until a reply is received. See
2452  * g_dbus_proxy_call() for the asynchronous version of this
2453  * method.
2454  *
2455  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
2456  * return values. Free with g_variant_unref().
2457  *
2458  * Since: 2.26
2459  */
2460 GVariant *
2461 g_dbus_proxy_call_sync (GDBusProxy      *proxy,
2462                         const gchar     *method_name,
2463                         GVariant        *parameters,
2464                         GDBusCallFlags   flags,
2465                         gint             timeout_msec,
2466                         GCancellable    *cancellable,
2467                         GError         **error)
2468 {
2469   GVariant *ret;
2470   gboolean was_split;
2471   gchar *split_interface_name;
2472   const gchar *split_method_name;
2473   const gchar *target_method_name;
2474   const gchar *target_interface_name;
2475   const gchar *destination;
2476   GVariantType *reply_type;
2477
2478   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
2479   g_return_val_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name), NULL);
2480   g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
2481   g_return_val_if_fail (timeout_msec == -1 || timeout_msec >= 0, NULL);
2482   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2483
2484   reply_type = NULL;
2485
2486   was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
2487   target_method_name = was_split ? split_method_name : method_name;
2488   target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
2489
2490   /* Warn if method is unexpected (cf. :g-interface-info) */
2491   if (!was_split)
2492     {
2493       const GDBusMethodInfo *expected_method_info;
2494       expected_method_info = lookup_method_info_or_warn (proxy, target_method_name);
2495       if (expected_method_info != NULL)
2496         reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
2497     }
2498
2499   destination = NULL;
2500   if (proxy->priv->name != NULL)
2501     {
2502       destination = get_destination_for_call (proxy);
2503       if (destination == NULL)
2504         {
2505           g_set_error_literal (error,
2506                                G_IO_ERROR,
2507                                G_IO_ERROR_FAILED,
2508                                _("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"));
2509           ret = NULL;
2510           goto out;
2511         }
2512     }
2513
2514   ret = g_dbus_connection_call_sync (proxy->priv->connection,
2515                                      destination,
2516                                      proxy->priv->object_path,
2517                                      target_interface_name,
2518                                      target_method_name,
2519                                      parameters,
2520                                      reply_type,
2521                                      flags,
2522                                      timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
2523                                      cancellable,
2524                                      error);
2525
2526  out:
2527   if (reply_type != NULL)
2528     g_variant_type_free (reply_type);
2529
2530   g_free (split_interface_name);
2531
2532   return ret;
2533 }
2534
2535 /* ---------------------------------------------------------------------------------------------------- */