gio/gdbusconnection.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 /*
  24  * TODO for GDBus:
  25  *
  26  * - Validate all data (e.g. UTF-8) and check all the required D-Bus headers
  27  *   are present and forbidden ones aren't
  28  *   - When writing: g_dbus_message_to_blob()
  29  *   - When reading: g_dbus_message_new_from_blob()
  30  *
  31  * - would be nice to expose GDBusAuthMechanism and an extension point
  32  *
  33  * - Need to rewrite GDBusAuth and rework GDBusAuthMechanism. In particular
  34  *   the mechanism VFuncs need to be able to set an error.
  35  *
  36  * - Need to document other mechanisms/sources for determining the D-Bus
  37  *   address of a well-known bus.
  38  *
  39  *   - e.g. on Win32 we need code like from here
  40  *
  41  *     http://cgit.freedesktop.org/~david/gdbus-standalone/tree/gdbus/gdbusaddress.c#n900
  42  *
  43  *     that was never copied over here because it originally was copy-paste
  44  *     from the GPLv2 / AFL 2.1 libdbus sources.
  45  *
  46  *   - on OS X we need to look in launchd for the address
  47  *
  48  *     https://bugs.freedesktop.org/show_bug.cgi?id=14259
  49  *
  50  *   - on X11 we need to look in a X11 property on the X server
  51  *     - (we can also just use dbus-launch(1) from the D-Bus
  52  *        distribution)
  53  *
  54  *   - (ideally) this requires D-Bus spec work because none of
  55  *     this has never really been specced out properly (excect
  56  *     the X11 bits)
  57  *
  58  * - Related to the above, we also need to be able to launch a message bus
  59  *   instance.... Since we don't want to write our own bus daemon we should
  60  *   launch dbus-daemon(1) (thus: Win32 and OS X need to bundle it)
  61  *
  62  * - probably want a G_DBUS_NONCE_TCP_TMPDIR environment variable
  63  *   to specify where the nonce is stored. This will allow people to use
  64  *   G_DBUS_NONCE_TCP_TMPDIR=/mnt/secure.company.server/dbus-nonce-dir
  65  *   to easily acheive secure RPC via nonce-tcp.
  66  *
  67  * - need to expose an extension point for resolving D-Bus address and
  68  *   turning them into GIOStream objects. This will allow us to implement
  69  *   e.g. X11 D-Bus transports without dlopen()'ing or linking against
  70  *   libX11 from libgio.
  71  *   - see g_dbus_address_connect() in gdbusaddress.c
  72  *
  73  * - would be cute to use kernel-specific APIs to resolve fds for
  74  *   debug output when using G_DBUS_DEBUG=messages, e.g. in addition to
  75  *
  76  *     fd 21: dev=8:1,mode=0100644,ino=1171231,uid=0,gid=0,rdev=0:0,size=234,atime=1273070640,mtime=1267126160,ctime=1267126160
  77  *
  78  *   maybe we can show more information about what fd 21 really is.
  79  *   Ryan suggests looking in /proc/self/fd for clues / symlinks!
  80  *   Initial experiments on Linux 2.6 suggests that the symlink looks
  81  *   like this:
  82  *
  83  *    3 -> /proc/18068/fd
  84  *
  85  *   e.g. not of much use.
  86  *
  87  *  - GDBus High-Level docs
  88  *    - Proxy: properties, signals...
  89  *    - Connection: IOStream based, ::close, connection setup steps
  90  *                  mainloop integration, threading
  91  *    - Differences from libdbus (extend "Migrating from")
  92  *      - the message handling thread
  93  *      - Using GVariant instead of GValue
  94  *    - Explain why the high-level API is a good thing and what
  95  *      kind of pitfalls it avoids
  96  *      - Export objects before claiming names
  97  *    - Talk about auto-starting services (cf. GBusNameWatcherFlags)
  98  */
  99
 100 #include "config.h"
 101
 102 #include <stdlib.h>
 103 #include <string.h>
 104 #include <sys/types.h>
 105 #ifdef HAVE_UNISTD_H
 106 #include <unistd.h>
 107 #endif
 108
 109 #include "gdbusauth.h"
 110 #include "gdbusutils.h"
 111 #include "gdbusaddress.h"
 112 #include "gdbusmessage.h"
 113 #include "gdbusconnection.h"
 114 #include "gdbuserror.h"
 115 #include "gioenumtypes.h"
 116 #include "gdbusintrospection.h"
 117 #include "gdbusmethodinvocation.h"
 118 #include "gdbusprivate.h"
 119 #include "gdbusauthobserver.h"
 120 #include "gio-marshal.h"
 121 #include "ginitable.h"
 122 #include "gasyncinitable.h"
 123 #include "giostream.h"
 124 #include "gasyncresult.h"
 125 #include "gsimpleasyncresult.h"
 126
 127 #ifdef G_OS_UNIX
 128 #include "gunixconnection.h"
 129 #include "gunixfdmessage.h"
 130 #endif
 131
 132 #include "glibintl.h"
 133 #include "gioalias.h"
 134
 135 /**
 136  * SECTION:gdbusconnection
 137  * @short_description: D-Bus Connections
 138  * @include: gio/gio.h
 139  *
 140  * The #GDBusConnection type is used for D-Bus connections to remote
 141  * peers such as a message buses. It is a low-level API that offers a
 142  * lot of flexibility. For instance, it lets you establish a connection
 143  * over any transport that can by represented as an #GIOStream.
 144  *
 145  * This class is rarely used directly in D-Bus clients. If you are writing
 146  * an D-Bus client, it is often easier to use the g_bus_own_name(),
 147  * g_bus_watch_name() or g_bus_watch_proxy() APIs.
 148  *
 149  * <example id="gdbus-server"><title>D-Bus server example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-server.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
 150  *
 151  * <example id="gdbus-subtree-server"><title>D-Bus subtree example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-subtree.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
 152  *
 153  * <example id="gdbus-unix-fd-client"><title>D-Bus UNIX File Descriptor example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-unix-fd-client.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
 154  *
 155  * <example id="gdbus-export"><title>Exporting a GObject</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-export.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
 156  */
 157
 158 /* ---------------------------------------------------------------------------------------------------- */
 159
 160 G_LOCK_DEFINE_STATIC (message_bus_lock);
 161
 162 static GDBusConnection *the_session_bus = NULL;
 163 static GDBusConnection *the_system_bus = NULL;
 164
 165 /* ---------------------------------------------------------------------------------------------------- */
 166
 167 static gboolean
 168 _g_strv_has_string (const gchar* const *haystack,
 169                     const gchar        *needle)
 170 {
 171   guint n;
 172
 173   for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
 174     {
 175       if (g_strcmp0 (haystack[n], needle) == 0)
 176         return TRUE;
 177     }
 178   return FALSE;
 179 }
 180
 181 /* ---------------------------------------------------------------------------------------------------- */
 182
 183 #ifdef G_OS_WIN32
 184 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
 185 #else
 186 // TODO: for some reason this doesn't work on Windows
 187 #define CONNECTION_ENSURE_LOCK(obj) do {                                \
 188     if (G_UNLIKELY (g_mutex_trylock((obj)->priv->lock)))                \
 189       {                                                                 \
 190         g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 191                              "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
 192       }                                                                 \
 193   } while (FALSE)
 194 #endif
 195
 196 #define CONNECTION_LOCK(obj) do {                                       \
 197     g_mutex_lock ((obj)->priv->lock);                                   \
 198   } while (FALSE)
 199
 200 #define CONNECTION_UNLOCK(obj) do {                                     \
 201     g_mutex_unlock ((obj)->priv->lock);                                 \
 202   } while (FALSE)
 203
 204 struct _GDBusConnectionPrivate
 205 {
 206   /* ------------------------------------------------------------------------ */
 207   /* -- General object state ------------------------------------------------ */
 208   /* ------------------------------------------------------------------------ */
 209
 210   /* object-wide lock */
 211   GMutex *lock;
 212
 213   /* A lock used in the init() method of the GInitable interface - see comments
 214    * in initable_init() for why a separate lock is needed
 215    */
 216   GMutex *init_lock;
 217
 218   /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
 219    * someone calls org.freedesktop.DBus.GetMachineId()
 220    */
 221   gchar *machine_id;
 222
 223   /* The underlying stream used for communication */
 224   GIOStream *stream;
 225
 226   /* The object used for authentication (if any) */
 227   GDBusAuth *auth;
 228
 229   /* Set to TRUE if the connection has been closed */
 230   gboolean closed;
 231
 232   /* Last serial used */
 233   guint32 last_serial;
 234
 235   /* The object used to send/receive message */
 236   GDBusWorker *worker;
 237
 238   /* If connected to a message bus, this contains the unique name assigned to
 239    * us by the bus (e.g. ":1.42")
 240    */
 241   gchar *bus_unique_name;
 242
 243   /* The GUID returned by the other side if we authenticed as a client or
 244    * the GUID to use if authenticating as a server
 245    */
 246   gchar *guid;
 247
 248   /* set to TRUE exactly when initable_init() has finished running */
 249   gboolean is_initialized;
 250
 251   /* If the connection could not be established during initable_init(), this GError will set */
 252   GError *initialization_error;
 253
 254   /* The result of g_main_context_get_thread_default() when the object
 255    * was created (the GObject _init() function) - this is used for delivery
 256    * of the :closed GObject signal.
 257    */
 258   GMainContext *main_context_at_construction;
 259
 260   /* construct properties */
 261   gchar *address;
 262   GDBusConnectionFlags flags;
 263
 264   /* Map used for managing method replies */
 265   GHashTable *map_method_serial_to_send_message_data;  /* guint32 -> SendMessageData* */
 266
 267   /* Maps used for managing signal subscription */
 268   GHashTable *map_rule_to_signal_data;          /* gchar* -> SignalData */
 269   GHashTable *map_id_to_signal_data;            /* guint  -> SignalData */
 270   GHashTable *map_sender_to_signal_data_array;  /* gchar* -> GPtrArray* of SignalData */
 271
 272   /* Maps used for managing exported objects and subtrees */
 273   GHashTable *map_object_path_to_eo;  /* gchar* -> ExportedObject* */
 274   GHashTable *map_id_to_ei;           /* guint  -> ExportedInterface* */
 275   GHashTable *map_object_path_to_es;  /* gchar* -> ExportedSubtree* */
 276   GHashTable *map_id_to_es;           /* guint  -> ExportedSubtree* */
 277
 278   /* Structure used for message filters */
 279   GPtrArray *filters;
 280
 281   /* Whether to exit on close */
 282   gboolean exit_on_close;
 283
 284   /* Capabilities negotiated during authentication */
 285   GDBusCapabilityFlags capabilities;
 286
 287   GDBusAuthObserver *authentication_observer;
 288   GCredentials *crendentials;
 289 };
 290
 291 typedef struct ExportedObject ExportedObject;
 292 static void exported_object_free (ExportedObject *eo);
 293
 294 typedef struct ExportedSubtree ExportedSubtree;
 295 static void exported_subtree_free (ExportedSubtree *es);
 296
 297 enum
 298 {
 299   CLOSED_SIGNAL,
 300   LAST_SIGNAL,
 301 };
 302
 303 enum
 304 {
 305   PROP_0,
 306   PROP_STREAM,
 307   PROP_ADDRESS,
 308   PROP_FLAGS,
 309   PROP_GUID,
 310   PROP_UNIQUE_NAME,
 311   PROP_CLOSED,
 312   PROP_EXIT_ON_CLOSE,
 313   PROP_CAPABILITY_FLAGS,
 314   PROP_AUTHENTICATION_OBSERVER,
 315 };
 316
 317 static void distribute_signals (GDBusConnection  *connection,
 318                                 GDBusMessage     *message);
 319
 320 static void distribute_method_call (GDBusConnection  *connection,
 321                                     GDBusMessage     *message);
 322
 323 static gboolean handle_generic_unlocked (GDBusConnection *connection,
 324                                          GDBusMessage    *message);
 325
 326
 327 static void purge_all_signal_subscriptions (GDBusConnection *connection);
 328 static void purge_all_filters (GDBusConnection *connection);
 329
 330 #define _G_ENSURE_LOCK(name) do {                                       \
 331     if (G_UNLIKELY (G_TRYLOCK(name)))                                   \
 332       {                                                                 \
 333         g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 334                              "_G_ENSURE_LOCK: Lock `" #name "' is not locked"); \
 335       }                                                                 \
 336   } while (FALSE)                                                       \
 337
 338 static guint signals[LAST_SIGNAL] = { 0 };
 339
 340 static void initable_iface_init       (GInitableIface      *initable_iface);
 341 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
 342
 343 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
 344                          G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
 345                          G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
 346                          );
 347
 348 static void
 349 g_dbus_connection_dispose (GObject *object)
 350 {
 351   GDBusConnection *connection = G_DBUS_CONNECTION (object);
 352
 353   G_LOCK (message_bus_lock);
 354   //g_debug ("disposing %p", connection);
 355   if (connection == the_session_bus)
 356     {
 357       the_session_bus = NULL;
 358     }
 359   else if (connection == the_system_bus)
 360     {
 361       the_system_bus = NULL;
 362     }
 363   if (connection->priv->worker != NULL)
 364     {
 365       _g_dbus_worker_stop (connection->priv->worker);
 366       connection->priv->worker = NULL;
 367     }
 368   G_UNLOCK (message_bus_lock);
 369
 370   if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
 371     G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
 372 }
 373
 374 static void
 375 g_dbus_connection_finalize (GObject *object)
 376 {
 377   GDBusConnection *connection = G_DBUS_CONNECTION (object);
 378
 379   if (connection->priv->authentication_observer != NULL)
 380     g_object_unref (connection->priv->authentication_observer);
 381
 382   if (connection->priv->auth != NULL)
 383     g_object_unref (connection->priv->auth);
 384
 385   //g_debug ("finalizing %p", connection);
 386   if (connection->priv->stream != NULL)
 387     {
 388       /* We don't really care if closing the stream succeeds or not */
 389       g_io_stream_close_async (connection->priv->stream,
 390                                G_PRIORITY_DEFAULT,
 391                                NULL,  /* GCancellable */
 392                                NULL,  /* GAsyncReadyCallback */
 393                                NULL); /* userdata */
 394       g_object_unref (connection->priv->stream);
 395       connection->priv->stream = NULL;
 396     }
 397
 398   g_free (connection->priv->address);
 399
 400   g_free (connection->priv->guid);
 401   g_free (connection->priv->bus_unique_name);
 402
 403   if (connection->priv->initialization_error != NULL)
 404     g_error_free (connection->priv->initialization_error);
 405
 406   g_hash_table_unref (connection->priv->map_method_serial_to_send_message_data);
 407
 408   purge_all_signal_subscriptions (connection);
 409   g_hash_table_unref (connection->priv->map_rule_to_signal_data);
 410   g_hash_table_unref (connection->priv->map_id_to_signal_data);
 411   g_hash_table_unref (connection->priv->map_sender_to_signal_data_array);
 412
 413   g_hash_table_unref (connection->priv->map_id_to_ei);
 414   g_hash_table_unref (connection->priv->map_object_path_to_eo);
 415   g_hash_table_unref (connection->priv->map_id_to_es);
 416   g_hash_table_unref (connection->priv->map_object_path_to_es);
 417
 418   purge_all_filters (connection);
 419   g_ptr_array_unref (connection->priv->filters);
 420
 421   if (connection->priv->main_context_at_construction != NULL)
 422     g_main_context_unref (connection->priv->main_context_at_construction);
 423
 424   g_free (connection->priv->machine_id);
 425
 426   g_mutex_free (connection->priv->init_lock);
 427   g_mutex_free (connection->priv->lock);
 428
 429   G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
 430 }
 431
 432 static void
 433 g_dbus_connection_get_property (GObject    *object,
 434                                 guint       prop_id,
 435                                 GValue     *value,
 436                                 GParamSpec *pspec)
 437 {
 438   GDBusConnection *connection = G_DBUS_CONNECTION (object);
 439
 440   switch (prop_id)
 441     {
 442     case PROP_STREAM:
 443       g_value_set_object (value, g_dbus_connection_get_stream (connection));
 444       break;
 445
 446     case PROP_GUID:
 447       g_value_set_string (value, g_dbus_connection_get_guid (connection));
 448       break;
 449
 450     case PROP_UNIQUE_NAME:
 451       g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
 452       break;
 453
 454     case PROP_CLOSED:
 455       g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
 456       break;
 457
 458     case PROP_EXIT_ON_CLOSE:
 459       g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
 460       break;
 461
 462     case PROP_CAPABILITY_FLAGS:
 463       g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
 464       break;
 465
 466     default:
 467       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 468       break;
 469     }
 470 }
 471
 472 static void
 473 g_dbus_connection_set_property (GObject      *object,
 474                                 guint         prop_id,
 475                                 const GValue *value,
 476                                 GParamSpec   *pspec)
 477 {
 478   GDBusConnection *connection = G_DBUS_CONNECTION (object);
 479
 480   switch (prop_id)
 481     {
 482     case PROP_STREAM:
 483       connection->priv->stream = g_value_dup_object (value);
 484       break;
 485
 486     case PROP_GUID:
 487       connection->priv->guid = g_value_dup_string (value);
 488       break;
 489
 490     case PROP_ADDRESS:
 491       connection->priv->address = g_value_dup_string (value);
 492       break;
 493
 494     case PROP_FLAGS:
 495       connection->priv->flags = g_value_get_flags (value);
 496       break;
 497
 498     case PROP_EXIT_ON_CLOSE:
 499       g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
 500       break;
 501
 502     case PROP_AUTHENTICATION_OBSERVER:
 503       connection->priv->authentication_observer = g_value_dup_object (value);
 504       break;
 505
 506     default:
 507       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 508       break;
 509     }
 510 }
 511
 512 static void
 513 g_dbus_connection_real_closed (GDBusConnection *connection,
 514                                gboolean         remote_peer_vanished,
 515                                GError          *error)
 516 {
 517   if (remote_peer_vanished && connection->priv->exit_on_close)
 518     {
 519       g_print ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
 520       raise (SIGTERM);
 521     }
 522 }
 523
 524 static void
 525 g_dbus_connection_class_init (GDBusConnectionClass *klass)
 526 {
 527   GObjectClass *gobject_class;
 528
 529   g_type_class_add_private (klass, sizeof (GDBusConnectionPrivate));
 530
 531   gobject_class = G_OBJECT_CLASS (klass);
 532
 533   gobject_class->finalize     = g_dbus_connection_finalize;
 534   gobject_class->dispose      = g_dbus_connection_dispose;
 535   gobject_class->set_property = g_dbus_connection_set_property;
 536   gobject_class->get_property = g_dbus_connection_get_property;
 537
 538   klass->closed = g_dbus_connection_real_closed;
 539
 540   /**
 541    * GDBusConnection:stream:
 542    *
 543    * The underlying #GIOStream used for I/O.
 544    *
 545    * Since: 2.26
 546    */
 547   g_object_class_install_property (gobject_class,
 548                                    PROP_STREAM,
 549                                    g_param_spec_object ("stream",
 550                                                         P_("IO Stream"),
 551                                                         P_("The underlying streams used for I/O"),
 552                                                         G_TYPE_IO_STREAM,
 553                                                         G_PARAM_READABLE |
 554                                                         G_PARAM_WRITABLE |
 555                                                         G_PARAM_CONSTRUCT_ONLY |
 556                                                         G_PARAM_STATIC_NAME |
 557                                                         G_PARAM_STATIC_BLURB |
 558                                                         G_PARAM_STATIC_NICK));
 559
 560   /**
 561    * GDBusConnection:address:
 562    *
 563    * A D-Bus address specifying potential endpoints that can be used
 564    * when establishing the connection.
 565    *
 566    * Since: 2.26
 567    */
 568   g_object_class_install_property (gobject_class,
 569                                    PROP_ADDRESS,
 570                                    g_param_spec_string ("address",
 571                                                         P_("Address"),
 572                                                         P_("D-Bus address specifying potential socket endpoints"),
 573                                                         NULL,
 574                                                         G_PARAM_WRITABLE |
 575                                                         G_PARAM_CONSTRUCT_ONLY |
 576                                                         G_PARAM_STATIC_NAME |
 577                                                         G_PARAM_STATIC_BLURB |
 578                                                         G_PARAM_STATIC_NICK));
 579
 580   /**
 581    * GDBusConnection:flags:
 582    *
 583    * Flags from the #GDBusConnectionFlags enumeration.
 584    *
 585    * Since: 2.26
 586    */
 587   g_object_class_install_property (gobject_class,
 588                                    PROP_FLAGS,
 589                                    g_param_spec_flags ("flags",
 590                                                        P_("Flags"),
 591                                                        P_("Flags"),
 592                                                        G_TYPE_DBUS_CONNECTION_FLAGS,
 593                                                        G_DBUS_CONNECTION_FLAGS_NONE,
 594                                                        G_PARAM_WRITABLE |
 595                                                        G_PARAM_CONSTRUCT_ONLY |
 596                                                        G_PARAM_STATIC_NAME |
 597                                                        G_PARAM_STATIC_BLURB |
 598                                                        G_PARAM_STATIC_NICK));
 599
 600   /**
 601    * GDBusConnection:guid:
 602    *
 603    * The GUID of the peer performing the role of server when
 604    * authenticating.
 605    *
 606    * If you are constructing a #GDBusConnection and pass
 607    * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
 608    * #GDBusConnection:flags property then you MUST also set this
 609    * property to a valid guid.
 610    *
 611    * If you are constructing a #GDBusConnection and pass
 612    * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
 613    * #GDBusConnection:flags property you will be able to read the GUID
 614    * of the other peer here after the connection has been successfully
 615    * initialized.
 616    *
 617    * Since: 2.26
 618    */
 619   g_object_class_install_property (gobject_class,
 620                                    PROP_GUID,
 621                                    g_param_spec_string ("guid",
 622                                                         P_("GUID"),
 623                                                         P_("GUID of the server peer"),
 624                                                         NULL,
 625                                                         G_PARAM_READABLE |
 626                                                         G_PARAM_WRITABLE |
 627                                                         G_PARAM_CONSTRUCT_ONLY |
 628                                                         G_PARAM_STATIC_NAME |
 629                                                         G_PARAM_STATIC_BLURB |
 630                                                         G_PARAM_STATIC_NICK));
 631
 632   /**
 633    * GDBusConnection:unique-name:
 634    *
 635    * The unique name as assigned by the message bus or %NULL if the
 636    * connection is not open or not a message bus connection.
 637    *
 638    * Since: 2.26
 639    */
 640   g_object_class_install_property (gobject_class,
 641                                    PROP_UNIQUE_NAME,
 642                                    g_param_spec_string ("unique-name",
 643                                                         P_("unique-name"),
 644                                                         P_("Unique name of bus connection"),
 645                                                         NULL,
 646                                                         G_PARAM_READABLE |
 647                                                         G_PARAM_STATIC_NAME |
 648                                                         G_PARAM_STATIC_BLURB |
 649                                                         G_PARAM_STATIC_NICK));
 650
 651   /**
 652    * GDBusConnection:closed:
 653    *
 654    * A boolean specifying whether the connection has been closed.
 655    *
 656    * Since: 2.26
 657    */
 658   g_object_class_install_property (gobject_class,
 659                                    PROP_CLOSED,
 660                                    g_param_spec_boolean ("closed",
 661                                                          P_("Closed"),
 662                                                          P_("Whether the connection is closed"),
 663                                                          FALSE,
 664                                                          G_PARAM_READABLE |
 665                                                          G_PARAM_STATIC_NAME |
 666                                                          G_PARAM_STATIC_BLURB |
 667                                                          G_PARAM_STATIC_NICK));
 668
 669   /**
 670    * GDBusConnection:exit-on-close:
 671    *
 672    * A boolean specifying whether the process will be terminated (by
 673    * calling <literal>raise(SIGTERM)</literal>) if the connection
 674    * is closed by the remote peer.
 675    *
 676    * Since: 2.26
 677    */
 678   g_object_class_install_property (gobject_class,
 679                                    PROP_EXIT_ON_CLOSE,
 680                                    g_param_spec_boolean ("exit-on-close",
 681                                                          P_("Exit on close"),
 682                                                          P_("Whether the process is terminated when the connection is closed"),
 683                                                          FALSE,
 684                                                          G_PARAM_READABLE |
 685                                                          G_PARAM_WRITABLE |
 686                                                          G_PARAM_STATIC_NAME |
 687                                                          G_PARAM_STATIC_BLURB |
 688                                                          G_PARAM_STATIC_NICK));
 689
 690   /**
 691    * GDBusConnection:capabilities:
 692    *
 693    * Flags from the #GDBusCapabilityFlags enumeration
 694    * representing connection features negotiated with the other peer.
 695    *
 696    * Since: 2.26
 697    */
 698   g_object_class_install_property (gobject_class,
 699                                    PROP_CAPABILITY_FLAGS,
 700                                    g_param_spec_flags ("capabilities",
 701                                                        P_("Capabilities"),
 702                                                        P_("Capabilities"),
 703                                                        G_TYPE_DBUS_CAPABILITY_FLAGS,
 704                                                        G_DBUS_CAPABILITY_FLAGS_NONE,
 705                                                        G_PARAM_READABLE |
 706                                                        G_PARAM_STATIC_NAME |
 707                                                        G_PARAM_STATIC_BLURB |
 708                                                        G_PARAM_STATIC_NICK));
 709
 710   /**
 711    * GDBusConnection:authentication-observer:
 712    *
 713    * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
 714    *
 715    * Since: 2.26
 716    */
 717   g_object_class_install_property (gobject_class,
 718                                    PROP_AUTHENTICATION_OBSERVER,
 719                                    g_param_spec_object ("authentication-observer",
 720                                                         P_("Authentication Observer"),
 721                                                         P_("Object used to assist in the authentication process"),
 722                                                         G_TYPE_DBUS_AUTH_OBSERVER,
 723                                                         G_PARAM_WRITABLE |
 724                                                         G_PARAM_CONSTRUCT_ONLY |
 725                                                         G_PARAM_STATIC_NAME |
 726                                                         G_PARAM_STATIC_BLURB |
 727                                                         G_PARAM_STATIC_NICK));
 728
 729   /**
 730    * GDBusConnection::closed:
 731    * @connection: The #GDBusConnection emitting the signal.
 732    * @remote_peer_vanished: %TRUE if @connection is closed because the
 733    * remote peer closed its end of the connection.
 734    * @error: A #GError with more details about the event or %NULL.
 735    *
 736    * Emitted when the connection is closed.
 737    *
 738    * The cause of this event can be
 739    * <itemizedlist>
 740    * <listitem><para>
 741    *    If g_dbus_connection_close() is called. In this case
 742    *    @remote_peer_vanished is set to %FALSE and @error is %NULL.
 743    * </para></listitem>
 744    * <listitem><para>
 745    *    If the remote peer closes the connection. In this case
 746    *    @remote_peer_vanished is set to %TRUE and @error is set.
 747    * </para></listitem>
 748    * <listitem><para>
 749    *    If the remote peer sends invalid or malformed data. In this
 750    *    case @remote_peer_vanished is set to %FALSE and @error
 751    *    is set.
 752    * </para></listitem>
 753    * </itemizedlist>
 754    *
 755    * Upon receiving this signal, you should give up your reference to
 756    * @connection. You are guaranteed that this signal is emitted only
 757    * once.
 758    *
 759    * Since: 2.26
 760    */
 761   signals[CLOSED_SIGNAL] = g_signal_new ("closed",
 762                                          G_TYPE_DBUS_CONNECTION,
 763                                          G_SIGNAL_RUN_LAST,
 764                                          G_STRUCT_OFFSET (GDBusConnectionClass, closed),
 765                                          NULL,
 766                                          NULL,
 767                                          _gio_marshal_VOID__BOOLEAN_BOXED,
 768                                          G_TYPE_NONE,
 769                                          2,
 770                                          G_TYPE_BOOLEAN,
 771                                          G_TYPE_ERROR);
 772 }
 773
 774 static void
 775 g_dbus_connection_init (GDBusConnection *connection)
 776 {
 777   connection->priv = G_TYPE_INSTANCE_GET_PRIVATE (connection, G_TYPE_DBUS_CONNECTION, GDBusConnectionPrivate);
 778
 779   connection->priv->lock = g_mutex_new ();
 780   connection->priv->init_lock = g_mutex_new ();
 781
 782   connection->priv->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
 783
 784   connection->priv->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
 785                                                                 g_str_equal);
 786   connection->priv->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
 787                                                               g_direct_equal);
 788   connection->priv->map_sender_to_signal_data_array = g_hash_table_new_full (g_str_hash,
 789                                                                              g_str_equal,
 790                                                                              g_free,
 791                                                                              NULL);
 792
 793   connection->priv->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
 794                                                                    g_str_equal,
 795                                                                    NULL,
 796                                                                    (GDestroyNotify) exported_object_free);
 797
 798   connection->priv->map_id_to_ei = g_hash_table_new (g_direct_hash,
 799                                                      g_direct_equal);
 800
 801   connection->priv->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
 802                                                                    g_str_equal,
 803                                                                    NULL,
 804                                                                    (GDestroyNotify) exported_subtree_free);
 805
 806   connection->priv->map_id_to_es = g_hash_table_new (g_direct_hash,
 807                                                      g_direct_equal);
 808
 809   connection->priv->main_context_at_construction = g_main_context_get_thread_default ();
 810   if (connection->priv->main_context_at_construction != NULL)
 811     g_main_context_ref (connection->priv->main_context_at_construction);
 812
 813   connection->priv->filters = g_ptr_array_new ();
 814 }
 815
 816 /**
 817  * g_dbus_connection_get_stream:
 818  * @connection: a #GDBusConnection
 819  *
 820  * Gets the underlying stream used for IO.
 821  *
 822  * Returns: the stream used for IO
 823  *
 824  * Since: 2.26
 825  */
 826 GIOStream *
 827 g_dbus_connection_get_stream (GDBusConnection *connection)
 828 {
 829   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
 830   return connection->priv->stream;
 831 }
 832
 833
 834 /**
 835  * g_dbus_connection_is_closed:
 836  * @connection: A #GDBusConnection.
 837  *
 838  * Gets whether @connection is closed.
 839  *
 840  * Returns: %TRUE if the connection is closed, %FALSE otherwise.
 841  *
 842  * Since: 2.26
 843  */
 844 gboolean
 845 g_dbus_connection_is_closed (GDBusConnection *connection)
 846 {
 847   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
 848   return connection->priv->closed;
 849 }
 850
 851 /**
 852  * g_dbus_connection_get_capabilities:
 853  * @connection: A #GDBusConnection.
 854  *
 855  * Gets the capabilities negotiated with the remote peer
 856  *
 857  * Returns: Zero or more flags from the #GDBusCapabilityFlags enumeration.
 858  *
 859  * Since: 2.26
 860  */
 861 GDBusCapabilityFlags
 862 g_dbus_connection_get_capabilities (GDBusConnection *connection)
 863 {
 864   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
 865   return connection->priv->capabilities;
 866 }
 867
 868
 869 /* ---------------------------------------------------------------------------------------------------- */
 870
 871 typedef struct
 872 {
 873   GDBusConnection *connection;
 874   GError *error;
 875   gboolean remote_peer_vanished;
 876 } EmitClosedData;
 877
 878 static void
 879 emit_closed_data_free (EmitClosedData *data)
 880 {
 881   g_object_unref (data->connection);
 882   if (data->error != NULL)
 883     g_error_free (data->error);
 884   g_free (data);
 885 }
 886
 887 static gboolean
 888 emit_closed_in_idle (gpointer user_data)
 889 {
 890   EmitClosedData *data = user_data;
 891   gboolean result;
 892
 893   g_object_notify (G_OBJECT (data->connection), "closed");
 894   g_signal_emit (data->connection,
 895                  signals[CLOSED_SIGNAL],
 896                  0,
 897                  data->remote_peer_vanished,
 898                  data->error,
 899                  &result);
 900   return FALSE;
 901 }
 902
 903 /* Can be called from any thread, must hold lock */
 904 static void
 905 set_closed_unlocked (GDBusConnection *connection,
 906                      gboolean         remote_peer_vanished,
 907                      GError          *error)
 908 {
 909   GSource *idle_source;
 910   EmitClosedData *data;
 911
 912   CONNECTION_ENSURE_LOCK (connection);
 913
 914   g_assert (!connection->priv->closed);
 915
 916   connection->priv->closed = TRUE;
 917
 918   data = g_new0 (EmitClosedData, 1);
 919   data->connection = g_object_ref (connection);
 920   data->remote_peer_vanished = remote_peer_vanished;
 921   data->error = error != NULL ? g_error_copy (error) : NULL;
 922
 923   idle_source = g_idle_source_new ();
 924   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
 925   g_source_set_callback (idle_source,
 926                          emit_closed_in_idle,
 927                          data,
 928                          (GDestroyNotify) emit_closed_data_free);
 929   g_source_attach (idle_source, connection->priv->main_context_at_construction);
 930   g_source_unref (idle_source);
 931 }
 932
 933 /* ---------------------------------------------------------------------------------------------------- */
 934
 935 /**
 936  * g_dbus_connection_close:
 937  * @connection: A #GDBusConnection.
 938  *
 939  * Closes @connection. Note that this never causes the process to
 940  * exit (this might only happen if the other end of a shared message
 941  * bus connection disconnects).
 942  *
 943  * If @connection is already closed, this method does nothing.
 944  *
 945  * Since: 2.26
 946  */
 947 void
 948 g_dbus_connection_close (GDBusConnection *connection)
 949 {
 950   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
 951
 952   CONNECTION_LOCK (connection);
 953   if (!connection->priv->closed)
 954     {
 955       GError *error = NULL;
 956
 957       /* TODO: do this async */
 958       //g_debug ("closing connection %p's stream %p", connection, connection->priv->stream);
 959       if (!g_io_stream_close (connection->priv->stream, NULL, &error))
 960         {
 961           g_warning ("Error closing stream: %s", error->message);
 962           g_error_free (error);
 963         }
 964
 965       set_closed_unlocked (connection, FALSE, NULL);
 966     }
 967   CONNECTION_UNLOCK (connection);
 968 }
 969
 970 /* ---------------------------------------------------------------------------------------------------- */
 971
 972 static gboolean
 973 g_dbus_connection_send_message_unlocked (GDBusConnection   *connection,
 974                                          GDBusMessage      *message,
 975                                          volatile guint32  *out_serial,
 976                                          GError           **error)
 977 {
 978   guchar *blob;
 979   gsize blob_size;
 980   guint32 serial_to_use;
 981   gboolean ret;
 982
 983   CONNECTION_ENSURE_LOCK (connection);
 984
 985   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
 986   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
 987
 988   /* TODO: check all necessary headers are present */
 989
 990   ret = FALSE;
 991   blob = NULL;
 992
 993   if (out_serial != NULL)
 994     *out_serial = 0;
 995
 996   if (connection->priv->closed)
 997     {
 998       g_set_error_literal (error,
 999                            G_IO_ERROR,
1000                            G_IO_ERROR_CLOSED,
1001                            _("The connection is closed"));
1002       goto out;
1003     }
1004
1005   blob = g_dbus_message_to_blob (message,
1006                                  &blob_size,
1007                                  connection->priv->capabilities,
1008                                  error);
1009   if (blob == NULL)
1010     goto out;
1011
1012   serial_to_use = ++connection->priv->last_serial; /* TODO: handle overflow */
1013
1014   switch (blob[0])
1015     {
1016     case 'l':
1017       ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
1018       break;
1019     case 'B':
1020       ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
1021       break;
1022     default:
1023       g_assert_not_reached ();
1024       break;
1025     }
1026
1027 #if 0
1028   g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
1029               blob_size, serial_to_use, connection);
1030   g_printerr ("----\n");
1031   hexdump (blob, blob_size);
1032   g_printerr ("----\n");
1033 #endif
1034
1035   /* TODO: use connection->priv->auth to encode the blob */
1036
1037   if (out_serial != NULL)
1038     *out_serial = serial_to_use;
1039
1040   g_dbus_message_set_serial (message, serial_to_use);
1041
1042   _g_dbus_worker_send_message (connection->priv->worker,
1043                                message,
1044                                (gchar*) blob,
1045                                blob_size);
1046   blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
1047
1048   ret = TRUE;
1049
1050  out:
1051   g_free (blob);
1052
1053   return ret;
1054 }
1055
1056 /**
1057  * g_dbus_connection_send_message:
1058  * @connection: A #GDBusConnection.
1059  * @message: A #GDBusMessage
1060  * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1061  * @error: Return location for error or %NULL.
1062  *
1063  * Asynchronously sends @message to the peer represented by @connection.
1064  *
1065  * If @out_serial is not %NULL, then the serial number assigned to
1066  * @message by @connection will be written to this location prior to
1067  * submitting the message to the underlying transport.
1068  *
1069  * If @connection is closed then the operation will fail with
1070  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
1071  * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
1072  * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1073  *
1074  * See <xref linkend="gdbus-server"/> and <xref
1075  * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1076  * low-level API to send and receive UNIX file descriptors.
1077  *
1078  * Returns: %TRUE if the message was well-formed and queued for
1079  * transmission, %FALSE if @error is set.
1080  *
1081  * Since: 2.26
1082  */
1083 gboolean
1084 g_dbus_connection_send_message (GDBusConnection   *connection,
1085                                 GDBusMessage      *message,
1086                                 volatile guint32  *out_serial,
1087                                 GError           **error)
1088 {
1089   gboolean ret;
1090
1091   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1092   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1093   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1094
1095   CONNECTION_LOCK (connection);
1096   ret = g_dbus_connection_send_message_unlocked (connection, message, out_serial, error);
1097   CONNECTION_UNLOCK (connection);
1098   return ret;
1099 }
1100
1101 /* ---------------------------------------------------------------------------------------------------- */
1102
1103 typedef struct
1104 {
1105   volatile gint ref_count;
1106   GDBusConnection *connection;
1107   guint32 serial;
1108   GSimpleAsyncResult *simple;
1109
1110   GMainContext *main_context;
1111
1112   GCancellable *cancellable;
1113
1114   gulong cancellable_handler_id;
1115
1116   GSource *timeout_source;
1117
1118   gboolean delivered;
1119 } SendMessageData;
1120
1121 static SendMessageData *
1122 send_message_data_ref (SendMessageData *data)
1123 {
1124   g_atomic_int_inc (&data->ref_count);
1125   return data;
1126 }
1127
1128 static void
1129 send_message_data_unref (SendMessageData *data)
1130 {
1131   if (g_atomic_int_dec_and_test (&data->ref_count))
1132     {
1133       g_assert (data->timeout_source == NULL);
1134       g_assert (data->simple == NULL);
1135       g_assert (data->cancellable_handler_id == 0);
1136       g_object_unref (data->connection);
1137       if (data->cancellable != NULL)
1138         g_object_unref (data->cancellable);
1139       if (data->main_context != NULL)
1140         g_main_context_unref (data->main_context);
1141       g_free (data);
1142     }
1143 }
1144
1145 /* ---------------------------------------------------------------------------------------------------- */
1146
1147 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
1148 static void
1149 send_message_with_reply_deliver (SendMessageData *data)
1150 {
1151   CONNECTION_ENSURE_LOCK (data->connection);
1152
1153   g_assert (!data->delivered);
1154
1155   data->delivered = TRUE;
1156
1157   g_simple_async_result_complete_in_idle (data->simple);
1158   g_object_unref (data->simple);
1159   data->simple = NULL;
1160
1161   if (data->timeout_source != NULL)
1162     {
1163       g_source_destroy (data->timeout_source);
1164       data->timeout_source = NULL;
1165     }
1166   if (data->cancellable_handler_id > 0)
1167     {
1168       g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
1169       data->cancellable_handler_id = 0;
1170     }
1171
1172   g_warn_if_fail (g_hash_table_remove (data->connection->priv->map_method_serial_to_send_message_data,
1173                                        GUINT_TO_POINTER (data->serial)));
1174
1175   send_message_data_unref (data);
1176 }
1177
1178 /* ---------------------------------------------------------------------------------------------------- */
1179
1180 /* must hold lock */
1181 static void
1182 send_message_data_deliver_reply_unlocked (SendMessageData *data,
1183                                           GDBusMessage    *reply)
1184 {
1185   if (data->delivered)
1186     goto out;
1187
1188   g_simple_async_result_set_op_res_gpointer (data->simple,
1189                                              g_object_ref (reply),
1190                                              g_object_unref);
1191
1192   send_message_with_reply_deliver (data);
1193
1194  out:
1195   ;
1196 }
1197
1198 /* ---------------------------------------------------------------------------------------------------- */
1199
1200 static gboolean
1201 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
1202 {
1203   SendMessageData *data = user_data;
1204
1205   CONNECTION_LOCK (data->connection);
1206   if (data->delivered)
1207     goto out;
1208
1209   g_simple_async_result_set_error (data->simple,
1210                                    G_IO_ERROR,
1211                                    G_IO_ERROR_CANCELLED,
1212                                    _("Operation was cancelled"));
1213
1214   send_message_with_reply_deliver (data);
1215
1216  out:
1217   CONNECTION_UNLOCK (data->connection);
1218   return FALSE;
1219 }
1220
1221 /* Can be called from any thread with or without lock held */
1222 static void
1223 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
1224                                       gpointer      user_data)
1225 {
1226   SendMessageData *data = user_data;
1227   GSource *idle_source;
1228
1229   /* postpone cancellation to idle handler since we may be called directly
1230    * via g_cancellable_connect() (e.g. holding lock)
1231    */
1232   idle_source = g_idle_source_new ();
1233   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1234   g_source_set_callback (idle_source,
1235                          send_message_with_reply_cancelled_idle_cb,
1236                          send_message_data_ref (data),
1237                          (GDestroyNotify) send_message_data_unref);
1238   g_source_attach (idle_source, data->main_context);
1239   g_source_unref (idle_source);
1240 }
1241
1242 /* ---------------------------------------------------------------------------------------------------- */
1243
1244 static gboolean
1245 send_message_with_reply_timeout_cb (gpointer user_data)
1246 {
1247   SendMessageData *data = user_data;
1248
1249   CONNECTION_LOCK (data->connection);
1250   if (data->delivered)
1251     goto out;
1252
1253   g_simple_async_result_set_error (data->simple,
1254                                    G_IO_ERROR,
1255                                    G_IO_ERROR_TIMED_OUT,
1256                                    _("Timeout was reached"));
1257
1258   send_message_with_reply_deliver (data);
1259
1260  out:
1261   CONNECTION_UNLOCK (data->connection);
1262
1263   return FALSE;
1264 }
1265
1266 /* ---------------------------------------------------------------------------------------------------- */
1267
1268 static void
1269 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection     *connection,
1270                                                     GDBusMessage        *message,
1271                                                     gint                 timeout_msec,
1272                                                     volatile guint32    *out_serial,
1273                                                     GCancellable        *cancellable,
1274                                                     GAsyncReadyCallback  callback,
1275                                                     gpointer             user_data)
1276 {
1277   GSimpleAsyncResult *simple;
1278   SendMessageData *data;
1279   GError *error;
1280   volatile guint32 serial;
1281
1282   data = NULL;
1283
1284   if (out_serial == NULL)
1285     out_serial = &serial;
1286
1287   if (timeout_msec == -1)
1288     timeout_msec = 25 * 1000;
1289
1290   simple = g_simple_async_result_new (G_OBJECT (connection),
1291                                       callback,
1292                                       user_data,
1293                                       g_dbus_connection_send_message_with_reply);
1294
1295   if (g_cancellable_is_cancelled (cancellable))
1296     {
1297       g_simple_async_result_set_error (simple,
1298                                        G_IO_ERROR,
1299                                        G_IO_ERROR_CANCELLED,
1300                                        _("Operation was cancelled"));
1301       g_simple_async_result_complete_in_idle (simple);
1302       g_object_unref (simple);
1303       goto out;
1304     }
1305
1306   if (connection->priv->closed)
1307     {
1308       g_simple_async_result_set_error (simple,
1309                                        G_IO_ERROR,
1310                                        G_IO_ERROR_CLOSED,
1311                                        _("The connection is closed"));
1312       g_simple_async_result_complete_in_idle (simple);
1313       g_object_unref (simple);
1314       goto out;
1315     }
1316
1317   error = NULL;
1318   if (!g_dbus_connection_send_message_unlocked (connection, message, out_serial, &error))
1319     {
1320       g_simple_async_result_set_from_error (simple, error);
1321       g_simple_async_result_complete_in_idle (simple);
1322       g_object_unref (simple);
1323       goto out;
1324     }
1325
1326   data = g_new0 (SendMessageData, 1);
1327   data->ref_count = 1;
1328   data->connection = g_object_ref (connection);
1329   data->simple = simple;
1330   data->serial = *out_serial;
1331   data->main_context = g_main_context_get_thread_default ();
1332   if (data->main_context != NULL)
1333     g_main_context_ref (data->main_context);
1334
1335   if (cancellable != NULL)
1336     {
1337       data->cancellable = g_object_ref (cancellable);
1338       data->cancellable_handler_id = g_cancellable_connect (cancellable,
1339                                                             G_CALLBACK (send_message_with_reply_cancelled_cb),
1340                                                             send_message_data_ref (data),
1341                                                             (GDestroyNotify) send_message_data_unref);
1342       g_object_set_data_full (G_OBJECT (simple),
1343                               "cancellable",
1344                               g_object_ref (cancellable),
1345                               (GDestroyNotify) g_object_unref);
1346     }
1347
1348   data->timeout_source = g_timeout_source_new (timeout_msec);
1349   g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
1350   g_source_set_callback (data->timeout_source,
1351                          send_message_with_reply_timeout_cb,
1352                          send_message_data_ref (data),
1353                          (GDestroyNotify) send_message_data_unref);
1354   g_source_attach (data->timeout_source, data->main_context);
1355   g_source_unref (data->timeout_source);
1356
1357   g_hash_table_insert (connection->priv->map_method_serial_to_send_message_data,
1358                        GUINT_TO_POINTER (*out_serial),
1359                        data);
1360
1361  out:
1362   ;
1363 }
1364
1365 /**
1366  * g_dbus_connection_send_message_with_reply:
1367  * @connection: A #GDBusConnection.
1368  * @message: A #GDBusMessage.
1369  * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
1370  * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1371  * @cancellable: A #GCancellable or %NULL.
1372  * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
1373  * care about the result.
1374  * @user_data: The data to pass to @callback.
1375  *
1376  * Asynchronously sends @message to the peer represented by @connection.
1377  *
1378  * If @out_serial is not %NULL, then the serial number assigned to
1379  * @message by @connection will be written to this location prior to
1380  * submitting the message to the underlying transport.
1381  *
1382  * If @connection is closed then the operation will fail with
1383  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
1384  * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
1385  * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1386  *
1387  * This is an asynchronous method. When the operation is finished, @callback will be invoked
1388  * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
1389  * of the thread you are calling this method from. You can then call
1390  * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
1391  * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
1392  *
1393  * See <xref linkend="gdbus-server"/> and <xref
1394  * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1395  * low-level API to send and receive UNIX file descriptors.
1396  *
1397  * Since: 2.26
1398  */
1399 void
1400 g_dbus_connection_send_message_with_reply (GDBusConnection     *connection,
1401                                            GDBusMessage        *message,
1402                                            gint                 timeout_msec,
1403                                            volatile guint32    *out_serial,
1404                                            GCancellable        *cancellable,
1405                                            GAsyncReadyCallback  callback,
1406                                            gpointer             user_data)
1407 {
1408   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1409   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1410   g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
1411
1412   CONNECTION_LOCK (connection);
1413   g_dbus_connection_send_message_with_reply_unlocked (connection,
1414                                                       message,
1415                                                       timeout_msec,
1416                                                       out_serial,
1417                                                       cancellable,
1418                                                       callback,
1419                                                       user_data);
1420   CONNECTION_UNLOCK (connection);
1421 }
1422
1423 /**
1424  * g_dbus_connection_send_message_with_reply_finish:
1425  * @connection: a #GDBusConnection
1426  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
1427  * @error: Return location for error or %NULL.
1428  *
1429  * Finishes an operation started with g_dbus_connection_send_message_with_reply().
1430  *
1431  * Note that @error is only set if a local in-process error
1432  * occured. That is to say that the returned #GDBusMessage object may
1433  * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
1434  * g_dbus_message_to_gerror() to transcode this to a #GError.
1435  *
1436  * See <xref linkend="gdbus-server"/> and <xref
1437  * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1438  * low-level API to send and receive UNIX file descriptors.
1439  *
1440  * Returns: A #GDBusMessage or %NULL if @error is set.
1441  *
1442  * Since: 2.26
1443  */
1444 GDBusMessage *
1445 g_dbus_connection_send_message_with_reply_finish (GDBusConnection  *connection,
1446                                                   GAsyncResult     *res,
1447                                                   GError          **error)
1448 {
1449   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1450   GDBusMessage *reply;
1451   GCancellable *cancellable;
1452
1453   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1454   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1455
1456   reply = NULL;
1457
1458   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
1459
1460   if (g_simple_async_result_propagate_error (simple, error))
1461     goto out;
1462
1463   reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
1464   cancellable = g_object_get_data (G_OBJECT (simple), "cancellable");
1465   if (cancellable != NULL && g_cancellable_is_cancelled (cancellable))
1466     {
1467       g_object_unref (reply);
1468       reply = NULL;
1469       g_set_error_literal (error,
1470                            G_IO_ERROR,
1471                            G_IO_ERROR_CANCELLED,
1472                            _("Operation was cancelled"));
1473     }
1474  out:
1475   return reply;
1476 }
1477
1478 /* ---------------------------------------------------------------------------------------------------- */
1479
1480 typedef struct
1481 {
1482   GAsyncResult *res;
1483   GMainContext *context;
1484   GMainLoop *loop;
1485 } SendMessageSyncData;
1486
1487 static void
1488 send_message_with_reply_sync_cb (GDBusConnection *connection,
1489                                  GAsyncResult    *res,
1490                                  gpointer         user_data)
1491 {
1492   SendMessageSyncData *data = user_data;
1493   data->res = g_object_ref (res);
1494   g_main_loop_quit (data->loop);
1495 }
1496
1497 /**
1498  * g_dbus_connection_send_message_with_reply_sync:
1499  * @connection: A #GDBusConnection.
1500  * @message: A #GDBusMessage.
1501  * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
1502  * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1503  * @cancellable: A #GCancellable or %NULL.
1504  * @error: Return location for error or %NULL.
1505  *
1506  * Synchronously sends @message to the peer represented by @connection
1507  * and blocks the calling thread until a reply is received or the
1508  * timeout is reached. See g_dbus_connection_send_message_with_reply()
1509  * for the asynchronous version of this method.
1510  *
1511  * If @out_serial is not %NULL, then the serial number assigned to
1512  * @message by @connection will be written to this location prior to
1513  * submitting the message to the underlying transport.
1514  *
1515  * If @connection is closed then the operation will fail with
1516  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
1517  * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
1518  * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1519  *
1520  * Note that @error is only set if a local in-process error
1521  * occured. That is to say that the returned #GDBusMessage object may
1522  * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
1523  * g_dbus_message_to_gerror() to transcode this to a #GError.
1524  *
1525  * See <xref linkend="gdbus-server"/> and <xref
1526  * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1527  * low-level API to send and receive UNIX file descriptors.
1528  *
1529  * Returns: A #GDBusMessage that is the reply to @message or %NULL if @error is set.
1530  *
1531  * Since: 2.26
1532  */
1533 GDBusMessage *
1534 g_dbus_connection_send_message_with_reply_sync (GDBusConnection   *connection,
1535                                                 GDBusMessage      *message,
1536                                                 gint               timeout_msec,
1537                                                 volatile guint32  *out_serial,
1538                                                 GCancellable      *cancellable,
1539                                                 GError           **error)
1540 {
1541   SendMessageSyncData *data;
1542   GDBusMessage *reply;
1543
1544   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1545   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1546   g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
1547   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1548
1549   data = g_new0 (SendMessageSyncData, 1);
1550   data->context = g_main_context_new ();
1551   data->loop = g_main_loop_new (data->context, FALSE);
1552
1553   g_main_context_push_thread_default (data->context);
1554
1555   g_dbus_connection_send_message_with_reply (connection,
1556                                              message,
1557                                              timeout_msec,
1558                                              out_serial,
1559                                              cancellable,
1560                                              (GAsyncReadyCallback) send_message_with_reply_sync_cb,
1561                                              data);
1562   g_main_loop_run (data->loop);
1563   reply = g_dbus_connection_send_message_with_reply_finish (connection,
1564                                                             data->res,
1565                                                             error);
1566
1567   g_main_context_pop_thread_default (data->context);
1568
1569   g_main_context_unref (data->context);
1570   g_main_loop_unref (data->loop);
1571   g_object_unref (data->res);
1572   g_free (data);
1573
1574   return reply;
1575 }
1576
1577 /* ---------------------------------------------------------------------------------------------------- */
1578
1579 typedef struct
1580 {
1581   GDBusMessageFilterFunction func;
1582   gpointer user_data;
1583 } FilterCallback;
1584
1585 typedef struct
1586 {
1587   guint                       id;
1588   GDBusMessageFilterFunction  filter_function;
1589   gpointer                    user_data;
1590   GDestroyNotify              user_data_free_func;
1591 } FilterData;
1592
1593 /* Called in worker's thread - we must not block */
1594 static void
1595 on_worker_message_received (GDBusWorker  *worker,
1596                             GDBusMessage *message,
1597                             gpointer      user_data)
1598 {
1599   GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
1600   FilterCallback *filters;
1601   gboolean consumed_by_filter;
1602   guint num_filters;
1603   guint n;
1604
1605   //g_debug ("in on_worker_message_received");
1606
1607   g_object_ref (connection);
1608
1609   /* First collect the set of callback functions */
1610   CONNECTION_LOCK (connection);
1611   num_filters = connection->priv->filters->len;
1612   filters = g_new0 (FilterCallback, num_filters);
1613   for (n = 0; n < num_filters; n++)
1614     {
1615       FilterData *data = connection->priv->filters->pdata[n];
1616       filters[n].func = data->filter_function;
1617       filters[n].user_data = data->user_data;
1618     }
1619   CONNECTION_UNLOCK (connection);
1620
1621   /* the call the filters in order (without holding the lock) */
1622   consumed_by_filter = FALSE;
1623   for (n = 0; n < num_filters; n++)
1624     {
1625       consumed_by_filter = filters[n].func (connection,
1626                                             message,
1627                                             filters[n].user_data);
1628       if (consumed_by_filter)
1629         break;
1630     }
1631
1632   /* Standard dispatch unless the filter ate the message */
1633   if (!consumed_by_filter)
1634     {
1635       GDBusMessageType message_type;
1636
1637       message_type = g_dbus_message_get_message_type (message);
1638       if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
1639         {
1640           guint32 reply_serial;
1641           SendMessageData *send_message_data;
1642
1643           reply_serial = g_dbus_message_get_reply_serial (message);
1644           CONNECTION_LOCK (connection);
1645           send_message_data = g_hash_table_lookup (connection->priv->map_method_serial_to_send_message_data,
1646                                                    GUINT_TO_POINTER (reply_serial));
1647           if (send_message_data != NULL)
1648             {
1649               //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
1650               send_message_data_deliver_reply_unlocked (send_message_data, message);
1651             }
1652           else
1653             {
1654               //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
1655             }
1656           CONNECTION_UNLOCK (connection);
1657         }
1658       else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
1659         {
1660           CONNECTION_LOCK (connection);
1661           distribute_signals (connection, message);
1662           CONNECTION_UNLOCK (connection);
1663         }
1664       else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
1665         {
1666           CONNECTION_LOCK (connection);
1667           distribute_method_call (connection, message);
1668           CONNECTION_UNLOCK (connection);
1669         }
1670     }
1671
1672   g_object_unref (connection);
1673   g_free (filters);
1674 }
1675
1676 /* Called in worker's thread - we must not block */
1677 static void
1678 on_worker_closed (GDBusWorker *worker,
1679                   gboolean     remote_peer_vanished,
1680                   GError      *error,
1681                   gpointer     user_data)
1682 {
1683   GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
1684
1685   //g_debug ("in on_worker_closed: %s", error->message);
1686
1687   CONNECTION_LOCK (connection);
1688   if (!connection->priv->closed)
1689     set_closed_unlocked (connection, remote_peer_vanished, error);
1690   CONNECTION_UNLOCK (connection);
1691 }
1692
1693 /* ---------------------------------------------------------------------------------------------------- */
1694
1695 /* Determines the biggest set of capabilities we can support on this connection */
1696 static GDBusCapabilityFlags
1697 get_offered_capabilities_max (GDBusConnection *connection)
1698 {
1699       GDBusCapabilityFlags ret;
1700       ret = G_DBUS_CAPABILITY_FLAGS_NONE;
1701 #ifdef G_OS_UNIX
1702       if (G_IS_UNIX_CONNECTION (connection->priv->stream))
1703         ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
1704 #endif
1705       return ret;
1706 }
1707
1708 static gboolean
1709 initable_init (GInitable     *initable,
1710                GCancellable  *cancellable,
1711                GError       **error)
1712 {
1713   GDBusConnection *connection = G_DBUS_CONNECTION (initable);
1714   gboolean ret;
1715
1716   /* This method needs to be idempotent to work with the singleton
1717    * pattern. See the docs for g_initable_init(). We implement this by
1718    * locking.
1719    *
1720    * Unfortunately we can't use the main lock since the on_worker_*()
1721    * callbacks above needs the lock during initialization (for message
1722    * bus connections we do a synchronous Hello() call on the bus).
1723    */
1724   g_mutex_lock (connection->priv->init_lock);
1725
1726   ret = FALSE;
1727
1728   if (connection->priv->is_initialized)
1729     {
1730       if (connection->priv->stream != NULL)
1731         ret = TRUE;
1732       else
1733         g_assert (connection->priv->initialization_error != NULL);
1734       goto out;
1735     }
1736   g_assert (connection->priv->initialization_error == NULL);
1737
1738   /* The user can pass multiple (but mutally exclusive) construct
1739    * properties:
1740    *
1741    *  - stream (of type GIOStream)
1742    *  - address (of type gchar*)
1743    *
1744    * At the end of the day we end up with a non-NULL GIOStream
1745    * object in connection->priv->stream.
1746    */
1747   if (connection->priv->address != NULL)
1748     {
1749       g_assert (connection->priv->stream == NULL);
1750
1751       if ((connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
1752           (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
1753         {
1754           g_set_error_literal (error,
1755                                G_IO_ERROR,
1756                                G_IO_ERROR_INVALID_ARGUMENT,
1757                                _("Unsupported flags encountered when constructing a client-side connection"));
1758           goto out;
1759         }
1760
1761       connection->priv->stream = g_dbus_address_get_stream_sync (connection->priv->address,
1762                                                                  NULL, /* TODO: out_guid */
1763                                                                  cancellable,
1764                                                                  &connection->priv->initialization_error);
1765       if (connection->priv->stream == NULL)
1766         goto out;
1767     }
1768   else if (connection->priv->stream != NULL)
1769     {
1770       /* nothing to do */
1771     }
1772   else
1773     {
1774       g_assert_not_reached ();
1775     }
1776
1777   /* Authenticate the connection */
1778   if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
1779     {
1780       g_assert (!(connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
1781       g_assert (connection->priv->guid != NULL);
1782       connection->priv->auth = _g_dbus_auth_new (connection->priv->stream);
1783       if (!_g_dbus_auth_run_server (connection->priv->auth,
1784                                     connection->priv->authentication_observer,
1785                                     connection->priv->guid,
1786                                     (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
1787                                     get_offered_capabilities_max (connection),
1788                                     &connection->priv->capabilities,
1789                                     &connection->priv->crendentials,
1790                                     cancellable,
1791                                     &connection->priv->initialization_error))
1792         goto out;
1793     }
1794   else if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
1795     {
1796       g_assert (!(connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
1797       g_assert (connection->priv->guid == NULL);
1798       connection->priv->auth = _g_dbus_auth_new (connection->priv->stream);
1799       connection->priv->guid = _g_dbus_auth_run_client (connection->priv->auth,
1800                                                         get_offered_capabilities_max (connection),
1801                                                         &connection->priv->capabilities,
1802                                                         cancellable,
1803                                                         &connection->priv->initialization_error);
1804       if (connection->priv->guid == NULL)
1805         goto out;
1806     }
1807
1808   if (connection->priv->authentication_observer != NULL)
1809     {
1810       g_object_unref (connection->priv->authentication_observer);
1811       connection->priv->authentication_observer = NULL;
1812     }
1813
1814   //g_output_stream_flush (G_SOCKET_CONNECTION (connection->priv->stream)
1815
1816   //g_debug ("haz unix fd passing powers: %d", connection->priv->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
1817
1818   /* Hack used until
1819    *
1820    *  https://bugzilla.gnome.org/show_bug.cgi?id=616458
1821    *
1822    * has been resolved
1823    */
1824   if (G_IS_SOCKET_CONNECTION (connection->priv->stream))
1825     {
1826       g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->priv->stream)), FALSE);
1827     }
1828
1829   connection->priv->worker = _g_dbus_worker_new (connection->priv->stream,
1830                                                  connection->priv->capabilities,
1831                                                  on_worker_message_received,
1832                                                  on_worker_closed,
1833                                                  connection);
1834
1835   /* if a bus connection, invoke org.freedesktop.DBus.Hello - this is how we're getting a name */
1836   if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
1837     {
1838       GVariant *hello_result;
1839
1840       hello_result = g_dbus_connection_call_sync (connection,
1841                                                   "org.freedesktop.DBus", /* name */
1842                                                   "/org/freedesktop/DBus", /* path */
1843                                                   "org.freedesktop.DBus", /* interface */
1844                                                   "Hello",
1845                                                   NULL, /* parameters */
1846                                                   G_DBUS_CALL_FLAGS_NONE,
1847                                                   -1,
1848                                                   NULL, /* TODO: cancellable */
1849                                                   &connection->priv->initialization_error);
1850       if (hello_result == NULL)
1851         goto out;
1852
1853       g_variant_get (hello_result, "(s)", &connection->priv->bus_unique_name);
1854       g_variant_unref (hello_result);
1855       //g_debug ("unique name is `%s'", connection->priv->bus_unique_name);
1856     }
1857
1858   connection->priv->is_initialized = TRUE;
1859
1860   ret = TRUE;
1861  out:
1862   if (!ret)
1863     {
1864       g_assert (connection->priv->initialization_error != NULL);
1865       g_propagate_error (error, g_error_copy (connection->priv->initialization_error));
1866     }
1867
1868   g_mutex_unlock (connection->priv->init_lock);
1869
1870   return ret;
1871 }
1872
1873 static void
1874 initable_iface_init (GInitableIface *initable_iface)
1875 {
1876   initable_iface->init = initable_init;
1877 }
1878
1879 /* ---------------------------------------------------------------------------------------------------- */
1880
1881 static void
1882 async_init_thread (GSimpleAsyncResult *res,
1883                    GObject            *object,
1884                    GCancellable       *cancellable)
1885 {
1886   GError *error = NULL;
1887
1888   if (!g_initable_init (G_INITABLE (object), cancellable, &error))
1889     {
1890       g_simple_async_result_set_from_error (res, error);
1891       g_error_free (error);
1892     }
1893 }
1894
1895 static void
1896 async_initable_init_async (GAsyncInitable      *initable,
1897                            gint                 io_priority,
1898                            GCancellable        *cancellable,
1899                            GAsyncReadyCallback  callback,
1900                            gpointer             user_data)
1901 {
1902   GSimpleAsyncResult *res;
1903
1904   g_return_if_fail (G_IS_INITABLE (initable));
1905
1906   res = g_simple_async_result_new (G_OBJECT (initable), callback, user_data,
1907                                    async_initable_init_async);
1908   g_simple_async_result_run_in_thread (res, async_init_thread,
1909                                        io_priority, cancellable);
1910   g_object_unref (res);
1911 }
1912
1913 static gboolean
1914 async_initable_init_finish (GAsyncInitable  *initable,
1915                             GAsyncResult    *res,
1916                             GError         **error)
1917 {
1918   return TRUE; /* Errors handled by base impl */
1919 }
1920
1921 static void
1922 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
1923 {
1924   /* We basically just want to use GIO's default implementation - though that one is
1925    * unfortunately broken, see #615111. So we copy-paste a fixed-up version.
1926    */
1927   async_initable_iface->init_async = async_initable_init_async;
1928   async_initable_iface->init_finish = async_initable_init_finish;
1929 }
1930
1931 /* ---------------------------------------------------------------------------------------------------- */
1932
1933 /**
1934  * g_dbus_connection_new:
1935  * @stream: A #GIOStream.
1936  * @guid: The GUID to use if a authenticating as a server or %NULL.
1937  * @flags: Flags describing how to make the connection.
1938  * @observer: A #GDBusAuthObserver or %NULL.
1939  * @cancellable: A #GCancellable or %NULL.
1940  * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
1941  * @user_data: The data to pass to @callback.
1942  *
1943  * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
1944  * with the end represented by @stream.
1945  *
1946  * If @observer is not %NULL it may be used to control the
1947  * authentication process.
1948  *
1949  * When the operation is finished, @callback will be invoked. You can
1950  * then call g_dbus_connection_new_finish() to get the result of the
1951  * operation.
1952  *
1953  * This is a asynchronous failable constructor. See
1954  * g_dbus_connection_new_sync() for the synchronous
1955  * version.
1956  *
1957  * Since: 2.26
1958  */
1959 void
1960 g_dbus_connection_new (GIOStream            *stream,
1961                        const gchar          *guid,
1962                        GDBusConnectionFlags  flags,
1963                        GDBusAuthObserver    *observer,
1964                        GCancellable         *cancellable,
1965                        GAsyncReadyCallback   callback,
1966                        gpointer              user_data)
1967 {
1968   g_return_if_fail (G_IS_IO_STREAM (stream));
1969   g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
1970                               G_PRIORITY_DEFAULT,
1971                               cancellable,
1972                               callback,
1973                               user_data,
1974                               "stream", stream,
1975                               "guid", guid,
1976                               "flags", flags,
1977                               "authentication-observer", observer,
1978                               NULL);
1979 }
1980
1981 /**
1982  * g_dbus_connection_new_finish:
1983  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
1984  * @error: Return location for error or %NULL.
1985  *
1986  * Finishes an operation started with g_dbus_connection_new().
1987  *
1988  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
1989  *
1990  * Since: 2.26
1991  */
1992 GDBusConnection *
1993 g_dbus_connection_new_finish (GAsyncResult  *res,
1994                               GError       **error)
1995 {
1996   GObject *object;
1997   GObject *source_object;
1998
1999   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2000   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2001
2002   source_object = g_async_result_get_source_object (res);
2003   g_assert (source_object != NULL);
2004   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2005                                         res,
2006                                         error);
2007   g_object_unref (source_object);
2008   if (object != NULL)
2009     return G_DBUS_CONNECTION (object);
2010   else
2011     return NULL;
2012 }
2013
2014 /**
2015  * g_dbus_connection_new_sync:
2016  * @stream: A #GIOStream.
2017  * @guid: The GUID to use if a authenticating as a server or %NULL.
2018  * @flags: Flags describing how to make the connection.
2019  * @observer: A #GDBusAuthObserver or %NULL.
2020  * @cancellable: A #GCancellable or %NULL.
2021  * @error: Return location for error or %NULL.
2022  *
2023  * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
2024  * with the end represented by @stream.
2025  *
2026  * If @observer is not %NULL it may be used to control the
2027  * authentication process.
2028  *
2029  * This is a synchronous failable constructor. See
2030  * g_dbus_connection_new() for the asynchronous version.
2031  *
2032  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2033  *
2034  * Since: 2.26
2035  */
2036 GDBusConnection *
2037 g_dbus_connection_new_sync (GIOStream             *stream,
2038                             const gchar           *guid,
2039                             GDBusConnectionFlags   flags,
2040                             GDBusAuthObserver     *observer,
2041                             GCancellable          *cancellable,
2042                             GError               **error)
2043 {
2044   g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
2045   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2046   return g_initable_new (G_TYPE_DBUS_CONNECTION,
2047                          cancellable,
2048                          error,
2049                          "stream", stream,
2050                          "guid", guid,
2051                          "flags", flags,
2052                          "authentication-observer", observer,
2053                          NULL);
2054 }
2055
2056 /* ---------------------------------------------------------------------------------------------------- */
2057
2058 /**
2059  * g_dbus_connection_new_for_address:
2060  * @address: A D-Bus address.
2061  * @flags: Flags describing how to make the connection.
2062  * @observer: A #GDBusAuthObserver or %NULL.
2063  * @cancellable: A #GCancellable or %NULL.
2064  * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2065  * @user_data: The data to pass to @callback.
2066  *
2067  * Asynchronously connects and sets up a D-Bus client connection for
2068  * exchanging D-Bus messages with an endpoint specified by @address
2069  * which must be in the D-Bus address format.
2070  *
2071  * This constructor can only be used to initiate client-side
2072  * connections - use g_dbus_connection_new() if you need to act as the
2073  * server. In particular, @flags cannot contain the
2074  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2075  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2076  *
2077  * When the operation is finished, @callback will be invoked. You can
2078  * then call g_dbus_connection_new_finish() to get the result of the
2079  * operation.
2080  *
2081  * If @observer is not %NULL it may be used to control the
2082  * authentication process.
2083  *
2084  * This is a asynchronous failable constructor. See
2085  * g_dbus_connection_new_for_address_sync() for the synchronous
2086  * version.
2087  *
2088  * Since: 2.26
2089  */
2090 void
2091 g_dbus_connection_new_for_address (const gchar          *address,
2092                                    GDBusConnectionFlags  flags,
2093                                    GDBusAuthObserver    *observer,
2094                                    GCancellable         *cancellable,
2095                                    GAsyncReadyCallback   callback,
2096                                    gpointer              user_data)
2097 {
2098   g_return_if_fail (address != NULL);
2099   g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2100                               G_PRIORITY_DEFAULT,
2101                               cancellable,
2102                               callback,
2103                               user_data,
2104                               "address", address,
2105                               "flags", flags,
2106                               "authentication-observer", observer,
2107                               NULL);
2108 }
2109
2110 /**
2111  * g_dbus_connection_new_for_address_finish:
2112  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2113  * @error: Return location for error or %NULL.
2114  *
2115  * Finishes an operation started with g_dbus_connection_new_for_address().
2116  *
2117  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2118  *
2119  * Since: 2.26
2120  */
2121 GDBusConnection *
2122 g_dbus_connection_new_for_address_finish (GAsyncResult  *res,
2123                                           GError       **error)
2124 {
2125   GObject *object;
2126   GObject *source_object;
2127
2128   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2129   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2130
2131   source_object = g_async_result_get_source_object (res);
2132   g_assert (source_object != NULL);
2133   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2134                                         res,
2135                                         error);
2136   g_object_unref (source_object);
2137   if (object != NULL)
2138     return G_DBUS_CONNECTION (object);
2139   else
2140     return NULL;
2141 }
2142
2143 /**
2144  * g_dbus_connection_new_for_address_sync:
2145  * @address: A D-Bus address.
2146  * @flags: Flags describing how to make the connection.
2147  * @observer: A #GDBusAuthObserver or %NULL.
2148  * @cancellable: A #GCancellable or %NULL.
2149  * @error: Return location for error or %NULL.
2150  *
2151  * Synchronously connects and sets up a D-Bus client connection for
2152  * exchanging D-Bus messages with an endpoint specified by @address
2153  * which must be in the D-Bus address format.
2154  *
2155  * This constructor can only be used to initiate client-side
2156  * connections - use g_dbus_connection_new_sync() if you need to act
2157  * as the server. In particular, @flags cannot contain the
2158  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2159  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2160  *
2161  * This is a synchronous failable constructor. See
2162  * g_dbus_connection_new_for_address() for the asynchronous version.
2163  *
2164  * If @observer is not %NULL it may be used to control the
2165  * authentication process.
2166  *
2167  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2168  *
2169  * Since: 2.26
2170  */
2171 GDBusConnection *
2172 g_dbus_connection_new_for_address_sync (const gchar           *address,
2173                                         GDBusConnectionFlags   flags,
2174                                         GDBusAuthObserver     *observer,
2175                                         GCancellable          *cancellable,
2176                                         GError               **error)
2177 {
2178   g_return_val_if_fail (address != NULL, NULL);
2179   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2180   return g_initable_new (G_TYPE_DBUS_CONNECTION,
2181                          cancellable,
2182                          error,
2183                          "address", address,
2184                          "flags", flags,
2185                          "authentication-observer", observer,
2186                          NULL);
2187 }
2188
2189 /* ---------------------------------------------------------------------------------------------------- */
2190
2191 /**
2192  * g_dbus_connection_set_exit_on_close:
2193  * @connection: A #GDBusConnection.
2194  * @exit_on_close: Whether the process should be terminated
2195  * when @connection is closed by the remote peer.
2196  *
2197  * Sets whether the process should be terminated when @connection is
2198  * closed by the remote peer. See #GDBusConnection:exit-on-close for
2199  * more details.
2200  *
2201  * Since: 2.26
2202  */
2203 void
2204 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
2205                                      gboolean         exit_on_close)
2206 {
2207   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2208   connection->priv->exit_on_close = exit_on_close;
2209 }
2210
2211 /**
2212  * g_dbus_connection_get_exit_on_close:
2213  * @connection: A #GDBusConnection.
2214  *
2215  * Gets whether the process is terminated when @connection is
2216  * closed by the remote peer. See
2217  * #GDBusConnection:exit-on-close for more details.
2218  *
2219  * Returns: Whether the process is terminated when @connection is
2220  * closed by the remote peer.
2221  *
2222  * Since: 2.26
2223  */
2224 gboolean
2225 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
2226 {
2227   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2228   return connection->priv->exit_on_close;
2229 }
2230
2231 /**
2232  * g_dbus_connection_get_guid:
2233  * @connection: A #GDBusConnection.
2234  *
2235  * The GUID of the peer performing the role of server when
2236  * authenticating. See #GDBusConnection:guid for more details.
2237  *
2238  * Returns: The GUID. Do not free this string, it is owned by
2239  * @connection.
2240  *
2241  * Since: 2.26
2242  */
2243 const gchar *
2244 g_dbus_connection_get_guid (GDBusConnection *connection)
2245 {
2246   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2247   return connection->priv->guid;
2248 }
2249
2250 /**
2251  * g_dbus_connection_get_unique_name:
2252  * @connection: A #GDBusConnection.
2253  *
2254  * Gets the unique name of @connection as assigned by the message
2255  * bus. This can also be used to figure out if @connection is a
2256  * message bus connection.
2257  *
2258  * Returns: The unique name or %NULL if @connection is not a message
2259  * bus connection. Do not free this string, it is owned by
2260  * @connection.
2261  *
2262  * Since: 2.26
2263  */
2264 const gchar *
2265 g_dbus_connection_get_unique_name (GDBusConnection *connection)
2266 {
2267   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2268   return connection->priv->bus_unique_name;
2269 }
2270
2271 /**
2272  * g_dbus_connection_get_peer_credentials:
2273  * @connection: A #GDBusConnection.
2274  *
2275  * Gets the credentials of the authenticated peer. This will always
2276  * return %NULL unless @connection acted as a server
2277  * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
2278  * when set up and the client passed credentials as part of the
2279  * authentication process.
2280  *
2281  * In a message bus setup, the message bus is always the server and
2282  * each application is a client. So this method will always return
2283  * %NULL for message bus clients.
2284  *
2285  * Returns: A #GCredentials or %NULL if not available. Do not free
2286  * this object, it is owned by @connection.
2287  *
2288  * Since: 2.26
2289  */
2290 GCredentials *
2291 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
2292 {
2293   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2294   return connection->priv->crendentials;
2295 }
2296
2297 /* ---------------------------------------------------------------------------------------------------- */
2298
2299 static guint _global_filter_id = 1;
2300
2301 /**
2302  * g_dbus_connection_add_filter:
2303  * @connection: A #GDBusConnection.
2304  * @filter_function: A filter function.
2305  * @user_data: User data to pass to @filter_function.
2306  * @user_data_free_func: Function to free @user_data with when filter
2307  * is removed or %NULL.
2308  *
2309  * Adds a message filter. Filters are handlers that are run on all
2310  * incoming messages, prior to standard dispatch. Filters are run in
2311  * the order that they were added.  The same handler can be added as a
2312  * filter more than once, in which case it will be run more than once.
2313  * Filters added during a filter callback won't be run on the message
2314  * being processed.
2315  *
2316  * Note that filters are run in a dedicated message handling thread so
2317  * they can't block and, generally, can't do anything but signal a
2318  * worker thread. Also note that filters are rarely needed - use API
2319  * such as g_dbus_connection_send_message_with_reply(),
2320  * g_dbus_connection_signal_subscribe() or
2321  * g_dbus_connection_call() instead.
2322  *
2323  * Returns: A filter identifier that can be used with
2324  * g_dbus_connection_remove_filter().
2325  *
2326  * Since: 2.26
2327  */
2328 guint
2329 g_dbus_connection_add_filter (GDBusConnection            *connection,
2330                               GDBusMessageFilterFunction  filter_function,
2331                               gpointer                    user_data,
2332                               GDestroyNotify              user_data_free_func)
2333 {
2334   FilterData *data;
2335
2336   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2337   g_return_val_if_fail (filter_function != NULL, 0);
2338
2339   CONNECTION_LOCK (connection);
2340   data = g_new0 (FilterData, 1);
2341   data->id = _global_filter_id++; /* TODO: overflow etc. */
2342   data->filter_function = filter_function;
2343   data->user_data = user_data;
2344   data->user_data_free_func = user_data_free_func;
2345   g_ptr_array_add (connection->priv->filters, data);
2346   CONNECTION_UNLOCK (connection);
2347
2348   return data->id;
2349 }
2350
2351 /* only called from finalize(), removes all filters */
2352 static void
2353 purge_all_filters (GDBusConnection *connection)
2354 {
2355   guint n;
2356   for (n = 0; n < connection->priv->filters->len; n++)
2357     {
2358       FilterData *data = connection->priv->filters->pdata[n];
2359       if (data->user_data_free_func != NULL)
2360         data->user_data_free_func (data->user_data);
2361       g_free (data);
2362     }
2363 }
2364
2365 /**
2366  * g_dbus_connection_remove_filter:
2367  * @connection: a #GDBusConnection
2368  * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
2369  *
2370  * Removes a filter.
2371  *
2372  * Since: 2.26
2373  */
2374 void
2375 g_dbus_connection_remove_filter (GDBusConnection *connection,
2376                                  guint            filter_id)
2377 {
2378   guint n;
2379   FilterData *to_destroy;
2380
2381   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2382
2383   CONNECTION_LOCK (connection);
2384   to_destroy = NULL;
2385   for (n = 0; n < connection->priv->filters->len; n++)
2386     {
2387       FilterData *data = connection->priv->filters->pdata[n];
2388       if (data->id == filter_id)
2389         {
2390           g_ptr_array_remove_index (connection->priv->filters, n);
2391           to_destroy = data;
2392           break;
2393         }
2394     }
2395   CONNECTION_UNLOCK (connection);
2396
2397   /* do free without holding lock */
2398   if (to_destroy != NULL)
2399     {
2400       if (to_destroy->user_data_free_func != NULL)
2401         to_destroy->user_data_free_func (to_destroy->user_data);
2402       g_free (to_destroy);
2403     }
2404   else
2405     {
2406       g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
2407     }
2408 }
2409
2410 /* ---------------------------------------------------------------------------------------------------- */
2411
2412 typedef struct
2413 {
2414   gchar *rule;
2415   gchar *sender;
2416   gchar *interface_name;
2417   gchar *member;
2418   gchar *object_path;
2419   gchar *arg0;
2420   GArray *subscribers;
2421 } SignalData;
2422
2423 typedef struct
2424 {
2425   GDBusSignalCallback callback;
2426   gpointer user_data;
2427   GDestroyNotify user_data_free_func;
2428   guint id;
2429   GMainContext *context;
2430 } SignalSubscriber;
2431
2432 static void
2433 signal_data_free (SignalData *data)
2434 {
2435   g_free (data->rule);
2436   g_free (data->sender);
2437   g_free (data->interface_name);
2438   g_free (data->member);
2439   g_free (data->object_path);
2440   g_free (data->arg0);
2441   g_array_free (data->subscribers, TRUE);
2442   g_free (data);
2443 }
2444
2445 static gchar *
2446 args_to_rule (const gchar *sender,
2447               const gchar *interface_name,
2448               const gchar *member,
2449               const gchar *object_path,
2450               const gchar *arg0)
2451 {
2452   GString *rule;
2453
2454   rule = g_string_new ("type='signal'");
2455   if (sender != NULL)
2456     g_string_append_printf (rule, ",sender='%s'", sender);
2457   if (interface_name != NULL)
2458     g_string_append_printf (rule, ",interface='%s'", interface_name);
2459   if (member != NULL)
2460     g_string_append_printf (rule, ",member='%s'", member);
2461   if (object_path != NULL)
2462     g_string_append_printf (rule, ",path='%s'", object_path);
2463   if (arg0 != NULL)
2464     g_string_append_printf (rule, ",arg0='%s'", arg0);
2465
2466   return g_string_free (rule, FALSE);
2467 }
2468
2469 static guint _global_subscriber_id = 1;
2470 static guint _global_registration_id = 1;
2471 static guint _global_subtree_registration_id = 1;
2472
2473 /* ---------------------------------------------------------------------------------------------------- */
2474
2475 /* must hold lock when calling */
2476 static void
2477 add_match_rule (GDBusConnection *connection,
2478                 const gchar     *match_rule)
2479 {
2480   GError *error;
2481   GDBusMessage *message;
2482
2483   message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
2484                                             "/org/freedesktop/DBus", /* path */
2485                                             "org.freedesktop.DBus", /* interface */
2486                                             "AddMatch");
2487   g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
2488
2489   error = NULL;
2490   if (!g_dbus_connection_send_message_unlocked (connection,
2491                                                 message,
2492                                                 NULL,
2493                                                 &error))
2494     {
2495       g_critical ("Error while sending AddMatch() message: %s", error->message);
2496       g_error_free (error);
2497     }
2498   g_object_unref (message);
2499 }
2500
2501 /* ---------------------------------------------------------------------------------------------------- */
2502
2503 /* must hold lock when calling */
2504 static void
2505 remove_match_rule (GDBusConnection *connection,
2506                    const gchar     *match_rule)
2507 {
2508   GError *error;
2509   GDBusMessage *message;
2510
2511   message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
2512                                             "/org/freedesktop/DBus", /* path */
2513                                             "org.freedesktop.DBus", /* interface */
2514                                             "RemoveMatch");
2515   g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
2516
2517   error = NULL;
2518   if (!g_dbus_connection_send_message_unlocked (connection,
2519                                                 message,
2520                                                 NULL,
2521                                                 &error))
2522     {
2523       g_critical ("Error while sending RemoveMatch() message: %s", error->message);
2524       g_error_free (error);
2525     }
2526   g_object_unref (message);
2527 }
2528
2529 /* ---------------------------------------------------------------------------------------------------- */
2530
2531 static gboolean
2532 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
2533 {
2534   return g_strcmp0 (signal_data->sender, "org.freedesktop.DBus") == 0 &&
2535          g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
2536          g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
2537          (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
2538           g_strcmp0 (signal_data->member, "NameAcquired") == 0);
2539 }
2540
2541 /* ---------------------------------------------------------------------------------------------------- */
2542
2543 /**
2544  * g_dbus_connection_signal_subscribe:
2545  * @connection: A #GDBusConnection.
2546  * @sender: Sender name to match on. Must be either <literal>org.freedesktop.DBus</literal> (for listening to signals from the message bus daemon) or a unique name or %NULL to listen from all senders.
2547  * @interface_name: D-Bus interface name to match on or %NULL to match on all interfaces.
2548  * @member: D-Bus signal name to match on or %NULL to match on all signals.
2549  * @object_path: Object path to match on or %NULL to match on all object paths.
2550  * @arg0: Contents of first string argument to match on or %NULL to match on all kinds of arguments.
2551  * @callback: Callback to invoke when there is a signal matching the requested data.
2552  * @user_data: User data to pass to @callback.
2553  * @user_data_free_func: Function to free @user_data with when subscription is removed or %NULL.
2554  *
2555  * Subscribes to signals on @connection and invokes @callback with a
2556  * whenever the signal is received. Note that @callback
2557  * will be invoked in the <link
2558  * linkend="g-main-context-push-thread-default">thread-default main
2559  * loop</link> of the thread you are calling this method from.
2560  *
2561  * It is considered a programming error to use this function if @connection is closed.
2562  *
2563  * Note that if @sender is not <literal>org.freedesktop.DBus</literal> (for listening to signals from the
2564  * message bus daemon), then it needs to be a unique bus name or %NULL (for listening to signals from any
2565  * name) - you cannot pass a name like <literal>com.example.MyApp</literal>.
2566  * Use e.g. g_bus_watch_name() to find the unique name for the owner of the name you are interested in. Also note
2567  * that this function does not remove a subscription if @sender vanishes from the bus. You have to manually
2568  * call g_dbus_connection_signal_unsubscribe() to remove a subscription.
2569  *
2570  * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
2571  *
2572  * Since: 2.26
2573  */
2574 guint
2575 g_dbus_connection_signal_subscribe (GDBusConnection     *connection,
2576                                     const gchar         *sender,
2577                                     const gchar         *interface_name,
2578                                     const gchar         *member,
2579                                     const gchar         *object_path,
2580                                     const gchar         *arg0,
2581                                     GDBusSignalCallback  callback,
2582                                     gpointer             user_data,
2583                                     GDestroyNotify       user_data_free_func)
2584 {
2585   gchar *rule;
2586   SignalData *signal_data;
2587   SignalSubscriber subscriber;
2588   GPtrArray *signal_data_array;
2589
2590   /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
2591    * an OOM condition. We might want to change that but that would involve making
2592    * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
2593    * handle that. And there's really no sensible way of handling this short of retrying
2594    * to add the match rule... and then there's the little thing that, hey, maybe there's
2595    * a reason the bus in an OOM condition.
2596    *
2597    * Doable, but not really sure it's worth it...
2598    */
2599
2600   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2601   g_return_val_if_fail (!g_dbus_connection_is_closed (connection), 0);
2602   g_return_val_if_fail (sender == NULL || ((strcmp (sender, "org.freedesktop.DBus") == 0 || sender[0] == ':') &&
2603                                            (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
2604   g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
2605   g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
2606   g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
2607   g_return_val_if_fail (callback != NULL, 0);
2608
2609   CONNECTION_LOCK (connection);
2610
2611   rule = args_to_rule (sender, interface_name, member, object_path, arg0);
2612
2613   if (sender == NULL)
2614     sender = "";
2615
2616   subscriber.callback = callback;
2617   subscriber.user_data = user_data;
2618   subscriber.user_data_free_func = user_data_free_func;
2619   subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
2620   subscriber.context = g_main_context_get_thread_default ();
2621   if (subscriber.context != NULL)
2622     g_main_context_ref (subscriber.context);
2623
2624   /* see if we've already have this rule */
2625   signal_data = g_hash_table_lookup (connection->priv->map_rule_to_signal_data, rule);
2626   if (signal_data != NULL)
2627     {
2628       g_array_append_val (signal_data->subscribers, subscriber);
2629       g_free (rule);
2630       goto out;
2631     }
2632
2633   signal_data = g_new0 (SignalData, 1);
2634   signal_data->rule           = rule;
2635   signal_data->sender         = g_strdup (sender);
2636   signal_data->interface_name = g_strdup (interface_name);
2637   signal_data->member         = g_strdup (member);
2638   signal_data->object_path    = g_strdup (object_path);
2639   signal_data->arg0           = g_strdup (arg0);
2640   signal_data->subscribers    = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
2641   g_array_append_val (signal_data->subscribers, subscriber);
2642
2643   g_hash_table_insert (connection->priv->map_rule_to_signal_data,
2644                        signal_data->rule,
2645                        signal_data);
2646
2647   /* Add the match rule to the bus...
2648    *
2649    * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
2650    * always send such messages to us.
2651    */
2652   if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2653     {
2654       if (!is_signal_data_for_name_lost_or_acquired (signal_data))
2655         add_match_rule (connection, signal_data->rule);
2656     }
2657
2658  out:
2659   g_hash_table_insert (connection->priv->map_id_to_signal_data,
2660                        GUINT_TO_POINTER (subscriber.id),
2661                        signal_data);
2662
2663   signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array,
2664                                            signal_data->sender);
2665   if (signal_data_array == NULL)
2666     {
2667       signal_data_array = g_ptr_array_new ();
2668       g_hash_table_insert (connection->priv->map_sender_to_signal_data_array,
2669                            g_strdup (signal_data->sender),
2670                            signal_data_array);
2671     }
2672   g_ptr_array_add (signal_data_array, signal_data);
2673
2674   CONNECTION_UNLOCK (connection);
2675
2676   return subscriber.id;
2677 }
2678
2679 /* ---------------------------------------------------------------------------------------------------- */
2680
2681 /* must hold lock when calling this */
2682 static void
2683 unsubscribe_id_internal (GDBusConnection *connection,
2684                          guint            subscription_id,
2685                          GArray          *out_removed_subscribers)
2686 {
2687   SignalData *signal_data;
2688   GPtrArray *signal_data_array;
2689   guint n;
2690
2691   signal_data = g_hash_table_lookup (connection->priv->map_id_to_signal_data,
2692                                      GUINT_TO_POINTER (subscription_id));
2693   if (signal_data == NULL)
2694     {
2695       /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
2696       goto out;
2697     }
2698
2699   for (n = 0; n < signal_data->subscribers->len; n++)
2700     {
2701       SignalSubscriber *subscriber;
2702
2703       subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
2704       if (subscriber->id != subscription_id)
2705         continue;
2706
2707       g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_signal_data,
2708                                            GUINT_TO_POINTER (subscription_id)));
2709       g_array_append_val (out_removed_subscribers, *subscriber);
2710       g_array_remove_index (signal_data->subscribers, n);
2711
2712       if (signal_data->subscribers->len == 0)
2713         g_warn_if_fail (g_hash_table_remove (connection->priv->map_rule_to_signal_data, signal_data->rule));
2714
2715       signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array,
2716                                                signal_data->sender);
2717       g_warn_if_fail (signal_data_array != NULL);
2718       g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
2719
2720       if (signal_data_array->len == 0)
2721         {
2722           g_warn_if_fail (g_hash_table_remove (connection->priv->map_sender_to_signal_data_array, signal_data->sender));
2723
2724           /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
2725           if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2726             {
2727               if (!is_signal_data_for_name_lost_or_acquired (signal_data))
2728                 remove_match_rule (connection, signal_data->rule);
2729             }
2730
2731           signal_data_free (signal_data);
2732         }
2733
2734       goto out;
2735     }
2736
2737   g_assert_not_reached ();
2738
2739  out:
2740   ;
2741 }
2742
2743 /**
2744  * g_dbus_connection_signal_unsubscribe:
2745  * @connection: A #GDBusConnection.
2746  * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
2747  *
2748  * Unsubscribes from signals.
2749  *
2750  * Since: 2.26
2751  */
2752 void
2753 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
2754                                       guint            subscription_id)
2755 {
2756   GArray *subscribers;
2757   guint n;
2758
2759   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2760
2761   subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
2762
2763   CONNECTION_LOCK (connection);
2764   unsubscribe_id_internal (connection,
2765                            subscription_id,
2766                            subscribers);
2767   CONNECTION_UNLOCK (connection);
2768
2769   /* invariant */
2770   g_assert (subscribers->len == 0 || subscribers->len == 1);
2771
2772   /* call GDestroyNotify without lock held */
2773   for (n = 0; n < subscribers->len; n++)
2774     {
2775       SignalSubscriber *subscriber;
2776       subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
2777       if (subscriber->user_data_free_func != NULL)
2778         subscriber->user_data_free_func (subscriber->user_data);
2779       if (subscriber->context != NULL)
2780         g_main_context_unref (subscriber->context);
2781     }
2782
2783   g_array_free (subscribers, TRUE);
2784 }
2785
2786 /* ---------------------------------------------------------------------------------------------------- */
2787
2788 typedef struct
2789 {
2790   guint                subscription_id;
2791   GDBusSignalCallback  callback;
2792   gpointer             user_data;
2793   GDBusMessage        *message;
2794   GDBusConnection     *connection;
2795   const gchar         *sender;
2796   const gchar         *path;
2797   const gchar         *interface;
2798   const gchar         *member;
2799 } SignalInstance;
2800
2801 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
2802  * no locks held
2803  */
2804 static gboolean
2805 emit_signal_instance_in_idle_cb (gpointer data)
2806 {
2807   SignalInstance *signal_instance = data;
2808   GVariant *parameters;
2809   gboolean has_subscription;
2810
2811   parameters = g_dbus_message_get_body (signal_instance->message);
2812   if (parameters == NULL)
2813     {
2814       parameters = g_variant_new ("()");
2815       g_variant_ref_sink (parameters);
2816     }
2817   else
2818     {
2819       g_variant_ref_sink (parameters);
2820     }
2821
2822 #if 0
2823   g_debug ("in emit_signal_instance_in_idle_cb (sender=%s path=%s interface=%s member=%s params=%s)",
2824            signal_instance->sender,
2825            signal_instance->path,
2826            signal_instance->interface,
2827            signal_instance->member,
2828            g_variant_print (parameters, TRUE));
2829 #endif
2830
2831   /* Careful here, don't do the callback if we no longer has the subscription */
2832   CONNECTION_LOCK (signal_instance->connection);
2833   has_subscription = FALSE;
2834   if (g_hash_table_lookup (signal_instance->connection->priv->map_id_to_signal_data,
2835                            GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
2836     has_subscription = TRUE;
2837   CONNECTION_UNLOCK (signal_instance->connection);
2838
2839   if (has_subscription)
2840     signal_instance->callback (signal_instance->connection,
2841                                signal_instance->sender,
2842                                signal_instance->path,
2843                                signal_instance->interface,
2844                                signal_instance->member,
2845                                parameters,
2846                                signal_instance->user_data);
2847
2848   if (parameters != NULL)
2849     g_variant_unref (parameters);
2850
2851   return FALSE;
2852 }
2853
2854 static void
2855 signal_instance_free (SignalInstance *signal_instance)
2856 {
2857   g_object_unref (signal_instance->message);
2858   g_object_unref (signal_instance->connection);
2859   g_free (signal_instance);
2860 }
2861
2862 /* called in message handler thread WITH lock held */
2863 static void
2864 schedule_callbacks (GDBusConnection *connection,
2865                     GPtrArray       *signal_data_array,
2866                     GDBusMessage    *message,
2867                     const gchar     *sender)
2868 {
2869   guint n, m;
2870   const gchar *interface;
2871   const gchar *member;
2872   const gchar *path;
2873   const gchar *arg0;
2874
2875   interface = NULL;
2876   member = NULL;
2877   path = NULL;
2878   arg0 = NULL;
2879
2880   interface = g_dbus_message_get_interface (message);
2881   member = g_dbus_message_get_member (message);
2882   path = g_dbus_message_get_path (message);
2883   arg0 = g_dbus_message_get_arg0 (message);
2884
2885 #if 0
2886   g_debug ("sender    = `%s'", sender);
2887   g_debug ("interface = `%s'", interface);
2888   g_debug ("member    = `%s'", member);
2889   g_debug ("path      = `%s'", path);
2890   g_debug ("arg0      = `%s'", arg0);
2891 #endif
2892
2893   /* TODO: if this is slow, then we can change signal_data_array into
2894    *       map_object_path_to_signal_data_array or something.
2895    */
2896   for (n = 0; n < signal_data_array->len; n++)
2897     {
2898       SignalData *signal_data = signal_data_array->pdata[n];
2899
2900       if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
2901         continue;
2902
2903       if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
2904         continue;
2905
2906       if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
2907         continue;
2908
2909       if (signal_data->arg0 != NULL && g_strcmp0 (signal_data->arg0, arg0) != 0)
2910         continue;
2911
2912       for (m = 0; m < signal_data->subscribers->len; m++)
2913         {
2914           SignalSubscriber *subscriber;
2915           GSource *idle_source;
2916           SignalInstance *signal_instance;
2917
2918           subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
2919
2920           signal_instance = g_new0 (SignalInstance, 1);
2921           signal_instance->subscription_id = subscriber->id;
2922           signal_instance->callback = subscriber->callback;
2923           signal_instance->user_data = subscriber->user_data;
2924           signal_instance->message = g_object_ref (message);
2925           signal_instance->connection = g_object_ref (connection);
2926           signal_instance->sender = sender;
2927           signal_instance->path = path;
2928           signal_instance->interface = interface;
2929           signal_instance->member = member;
2930
2931           idle_source = g_idle_source_new ();
2932           g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
2933           g_source_set_callback (idle_source,
2934                                  emit_signal_instance_in_idle_cb,
2935                                  signal_instance,
2936                                  (GDestroyNotify) signal_instance_free);
2937           g_source_attach (idle_source, subscriber->context);
2938           g_source_unref (idle_source);
2939         }
2940     }
2941 }
2942
2943 /* called in message handler thread with lock held */
2944 static void
2945 distribute_signals (GDBusConnection *connection,
2946                     GDBusMessage    *message)
2947 {
2948   GPtrArray *signal_data_array;
2949   const gchar *sender;
2950
2951   sender = g_dbus_message_get_sender (message);
2952
2953   /* collect subscribers that match on sender */
2954   if (sender != NULL)
2955     {
2956       signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array, sender);
2957       if (signal_data_array != NULL)
2958         schedule_callbacks (connection, signal_data_array, message, sender);
2959     }
2960
2961   /* collect subscribers not matching on sender */
2962   signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array, "");
2963   if (signal_data_array != NULL)
2964     schedule_callbacks (connection, signal_data_array, message, sender);
2965 }
2966
2967 /* ---------------------------------------------------------------------------------------------------- */
2968
2969 /* only called from finalize(), removes all subscriptions */
2970 static void
2971 purge_all_signal_subscriptions (GDBusConnection *connection)
2972 {
2973   GHashTableIter iter;
2974   gpointer key;
2975   GArray *ids;
2976   GArray *subscribers;
2977   guint n;
2978
2979   ids = g_array_new (FALSE, FALSE, sizeof (guint));
2980   g_hash_table_iter_init (&iter, connection->priv->map_id_to_signal_data);
2981   while (g_hash_table_iter_next (&iter, &key, NULL))
2982     {
2983       guint subscription_id = GPOINTER_TO_UINT (key);
2984       g_array_append_val (ids, subscription_id);
2985     }
2986
2987   subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
2988   for (n = 0; n < ids->len; n++)
2989     {
2990       guint subscription_id = g_array_index (ids, guint, n);
2991       unsubscribe_id_internal (connection,
2992                                subscription_id,
2993                                subscribers);
2994     }
2995   g_array_free (ids, TRUE);
2996
2997   /* call GDestroyNotify without lock held */
2998   for (n = 0; n < subscribers->len; n++)
2999     {
3000       SignalSubscriber *subscriber;
3001       subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3002       if (subscriber->user_data_free_func != NULL)
3003         subscriber->user_data_free_func (subscriber->user_data);
3004       if (subscriber->context != NULL)
3005         g_main_context_unref (subscriber->context);
3006     }
3007
3008   g_array_free (subscribers, TRUE);
3009 }
3010
3011 /* ---------------------------------------------------------------------------------------------------- */
3012
3013 struct ExportedObject
3014 {
3015   gchar *object_path;
3016   GDBusConnection *connection;
3017
3018   /* maps gchar* -> ExportedInterface* */
3019   GHashTable *map_if_name_to_ei;
3020 };
3021
3022 /* only called with lock held */
3023 static void
3024 exported_object_free (ExportedObject *eo)
3025 {
3026   g_free (eo->object_path);
3027   g_hash_table_unref (eo->map_if_name_to_ei);
3028   g_free (eo);
3029 }
3030
3031 typedef struct
3032 {
3033   ExportedObject *eo;
3034
3035   guint                       id;
3036   gchar                      *interface_name;
3037   const GDBusInterfaceVTable *vtable;
3038   const GDBusInterfaceInfo   *introspection_data;
3039
3040   GMainContext               *context;
3041   gpointer                    user_data;
3042   GDestroyNotify              user_data_free_func;
3043 } ExportedInterface;
3044
3045 /* called with lock held */
3046 static void
3047 exported_interface_free (ExportedInterface *ei)
3048 {
3049   if (ei->user_data_free_func != NULL)
3050     /* TODO: push to thread-default mainloop */
3051     ei->user_data_free_func (ei->user_data);
3052
3053   if (ei->context != NULL)
3054     g_main_context_unref (ei->context);
3055
3056   g_free (ei->interface_name);
3057   g_free (ei);
3058 }
3059
3060 /* ---------------------------------------------------------------------------------------------------- */
3061
3062 typedef struct
3063 {
3064   GDBusConnection *connection;
3065   GDBusMessage *message;
3066   gpointer user_data;
3067   const char *property_name;
3068   const GDBusInterfaceVTable *vtable;
3069   const GDBusInterfaceInfo *interface_info;
3070   const GDBusPropertyInfo *property_info;
3071 } PropertyData;
3072
3073 static void
3074 property_data_free (PropertyData *data)
3075 {
3076   g_object_unref (data->connection);
3077   g_object_unref (data->message);
3078   g_free (data);
3079 }
3080
3081 /* called in thread where object was registered - no locks held */
3082 static gboolean
3083 invoke_get_property_in_idle_cb (gpointer _data)
3084 {
3085   PropertyData *data = _data;
3086   GVariant *value;
3087   GError *error;
3088   GDBusMessage *reply;
3089
3090   error = NULL;
3091   value = data->vtable->get_property (data->connection,
3092                                       g_dbus_message_get_sender (data->message),
3093                                       g_dbus_message_get_path (data->message),
3094                                       data->interface_info->name,
3095                                       data->property_name,
3096                                       &error,
3097                                       data->user_data);
3098
3099
3100   if (value != NULL)
3101     {
3102       g_assert_no_error (error);
3103
3104       g_variant_ref_sink (value);
3105       reply = g_dbus_message_new_method_reply (data->message);
3106       g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
3107       g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3108       g_variant_unref (value);
3109       g_object_unref (reply);
3110     }
3111   else
3112     {
3113       gchar *dbus_error_name;
3114
3115       g_assert (error != NULL);
3116
3117       dbus_error_name = g_dbus_error_encode_gerror (error);
3118       reply = g_dbus_message_new_method_error_literal (data->message,
3119                                                        dbus_error_name,
3120                                                        error->message);
3121       g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3122       g_free (dbus_error_name);
3123       g_error_free (error);
3124       g_object_unref (reply);
3125     }
3126
3127   return FALSE;
3128 }
3129
3130 /* called in thread where object was registered - no locks held */
3131 static gboolean
3132 invoke_set_property_in_idle_cb (gpointer _data)
3133 {
3134   PropertyData *data = _data;
3135   GError *error;
3136   GDBusMessage *reply;
3137   GVariant *value;
3138
3139   error = NULL;
3140   value = NULL;
3141
3142   g_variant_get (g_dbus_message_get_body (data->message),
3143                  "(ssv)",
3144                  NULL,
3145                  NULL,
3146                  &value);
3147
3148   /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
3149    * of the given value is wrong
3150    */
3151   if (g_strcmp0 (g_variant_get_type_string (value), data->property_info->signature) != 0)
3152     {
3153       reply = g_dbus_message_new_method_error (data->message,
3154                                                "org.freedesktop.DBus.Error.InvalidArgs",
3155                                                _("Error setting property `%s': Expected type `%s' but got `%s'"),
3156                                                data->property_info->name,
3157                                                data->property_info->signature,
3158                                                g_variant_get_type_string (value));
3159       goto out;
3160     }
3161
3162   if (!data->vtable->set_property (data->connection,
3163                                    g_dbus_message_get_sender (data->message),
3164                                    g_dbus_message_get_path (data->message),
3165                                    data->interface_info->name,
3166                                    data->property_name,
3167                                    value,
3168                                    &error,
3169                                    data->user_data))
3170     {
3171       gchar *dbus_error_name;
3172       g_assert (error != NULL);
3173       dbus_error_name = g_dbus_error_encode_gerror (error);
3174       reply = g_dbus_message_new_method_error_literal (data->message,
3175                                                        dbus_error_name,
3176                                                        error->message);
3177       g_free (dbus_error_name);
3178       g_error_free (error);
3179     }
3180   else
3181     {
3182       reply = g_dbus_message_new_method_reply (data->message);
3183     }
3184
3185  out:
3186   g_assert (reply != NULL);
3187   g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3188   g_object_unref (reply);
3189
3190   return FALSE;
3191 }
3192
3193 /* called with lock held */
3194 static gboolean
3195 validate_and_maybe_schedule_property_getset (GDBusConnection            *connection,
3196                                              GDBusMessage               *message,
3197                                              gboolean                    is_get,
3198                                              const GDBusInterfaceInfo   *introspection_data,
3199                                              const GDBusInterfaceVTable *vtable,
3200                                              GMainContext               *main_context,
3201                                              gpointer                    user_data)
3202 {
3203   gboolean handled;
3204   const char *interface_name;
3205   const char *property_name;
3206   const GDBusPropertyInfo *property_info;
3207   GSource *idle_source;
3208   PropertyData *property_data;
3209   GDBusMessage *reply;
3210
3211   handled = FALSE;
3212
3213   if (is_get)
3214     g_variant_get (g_dbus_message_get_body (message),
3215                    "(&s&s)",
3216                    &interface_name,
3217                    &property_name);
3218   else
3219     g_variant_get (g_dbus_message_get_body (message),
3220                    "(&s&sv)",
3221                    &interface_name,
3222                    &property_name,
3223                    NULL);
3224
3225
3226   if (is_get)
3227     {
3228       if (vtable == NULL || vtable->get_property == NULL)
3229         goto out;
3230     }
3231   else
3232     {
3233       if (vtable == NULL || vtable->set_property == NULL)
3234         goto out;
3235     }
3236
3237   /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
3238    */
3239   property_info = NULL;
3240
3241   /* TODO: the cost of this is O(n) - it might be worth caching the result */
3242   property_info = g_dbus_interface_info_lookup_property (introspection_data, property_name);
3243   if (property_info == NULL)
3244     {
3245       reply = g_dbus_message_new_method_error (message,
3246                                                "org.freedesktop.DBus.Error.InvalidArgs",
3247                                                _("No such property `%s'"),
3248                                                property_name);
3249       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3250       g_object_unref (reply);
3251       handled = TRUE;
3252       goto out;
3253     }
3254
3255   if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
3256     {
3257       reply = g_dbus_message_new_method_error (message,
3258                                                "org.freedesktop.DBus.Error.InvalidArgs",
3259                                                _("Property `%s' is not readable"),
3260                                                property_name);
3261       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3262       g_object_unref (reply);
3263       handled = TRUE;
3264       goto out;
3265     }
3266   else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
3267     {
3268       reply = g_dbus_message_new_method_error (message,
3269                                                "org.freedesktop.DBus.Error.InvalidArgs",
3270                                                _("Property `%s' is not writable"),
3271                                                property_name);
3272       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3273       g_object_unref (reply);
3274       handled = TRUE;
3275       goto out;
3276     }
3277
3278   /* ok, got the property info - call user code in an idle handler */
3279   property_data = g_new0 (PropertyData, 1);
3280   property_data->connection = g_object_ref (connection);
3281   property_data->message = g_object_ref (message);
3282   property_data->user_data = user_data;
3283   property_data->property_name = property_name;
3284   property_data->vtable = vtable;
3285   property_data->interface_info = introspection_data;
3286   property_data->property_info = property_info;
3287
3288   idle_source = g_idle_source_new ();
3289   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3290   g_source_set_callback (idle_source,
3291                          is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
3292                          property_data,
3293                          (GDestroyNotify) property_data_free);
3294   g_source_attach (idle_source, main_context);
3295   g_source_unref (idle_source);
3296
3297   handled = TRUE;
3298
3299  out:
3300   return handled;
3301 }
3302
3303 /* called with lock held */
3304 static gboolean
3305 handle_getset_property (GDBusConnection *connection,
3306                         ExportedObject  *eo,
3307                         GDBusMessage    *message,
3308                         gboolean         is_get)
3309 {
3310   ExportedInterface *ei;
3311   gboolean handled;
3312   const char *interface_name;
3313   const char *property_name;
3314
3315   handled = FALSE;
3316
3317   if (is_get)
3318     g_variant_get (g_dbus_message_get_body (message),
3319                    "(&s&s)",
3320                    &interface_name,
3321                    &property_name);
3322   else
3323     g_variant_get (g_dbus_message_get_body (message),
3324                    "(&s&sv)",
3325                    &interface_name,
3326                    &property_name,
3327                    NULL);
3328
3329   /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
3330    * no such interface registered
3331    */
3332   ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3333   if (ei == NULL)
3334     {
3335       GDBusMessage *reply;
3336       reply = g_dbus_message_new_method_error (message,
3337                                                "org.freedesktop.DBus.Error.InvalidArgs",
3338                                                _("No such interface `%s'"),
3339                                                interface_name);
3340       g_dbus_connection_send_message_unlocked (eo->connection, reply, NULL, NULL);
3341       g_object_unref (reply);
3342       handled = TRUE;
3343       goto out;
3344     }
3345
3346   handled = validate_and_maybe_schedule_property_getset (eo->connection,
3347                                                          message,
3348                                                          is_get,
3349                                                          ei->introspection_data,
3350                                                          ei->vtable,
3351                                                          ei->context,
3352                                                          ei->user_data);
3353  out:
3354   return handled;
3355 }
3356
3357 /* ---------------------------------------------------------------------------------------------------- */
3358
3359 typedef struct
3360 {
3361   GDBusConnection *connection;
3362   GDBusMessage *message;
3363   gpointer user_data;
3364   const GDBusInterfaceVTable *vtable;
3365   const GDBusInterfaceInfo *interface_info;
3366 } PropertyGetAllData;
3367
3368 static void
3369 property_get_all_data_free (PropertyData *data)
3370 {
3371   g_object_unref (data->connection);
3372   g_object_unref (data->message);
3373   g_free (data);
3374 }
3375
3376 /* called in thread where object was registered - no locks held */
3377 static gboolean
3378 invoke_get_all_properties_in_idle_cb (gpointer _data)
3379 {
3380   PropertyGetAllData *data = _data;
3381   GVariantBuilder *builder;
3382   GVariant *packed;
3383   GVariant *result;
3384   GError *error;
3385   GDBusMessage *reply;
3386   guint n;
3387
3388   error = NULL;
3389
3390   /* TODO: Right now we never fail this call - we just omit values if
3391    *       a get_property() call is failing.
3392    *
3393    *       We could fail the whole call if just a single get_property() call
3394    *       returns an error. We need clarification in the D-Bus spec about this.
3395    */
3396   builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
3397   for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
3398     {
3399       const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
3400       GVariant *value;
3401
3402       if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
3403         continue;
3404
3405       value = data->vtable->get_property (data->connection,
3406                                           g_dbus_message_get_sender (data->message),
3407                                           g_dbus_message_get_path (data->message),
3408                                           data->interface_info->name,
3409                                           property_info->name,
3410                                           NULL,
3411                                           data->user_data);
3412
3413       if (value == NULL)
3414         continue;
3415
3416       g_variant_ref_sink (value);
3417       g_variant_builder_add (builder,
3418                              "{sv}",
3419                              property_info->name,
3420                              value);
3421       g_variant_unref (value);
3422     }
3423   result = g_variant_builder_end (builder);
3424
3425   builder = g_variant_builder_new (G_VARIANT_TYPE_TUPLE);
3426   g_variant_builder_add_value (builder, result); /* steals result since result is floating */
3427   packed = g_variant_builder_end (builder);
3428
3429   reply = g_dbus_message_new_method_reply (data->message);
3430   g_dbus_message_set_body (reply, packed);
3431   g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3432   g_object_unref (reply);
3433
3434   return FALSE;
3435 }
3436
3437 /* called with lock held */
3438 static gboolean
3439 validate_and_maybe_schedule_property_get_all (GDBusConnection            *connection,
3440                                               GDBusMessage               *message,
3441                                               const GDBusInterfaceInfo   *introspection_data,
3442                                               const GDBusInterfaceVTable *vtable,
3443                                               GMainContext               *main_context,
3444                                               gpointer                    user_data)
3445 {
3446   gboolean handled;
3447   const char *interface_name;
3448   GSource *idle_source;
3449   PropertyGetAllData *property_get_all_data;
3450
3451   handled = FALSE;
3452
3453   g_variant_get (g_dbus_message_get_body (message),
3454                  "(&s)",
3455                  &interface_name);
3456
3457   if (vtable == NULL || vtable->get_property == NULL)
3458     goto out;
3459
3460   /* ok, got the property info - call user in an idle handler */
3461   property_get_all_data = g_new0 (PropertyGetAllData, 1);
3462   property_get_all_data->connection = g_object_ref (connection);
3463   property_get_all_data->message = g_object_ref (message);
3464   property_get_all_data->user_data = user_data;
3465   property_get_all_data->vtable = vtable;
3466   property_get_all_data->interface_info = introspection_data;
3467
3468   idle_source = g_idle_source_new ();
3469   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3470   g_source_set_callback (idle_source,
3471                          invoke_get_all_properties_in_idle_cb,
3472                          property_get_all_data,
3473                          (GDestroyNotify) property_get_all_data_free);
3474   g_source_attach (idle_source, main_context);
3475   g_source_unref (idle_source);
3476
3477   handled = TRUE;
3478
3479  out:
3480   return handled;
3481 }
3482
3483 /* called with lock held */
3484 static gboolean
3485 handle_get_all_properties (GDBusConnection *connection,
3486                            ExportedObject  *eo,
3487                            GDBusMessage    *message)
3488 {
3489   ExportedInterface *ei;
3490   gboolean handled;
3491   const char *interface_name;
3492
3493   handled = FALSE;
3494
3495   g_variant_get (g_dbus_message_get_body (message),
3496                  "(&s)",
3497                  &interface_name);
3498
3499   /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
3500    * no such interface registered
3501    */
3502   ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3503   if (ei == NULL)
3504     {
3505       GDBusMessage *reply;
3506       reply = g_dbus_message_new_method_error (message,
3507                                                "org.freedesktop.DBus.Error.InvalidArgs",
3508                                                _("No such interface"),
3509                                                interface_name);
3510       g_dbus_connection_send_message_unlocked (eo->connection, reply, NULL, NULL);
3511       g_object_unref (reply);
3512       handled = TRUE;
3513       goto out;
3514     }
3515
3516   handled = validate_and_maybe_schedule_property_get_all (eo->connection,
3517                                                           message,
3518                                                           ei->introspection_data,
3519                                                           ei->vtable,
3520                                                           ei->context,
3521                                                           ei->user_data);
3522  out:
3523   return handled;
3524 }
3525
3526 /* ---------------------------------------------------------------------------------------------------- */
3527
3528 static const gchar introspect_header[] =
3529   "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
3530   "                      \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
3531   "<!-- GDBus " PACKAGE_VERSION " -->\n"
3532   "<node>\n";
3533
3534 static const gchar introspect_tail[] =
3535   "</node>\n";
3536
3537 static const gchar introspect_standard_interfaces[] =
3538   "  <interface name=\"org.freedesktop.DBus.Properties\">\n"
3539   "    <method name=\"Get\">\n"
3540   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3541   "      <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
3542   "      <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
3543   "    </method>\n"
3544   "    <method name=\"GetAll\">\n"
3545   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3546   "      <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
3547   "    </method>\n"
3548   "    <method name=\"Set\">\n"
3549   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3550   "      <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
3551   "      <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
3552   "    </method>\n"
3553   "    <signal name=\"PropertiesChanged\">\n"
3554   "      <arg type=\"s\" name=\"interface_name\"/>\n"
3555   "      <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
3556   "      <arg type=\"as\" name=\"invalidated_properties\"/>\n"
3557   "    </signal>\n"
3558   "  </interface>\n"
3559   "  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
3560   "    <method name=\"Introspect\">\n"
3561   "      <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
3562   "    </method>\n"
3563   "  </interface>\n"
3564   "  <interface name=\"org.freedesktop.DBus.Peer\">\n"
3565   "    <method name=\"Ping\"/>\n"
3566   "    <method name=\"GetMachineId\">\n"
3567   "      <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
3568   "    </method>\n"
3569   "  </interface>\n";
3570
3571 static void
3572 introspect_append_header (GString *s)
3573 {
3574   g_string_append (s, introspect_header);
3575 }
3576
3577 static void
3578 introspect_append_standard_interfaces (GString *s)
3579 {
3580   g_string_append (s, introspect_standard_interfaces);
3581 }
3582
3583 static void
3584 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
3585 {
3586   if (g_str_has_prefix (object_path, path) && strlen (object_path) >= path_len)
3587     {
3588       const gchar *begin;
3589       const gchar *end;
3590       gchar *s;
3591
3592       begin = object_path + path_len;
3593       end = strchr (begin, '/');
3594
3595       if (end != NULL)
3596         s = g_strndup (begin, end - begin);
3597       else
3598         s = g_strdup (begin);
3599
3600       if (g_hash_table_lookup (set, s) == NULL)
3601         g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
3602       else
3603         g_free (s);
3604     }
3605 }
3606
3607 /* TODO: we want a nicer public interface for this */
3608 static gchar **
3609 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
3610                                             const gchar     *path)
3611 {
3612   GPtrArray *p;
3613   gchar **ret;
3614   GHashTableIter hash_iter;
3615   const gchar *object_path;
3616   gsize path_len;
3617   GHashTable *set;
3618   GList *keys;
3619   GList *l;
3620
3621   CONNECTION_ENSURE_LOCK (connection);
3622
3623   path_len = strlen (path);
3624   if (path_len > 1)
3625     path_len++;
3626
3627   set = g_hash_table_new (g_str_hash, g_str_equal);
3628
3629   g_hash_table_iter_init (&hash_iter, connection->priv->map_object_path_to_eo);
3630   while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
3631     maybe_add_path (path, path_len, object_path, set);
3632
3633   g_hash_table_iter_init (&hash_iter, connection->priv->map_object_path_to_es);
3634   while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
3635     maybe_add_path (path, path_len, object_path, set);
3636
3637   p = g_ptr_array_new ();
3638   keys = g_hash_table_get_keys (set);
3639   for (l = keys; l != NULL; l = l->next)
3640     g_ptr_array_add (p, l->data);
3641   g_hash_table_unref (set);
3642   g_list_free (keys);
3643
3644   g_ptr_array_add (p, NULL);
3645   ret = (gchar **) g_ptr_array_free (p, FALSE);
3646   return ret;
3647 }
3648
3649 static gchar **
3650 g_dbus_connection_list_registered (GDBusConnection *connection,
3651                                    const gchar     *path)
3652 {
3653   gchar **ret;
3654   CONNECTION_LOCK (connection);
3655   ret = g_dbus_connection_list_registered_unlocked (connection, path);
3656   CONNECTION_UNLOCK (connection);
3657   return ret;
3658 }
3659
3660 /* called in message handler thread with lock held */
3661 static gboolean
3662 handle_introspect (GDBusConnection *connection,
3663                    ExportedObject  *eo,
3664                    GDBusMessage    *message)
3665 {
3666   guint n;
3667   GString *s;
3668   GDBusMessage *reply;
3669   GHashTableIter hash_iter;
3670   ExportedInterface *ei;
3671   gchar **registered;
3672
3673   /* first the header with the standard interfaces */
3674   s = g_string_sized_new (sizeof (introspect_header) +
3675                           sizeof (introspect_standard_interfaces) +
3676                           sizeof (introspect_tail));
3677   introspect_append_header (s);
3678   introspect_append_standard_interfaces (s);
3679
3680   /* then include the registered interfaces */
3681   g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
3682   while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
3683     g_dbus_interface_info_generate_xml (ei->introspection_data, 2, s);
3684
3685   /* finally include nodes registered below us */
3686   registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
3687   for (n = 0; registered != NULL && registered[n] != NULL; n++)
3688     g_string_append_printf (s, "  <node name=\"%s\"/>\n", registered[n]);
3689   g_strfreev (registered);
3690   g_string_append (s, introspect_tail);
3691
3692   reply = g_dbus_message_new_method_reply (message);
3693   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
3694   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3695   g_object_unref (reply);
3696   g_string_free (s, TRUE);
3697
3698   return TRUE;
3699 }
3700
3701 /* called in thread where object was registered - no locks held */
3702 static gboolean
3703 call_in_idle_cb (gpointer user_data)
3704 {
3705   GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
3706   GDBusInterfaceVTable *vtable;
3707
3708   vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
3709   g_assert (vtable != NULL && vtable->method_call != NULL);
3710
3711   vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
3712                        g_dbus_method_invocation_get_sender (invocation),
3713                        g_dbus_method_invocation_get_object_path (invocation),
3714                        g_dbus_method_invocation_get_interface_name (invocation),
3715                        g_dbus_method_invocation_get_method_name (invocation),
3716                        g_dbus_method_invocation_get_parameters (invocation),
3717                        g_object_ref (invocation),
3718                        g_dbus_method_invocation_get_user_data (invocation));
3719
3720   return FALSE;
3721 }
3722
3723 /* called in message handler thread with lock held */
3724 static gboolean
3725 validate_and_maybe_schedule_method_call (GDBusConnection            *connection,
3726                                          GDBusMessage               *message,
3727                                          const GDBusInterfaceInfo   *introspection_data,
3728                                          const GDBusInterfaceVTable *vtable,
3729                                          GMainContext               *main_context,
3730                                          gpointer                    user_data)
3731 {
3732   GDBusMethodInvocation *invocation;
3733   const GDBusMethodInfo *method_info;
3734   GDBusMessage *reply;
3735   GVariant *parameters;
3736   GSource *idle_source;
3737   gboolean handled;
3738   gchar *in_signature;
3739
3740   handled = FALSE;
3741
3742   /* TODO: the cost of this is O(n) - it might be worth caching the result */
3743   method_info = g_dbus_interface_info_lookup_method (introspection_data, g_dbus_message_get_member (message));
3744
3745   /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
3746    * error to the caller
3747    */
3748   if (method_info == NULL)
3749     {
3750       reply = g_dbus_message_new_method_error (message,
3751                                                "org.freedesktop.DBus.Error.UnknownMethod",
3752                                                _("No such method `%s'"),
3753                                                g_dbus_message_get_member (message));
3754       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3755       g_object_unref (reply);
3756       handled = TRUE;
3757       goto out;
3758     }
3759
3760   /* Check that the incoming args are of the right type - if they are not, return
3761    * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
3762    *
3763    * TODO: might also be worth caching the combined signature.
3764    */
3765   in_signature = _g_dbus_compute_complete_signature (method_info->in_args, FALSE);
3766   if (g_strcmp0 (g_dbus_message_get_signature (message), in_signature) != 0)
3767     {
3768       reply = g_dbus_message_new_method_error (message,
3769                                                "org.freedesktop.DBus.Error.InvalidArgs",
3770                                                _("Signature of message, `%s', does not match expected signature `%s'"),
3771                                                g_dbus_message_get_signature (message),
3772                                                in_signature);
3773       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3774       g_object_unref (reply);
3775       g_free (in_signature);
3776       handled = TRUE;
3777       goto out;
3778     }
3779   g_free (in_signature);
3780
3781   parameters = g_dbus_message_get_body (message);
3782   if (parameters == NULL)
3783     {
3784       parameters = g_variant_new ("()");
3785       g_variant_ref_sink (parameters);
3786     }
3787   else
3788     {
3789       g_variant_ref (parameters);
3790     }
3791
3792   /* schedule the call in idle */
3793   invocation = g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
3794                                              g_dbus_message_get_path (message),
3795                                              g_dbus_message_get_interface (message),
3796                                              g_dbus_message_get_member (message),
3797                                              method_info,
3798                                              connection,
3799                                              message,
3800                                              parameters,
3801                                              user_data);
3802   g_variant_unref (parameters);
3803   g_object_set_data (G_OBJECT (invocation),
3804                      "g-dbus-interface-vtable",
3805                      (gpointer) vtable);
3806
3807   idle_source = g_idle_source_new ();
3808   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3809   g_source_set_callback (idle_source,
3810                          call_in_idle_cb,
3811                          invocation,
3812                          g_object_unref);
3813   g_source_attach (idle_source, main_context);
3814   g_source_unref (idle_source);
3815
3816   handled = TRUE;
3817
3818  out:
3819   return handled;
3820 }
3821
3822 /* ---------------------------------------------------------------------------------------------------- */
3823
3824 /* called in message handler thread with lock held */
3825 static gboolean
3826 obj_message_func (GDBusConnection *connection,
3827                   ExportedObject  *eo,
3828                   GDBusMessage    *message)
3829 {
3830   const gchar *interface_name;
3831   const gchar *member;
3832   const gchar *signature;
3833   gboolean handled;
3834
3835   handled = FALSE;
3836
3837   interface_name = g_dbus_message_get_interface (message);
3838   member = g_dbus_message_get_member (message);
3839   signature = g_dbus_message_get_signature (message);
3840
3841   /* see if we have an interface for handling this call */
3842   if (interface_name != NULL)
3843     {
3844       ExportedInterface *ei;
3845       ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3846       if (ei != NULL)
3847         {
3848           /* we do - invoke the handler in idle in the right thread */
3849
3850           /* handle no vtable or handler being present */
3851           if (ei->vtable == NULL || ei->vtable->method_call == NULL)
3852             goto out;
3853
3854           handled = validate_and_maybe_schedule_method_call (connection,
3855                                                              message,
3856                                                              ei->introspection_data,
3857                                                              ei->vtable,
3858                                                              ei->context,
3859                                                              ei->user_data);
3860           goto out;
3861         }
3862     }
3863
3864   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
3865       g_strcmp0 (member, "Introspect") == 0 &&
3866       g_strcmp0 (signature, "") == 0)
3867     {
3868       handled = handle_introspect (connection, eo, message);
3869       goto out;
3870     }
3871   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
3872            g_strcmp0 (member, "Get") == 0 &&
3873            g_strcmp0 (signature, "ss") == 0)
3874     {
3875       handled = handle_getset_property (connection, eo, message, TRUE);
3876       goto out;
3877     }
3878   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
3879            g_strcmp0 (member, "Set") == 0 &&
3880            g_strcmp0 (signature, "ssv") == 0)
3881     {
3882       handled = handle_getset_property (connection, eo, message, FALSE);
3883       goto out;
3884     }
3885   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
3886            g_strcmp0 (member, "GetAll") == 0 &&
3887            g_strcmp0 (signature, "s") == 0)
3888     {
3889       handled = handle_get_all_properties (connection, eo, message);
3890       goto out;
3891     }
3892
3893  out:
3894   return handled;
3895 }
3896
3897 /**
3898  * g_dbus_connection_register_object:
3899  * @connection: A #GDBusConnection.
3900  * @object_path: The object path to register at.
3901  * @introspection_data: Introspection data for the interface.
3902  * @vtable: A #GDBusInterfaceVTable to call into or %NULL.
3903  * @user_data: Data to pass to functions in @vtable.
3904  * @user_data_free_func: Function to call when the object path is unregistered.
3905  * @error: Return location for error or %NULL.
3906  *
3907  * Registers callbacks for exported objects at @object_path with the
3908  * D-Bus interface that is described in @introspection_data.
3909  *
3910  * Calls to functions in @vtable (and @user_data_free_func) will
3911  * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
3912  * loop</link> of the thread you are calling this method from.
3913  *
3914  * Note that all #GVariant values passed to functions in @vtable will match
3915  * the signature given in @introspection_data - if a remote caller passes
3916  * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
3917  * is returned to the remote caller.
3918  *
3919  * Additionally, if the remote caller attempts to invoke methods or
3920  * access properties not mentioned in @introspection_data the
3921  * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
3922  * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
3923  * are returned to the caller.
3924  *
3925  * It is considered a programming error if the
3926  * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
3927  * #GVariant of incorrect type.
3928  *
3929  * If an existing callback is already registered at @object_path and
3930  * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
3931  *
3932  * GDBus automatically implements the standard D-Bus interfaces
3933  * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
3934  * and org.freedesktop.Peer, so you don't have to implement those for
3935  * the objects you export. You <emphasis>can</emphasis> implement
3936  * org.freedesktop.DBus.Properties yourself, e.g. to handle getting
3937  * and setting of properties asynchronously.
3938  *
3939  * See <xref linkend="gdbus-server"/> for an example of how to use this method.
3940  *
3941  * Returns: 0 if @error is set, otherwise a registration id (never 0)
3942  * that can be used with g_dbus_connection_unregister_object() .
3943  *
3944  * Since: 2.26
3945  */
3946 guint
3947 g_dbus_connection_register_object (GDBusConnection            *connection,
3948                                    const gchar                *object_path,
3949                                    const GDBusInterfaceInfo   *introspection_data,
3950                                    const GDBusInterfaceVTable *vtable,
3951                                    gpointer                    user_data,
3952                                    GDestroyNotify              user_data_free_func,
3953                                    GError                    **error)
3954 {
3955   ExportedObject *eo;
3956   ExportedInterface *ei;
3957   guint ret;
3958
3959   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3960   g_return_val_if_fail (!g_dbus_connection_is_closed (connection), 0);
3961   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
3962   g_return_val_if_fail (introspection_data != NULL, 0);
3963   g_return_val_if_fail (g_dbus_is_interface_name (introspection_data->name), 0);
3964   g_return_val_if_fail (error == NULL || *error == NULL, 0);
3965
3966   ret = 0;
3967
3968   CONNECTION_LOCK (connection);
3969
3970   eo = g_hash_table_lookup (connection->priv->map_object_path_to_eo, object_path);
3971   if (eo == NULL)
3972     {
3973       eo = g_new0 (ExportedObject, 1);
3974       eo->object_path = g_strdup (object_path);
3975       eo->connection = connection;
3976       eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
3977                                                      g_str_equal,
3978                                                      NULL,
3979                                                      (GDestroyNotify) exported_interface_free);
3980       g_hash_table_insert (connection->priv->map_object_path_to_eo, eo->object_path, eo);
3981     }
3982
3983   ei = g_hash_table_lookup (eo->map_if_name_to_ei, introspection_data->name);
3984   if (ei != NULL)
3985     {
3986       g_set_error (error,
3987                    G_IO_ERROR,
3988                    G_IO_ERROR_EXISTS,
3989                    _("An object is already exported for the interface %s at %s"),
3990                    introspection_data->name,
3991                    object_path);
3992       goto out;
3993     }
3994
3995   ei = g_new0 (ExportedInterface, 1);
3996   ei->id = _global_registration_id++; /* TODO: overflow etc. */
3997   ei->eo = eo;
3998   ei->user_data = user_data;
3999   ei->user_data_free_func = user_data_free_func;
4000   ei->vtable = vtable;
4001   ei->introspection_data = introspection_data;
4002   ei->interface_name = g_strdup (introspection_data->name);
4003   ei->context = g_main_context_get_thread_default ();
4004   if (ei->context != NULL)
4005     g_main_context_ref (ei->context);
4006
4007   g_hash_table_insert (eo->map_if_name_to_ei,
4008                        (gpointer) ei->interface_name,
4009                        ei);
4010   g_hash_table_insert (connection->priv->map_id_to_ei,
4011                        GUINT_TO_POINTER (ei->id),
4012                        ei);
4013
4014   ret = ei->id;
4015
4016  out:
4017   CONNECTION_UNLOCK (connection);
4018
4019   return ret;
4020 }
4021
4022 /**
4023  * g_dbus_connection_unregister_object:
4024  * @connection: A #GDBusConnection.
4025  * @registration_id: A registration id obtained from g_dbus_connection_register_object().
4026  *
4027  * Unregisters an object.
4028  *
4029  * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
4030  *
4031  * Since: 2.26
4032  */
4033 gboolean
4034 g_dbus_connection_unregister_object (GDBusConnection *connection,
4035                                      guint            registration_id)
4036 {
4037   ExportedInterface *ei;
4038   ExportedObject *eo;
4039   gboolean ret;
4040
4041   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4042
4043   ret = FALSE;
4044
4045   CONNECTION_LOCK (connection);
4046
4047   ei = g_hash_table_lookup (connection->priv->map_id_to_ei,
4048                             GUINT_TO_POINTER (registration_id));
4049   if (ei == NULL)
4050     goto out;
4051
4052   eo = ei->eo;
4053
4054   g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
4055   g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
4056   /* unregister object path if we have no more exported interfaces */
4057   if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
4058     g_warn_if_fail (g_hash_table_remove (connection->priv->map_object_path_to_eo,
4059                                          eo->object_path));
4060
4061   ret = TRUE;
4062
4063  out:
4064   CONNECTION_UNLOCK (connection);
4065
4066   return ret;
4067 }
4068
4069 /* ---------------------------------------------------------------------------------------------------- */
4070
4071 /**
4072  * g_dbus_connection_emit_signal:
4073  * @connection: A #GDBusConnection.
4074  * @destination_bus_name: The unique bus name for the destination for the signal or %NULL to emit to all listeners.
4075  * @object_path: Path of remote object.
4076  * @interface_name: D-Bus interface to emit a signal on.
4077  * @signal_name: The name of the signal to emit.
4078  * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
4079  * @error: Return location for error or %NULL.
4080  *
4081  * Emits a signal.
4082  *
4083  * If the parameters GVariant is floating, it is consumed.
4084  *
4085  * This can only fail if @parameters is not compatible with the D-Bus protocol.
4086  *
4087  * Returns: %TRUE unless @error is set.
4088  *
4089  * Since: 2.26
4090  */
4091 gboolean
4092 g_dbus_connection_emit_signal (GDBusConnection  *connection,
4093                                const gchar      *destination_bus_name,
4094                                const gchar      *object_path,
4095                                const gchar      *interface_name,
4096                                const gchar      *signal_name,
4097                                GVariant         *parameters,
4098                                GError          **error)
4099 {
4100   GDBusMessage *message;
4101   gboolean ret;
4102
4103   message = NULL;
4104   ret = FALSE;
4105
4106   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4107   g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
4108   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
4109   g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
4110   g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
4111   g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
4112
4113   message = g_dbus_message_new_signal (object_path,
4114                                        interface_name,
4115                                        signal_name);
4116
4117   if (destination_bus_name != NULL)
4118     g_dbus_message_set_header (message,
4119                                G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
4120                                g_variant_new_string (destination_bus_name));
4121
4122   if (parameters != NULL)
4123     g_dbus_message_set_body (message, parameters);
4124
4125   ret = g_dbus_connection_send_message (connection, message, NULL, error);
4126   g_object_unref (message);
4127
4128   return ret;
4129 }
4130
4131 static void
4132 add_call_flags (GDBusMessage           *message,
4133                          GDBusCallFlags  flags)
4134 {
4135   if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
4136     g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
4137 }
4138
4139 /**
4140  * g_dbus_connection_call:
4141  * @connection: A #GDBusConnection.
4142  * @bus_name: A unique or well-known bus name or %NULL if @connection is not a message bus connection.
4143  * @object_path: Path of remote object.
4144  * @interface_name: D-Bus interface to invoke method on.
4145  * @method_name: The name of the method to invoke.
4146  * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
4147  * @flags: Flags from the #GDBusCallFlags enumeration.
4148  * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
4149  * @cancellable: A #GCancellable or %NULL.
4150  * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
4151  * care about the result of the method invocation.
4152  * @user_data: The data to pass to @callback.
4153  *
4154  * Asynchronously invokes the @method_name method on the
4155  * @interface_name D-Bus interface on the remote object at
4156  * @object_path owned by @bus_name.
4157  *
4158  * If @connection is closed then the operation will fail with
4159  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
4160  * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
4161  * not compatible with the D-Bus protocol, the operation fails with
4162  * %G_IO_ERROR_INVALID_ARGUMENT.
4163  *
4164  * If the @parameters #GVariant is floating, it is consumed. This allows
4165  * convenient 'inline' use of g_variant_new(), e.g.:
4166  * |[
4167  *  g_dbus_connection_call (connection,
4168  *                          "org.freedesktop.StringThings",
4169  *                          "/org/freedesktop/StringThings",
4170  *                          "org.freedesktop.StringThings",
4171  *                          "TwoStrings",
4172  *                          g_variant_new ("(ss)",
4173  *                                         "Thing One",
4174  *                                         "Thing Two"),
4175  *                          G_DBUS_CALL_FLAGS_NONE,
4176  *                          -1,
4177  *                          NULL,
4178  *                          (GAsyncReadyCallback) two_strings_done,
4179  *                          NULL);
4180  * ]|
4181  *
4182  * This is an asynchronous method. When the operation is finished, @callback will be invoked
4183  * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
4184  * of the thread you are calling this method from. You can then call
4185  * g_dbus_connection_call_finish() to get the result of the operation.
4186  * See g_dbus_connection_call_sync() for the synchronous version of this
4187  * function.
4188  *
4189  * Since: 2.26
4190  */
4191 void
4192 g_dbus_connection_call (GDBusConnection        *connection,
4193                         const gchar            *bus_name,
4194                         const gchar            *object_path,
4195                         const gchar            *interface_name,
4196                         const gchar            *method_name,
4197                         GVariant               *parameters,
4198                         GDBusCallFlags          flags,
4199                         gint                    timeout_msec,
4200                         GCancellable           *cancellable,
4201                         GAsyncReadyCallback     callback,
4202                         gpointer                user_data)
4203 {
4204   GDBusMessage *message;
4205
4206   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
4207   g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
4208   g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
4209   g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
4210   g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
4211   g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
4212   g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
4213
4214   message = g_dbus_message_new_method_call (bus_name,
4215                                             object_path,
4216                                             interface_name,
4217                                             method_name);
4218   add_call_flags (message, flags);
4219   if (parameters != NULL)
4220     g_dbus_message_set_body (message, parameters);
4221
4222   g_dbus_connection_send_message_with_reply (connection,
4223                                              message,
4224                                              timeout_msec,
4225                                              NULL, /* volatile guint32 *out_serial */
4226                                              cancellable,
4227                                              callback,
4228                                              user_data);
4229
4230   if (message != NULL)
4231     g_object_unref (message);
4232 }
4233
4234 static GVariant *
4235 decode_method_reply (GDBusMessage  *reply,
4236                      GError       **error)
4237 {
4238   GVariant *result;
4239
4240   result = NULL;
4241   switch (g_dbus_message_get_message_type (reply))
4242     {
4243     case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
4244       result = g_dbus_message_get_body (reply);
4245       if (result == NULL)
4246         {
4247           result = g_variant_new ("()");
4248           g_variant_ref_sink (result);
4249         }
4250       else
4251         {
4252           g_variant_ref (result);
4253         }
4254       break;
4255
4256     case G_DBUS_MESSAGE_TYPE_ERROR:
4257       g_dbus_message_to_gerror (reply, error);
4258       break;
4259
4260     default:
4261       g_assert_not_reached ();
4262       break;
4263     }
4264
4265   return result;
4266 }
4267
4268 /**
4269  * g_dbus_connection_call_finish:
4270  * @connection: A #GDBusConnection.
4271  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().
4272  * @error: Return location for error or %NULL.
4273  *
4274  * Finishes an operation started with g_dbus_connection_call().
4275  *
4276  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
4277  * return values. Free with g_variant_unref().
4278  *
4279  * Since: 2.26
4280  */
4281 GVariant *
4282 g_dbus_connection_call_finish (GDBusConnection  *connection,
4283                                GAsyncResult     *res,
4284                                GError          **error)
4285 {
4286   GDBusMessage *reply;
4287   GVariant *result;
4288
4289   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
4290   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
4291   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
4292
4293   result = NULL;
4294
4295   reply = g_dbus_connection_send_message_with_reply_finish (connection, res, error);
4296   if (reply == NULL)
4297     goto out;
4298
4299   result = decode_method_reply (reply, error);
4300
4301   g_object_unref (reply);
4302
4303  out:
4304   return result;
4305 }
4306
4307 /* ---------------------------------------------------------------------------------------------------- */
4308
4309 /**
4310  * g_dbus_connection_call_sync:
4311  * @connection: A #GDBusConnection.
4312  * @bus_name: A unique or well-known bus name.
4313  * @object_path: Path of remote object.
4314  * @interface_name: D-Bus interface to invoke method on.
4315  * @method_name: The name of the method to invoke.
4316  * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
4317  * @flags: Flags from the #GDBusCallFlags enumeration.
4318  * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
4319  * @cancellable: A #GCancellable or %NULL.
4320  * @error: Return location for error or %NULL.
4321  *
4322  * Synchronously invokes the @method_name method on the
4323  * @interface_name D-Bus interface on the remote object at
4324  * @object_path owned by @bus_name.
4325  *
4326  * If @connection is closed then the operation will fail with
4327  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
4328  * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
4329  * contains a value not compatible with the D-Bus protocol, the operation
4330  * fails with %G_IO_ERROR_INVALID_ARGUMENT.
4331  *
4332  * If the @parameters #GVariant is floating, it is consumed.
4333  * This allows convenient 'inline' use of g_variant_new(), e.g.:
4334  * |[
4335  *  g_dbus_connection_call_sync (connection,
4336  *                               "org.freedesktop.StringThings",
4337  *                               "/org/freedesktop/StringThings",
4338  *                               "org.freedesktop.StringThings",
4339  *                               "TwoStrings",
4340  *                               g_variant_new ("(ss)",
4341  *                                              "Thing One",
4342  *                                              "Thing Two"),
4343  *                               G_DBUS_CALL_FLAGS_NONE,
4344  *                               -1,
4345  *                               NULL,
4346  *                               &amp;error);
4347  * ]|
4348  *
4349  * The calling thread is blocked until a reply is received. See
4350  * g_dbus_connection_call() for the asynchronous version of
4351  * this method.
4352  *
4353  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
4354  * return values. Free with g_variant_unref().
4355  *
4356  * Since: 2.26
4357  */
4358 GVariant *
4359 g_dbus_connection_call_sync (GDBusConnection         *connection,
4360                              const gchar             *bus_name,
4361                              const gchar             *object_path,
4362                              const gchar             *interface_name,
4363                              const gchar             *method_name,
4364                              GVariant                *parameters,
4365                              GDBusCallFlags           flags,
4366                              gint                     timeout_msec,
4367                              GCancellable            *cancellable,
4368                              GError                 **error)
4369 {
4370   GDBusMessage *message;
4371   GDBusMessage *reply;
4372   GVariant *result;
4373
4374   message = NULL;
4375   reply = NULL;
4376   result = NULL;
4377
4378   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
4379   g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
4380   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
4381   g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
4382   g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
4383   g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
4384   g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
4385
4386   message = g_dbus_message_new_method_call (bus_name,
4387                                             object_path,
4388                                             interface_name,
4389                                             method_name);
4390   add_call_flags (message, flags);
4391   if (parameters != NULL)
4392     g_dbus_message_set_body (message, parameters);
4393
4394   reply = g_dbus_connection_send_message_with_reply_sync (connection,
4395                                                           message,
4396                                                           timeout_msec,
4397                                                           NULL, /* volatile guint32 *out_serial */
4398                                                           cancellable,
4399                                                           error);
4400
4401   if (reply == NULL)
4402     goto out;
4403
4404   result = decode_method_reply (reply, error);
4405
4406  out:
4407   if (message != NULL)
4408     g_object_unref (message);
4409   if (reply != NULL)
4410     g_object_unref (reply);
4411
4412   return result;
4413 }
4414
4415 /* ---------------------------------------------------------------------------------------------------- */
4416
4417 struct ExportedSubtree
4418 {
4419   guint                     id;
4420   gchar                    *object_path;
4421   GDBusConnection          *connection;
4422   const GDBusSubtreeVTable *vtable;
4423   GDBusSubtreeFlags         flags;
4424
4425   GMainContext             *context;
4426   gpointer                  user_data;
4427   GDestroyNotify            user_data_free_func;
4428 };
4429
4430 static void
4431 exported_subtree_free (ExportedSubtree *es)
4432 {
4433   if (es->user_data_free_func != NULL)
4434     /* TODO: push to thread-default mainloop */
4435     es->user_data_free_func (es->user_data);
4436
4437   if (es->context != NULL)
4438     g_main_context_unref (es->context);
4439
4440   g_free (es->object_path);
4441   g_free (es);
4442 }
4443
4444 /* called without lock held */
4445 static gboolean
4446 handle_subtree_introspect (GDBusConnection *connection,
4447                            ExportedSubtree *es,
4448                            GDBusMessage    *message)
4449 {
4450   GString *s;
4451   gboolean handled;
4452   GDBusMessage *reply;
4453   gchar **children;
4454   gboolean is_root;
4455   const gchar *sender;
4456   const gchar *requested_object_path;
4457   const gchar *requested_node;
4458   GPtrArray *interfaces;
4459   guint n;
4460   gchar **subnode_paths;
4461
4462   handled = FALSE;
4463
4464   requested_object_path = g_dbus_message_get_path (message);
4465   sender = g_dbus_message_get_sender (message);
4466   is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
4467
4468   s = g_string_new (NULL);
4469   introspect_append_header (s);
4470
4471   /* Strictly we don't need the children in dynamic mode, but we avoid the
4472    * conditionals to preserve code clarity
4473    */
4474   children = es->vtable->enumerate (es->connection,
4475                                     sender,
4476                                     es->object_path,
4477                                     es->user_data);
4478
4479   if (!is_root)
4480     {
4481       requested_node = strrchr (requested_object_path, '/') + 1;
4482
4483       /* Assert existence of object if we are not dynamic */
4484       if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
4485           !_g_strv_has_string ((const gchar * const *) children, requested_node))
4486         goto out;
4487     }
4488   else
4489     {
4490       requested_node = "/";
4491     }
4492
4493   interfaces = es->vtable->introspect (es->connection,
4494                                        sender,
4495                                        es->object_path,
4496                                        requested_node,
4497                                        es->user_data);
4498   if (interfaces != NULL)
4499     {
4500       if (interfaces->len > 0)
4501         {
4502           /* we're in business */
4503           introspect_append_standard_interfaces (s);
4504
4505           for (n = 0; n < interfaces->len; n++)
4506             {
4507               const GDBusInterfaceInfo *interface_info = interfaces->pdata[n];
4508               g_dbus_interface_info_generate_xml (interface_info, 2, s);
4509             }
4510         }
4511       g_ptr_array_unref (interfaces);
4512     }
4513
4514   /* then include <node> entries from the Subtree for the root */
4515   if (is_root)
4516     {
4517       for (n = 0; children != NULL && children[n] != NULL; n++)
4518         g_string_append_printf (s, "  <node name=\"%s\"/>\n", children[n]);
4519     }
4520
4521   /* finally include nodes registered below us */
4522   subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
4523   for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
4524     g_string_append_printf (s, "  <node name=\"%s\"/>\n", subnode_paths[n]);
4525   g_strfreev (subnode_paths);
4526
4527   g_string_append (s, "</node>\n");
4528
4529   reply = g_dbus_message_new_method_reply (message);
4530   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
4531   g_dbus_connection_send_message (connection, reply, NULL, NULL);
4532   g_object_unref (reply);
4533
4534   handled = TRUE;
4535
4536  out:
4537   g_string_free (s, TRUE);
4538   g_strfreev (children);
4539   return handled;
4540 }
4541
4542 /* called without lock held */
4543 static gboolean
4544 handle_subtree_method_invocation (GDBusConnection *connection,
4545                                   ExportedSubtree *es,
4546                                   GDBusMessage    *message)
4547 {
4548   gboolean handled;;
4549   const gchar *sender;
4550   const gchar *interface_name;
4551   const gchar *member;
4552   const gchar *signature;
4553   const gchar *requested_object_path;
4554   const gchar *requested_node;
4555   gboolean is_root;
4556   gchar **children;
4557   const GDBusInterfaceInfo *introspection_data;
4558   const GDBusInterfaceVTable *interface_vtable;
4559   gpointer interface_user_data;
4560   guint n;
4561   GPtrArray *interfaces;
4562   gboolean is_property_get;
4563   gboolean is_property_set;
4564   gboolean is_property_get_all;
4565
4566   handled = FALSE;
4567   interfaces = NULL;
4568
4569   requested_object_path = g_dbus_message_get_path (message);
4570   sender = g_dbus_message_get_sender (message);
4571   interface_name = g_dbus_message_get_interface (message);
4572   member = g_dbus_message_get_member (message);
4573   signature = g_dbus_message_get_signature (message);
4574   is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
4575
4576   is_property_get = FALSE;
4577   is_property_set = FALSE;
4578   is_property_get_all = FALSE;
4579   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
4580     {
4581       if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
4582         is_property_get = TRUE;
4583       else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
4584         is_property_set = TRUE;
4585       else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
4586         is_property_get_all = TRUE;
4587     }
4588
4589   children = es->vtable->enumerate (es->connection,
4590                                     sender,
4591                                     es->object_path,
4592                                     es->user_data);
4593
4594   if (!is_root)
4595     {
4596       requested_node = strrchr (requested_object_path, '/') + 1;
4597
4598       /* If not dynamic, skip if requested node is not part of children */
4599       if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
4600           !_g_strv_has_string ((const gchar * const *) children, requested_node))
4601         goto out;
4602     }
4603   else
4604     {
4605       requested_node = "/";
4606     }
4607
4608   /* get introspection data for the node */
4609   interfaces = es->vtable->introspect (es->connection,
4610                                        sender,
4611                                        requested_object_path,
4612                                        requested_node,
4613                                        es->user_data);
4614   g_assert (interfaces != NULL);
4615   introspection_data = NULL;
4616   for (n = 0; n < interfaces->len; n++)
4617     {
4618       const GDBusInterfaceInfo *id_n = (const GDBusInterfaceInfo *) interfaces->pdata[n];
4619       if (g_strcmp0 (id_n->name, interface_name) == 0)
4620         introspection_data = id_n;
4621     }
4622
4623   /* dispatch the call if the user wants to handle it */
4624   if (introspection_data != NULL)
4625     {
4626       /* figure out where to dispatch the method call */
4627       interface_user_data = NULL;
4628       interface_vtable = es->vtable->dispatch (es->connection,
4629                                                sender,
4630                                                es->object_path,
4631                                                interface_name,
4632                                                requested_node,
4633                                                &interface_user_data,
4634                                                es->user_data);
4635       if (interface_vtable == NULL)
4636         goto out;
4637
4638       CONNECTION_LOCK (connection);
4639       handled = validate_and_maybe_schedule_method_call (es->connection,
4640                                                          message,
4641                                                          introspection_data,
4642                                                          interface_vtable,
4643                                                          es->context,
4644                                                          interface_user_data);
4645       CONNECTION_UNLOCK (connection);
4646     }
4647   /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
4648   else if (is_property_get || is_property_set || is_property_get_all)
4649     {
4650       if (is_property_get)
4651         g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
4652       else if (is_property_set)
4653         g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
4654       else if (is_property_get_all)
4655         g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
4656       else
4657         g_assert_not_reached ();
4658
4659       /* see if the object supports this interface at all */
4660       for (n = 0; n < interfaces->len; n++)
4661         {
4662           const GDBusInterfaceInfo *id_n = (const GDBusInterfaceInfo *) interfaces->pdata[n];
4663           if (g_strcmp0 (id_n->name, interface_name) == 0)
4664             introspection_data = id_n;
4665         }
4666
4667       /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
4668        * claims it won't support the interface
4669        */
4670       if (introspection_data == NULL)
4671         {
4672           GDBusMessage *reply;
4673           reply = g_dbus_message_new_method_error (message,
4674                                                    "org.freedesktop.DBus.Error.InvalidArgs",
4675                                                    _("No such interface `%s'"),
4676                                                    interface_name);
4677           g_dbus_connection_send_message (es->connection, reply, NULL, NULL);
4678           g_object_unref (reply);
4679           handled = TRUE;
4680           goto out;
4681         }
4682
4683       /* figure out where to dispatch the property get/set/getall calls */
4684       interface_user_data = NULL;
4685       interface_vtable = es->vtable->dispatch (es->connection,
4686                                                sender,
4687                                                es->object_path,
4688                                                interface_name,
4689                                                requested_node,
4690                                                &interface_user_data,
4691                                                es->user_data);
4692       if (interface_vtable == NULL)
4693         goto out;
4694
4695       if (is_property_get || is_property_set)
4696         {
4697           CONNECTION_LOCK (connection);
4698           handled = validate_and_maybe_schedule_property_getset (es->connection,
4699                                                                  message,
4700                                                                  is_property_get,
4701                                                                  introspection_data,
4702                                                                  interface_vtable,
4703                                                                  es->context,
4704                                                                  interface_user_data);
4705           CONNECTION_UNLOCK (connection);
4706         }
4707       else if (is_property_get_all)
4708         {
4709           CONNECTION_LOCK (connection);
4710           handled = validate_and_maybe_schedule_property_get_all (es->connection,
4711                                                                   message,
4712                                                                   introspection_data,
4713                                                                   interface_vtable,
4714                                                                   es->context,
4715                                                                   interface_user_data);
4716           CONNECTION_UNLOCK (connection);
4717         }
4718     }
4719
4720  out:
4721   if (interfaces != NULL)
4722     g_ptr_array_unref (interfaces);
4723   g_strfreev (children);
4724   return handled;
4725 }
4726
4727 typedef struct
4728 {
4729   GDBusMessage *message;
4730   ExportedSubtree *es;
4731 } SubtreeDeferredData;
4732
4733 static void
4734 subtree_deferred_data_free (SubtreeDeferredData *data)
4735 {
4736   g_object_unref (data->message);
4737   g_free (data);
4738 }
4739
4740 /* called without lock held in the thread where the caller registered the subtree */
4741 static gboolean
4742 process_subtree_vtable_message_in_idle_cb (gpointer _data)
4743 {
4744   SubtreeDeferredData *data = _data;
4745   gboolean handled;
4746
4747   handled = FALSE;
4748
4749   if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
4750       g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
4751       g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
4752     handled = handle_subtree_introspect (data->es->connection,
4753                                          data->es,
4754                                          data->message);
4755   else
4756     handled = handle_subtree_method_invocation (data->es->connection,
4757                                                 data->es,
4758                                                 data->message);
4759
4760   if (!handled)
4761     {
4762       CONNECTION_LOCK (data->es->connection);
4763       handled = handle_generic_unlocked (data->es->connection, data->message);
4764       CONNECTION_UNLOCK (data->es->connection);
4765     }
4766
4767   /* if we couldn't handle the request, just bail with the UnknownMethod error */
4768   if (!handled)
4769     {
4770       GDBusMessage *reply;
4771       reply = g_dbus_message_new_method_error (data->message,
4772                                                "org.freedesktop.DBus.Error.UnknownMethod",
4773                                                _("Method `%s' on interface `%s' with signature `%s' does not exist"),
4774                                                g_dbus_message_get_member (data->message),
4775                                                g_dbus_message_get_interface (data->message),
4776                                                g_dbus_message_get_signature (data->message));
4777       g_dbus_connection_send_message (data->es->connection, reply, NULL, NULL);
4778       g_object_unref (reply);
4779     }
4780
4781   return FALSE;
4782 }
4783
4784 /* called in message handler thread with lock held */
4785 static gboolean
4786 subtree_message_func (GDBusConnection *connection,
4787                       ExportedSubtree *es,
4788                       GDBusMessage    *message)
4789 {
4790   GSource *idle_source;
4791   SubtreeDeferredData *data;
4792
4793   data = g_new0 (SubtreeDeferredData, 1);
4794   data->message = g_object_ref (message);
4795   data->es = es;
4796
4797   /* defer this call to an idle handler in the right thread */
4798   idle_source = g_idle_source_new ();
4799   g_source_set_priority (idle_source, G_PRIORITY_HIGH);
4800   g_source_set_callback (idle_source,
4801                          process_subtree_vtable_message_in_idle_cb,
4802                          data,
4803                          (GDestroyNotify) subtree_deferred_data_free);
4804   g_source_attach (idle_source, es->context);
4805   g_source_unref (idle_source);
4806
4807   /* since we own the entire subtree, handlers for objects not in the subtree have been
4808    * tried already by libdbus-1 - so we just need to ensure that we're always going
4809    * to reply to the message
4810    */
4811   return TRUE;
4812 }
4813
4814 /**
4815  * g_dbus_connection_register_subtree:
4816  * @connection: A #GDBusConnection.
4817  * @object_path: The object path to register the subtree at.
4818  * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
4819  * @flags: Flags used to fine tune the behavior of the subtree.
4820  * @user_data: Data to pass to functions in @vtable.
4821  * @user_data_free_func: Function to call when the subtree is unregistered.
4822  * @error: Return location for error or %NULL.
4823  *
4824  * Registers a whole subtree of <quote>dynamic</quote> objects.
4825  *
4826  * The @enumerate and @introspection functions in @vtable are used to
4827  * convey, to remote callers, what nodes exist in the subtree rooted
4828  * by @object_path.
4829  *
4830  * When handling remote calls into any node in the subtree, first the
4831  * @enumerate function is used to check if the node exists. If the node exists
4832  * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
4833  * the @introspection function is used to check if the node supports the
4834  * requested method. If so, the @dispatch function is used to determine
4835  * where to dispatch the call. The collected #GDBusInterfaceVTable and
4836  * #gpointer will be used to call into the interface vtable for processing
4837  * the request.
4838  *
4839  * All calls into user-provided code will be invoked in the <link
4840  * linkend="g-main-context-push-thread-default">thread-default main
4841  * loop</link> of the thread you are calling this method from.
4842  *
4843  * If an existing subtree is already registered at @object_path or
4844  * then @error is set to #G_IO_ERROR_EXISTS.
4845  *
4846  * Note that it is valid to register regular objects (using
4847  * g_dbus_connection_register_object()) in a subtree registered with
4848  * g_dbus_connection_register_subtree() - if so, the subtree handler
4849  * is tried as the last resort. One way to think about a subtree
4850  * handler is to consider it a <quote>fallback handler</quote>
4851  * for object paths not registered via g_dbus_connection_register_object()
4852  * or other bindings.
4853  *
4854  * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
4855  *
4856  * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
4857  * that can be used with g_dbus_connection_unregister_subtree() .
4858  *
4859  * Since: 2.26
4860  */
4861 guint
4862 g_dbus_connection_register_subtree (GDBusConnection           *connection,
4863                                     const gchar               *object_path,
4864                                     const GDBusSubtreeVTable  *vtable,
4865                                     GDBusSubtreeFlags          flags,
4866                                     gpointer                   user_data,
4867                                     GDestroyNotify             user_data_free_func,
4868                                     GError                   **error)
4869 {
4870   guint ret;
4871   ExportedSubtree *es;
4872
4873   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
4874   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
4875   g_return_val_if_fail (vtable != NULL, 0);
4876   g_return_val_if_fail (error == NULL || *error == NULL, 0);
4877
4878   ret = 0;
4879
4880   CONNECTION_LOCK (connection);
4881
4882   es = g_hash_table_lookup (connection->priv->map_object_path_to_es, object_path);
4883   if (es != NULL)
4884     {
4885       g_set_error (error,
4886                    G_IO_ERROR,
4887                    G_IO_ERROR_EXISTS,
4888                    _("A subtree is already exported for %s"),
4889                    object_path);
4890       goto out;
4891     }
4892
4893   es = g_new0 (ExportedSubtree, 1);
4894   es->object_path = g_strdup (object_path);
4895   es->connection = connection;
4896
4897   es->vtable = vtable;
4898   es->flags = flags;
4899   es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
4900   es->user_data = user_data;
4901   es->user_data_free_func = user_data_free_func;
4902   es->context = g_main_context_get_thread_default ();
4903   if (es->context != NULL)
4904     g_main_context_ref (es->context);
4905
4906   g_hash_table_insert (connection->priv->map_object_path_to_es, es->object_path, es);
4907   g_hash_table_insert (connection->priv->map_id_to_es,
4908                        GUINT_TO_POINTER (es->id),
4909                        es);
4910
4911   ret = es->id;
4912
4913  out:
4914   CONNECTION_UNLOCK (connection);
4915
4916   return ret;
4917 }
4918
4919 /* ---------------------------------------------------------------------------------------------------- */
4920
4921 /**
4922  * g_dbus_connection_unregister_subtree:
4923  * @connection: A #GDBusConnection.
4924  * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
4925  *
4926  * Unregisters a subtree.
4927  *
4928  * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
4929  *
4930  * Since: 2.26
4931  */
4932 gboolean
4933 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
4934                                       guint            registration_id)
4935 {
4936   ExportedSubtree *es;
4937   gboolean ret;
4938
4939   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4940
4941   ret = FALSE;
4942
4943   CONNECTION_LOCK (connection);
4944
4945   es = g_hash_table_lookup (connection->priv->map_id_to_es,
4946                             GUINT_TO_POINTER (registration_id));
4947   if (es == NULL)
4948     goto out;
4949
4950   g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_es, GUINT_TO_POINTER (es->id)));
4951   g_warn_if_fail (g_hash_table_remove (connection->priv->map_object_path_to_es, es->object_path));
4952
4953   ret = TRUE;
4954
4955  out:
4956   CONNECTION_UNLOCK (connection);
4957
4958   return ret;
4959 }
4960
4961 /* ---------------------------------------------------------------------------------------------------- */
4962
4963 /* must be called with lock held */
4964 static void
4965 handle_generic_ping_unlocked (GDBusConnection *connection,
4966                               const gchar     *object_path,
4967                               GDBusMessage    *message)
4968 {
4969   GDBusMessage *reply;
4970   reply = g_dbus_message_new_method_reply (message);
4971   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
4972   g_object_unref (reply);
4973 }
4974
4975 /* must be called with lock held */
4976 static void
4977 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
4978                                         const gchar     *object_path,
4979                                         GDBusMessage    *message)
4980 {
4981   GDBusMessage *reply;
4982
4983   reply = NULL;
4984   if (connection->priv->machine_id == NULL)
4985     {
4986       GError *error;
4987       error = NULL;
4988       /* TODO: use PACKAGE_LOCALSTATEDIR ? */
4989       if (!g_file_get_contents ("/var/lib/dbus/machine-id",
4990                                 &connection->priv->machine_id,
4991                                 NULL,
4992                                 &error))
4993         {
4994           reply = g_dbus_message_new_method_error (message,
4995                                                    "org.freedesktop.DBus.Error.Failed",
4996                                                    _("Unable to load /var/lib/dbus/machine-id: %s"),
4997                                                    error->message);
4998           g_error_free (error);
4999         }
5000       else
5001         {
5002           g_strstrip (connection->priv->machine_id);
5003           /* TODO: validate value */
5004         }
5005     }
5006
5007   if (reply == NULL)
5008     {
5009       reply = g_dbus_message_new_method_reply (message);
5010       g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->priv->machine_id));
5011     }
5012   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5013   g_object_unref (reply);
5014 }
5015
5016 /* must be called with lock held */
5017 static void
5018 handle_generic_introspect_unlocked (GDBusConnection *connection,
5019                                     const gchar     *object_path,
5020                                     GDBusMessage    *message)
5021 {
5022   guint n;
5023   GString *s;
5024   gchar **registered;
5025   GDBusMessage *reply;
5026
5027   /* first the header */
5028   s = g_string_new (NULL);
5029   introspect_append_header (s);
5030
5031   registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
5032   for (n = 0; registered != NULL && registered[n] != NULL; n++)
5033       g_string_append_printf (s, "  <node name=\"%s\"/>\n", registered[n]);
5034   g_strfreev (registered);
5035   g_string_append (s, "</node>\n");
5036
5037   reply = g_dbus_message_new_method_reply (message);
5038   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5039   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5040   g_object_unref (reply);
5041   g_string_free (s, TRUE);
5042 }
5043
5044 /* must be called with lock held */
5045 static gboolean
5046 handle_generic_unlocked (GDBusConnection *connection,
5047                          GDBusMessage    *message)
5048 {
5049   gboolean handled;
5050   const gchar *interface_name;
5051   const gchar *member;
5052   const gchar *signature;
5053   const gchar *path;
5054
5055   CONNECTION_ENSURE_LOCK (connection);
5056
5057   handled = FALSE;
5058
5059   interface_name = g_dbus_message_get_interface (message);
5060   member = g_dbus_message_get_member (message);
5061   signature = g_dbus_message_get_signature (message);
5062   path = g_dbus_message_get_path (message);
5063
5064   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
5065       g_strcmp0 (member, "Introspect") == 0 &&
5066       g_strcmp0 (signature, "") == 0)
5067     {
5068       handle_generic_introspect_unlocked (connection, path, message);
5069       handled = TRUE;
5070     }
5071   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
5072            g_strcmp0 (member, "Ping") == 0 &&
5073            g_strcmp0 (signature, "") == 0)
5074     {
5075       handle_generic_ping_unlocked (connection, path, message);
5076       handled = TRUE;
5077     }
5078   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
5079            g_strcmp0 (member, "GetMachineId") == 0 &&
5080            g_strcmp0 (signature, "") == 0)
5081     {
5082       handle_generic_get_machine_id_unlocked (connection, path, message);
5083       handled = TRUE;
5084     }
5085
5086   return handled;
5087 }
5088
5089 /* ---------------------------------------------------------------------------------------------------- */
5090
5091 /* called in message handler thread with lock held */
5092 static void
5093 distribute_method_call (GDBusConnection *connection,
5094                         GDBusMessage    *message)
5095 {
5096   ExportedObject *eo;
5097   ExportedSubtree *es;
5098   const gchar *object_path;
5099   const gchar *interface_name;
5100   const gchar *member;
5101   const gchar *signature;
5102   const gchar *path;
5103   gchar *subtree_path;
5104   gchar *needle;
5105
5106   g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
5107
5108   interface_name = g_dbus_message_get_interface (message);
5109   member = g_dbus_message_get_member (message);
5110   signature = g_dbus_message_get_signature (message);
5111   path = g_dbus_message_get_path (message);
5112   subtree_path = g_strdup (path);
5113   needle = strrchr (subtree_path, '/');
5114   if (needle != NULL && needle != subtree_path)
5115     {
5116       *needle = '\0';
5117     }
5118   else
5119     {
5120       g_free (subtree_path);
5121       subtree_path = NULL;
5122     }
5123
5124 #if 0
5125   g_debug ("interface    = `%s'", interface_name);
5126   g_debug ("member       = `%s'", member);
5127   g_debug ("signature    = `%s'", signature);
5128   g_debug ("path         = `%s'", path);
5129   g_debug ("subtree_path = `%s'", subtree_path != NULL ? subtree_path : "N/A");
5130 #endif
5131
5132   object_path = g_dbus_message_get_path (message);
5133   g_assert (object_path != NULL);
5134
5135   eo = g_hash_table_lookup (connection->priv->map_object_path_to_eo, object_path);
5136   if (eo != NULL)
5137     {
5138       if (obj_message_func (connection, eo, message))
5139         goto out;
5140     }
5141
5142   es = g_hash_table_lookup (connection->priv->map_object_path_to_es, object_path);
5143   if (es != NULL)
5144     {
5145       if (subtree_message_func (connection, es, message))
5146         goto out;
5147     }
5148
5149   if (subtree_path != NULL)
5150     {
5151       es = g_hash_table_lookup (connection->priv->map_object_path_to_es, subtree_path);
5152       if (es != NULL)
5153         {
5154           if (subtree_message_func (connection, es, message))
5155             goto out;
5156         }
5157     }
5158
5159   if (handle_generic_unlocked (connection, message))
5160     goto out;
5161
5162   /* if we end up here, the message has not been not handled */
5163
5164  out:
5165   g_free (subtree_path);
5166 }
5167
5168 /* ---------------------------------------------------------------------------------------------------- */
5169
5170 static GDBusConnection **
5171 message_bus_get_singleton (GBusType   bus_type,
5172                            GError   **error)
5173 {
5174   GDBusConnection **ret;
5175   const gchar *starter_bus;
5176
5177   ret = NULL;
5178
5179   switch (bus_type)
5180     {
5181     case G_BUS_TYPE_SESSION:
5182       ret = &the_session_bus;
5183       break;
5184
5185     case G_BUS_TYPE_SYSTEM:
5186       ret = &the_system_bus;
5187       break;
5188
5189     case G_BUS_TYPE_STARTER:
5190       starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
5191       if (g_strcmp0 (starter_bus, "session") == 0)
5192         {
5193           ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
5194           goto out;
5195         }
5196       else if (g_strcmp0 (starter_bus, "system") == 0)
5197         {
5198           ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
5199           goto out;
5200         }
5201       else
5202         {
5203           if (starter_bus != NULL)
5204             {
5205               g_set_error (error,
5206                            G_IO_ERROR,
5207                            G_IO_ERROR_INVALID_ARGUMENT,
5208                            _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
5209                              " - unknown value `%s'"),
5210                            starter_bus);
5211             }
5212           else
5213             {
5214               g_set_error_literal (error,
5215                                    G_IO_ERROR,
5216                                    G_IO_ERROR_INVALID_ARGUMENT,
5217                                    _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
5218                                      "variable is not set"));
5219             }
5220         }
5221       break;
5222
5223     default:
5224       g_assert_not_reached ();
5225       break;
5226     }
5227
5228  out:
5229   return ret;
5230 }
5231
5232 static GDBusConnection *
5233 get_uninitialized_connection (GBusType       bus_type,
5234                               GCancellable  *cancellable,
5235                               GError       **error)
5236 {
5237   GDBusConnection **singleton;
5238   GDBusConnection *ret;
5239
5240   ret = NULL;
5241
5242   G_LOCK (message_bus_lock);
5243   singleton = message_bus_get_singleton (bus_type, error);
5244   if (singleton == NULL)
5245     goto out;
5246
5247   if (*singleton == NULL)
5248     {
5249       gchar *address;
5250       address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
5251       if (address == NULL)
5252         goto out;
5253       ret = *singleton = g_object_new (G_TYPE_DBUS_CONNECTION,
5254                                        "address", address,
5255                                        "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
5256                                                 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
5257                                        "exit-on-close", TRUE,
5258                                        NULL);
5259       g_free (address);
5260     }
5261   else
5262     {
5263       ret = g_object_ref (*singleton);
5264     }
5265
5266   g_assert (ret != NULL);
5267
5268  out:
5269   G_UNLOCK (message_bus_lock);
5270   return ret;
5271 }
5272
5273 /**
5274  * g_bus_get_sync:
5275  * @bus_type: A #GBusType.
5276  * @cancellable: A #GCancellable or %NULL.
5277  * @error: Return location for error or %NULL.
5278  *
5279  * Synchronously connects to the message bus specified by @bus_type.
5280  * Note that the returned object may shared with other callers,
5281  * e.g. if two separate parts of a process calls this function with
5282  * the same @bus_type, they will share the same object.
5283  *
5284  * This is a synchronous failable function. See g_bus_get() and
5285  * g_bus_get_finish() for the asynchronous version.
5286  *
5287  * The returned object is a singleton, that is, shared with other
5288  * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
5289  * event that you need a private message bus connection, use
5290  * g_dbus_address_get_for_bus_sync() and
5291  * g_dbus_connection_new_for_address().
5292  *
5293  * Note that the returned #GDBusConnection object will (usually) have
5294  * the #GDBusConnection:exit-on-close property set to %TRUE.
5295  *
5296  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
5297  *
5298  * Since: 2.26
5299  */
5300 GDBusConnection *
5301 g_bus_get_sync (GBusType       bus_type,
5302                 GCancellable  *cancellable,
5303                 GError       **error)
5304 {
5305   GDBusConnection *connection;
5306
5307   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5308
5309   connection = get_uninitialized_connection (bus_type, cancellable, error);
5310   if (connection == NULL)
5311     goto out;
5312
5313   if (!g_initable_init (G_INITABLE (connection), cancellable, error))
5314     {
5315       g_object_unref (connection);
5316       connection = NULL;
5317     }
5318
5319  out:
5320   return connection;
5321 }
5322
5323 static void
5324 bus_get_async_initable_cb (GObject      *source_object,
5325                            GAsyncResult *res,
5326                            gpointer      user_data)
5327 {
5328   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
5329   GError *error;
5330
5331   error = NULL;
5332   if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
5333                                      res,
5334                                      &error))
5335     {
5336       g_assert (error != NULL);
5337       g_simple_async_result_set_from_error (simple, error);
5338       g_error_free (error);
5339       g_object_unref (source_object);
5340     }
5341   else
5342     {
5343       g_simple_async_result_set_op_res_gpointer (simple,
5344                                                  source_object,
5345                                                  g_object_unref);
5346     }
5347   g_simple_async_result_complete_in_idle (simple);
5348   g_object_unref (simple);
5349 }
5350
5351 /**
5352  * g_bus_get:
5353  * @bus_type: A #GBusType.
5354  * @cancellable: A #GCancellable or %NULL.
5355  * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
5356  * @user_data: The data to pass to @callback.
5357  *
5358  * Asynchronously connects to the message bus specified by @bus_type.
5359  *
5360  * When the operation is finished, @callback will be invoked. You can
5361  * then call g_bus_get_finish() to get the result of the operation.
5362  *
5363  * This is a asynchronous failable function. See g_bus_get_sync() for
5364  * the synchronous version.
5365  *
5366  * Since: 2.26
5367  */
5368 void
5369 g_bus_get (GBusType             bus_type,
5370            GCancellable        *cancellable,
5371            GAsyncReadyCallback  callback,
5372            gpointer             user_data)
5373 {
5374   GDBusConnection *connection;
5375   GSimpleAsyncResult *simple;
5376   GError *error;
5377
5378   simple = g_simple_async_result_new (NULL,
5379                                       callback,
5380                                       user_data,
5381                                       g_bus_get);
5382
5383   error = NULL;
5384   connection = get_uninitialized_connection (bus_type, cancellable, &error);
5385   if (connection == NULL)
5386     {
5387       g_assert (error != NULL);
5388       g_simple_async_result_set_from_error (simple, error);
5389       g_error_free (error);
5390       g_simple_async_result_complete_in_idle (simple);
5391       g_object_unref (simple);
5392     }
5393   else
5394     {
5395       g_async_initable_init_async (G_ASYNC_INITABLE (connection),
5396                                    G_PRIORITY_DEFAULT,
5397                                    cancellable,
5398                                    bus_get_async_initable_cb,
5399                                    simple);
5400     }
5401 }
5402
5403 /**
5404  * g_bus_get_finish:
5405  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
5406  * @error: Return location for error or %NULL.
5407  *
5408  * Finishes an operation started with g_bus_get().
5409  *
5410  * The returned object is a singleton, that is, shared with other
5411  * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
5412  * event that you need a private message bus connection, use
5413  * g_dbus_address_get_for_bus() and
5414  * g_dbus_connection_new_for_address().
5415  *
5416  * Note that the returned #GDBusConnection object will (usually) have
5417  * the #GDBusConnection:exit-on-close property set to %TRUE.
5418  *
5419  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
5420  *
5421  * Since: 2.26
5422  */
5423 GDBusConnection *
5424 g_bus_get_finish (GAsyncResult  *res,
5425                   GError       **error)
5426 {
5427   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5428   GObject *object;
5429   GDBusConnection *ret;
5430
5431   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5432
5433   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
5434
5435   ret = NULL;
5436
5437   if (g_simple_async_result_propagate_error (simple, error))
5438     goto out;
5439
5440   object = g_simple_async_result_get_op_res_gpointer (simple);
5441   g_assert (object != NULL);
5442   ret = g_object_ref (G_DBUS_CONNECTION (object));
5443
5444  out:
5445   return ret;
5446 }
5447
5448 /* ---------------------------------------------------------------------------------------------------- */
5449
5450 #define __G_DBUS_CONNECTION_C__
5451 #include "gioaliasdef.c"