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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: David Zeuthen <davidz@redhat.com>
  19  */
  20
  21 /*
  22  * TODO for GDBus:
  23  *
  24  * - would be nice to expose GDBusAuthMechanism and an extension point
  25  *
  26  * - Need to rewrite GDBusAuth and rework GDBusAuthMechanism. In particular
  27  *   the mechanism VFuncs need to be able to set an error.
  28  *
  29  * - Need to document other mechanisms/sources for determining the D-Bus
  30  *   address of a well-known bus.
  31  *
  32  *   - e.g. on Win32 we need code like from here
  33  *
  34  *     http://cgit.freedesktop.org/~david/gdbus-standalone/tree/gdbus/gdbusaddress.c#n900
  35  *
  36  *     that was never copied over here because it originally was copy-paste
  37  *     from the GPLv2 / AFL 2.1 libdbus sources.
  38  *
  39  *   - on OS X we need to look in launchd for the address
  40  *
  41  *     https://bugs.freedesktop.org/show_bug.cgi?id=14259
  42  *
  43  *   - on X11 we need to look in a X11 property on the X server
  44  *     - (we can also just use dbus-launch(1) from the D-Bus
  45  *        distribution)
  46  *
  47  *   - (ideally) this requires D-Bus spec work because none of
  48  *     this has never really been specced out properly (except
  49  *     the X11 bits)
  50  *
  51  * - Related to the above, we also need to be able to launch a message bus
  52  *   instance.... Since we don't want to write our own bus daemon we should
  53  *   launch dbus-daemon(1) (thus: Win32 and OS X need to bundle it)
  54  *
  55  * - probably want a G_DBUS_NONCE_TCP_TMPDIR environment variable
  56  *   to specify where the nonce is stored. This will allow people to use
  57  *   G_DBUS_NONCE_TCP_TMPDIR=/mnt/secure.company.server/dbus-nonce-dir
  58  *   to easily achieve secure RPC via nonce-tcp.
  59  *
  60  * - need to expose an extension point for resolving D-Bus address and
  61  *   turning them into GIOStream objects. This will allow us to implement
  62  *   e.g. X11 D-Bus transports without dlopen()'ing or linking against
  63  *   libX11 from libgio.
  64  *   - see g_dbus_address_connect() in gdbusaddress.c
  65  *
  66  * - would be cute to use kernel-specific APIs to resolve fds for
  67  *   debug output when using G_DBUS_DEBUG=message, e.g. in addition to
  68  *
  69  *     fd 21: dev=8:1,mode=0100644,ino=1171231,uid=0,gid=0,rdev=0:0,size=234,atime=1273070640,mtime=1267126160,ctime=1267126160
  70  *
  71  *   maybe we can show more information about what fd 21 really is.
  72  *   Ryan suggests looking in /proc/self/fd for clues / symlinks!
  73  *   Initial experiments on Linux 2.6 suggests that the symlink looks
  74  *   like this:
  75  *
  76  *    3 -> /proc/18068/fd
  77  *
  78  *   e.g. not of much use.
  79  *
  80  *  - GDBus High-Level docs
  81  *    - Proxy: properties, signals...
  82  *    - Connection: IOStream based, ::close, connection setup steps
  83  *                  mainloop integration, threading
  84  *    - Differences from libdbus (extend "Migrating from")
  85  *      - the message handling thread
  86  *      - Using GVariant instead of GValue
  87  *    - Explain why the high-level API is a good thing and what
  88  *      kind of pitfalls it avoids
  89  *      - Export objects before claiming names
  90  *    - Talk about auto-starting services (cf. GBusNameWatcherFlags)
  91  *
  92  *  - use abstract sockets in test code
  93  *   - right now it doesn't work, dbus-daemon(1) fails with
  94  *
  95  *        /gdbus/connection/filter: Failed to start message bus: Failed to bind
  96  *        socket "/tmp/g-dbus-tests-pid-28531": Address already in use
  97  *        ** WARNING **: Error reading address from dbus daemon, 0 bytes read
  98  *
  99  *     or similar.
 100  */
 101
 102 #include "config.h"
 103
 104 #include <stdlib.h>
 105 #include <string.h>
 106
 107 #include "gdbusauth.h"
 108 #include "gdbusutils.h"
 109 #include "gdbusaddress.h"
 110 #include "gdbusmessage.h"
 111 #include "gdbusconnection.h"
 112 #include "gdbuserror.h"
 113 #include "gioenumtypes.h"
 114 #include "gdbusintrospection.h"
 115 #include "gdbusmethodinvocation.h"
 116 #include "gdbusprivate.h"
 117 #include "gdbusauthobserver.h"
 118 #include "ginitable.h"
 119 #include "gasyncinitable.h"
 120 #include "giostream.h"
 121 #include "gasyncresult.h"
 122 #include "gsimpleasyncresult.h"
 123
 124 #ifdef G_OS_UNIX
 125 #include "gkdbus.h"
 126 #include "gunixconnection.h"
 127 #include "gunixfdmessage.h"
 128 #endif
 129
 130 #include "glibintl.h"
 131
 132 /**
 133  * SECTION:gdbusconnection
 134  * @short_description: D-Bus Connections
 135  * @include: gio/gio.h
 136  *
 137  * The #GDBusConnection type is used for D-Bus connections to remote
 138  * peers such as a message buses. It is a low-level API that offers a
 139  * lot of flexibility. For instance, it lets you establish a connection
 140  * over any transport that can by represented as an #GIOStream.
 141  *
 142  * This class is rarely used directly in D-Bus clients. If you are writing
 143  * a D-Bus client, it is often easier to use the g_bus_own_name(),
 144  * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
 145  *
 146  * As an exception to the usual GLib rule that a particular object must not
 147  * be used by two threads at the same time, #GDBusConnection's methods may be
 148  * called from any thread. This is so that g_bus_get() and g_bus_get_sync()
 149  * can safely return the same #GDBusConnection when called from any thread.
 150  *
 151  * Most of the ways to obtain a #GDBusConnection automatically initialize it
 152  * (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and
 153  * g_bus_get(), and the synchronous versions of those methods, give you an
 154  * initialized connection. Language bindings for GIO should use
 155  * g_initable_new() or g_async_initable_new_async(), which also initialize the
 156  * connection.
 157  *
 158  * If you construct an uninitialized #GDBusConnection, such as via
 159  * g_object_new(), you must initialize it via g_initable_init() or
 160  * g_async_initable_init_async() before using its methods or properties.
 161  * Calling methods or accessing properties on a #GDBusConnection that has not
 162  * completed initialization successfully is considered to be invalid, and leads
 163  * to undefined behaviour. In particular, if initialization fails with a
 164  * #GError, the only valid thing you can do with that #GDBusConnection is to
 165  * free it with g_object_unref().
 166  *
 167  * ## An example D-Bus server # {#gdbus-server}
 168  *
 169  * Here is an example for a D-Bus server:
 170  * [gdbus-example-server.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-server.c)
 171  *
 172  * ## An example for exporting a subtree # {#gdbus-subtree-server}
 173  *
 174  * Here is an example for exporting a subtree:
 175  * [gdbus-example-subtree.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-subtree.c)
 176  *
 177  * ## An example for file descriptor passing # {#gdbus-unix-fd-client}
 178  *
 179  * Here is an example for passing UNIX file descriptors:
 180  * [gdbus-unix-fd-client.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-unix-fd-client.c)
 181  *
 182  * ## An example for exporting a GObject # {#gdbus-export}
 183  *
 184  * Here is an example for exporting a #GObject:
 185  * [gdbus-example-export.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-export.c)
 186  */
 187
 188 /* ---------------------------------------------------------------------------------------------------- */
 189
 190 typedef struct _GDBusConnectionClass GDBusConnectionClass;
 191
 192 /**
 193  * GDBusConnectionClass:
 194  * @closed: Signal class handler for the #GDBusConnection::closed signal.
 195  *
 196  * Class structure for #GDBusConnection.
 197  *
 198  * Since: 2.26
 199  */
 200 struct _GDBusConnectionClass
 201 {
 202   /*< private >*/
 203   GObjectClass parent_class;
 204
 205   /*< public >*/
 206   /* Signals */
 207   void (*closed) (GDBusConnection *connection,
 208                   gboolean         remote_peer_vanished,
 209                   GError          *error);
 210 };
 211
 212 G_LOCK_DEFINE_STATIC (message_bus_lock);
 213
 214 static GWeakRef the_session_bus;
 215 static GWeakRef the_system_bus;
 216 static GWeakRef the_user_bus;
 217 static GWeakRef the_machine_bus;
 218
 219 /* Extra pseudo-member of GDBusSendMessageFlags.
 220  * Set by initable_init() to indicate that despite not being initialized yet,
 221  * enough of the only-valid-after-init members are set that we can send a
 222  * message, and we're being called from its thread, so no memory barrier is
 223  * required before accessing them.
 224  */
 225 #define SEND_MESSAGE_FLAGS_INITIALIZING (1<<31)
 226
 227 /* Same as SEND_MESSAGE_FLAGS_INITIALIZING, but in GDBusCallFlags */
 228 #define CALL_FLAGS_INITIALIZING (1<<31)
 229
 230 /* ---------------------------------------------------------------------------------------------------- */
 231
 232 typedef struct
 233 {
 234   GDestroyNotify              callback;
 235   gpointer                    user_data;
 236   GMainContext               *context;
 237 } CallDestroyNotifyData;
 238
 239 static gboolean
 240 call_destroy_notify_data_in_idle (gpointer user_data)
 241 {
 242   CallDestroyNotifyData *data = user_data;
 243   data->callback (data->user_data);
 244   return FALSE;
 245 }
 246
 247 static void
 248 call_destroy_notify_data_free (CallDestroyNotifyData *data)
 249 {
 250   if (data->context != NULL)
 251     g_main_context_unref (data->context);
 252   g_free (data);
 253 }
 254
 255 /*
 256  * call_destroy_notify: <internal>
 257  * @context: (allow-none): A #GMainContext or %NULL.
 258  * @callback: (allow-none): A #GDestroyNotify or %NULL.
 259  * @user_data: Data to pass to @callback.
 260  *
 261  * Schedules @callback to run in @context.
 262  */
 263 static void
 264 call_destroy_notify (GMainContext  *context,
 265                      GDestroyNotify callback,
 266                      gpointer       user_data)
 267 {
 268   GSource *idle_source;
 269   CallDestroyNotifyData *data;
 270
 271   if (callback == NULL)
 272     goto out;
 273
 274   data = g_new0 (CallDestroyNotifyData, 1);
 275   data->callback = callback;
 276   data->user_data = user_data;
 277   data->context = context;
 278   if (data->context != NULL)
 279     g_main_context_ref (data->context);
 280
 281   idle_source = g_idle_source_new ();
 282   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
 283   g_source_set_callback (idle_source,
 284                          call_destroy_notify_data_in_idle,
 285                          data,
 286                          (GDestroyNotify) call_destroy_notify_data_free);
 287   g_source_set_name (idle_source, "[gio] call_destroy_notify_data_in_idle");
 288   g_source_attach (idle_source, data->context);
 289   g_source_unref (idle_source);
 290
 291  out:
 292   ;
 293 }
 294
 295 /* ---------------------------------------------------------------------------------------------------- */
 296
 297 static gboolean
 298 _g_strv_has_string (const gchar* const *haystack,
 299                     const gchar        *needle)
 300 {
 301   guint n;
 302
 303   for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
 304     {
 305       if (g_strcmp0 (haystack[n], needle) == 0)
 306         return TRUE;
 307     }
 308   return FALSE;
 309 }
 310
 311 /* ---------------------------------------------------------------------------------------------------- */
 312
 313 #ifdef G_OS_WIN32
 314 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
 315 #else
 316 // TODO: for some reason this doesn't work on Windows
 317 #define CONNECTION_ENSURE_LOCK(obj) do {                                \
 318     if (G_UNLIKELY (g_mutex_trylock(&(obj)->lock)))                     \
 319       {                                                                 \
 320         g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 321                              "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
 322       }                                                                 \
 323   } while (FALSE)
 324 #endif
 325
 326 #define CONNECTION_LOCK(obj) do {                                       \
 327     g_mutex_lock (&(obj)->lock);                                        \
 328   } while (FALSE)
 329
 330 #define CONNECTION_UNLOCK(obj) do {                                     \
 331     g_mutex_unlock (&(obj)->lock);                                      \
 332   } while (FALSE)
 333
 334 /* Flags in connection->atomic_flags */
 335 enum {
 336     FLAG_INITIALIZED = 1 << 0,
 337     FLAG_EXIT_ON_CLOSE = 1 << 1,
 338     FLAG_CLOSED = 1 << 2
 339 };
 340
 341 /**
 342  * GDBusConnection:
 343  *
 344  * The #GDBusConnection structure contains only private data and
 345  * should only be accessed using the provided API.
 346  *
 347  * Since: 2.26
 348  */
 349 struct _GDBusConnection
 350 {
 351   /*< private >*/
 352   GObject parent_instance;
 353
 354   /* ------------------------------------------------------------------------ */
 355   /* -- General object state ------------------------------------------------ */
 356   /* ------------------------------------------------------------------------ */
 357
 358   /* General-purpose lock for most fields */
 359   GMutex lock;
 360
 361   /* A lock used in the init() method of the GInitable interface - see comments
 362    * in initable_init() for why a separate lock is needed.
 363    *
 364    * If you need both @lock and @init_lock, you must take @init_lock first.
 365    */
 366   GMutex init_lock;
 367
 368   /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
 369    * someone calls org.freedesktop.DBus.Peer.GetMachineId(). Protected by @lock.
 370    */
 371   gchar *machine_id;
 372
 373   /* The underlying stream used for communication
 374    * Read-only after initable_init(), so it may be read if you either
 375    * hold @init_lock or check for initialization first.
 376    */
 377   GIOStream *stream;
 378
 379   /* The object used for authentication (if any).
 380    * Read-only after initable_init(), so it may be read if you either
 381    * hold @init_lock or check for initialization first.
 382    */
 383   GDBusAuth *auth;
 384
 385   /* Last serial used. Protected by @lock. */
 386   guint32 last_serial;
 387
 388   /* The object used to send/receive messages.
 389    * Read-only after initable_init(), so it may be read if you either
 390    * hold @init_lock or check for initialization first.
 391    */
 392   GDBusWorker *worker;
 393   GKDBusWorker *kdbus_worker;
 394
 395   /* If connected to a message bus, this contains the unique name assigned to
 396    * us by the bus (e.g. ":1.42").
 397    * Read-only after initable_init(), so it may be read if you either
 398    * hold @init_lock or check for initialization first.
 399    */
 400   gchar *bus_unique_name;
 401
 402   /* The GUID returned by the other side if we authenticed as a client or
 403    * the GUID to use if authenticating as a server.
 404    * Read-only after initable_init(), so it may be read if you either
 405    * hold @init_lock or check for initialization first.
 406    */
 407   gchar *guid;
 408
 409   /* FLAG_INITIALIZED is set exactly when initable_init() has finished running.
 410    * Inspect @initialization_error to see whether it succeeded or failed.
 411    *
 412    * FLAG_EXIT_ON_CLOSE is the exit-on-close property.
 413    *
 414    * FLAG_CLOSED is the closed property. It may be read at any time, but
 415    * may only be written while holding @lock.
 416    */
 417   volatile gint atomic_flags;
 418
 419   /* If the connection could not be established during initable_init(),
 420    * this GError will be set.
 421    * Read-only after initable_init(), so it may be read if you either
 422    * hold @init_lock or check for initialization first.
 423    */
 424   GError *initialization_error;
 425
 426   /* The result of g_main_context_ref_thread_default() when the object
 427    * was created (the GObject _init() function) - this is used for delivery
 428    * of the :closed GObject signal.
 429    *
 430    * Only set in the GObject init function, so no locks are needed.
 431    */
 432   GMainContext *main_context_at_construction;
 433
 434   /* Read-only construct properties, no locks needed */
 435   gchar *address;
 436   GDBusConnectionFlags flags;
 437
 438   /* Map used for managing method replies, protected by @lock */
 439   GHashTable *map_method_serial_to_send_message_data;  /* guint32 -> SendMessageData* */
 440
 441   /* Maps used for managing signal subscription, protected by @lock */
 442   GHashTable *map_rule_to_signal_data;                      /* match rule (gchar*)    -> SignalData */
 443   GHashTable *map_id_to_signal_data;                        /* id (guint)             -> SignalData */
 444   GHashTable *map_sender_unique_name_to_signal_data_array;  /* unique sender (gchar*) -> GPtrArray* of SignalData */
 445
 446   /* Maps used for managing exported objects and subtrees,
 447    * protected by @lock
 448    */
 449   GHashTable *map_object_path_to_eo;  /* gchar* -> ExportedObject* */
 450   GHashTable *map_id_to_ei;           /* guint  -> ExportedInterface* */
 451   GHashTable *map_object_path_to_es;  /* gchar* -> ExportedSubtree* */
 452   GHashTable *map_id_to_es;           /* guint  -> ExportedSubtree* */
 453
 454   /* Map used for storing last used serials for each thread, protected by @lock */
 455   GHashTable *map_thread_to_last_serial;
 456
 457   /* Structure used for message filters, protected by @lock */
 458   GPtrArray *filters;
 459
 460   /* Capabilities negotiated during authentication
 461    * Read-only after initable_init(), so it may be read without holding a
 462    * lock, if you check for initialization first.
 463    */
 464   GDBusCapabilityFlags capabilities;
 465
 466   /* Protected by @init_lock */
 467   GDBusAuthObserver *authentication_observer;
 468
 469   /* Read-only after initable_init(), so it may be read if you either
 470    * hold @init_lock or check for initialization first.
 471    */
 472   GCredentials *credentials;
 473
 474   /* set to TRUE when finalizing */
 475   gboolean finalizing;
 476 };
 477
 478 typedef struct ExportedObject ExportedObject;
 479 static void exported_object_free (ExportedObject *eo);
 480
 481 typedef struct ExportedSubtree ExportedSubtree;
 482 static void exported_subtree_free (ExportedSubtree *es);
 483
 484 enum
 485 {
 486   CLOSED_SIGNAL,
 487   LAST_SIGNAL,
 488 };
 489
 490 enum
 491 {
 492   PROP_0,
 493   PROP_STREAM,
 494   PROP_ADDRESS,
 495   PROP_FLAGS,
 496   PROP_GUID,
 497   PROP_UNIQUE_NAME,
 498   PROP_CLOSED,
 499   PROP_EXIT_ON_CLOSE,
 500   PROP_CAPABILITY_FLAGS,
 501   PROP_AUTHENTICATION_OBSERVER,
 502 };
 503
 504 static void distribute_signals (GDBusConnection  *connection,
 505                                 GDBusMessage     *message);
 506
 507 static void distribute_method_call (GDBusConnection  *connection,
 508                                     GDBusMessage     *message);
 509
 510 static gboolean handle_generic_unlocked (GDBusConnection *connection,
 511                                          GDBusMessage    *message);
 512
 513
 514 static void purge_all_signal_subscriptions (GDBusConnection *connection);
 515 static void purge_all_filters (GDBusConnection *connection);
 516
 517 static void schedule_method_call (GDBusConnection            *connection,
 518                                   GDBusMessage               *message,
 519                                   guint                       registration_id,
 520                                   guint                       subtree_registration_id,
 521                                   const GDBusInterfaceInfo   *interface_info,
 522                                   const GDBusMethodInfo      *method_info,
 523                                   const GDBusPropertyInfo    *property_info,
 524                                   GVariant                   *parameters,
 525                                   const GDBusInterfaceVTable *vtable,
 526                                   GMainContext               *main_context,
 527                                   gpointer                    user_data);
 528
 529 #define _G_ENSURE_LOCK(name) do {                                       \
 530     if (G_UNLIKELY (G_TRYLOCK(name)))                                   \
 531       {                                                                 \
 532         g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 533                              "_G_ENSURE_LOCK: Lock '" #name "' is not locked"); \
 534       }                                                                 \
 535   } while (FALSE)                                                       \
 536
 537 static guint signals[LAST_SIGNAL] = { 0 };
 538
 539 static void initable_iface_init       (GInitableIface      *initable_iface);
 540 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
 541
 542 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
 543                          G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
 544                          G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
 545                          );
 546
 547 /*
 548  * Check that all members of @connection that can only be accessed after
 549  * the connection is initialized can safely be accessed. If not,
 550  * log a critical warning. This function is a memory barrier.
 551  *
 552  * Returns: %TRUE if initialized
 553  */
 554 static gboolean
 555 check_initialized (GDBusConnection *connection)
 556 {
 557   /* The access to @atomic_flags isn't conditional, so that this function
 558    * provides a memory barrier for thread-safety even if checks are disabled.
 559    * (If you don't want this stricter guarantee, you can call
 560    * g_return_if_fail (check_initialized (c)).)
 561    *
 562    * This isn't strictly necessary now that we've decided use of an
 563    * uninitialized GDBusConnection is undefined behaviour, but it seems
 564    * better to be as deterministic as is feasible.
 565    *
 566    * (Anything that could suffer a crash from seeing undefined values
 567    * must have a race condition - thread A initializes the connection while
 568    * thread B calls a method without initialization, hoping that thread A will
 569    * win the race - so its behaviour is undefined anyway.)
 570    */
 571   gint flags = g_atomic_int_get (&connection->atomic_flags);
 572
 573   g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
 574
 575   /* We can safely access this, due to the memory barrier above */
 576   g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
 577
 578   return TRUE;
 579 }
 580
 581 typedef enum {
 582     MAY_BE_UNINITIALIZED = (1<<1)
 583 } CheckUnclosedFlags;
 584
 585 /*
 586  * Check the same thing as check_initialized(), and also that the
 587  * connection is not closed. If the connection is uninitialized,
 588  * raise a critical warning (it's programmer error); if it's closed,
 589  * raise a recoverable GError (it's a runtime error).
 590  *
 591  * This function is a memory barrier.
 592  *
 593  * Returns: %TRUE if initialized and not closed
 594  */
 595 static gboolean
 596 check_unclosed (GDBusConnection     *connection,
 597                 CheckUnclosedFlags   check,
 598                 GError             **error)
 599 {
 600   /* check_initialized() is effectively inlined, so we don't waste time
 601    * doing two memory barriers
 602    */
 603   gint flags = g_atomic_int_get (&connection->atomic_flags);
 604
 605   if (!(check & MAY_BE_UNINITIALIZED))
 606     {
 607       g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
 608       g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
 609     }
 610
 611   if (flags & FLAG_CLOSED)
 612     {
 613       g_set_error_literal (error,
 614                            G_IO_ERROR,
 615                            G_IO_ERROR_CLOSED,
 616                            _("The connection is closed"));
 617       return FALSE;
 618     }
 619
 620   return TRUE;
 621 }
 622
 623 static GHashTable *alive_connections = NULL;
 624
 625 static void
 626 g_dbus_connection_dispose (GObject *object)
 627 {
 628   GDBusConnection *connection = G_DBUS_CONNECTION (object);
 629
 630   G_LOCK (message_bus_lock);
 631   CONNECTION_LOCK (connection);
 632   if (connection->worker != NULL)
 633     {
 634       _g_dbus_worker_stop (connection->worker);
 635       connection->worker = NULL;
 636       if (alive_connections != NULL)
 637         g_warn_if_fail (g_hash_table_remove (alive_connections, connection));
 638     }
 639   else
 640     {
 641       if (alive_connections != NULL)
 642         g_warn_if_fail (g_hash_table_lookup (alive_connections, connection) == NULL);
 643     }
 644   CONNECTION_UNLOCK (connection);
 645   G_UNLOCK (message_bus_lock);
 646
 647   if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
 648     G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
 649 }
 650
 651 static void
 652 g_dbus_connection_finalize (GObject *object)
 653 {
 654   GDBusConnection *connection = G_DBUS_CONNECTION (object);
 655
 656   connection->finalizing = TRUE;
 657
 658   purge_all_signal_subscriptions (connection);
 659
 660   purge_all_filters (connection);
 661   g_ptr_array_unref (connection->filters);
 662
 663   if (connection->authentication_observer != NULL)
 664     g_object_unref (connection->authentication_observer);
 665
 666   if (connection->auth != NULL)
 667     g_object_unref (connection->auth);
 668
 669   if (connection->credentials)
 670     g_object_unref (connection->credentials);
 671
 672   if (connection->stream != NULL)
 673     {
 674       g_object_unref (connection->stream);
 675       connection->stream = NULL;
 676     }
 677
 678   g_free (connection->address);
 679
 680   g_free (connection->guid);
 681   g_free (connection->bus_unique_name);
 682
 683   if (connection->initialization_error != NULL)
 684     g_error_free (connection->initialization_error);
 685
 686   g_hash_table_unref (connection->map_method_serial_to_send_message_data);
 687
 688   g_hash_table_unref (connection->map_rule_to_signal_data);
 689   g_hash_table_unref (connection->map_id_to_signal_data);
 690   g_hash_table_unref (connection->map_sender_unique_name_to_signal_data_array);
 691
 692   g_hash_table_unref (connection->map_id_to_ei);
 693   g_hash_table_unref (connection->map_object_path_to_eo);
 694   g_hash_table_unref (connection->map_id_to_es);
 695   g_hash_table_unref (connection->map_object_path_to_es);
 696
 697   g_hash_table_unref (connection->map_thread_to_last_serial);
 698
 699   g_main_context_unref (connection->main_context_at_construction);
 700
 701   g_free (connection->machine_id);
 702
 703   g_mutex_clear (&connection->init_lock);
 704   g_mutex_clear (&connection->lock);
 705
 706   G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
 707 }
 708
 709 /* called in any user thread, with the connection's lock not held */
 710 static void
 711 g_dbus_connection_get_property (GObject    *object,
 712                                 guint       prop_id,
 713                                 GValue     *value,
 714                                 GParamSpec *pspec)
 715 {
 716   GDBusConnection *connection = G_DBUS_CONNECTION (object);
 717
 718   switch (prop_id)
 719     {
 720     case PROP_STREAM:
 721       g_value_set_object (value, g_dbus_connection_get_stream (connection));
 722       break;
 723
 724     case PROP_GUID:
 725       g_value_set_string (value, g_dbus_connection_get_guid (connection));
 726       break;
 727
 728     case PROP_UNIQUE_NAME:
 729       g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
 730       break;
 731
 732     case PROP_CLOSED:
 733       g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
 734       break;
 735
 736     case PROP_EXIT_ON_CLOSE:
 737       g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
 738       break;
 739
 740     case PROP_CAPABILITY_FLAGS:
 741       g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
 742       break;
 743
 744     default:
 745       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 746       break;
 747     }
 748 }
 749
 750 /* called in any user thread, with the connection's lock not held */
 751 static void
 752 g_dbus_connection_set_property (GObject      *object,
 753                                 guint         prop_id,
 754                                 const GValue *value,
 755                                 GParamSpec   *pspec)
 756 {
 757   GDBusConnection *connection = G_DBUS_CONNECTION (object);
 758
 759   switch (prop_id)
 760     {
 761     case PROP_STREAM:
 762       connection->stream = g_value_dup_object (value);
 763       break;
 764
 765     case PROP_GUID:
 766       connection->guid = g_value_dup_string (value);
 767       break;
 768
 769     case PROP_ADDRESS:
 770       connection->address = g_value_dup_string (value);
 771       break;
 772
 773     case PROP_FLAGS:
 774       connection->flags = g_value_get_flags (value);
 775       break;
 776
 777     case PROP_EXIT_ON_CLOSE:
 778       g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
 779       break;
 780
 781     case PROP_AUTHENTICATION_OBSERVER:
 782       connection->authentication_observer = g_value_dup_object (value);
 783       break;
 784
 785     default:
 786       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 787       break;
 788     }
 789 }
 790
 791 /* Base-class implementation of GDBusConnection::closed.
 792  *
 793  * Called in a user thread, by the main context that was thread-default when
 794  * the object was constructed.
 795  */
 796 static void
 797 g_dbus_connection_real_closed (GDBusConnection *connection,
 798                                gboolean         remote_peer_vanished,
 799                                GError          *error)
 800 {
 801   gint flags = g_atomic_int_get (&connection->atomic_flags);
 802
 803   /* Because atomic int access is a memory barrier, we can safely read
 804    * initialization_error without a lock, as long as we do it afterwards.
 805    */
 806   if (remote_peer_vanished &&
 807       (flags & FLAG_EXIT_ON_CLOSE) != 0 &&
 808       (flags & FLAG_INITIALIZED) != 0 &&
 809       connection->initialization_error == NULL)
 810     {
 811       if (error != NULL)
 812         {
 813           g_printerr ("%s: Remote peer vanished with error: %s (%s, %d). Exiting.\n",
 814                       G_STRFUNC,
 815                       error->message,
 816                       g_quark_to_string (error->domain), error->code);
 817         }
 818       else
 819         {
 820           g_printerr ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
 821         }
 822       raise (SIGTERM);
 823     }
 824 }
 825
 826 static void
 827 g_dbus_connection_class_init (GDBusConnectionClass *klass)
 828 {
 829   GObjectClass *gobject_class;
 830
 831   gobject_class = G_OBJECT_CLASS (klass);
 832
 833   gobject_class->finalize     = g_dbus_connection_finalize;
 834   gobject_class->dispose      = g_dbus_connection_dispose;
 835   gobject_class->set_property = g_dbus_connection_set_property;
 836   gobject_class->get_property = g_dbus_connection_get_property;
 837
 838   klass->closed = g_dbus_connection_real_closed;
 839
 840   /**
 841    * GDBusConnection:stream:
 842    *
 843    * The underlying #GIOStream used for I/O.
 844    *
 845    * If this is passed on construction and is a #GSocketConnection,
 846    * then the corresponding #GSocket will be put into non-blocking mode.
 847    *
 848    * While the #GDBusConnection is active, it will interact with this
 849    * stream from a worker thread, so it is not safe to interact with
 850    * the stream directly.
 851    *
 852    * Since: 2.26
 853    */
 854   g_object_class_install_property (gobject_class,
 855                                    PROP_STREAM,
 856                                    g_param_spec_object ("stream",
 857                                                         P_("IO Stream"),
 858                                                         P_("The underlying streams used for I/O"),
 859                                                         G_TYPE_IO_STREAM,
 860                                                         G_PARAM_READABLE |
 861                                                         G_PARAM_WRITABLE |
 862                                                         G_PARAM_CONSTRUCT_ONLY |
 863                                                         G_PARAM_STATIC_NAME |
 864                                                         G_PARAM_STATIC_BLURB |
 865                                                         G_PARAM_STATIC_NICK));
 866
 867   /**
 868    * GDBusConnection:address:
 869    *
 870    * A D-Bus address specifying potential endpoints that can be used
 871    * when establishing the connection.
 872    *
 873    * Since: 2.26
 874    */
 875   g_object_class_install_property (gobject_class,
 876                                    PROP_ADDRESS,
 877                                    g_param_spec_string ("address",
 878                                                         P_("Address"),
 879                                                         P_("D-Bus address specifying potential socket endpoints"),
 880                                                         NULL,
 881                                                         G_PARAM_WRITABLE |
 882                                                         G_PARAM_CONSTRUCT_ONLY |
 883                                                         G_PARAM_STATIC_NAME |
 884                                                         G_PARAM_STATIC_BLURB |
 885                                                         G_PARAM_STATIC_NICK));
 886
 887   /**
 888    * GDBusConnection:flags:
 889    *
 890    * Flags from the #GDBusConnectionFlags enumeration.
 891    *
 892    * Since: 2.26
 893    */
 894   g_object_class_install_property (gobject_class,
 895                                    PROP_FLAGS,
 896                                    g_param_spec_flags ("flags",
 897                                                        P_("Flags"),
 898                                                        P_("Flags"),
 899                                                        G_TYPE_DBUS_CONNECTION_FLAGS,
 900                                                        G_DBUS_CONNECTION_FLAGS_NONE,
 901                                                        G_PARAM_WRITABLE |
 902                                                        G_PARAM_CONSTRUCT_ONLY |
 903                                                        G_PARAM_STATIC_NAME |
 904                                                        G_PARAM_STATIC_BLURB |
 905                                                        G_PARAM_STATIC_NICK));
 906
 907   /**
 908    * GDBusConnection:guid:
 909    *
 910    * The GUID of the peer performing the role of server when
 911    * authenticating.
 912    *
 913    * If you are constructing a #GDBusConnection and pass
 914    * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
 915    * #GDBusConnection:flags property then you MUST also set this
 916    * property to a valid guid.
 917    *
 918    * If you are constructing a #GDBusConnection and pass
 919    * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
 920    * #GDBusConnection:flags property you will be able to read the GUID
 921    * of the other peer here after the connection has been successfully
 922    * initialized.
 923    *
 924    * Since: 2.26
 925    */
 926   g_object_class_install_property (gobject_class,
 927                                    PROP_GUID,
 928                                    g_param_spec_string ("guid",
 929                                                         P_("GUID"),
 930                                                         P_("GUID of the server peer"),
 931                                                         NULL,
 932                                                         G_PARAM_READABLE |
 933                                                         G_PARAM_WRITABLE |
 934                                                         G_PARAM_CONSTRUCT_ONLY |
 935                                                         G_PARAM_STATIC_NAME |
 936                                                         G_PARAM_STATIC_BLURB |
 937                                                         G_PARAM_STATIC_NICK));
 938
 939   /**
 940    * GDBusConnection:unique-name:
 941    *
 942    * The unique name as assigned by the message bus or %NULL if the
 943    * connection is not open or not a message bus connection.
 944    *
 945    * Since: 2.26
 946    */
 947   g_object_class_install_property (gobject_class,
 948                                    PROP_UNIQUE_NAME,
 949                                    g_param_spec_string ("unique-name",
 950                                                         P_("unique-name"),
 951                                                         P_("Unique name of bus connection"),
 952                                                         NULL,
 953                                                         G_PARAM_READABLE |
 954                                                         G_PARAM_STATIC_NAME |
 955                                                         G_PARAM_STATIC_BLURB |
 956                                                         G_PARAM_STATIC_NICK));
 957
 958   /**
 959    * GDBusConnection:closed:
 960    *
 961    * A boolean specifying whether the connection has been closed.
 962    *
 963    * Since: 2.26
 964    */
 965   g_object_class_install_property (gobject_class,
 966                                    PROP_CLOSED,
 967                                    g_param_spec_boolean ("closed",
 968                                                          P_("Closed"),
 969                                                          P_("Whether the connection is closed"),
 970                                                          FALSE,
 971                                                          G_PARAM_READABLE |
 972                                                          G_PARAM_STATIC_NAME |
 973                                                          G_PARAM_STATIC_BLURB |
 974                                                          G_PARAM_STATIC_NICK));
 975
 976   /**
 977    * GDBusConnection:exit-on-close:
 978    *
 979    * A boolean specifying whether the process will be terminated (by
 980    * calling `raise(SIGTERM)`) if the connection is closed by the
 981    * remote peer.
 982    *
 983    * Note that #GDBusConnection objects returned by g_bus_get_finish()
 984    * and g_bus_get_sync() will (usually) have this property set to %TRUE.
 985    *
 986    * Since: 2.26
 987    */
 988   g_object_class_install_property (gobject_class,
 989                                    PROP_EXIT_ON_CLOSE,
 990                                    g_param_spec_boolean ("exit-on-close",
 991                                                          P_("Exit on close"),
 992                                                          P_("Whether the process is terminated when the connection is closed"),
 993                                                          FALSE,
 994                                                          G_PARAM_READABLE |
 995                                                          G_PARAM_WRITABLE |
 996                                                          G_PARAM_STATIC_NAME |
 997                                                          G_PARAM_STATIC_BLURB |
 998                                                          G_PARAM_STATIC_NICK));
 999
1000   /**
1001    * GDBusConnection:capabilities:
1002    *
1003    * Flags from the #GDBusCapabilityFlags enumeration
1004    * representing connection features negotiated with the other peer.
1005    *
1006    * Since: 2.26
1007    */
1008   g_object_class_install_property (gobject_class,
1009                                    PROP_CAPABILITY_FLAGS,
1010                                    g_param_spec_flags ("capabilities",
1011                                                        P_("Capabilities"),
1012                                                        P_("Capabilities"),
1013                                                        G_TYPE_DBUS_CAPABILITY_FLAGS,
1014                                                        G_DBUS_CAPABILITY_FLAGS_NONE,
1015                                                        G_PARAM_READABLE |
1016                                                        G_PARAM_STATIC_NAME |
1017                                                        G_PARAM_STATIC_BLURB |
1018                                                        G_PARAM_STATIC_NICK));
1019
1020   /**
1021    * GDBusConnection:authentication-observer:
1022    *
1023    * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
1024    *
1025    * Since: 2.26
1026    */
1027   g_object_class_install_property (gobject_class,
1028                                    PROP_AUTHENTICATION_OBSERVER,
1029                                    g_param_spec_object ("authentication-observer",
1030                                                         P_("Authentication Observer"),
1031                                                         P_("Object used to assist in the authentication process"),
1032                                                         G_TYPE_DBUS_AUTH_OBSERVER,
1033                                                         G_PARAM_WRITABLE |
1034                                                         G_PARAM_CONSTRUCT_ONLY |
1035                                                         G_PARAM_STATIC_NAME |
1036                                                         G_PARAM_STATIC_BLURB |
1037                                                         G_PARAM_STATIC_NICK));
1038
1039   /**
1040    * GDBusConnection::closed:
1041    * @connection: the #GDBusConnection emitting the signal
1042    * @remote_peer_vanished: %TRUE if @connection is closed because the
1043    *     remote peer closed its end of the connection
1044    * @error: (allow-none): a #GError with more details about the event or %NULL
1045    *
1046    * Emitted when the connection is closed.
1047    *
1048    * The cause of this event can be
1049    *
1050    * - If g_dbus_connection_close() is called. In this case
1051    *   @remote_peer_vanished is set to %FALSE and @error is %NULL.
1052    *
1053    * - If the remote peer closes the connection. In this case
1054    *   @remote_peer_vanished is set to %TRUE and @error is set.
1055    *
1056    * - If the remote peer sends invalid or malformed data. In this
1057    *   case @remote_peer_vanished is set to %FALSE and @error is set.
1058    *
1059    * Upon receiving this signal, you should give up your reference to
1060    * @connection. You are guaranteed that this signal is emitted only
1061    * once.
1062    *
1063    * Since: 2.26
1064    */
1065   signals[CLOSED_SIGNAL] = g_signal_new ("closed",
1066                                          G_TYPE_DBUS_CONNECTION,
1067                                          G_SIGNAL_RUN_LAST,
1068                                          G_STRUCT_OFFSET (GDBusConnectionClass, closed),
1069                                          NULL,
1070                                          NULL,
1071                                          NULL,
1072                                          G_TYPE_NONE,
1073                                          2,
1074                                          G_TYPE_BOOLEAN,
1075                                          G_TYPE_ERROR);
1076 }
1077
1078 static void
1079 g_dbus_connection_init (GDBusConnection *connection)
1080 {
1081   g_mutex_init (&connection->lock);
1082   g_mutex_init (&connection->init_lock);
1083
1084   connection->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
1085
1086   connection->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
1087                                                           g_str_equal);
1088   connection->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
1089                                                         g_direct_equal);
1090   connection->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
1091                                                                                    g_str_equal,
1092                                                                                    g_free,
1093                                                                                    (GDestroyNotify) g_ptr_array_unref);
1094
1095   connection->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
1096                                                              g_str_equal,
1097                                                              NULL,
1098                                                              (GDestroyNotify) exported_object_free);
1099
1100   connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
1101                                                g_direct_equal);
1102
1103   connection->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
1104                                                              g_str_equal,
1105                                                              NULL,
1106                                                              (GDestroyNotify) exported_subtree_free);
1107
1108   connection->map_id_to_es = g_hash_table_new (g_direct_hash,
1109                                                g_direct_equal);
1110
1111   connection->map_thread_to_last_serial = g_hash_table_new (g_direct_hash,
1112                                                             g_direct_equal);
1113
1114   connection->main_context_at_construction = g_main_context_ref_thread_default ();
1115
1116   connection->filters = g_ptr_array_new ();
1117 }
1118
1119 /**
1120  * g_dbus_connection_get_stream:
1121  * @connection: a #GDBusConnection
1122  *
1123  * Gets the underlying stream used for IO.
1124  *
1125  * While the #GDBusConnection is active, it will interact with this
1126  * stream from a worker thread, so it is not safe to interact with
1127  * the stream directly.
1128  *
1129  * Returns: (transfer none): the stream used for IO
1130  *
1131  * Since: 2.26
1132  */
1133 GIOStream *
1134 g_dbus_connection_get_stream (GDBusConnection *connection)
1135 {
1136   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1137
1138   /* do not use g_return_val_if_fail(), we want the memory barrier */
1139   if (!check_initialized (connection))
1140     return NULL;
1141
1142   return connection->stream;
1143 }
1144
1145 /**
1146  * g_dbus_connection_start_message_processing:
1147  * @connection: a #GDBusConnection
1148  *
1149  * If @connection was created with
1150  * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
1151  * starts processing messages. Does nothing on if @connection wasn't
1152  * created with this flag or if the method has already been called.
1153  *
1154  * Since: 2.26
1155  */
1156 void
1157 g_dbus_connection_start_message_processing (GDBusConnection *connection)
1158 {
1159   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1160
1161   /* do not use g_return_val_if_fail(), we want the memory barrier */
1162   if (!check_initialized (connection))
1163     return;
1164
1165   g_assert (connection->worker || connection->kdbus_worker);
1166
1167   if (connection->kdbus_worker)
1168     g_kdbus_worker_unfreeze (connection->kdbus_worker);
1169   else
1170     _g_dbus_worker_unfreeze (connection->worker);
1171 }
1172
1173 /**
1174  * g_dbus_connection_is_closed:
1175  * @connection: a #GDBusConnection
1176  *
1177  * Gets whether @connection is closed.
1178  *
1179  * Returns: %TRUE if the connection is closed, %FALSE otherwise
1180  *
1181  * Since: 2.26
1182  */
1183 gboolean
1184 g_dbus_connection_is_closed (GDBusConnection *connection)
1185 {
1186   gint flags;
1187
1188   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1189
1190   flags = g_atomic_int_get (&connection->atomic_flags);
1191
1192   return (flags & FLAG_CLOSED) ? TRUE : FALSE;
1193 }
1194
1195 /**
1196  * g_dbus_connection_get_capabilities:
1197  * @connection: a #GDBusConnection
1198  *
1199  * Gets the capabilities negotiated with the remote peer
1200  *
1201  * Returns: zero or more flags from the #GDBusCapabilityFlags enumeration
1202  *
1203  * Since: 2.26
1204  */
1205 GDBusCapabilityFlags
1206 g_dbus_connection_get_capabilities (GDBusConnection *connection)
1207 {
1208   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
1209
1210   /* do not use g_return_val_if_fail(), we want the memory barrier */
1211   if (!check_initialized (connection))
1212     return G_DBUS_CAPABILITY_FLAGS_NONE;
1213
1214   return connection->capabilities;
1215 }
1216
1217 /* ---------------------------------------------------------------------------------------------------- */
1218
1219 /* Called in a temporary thread without holding locks. */
1220 static void
1221 flush_in_thread_func (GSimpleAsyncResult *res,
1222                       GObject            *object,
1223                       GCancellable       *cancellable)
1224 {
1225   GError *error;
1226
1227   error = NULL;
1228   if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
1229                                      cancellable,
1230                                      &error))
1231     g_simple_async_result_take_error (res, error);
1232 }
1233
1234 /**
1235  * g_dbus_connection_flush:
1236  * @connection: a #GDBusConnection
1237  * @cancellable: (allow-none): a #GCancellable or %NULL
1238  * @callback: (allow-none): a #GAsyncReadyCallback to call when the
1239  *     request is satisfied or %NULL if you don't care about the result
1240  * @user_data: The data to pass to @callback
1241  *
1242  * Asynchronously flushes @connection, that is, writes all queued
1243  * outgoing message to the transport and then flushes the transport
1244  * (using g_output_stream_flush_async()). This is useful in programs
1245  * that wants to emit a D-Bus signal and then exit immediately. Without
1246  * flushing the connection, there is no guaranteed that the message has
1247  * been sent to the networking buffers in the OS kernel.
1248  *
1249  * This is an asynchronous method. When the operation is finished,
1250  * @callback will be invoked in the
1251  * [thread-default main context][g-main-context-push-thread-default]
1252  * of the thread you are calling this method from. You can
1253  * then call g_dbus_connection_flush_finish() to get the result of the
1254  * operation. See g_dbus_connection_flush_sync() for the synchronous
1255  * version.
1256  *
1257  * Since: 2.26
1258  */
1259 void
1260 g_dbus_connection_flush (GDBusConnection     *connection,
1261                          GCancellable        *cancellable,
1262                          GAsyncReadyCallback  callback,
1263                          gpointer             user_data)
1264 {
1265   GSimpleAsyncResult *simple;
1266
1267   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1268
1269   simple = g_simple_async_result_new (G_OBJECT (connection),
1270                                       callback,
1271                                       user_data,
1272                                       g_dbus_connection_flush);
1273   g_simple_async_result_set_check_cancellable (simple, cancellable);
1274   g_simple_async_result_run_in_thread (simple,
1275                                        flush_in_thread_func,
1276                                        G_PRIORITY_DEFAULT,
1277                                        cancellable);
1278   g_object_unref (simple);
1279 }
1280
1281 /**
1282  * g_dbus_connection_flush_finish:
1283  * @connection: a #GDBusConnection
1284  * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
1285  *     to g_dbus_connection_flush()
1286  * @error: return location for error or %NULL
1287  *
1288  * Finishes an operation started with g_dbus_connection_flush().
1289  *
1290  * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1291  *
1292  * Since: 2.26
1293  */
1294 gboolean
1295 g_dbus_connection_flush_finish (GDBusConnection  *connection,
1296                                 GAsyncResult     *res,
1297                                 GError          **error)
1298 {
1299   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1300   gboolean ret;
1301
1302   ret = FALSE;
1303
1304   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1305   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1306   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1307
1308   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
1309
1310   if (g_simple_async_result_propagate_error (simple, error))
1311     goto out;
1312
1313   ret = TRUE;
1314
1315  out:
1316   return ret;
1317 }
1318
1319 /**
1320  * g_dbus_connection_flush_sync:
1321  * @connection: a #GDBusConnection
1322  * @cancellable: (allow-none): a #GCancellable or %NULL
1323  * @error: return location for error or %NULL
1324  *
1325  * Synchronously flushes @connection. The calling thread is blocked
1326  * until this is done. See g_dbus_connection_flush() for the
1327  * asynchronous version of this method and more details about what it
1328  * does.
1329  *
1330  * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1331  *
1332  * Since: 2.26
1333  */
1334 gboolean
1335 g_dbus_connection_flush_sync (GDBusConnection  *connection,
1336                               GCancellable     *cancellable,
1337                               GError          **error)
1338 {
1339   gboolean ret;
1340
1341   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1342   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1343
1344   ret = FALSE;
1345
1346   /* This is only a best-effort attempt to see whether the connection is
1347    * closed, so it doesn't need the lock. If the connection closes just
1348    * after this check, but before scheduling the flush operation, the
1349    * result will be more or less the same as if the connection closed while
1350    * the flush operation was pending - it'll fail with either CLOSED or
1351    * CANCELLED.
1352    */
1353   if (!check_unclosed (connection, 0, error))
1354     goto out;
1355
1356   if (connection->kdbus_worker)
1357     {
1358       ret = TRUE;
1359       goto out;
1360     }
1361
1362   g_assert (connection->worker != NULL);
1363
1364   ret = _g_dbus_worker_flush_sync (connection->worker,
1365                                    cancellable,
1366                                    error);
1367
1368  out:
1369   return ret;
1370 }
1371
1372 /* ---------------------------------------------------------------------------------------------------- */
1373
1374 typedef struct
1375 {
1376   GDBusConnection *connection;
1377   GError *error;
1378   gboolean remote_peer_vanished;
1379 } EmitClosedData;
1380
1381 static void
1382 emit_closed_data_free (EmitClosedData *data)
1383 {
1384   g_object_unref (data->connection);
1385   if (data->error != NULL)
1386     g_error_free (data->error);
1387   g_free (data);
1388 }
1389
1390 /* Called in a user thread that has acquired the main context that was
1391  * thread-default when the object was constructed
1392  */
1393 static gboolean
1394 emit_closed_in_idle (gpointer user_data)
1395 {
1396   EmitClosedData *data = user_data;
1397   gboolean result;
1398
1399   g_object_notify (G_OBJECT (data->connection), "closed");
1400   g_signal_emit (data->connection,
1401                  signals[CLOSED_SIGNAL],
1402                  0,
1403                  data->remote_peer_vanished,
1404                  data->error,
1405                  &result);
1406   return FALSE;
1407 }
1408
1409 /* Can be called from any thread, must hold lock.
1410  * FLAG_CLOSED must already have been set.
1411  */
1412 static void
1413 schedule_closed_unlocked (GDBusConnection *connection,
1414                           gboolean         remote_peer_vanished,
1415                           GError          *error)
1416 {
1417   GSource *idle_source;
1418   EmitClosedData *data;
1419
1420   CONNECTION_ENSURE_LOCK (connection);
1421
1422   data = g_new0 (EmitClosedData, 1);
1423   data->connection = g_object_ref (connection);
1424   data->remote_peer_vanished = remote_peer_vanished;
1425   data->error = error != NULL ? g_error_copy (error) : NULL;
1426
1427   idle_source = g_idle_source_new ();
1428   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1429   g_source_set_callback (idle_source,
1430                          emit_closed_in_idle,
1431                          data,
1432                          (GDestroyNotify) emit_closed_data_free);
1433   g_source_set_name (idle_source, "[gio] emit_closed_in_idle");
1434   g_source_attach (idle_source, connection->main_context_at_construction);
1435   g_source_unref (idle_source);
1436 }
1437
1438 /* ---------------------------------------------------------------------------------------------------- */
1439
1440 /**
1441  * g_dbus_connection_close:
1442  * @connection: a #GDBusConnection
1443  * @cancellable: (allow-none): a #GCancellable or %NULL
1444  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
1445  *     satisfied or %NULL if you don't care about the result
1446  * @user_data: The data to pass to @callback
1447  *
1448  * Closes @connection. Note that this never causes the process to
1449  * exit (this might only happen if the other end of a shared message
1450  * bus connection disconnects, see #GDBusConnection:exit-on-close).
1451  *
1452  * Once the connection is closed, operations such as sending a message
1453  * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
1454  * will not automatically flush the connection so queued messages may
1455  * be lost. Use g_dbus_connection_flush() if you need such guarantees.
1456  *
1457  * If @connection is already closed, this method fails with
1458  * %G_IO_ERROR_CLOSED.
1459  *
1460  * When @connection has been closed, the #GDBusConnection::closed
1461  * signal is emitted in the
1462  * [thread-default main context][g-main-context-push-thread-default]
1463  * of the thread that @connection was constructed in.
1464  *
1465  * This is an asynchronous method. When the operation is finished,
1466  * @callback will be invoked in the
1467  * [thread-default main context][g-main-context-push-thread-default]
1468  * of the thread you are calling this method from. You can
1469  * then call g_dbus_connection_close_finish() to get the result of the
1470  * operation. See g_dbus_connection_close_sync() for the synchronous
1471  * version.
1472  *
1473  * Since: 2.26
1474  */
1475 void
1476 g_dbus_connection_close (GDBusConnection     *connection,
1477                          GCancellable        *cancellable,
1478                          GAsyncReadyCallback  callback,
1479                          gpointer             user_data)
1480 {
1481   GSimpleAsyncResult *simple;
1482
1483   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1484
1485   /* do not use g_return_val_if_fail(), we want the memory barrier */
1486   if (!check_initialized (connection))
1487     return;
1488
1489   g_assert (connection->worker != NULL);
1490
1491   simple = g_simple_async_result_new (G_OBJECT (connection),
1492                                       callback,
1493                                       user_data,
1494                                       g_dbus_connection_close);
1495   g_simple_async_result_set_check_cancellable (simple, cancellable);
1496   _g_dbus_worker_close (connection->worker, cancellable, simple);
1497   g_object_unref (simple);
1498 }
1499
1500 /**
1501  * g_dbus_connection_close_finish:
1502  * @connection: a #GDBusConnection
1503  * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
1504  *     to g_dbus_connection_close()
1505  * @error: return location for error or %NULL
1506  *
1507  * Finishes an operation started with g_dbus_connection_close().
1508  *
1509  * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1510  *
1511  * Since: 2.26
1512  */
1513 gboolean
1514 g_dbus_connection_close_finish (GDBusConnection  *connection,
1515                                 GAsyncResult     *res,
1516                                 GError          **error)
1517 {
1518   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1519   gboolean ret;
1520
1521   ret = FALSE;
1522
1523   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1524   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1525   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1526
1527   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_close);
1528
1529   if (g_simple_async_result_propagate_error (simple, error))
1530     goto out;
1531
1532   ret = TRUE;
1533
1534  out:
1535   return ret;
1536 }
1537
1538 typedef struct {
1539     GMainLoop *loop;
1540     GAsyncResult *result;
1541 } SyncCloseData;
1542
1543 /* Can be called by any thread, without the connection lock */
1544 static void
1545 sync_close_cb (GObject *source_object,
1546                GAsyncResult *res,
1547                gpointer user_data)
1548 {
1549   SyncCloseData *data = user_data;
1550
1551   data->result = g_object_ref (res);
1552   g_main_loop_quit (data->loop);
1553 }
1554
1555 /**
1556  * g_dbus_connection_close_sync:
1557  * @connection: a #GDBusConnection
1558  * @cancellable: (allow-none): a #GCancellable or %NULL
1559  * @error: return location for error or %NULL
1560  *
1561  * Synchronously closees @connection. The calling thread is blocked
1562  * until this is done. See g_dbus_connection_close() for the
1563  * asynchronous version of this method and more details about what it
1564  * does.
1565  *
1566  * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1567  *
1568  * Since: 2.26
1569  */
1570 gboolean
1571 g_dbus_connection_close_sync (GDBusConnection  *connection,
1572                               GCancellable     *cancellable,
1573                               GError          **error)
1574 {
1575   gboolean ret;
1576
1577   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1578   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1579
1580   ret = FALSE;
1581
1582   if (check_unclosed (connection, 0, error))
1583     {
1584       GMainContext *context;
1585       SyncCloseData data;
1586
1587       context = g_main_context_new ();
1588       g_main_context_push_thread_default (context);
1589       data.loop = g_main_loop_new (context, TRUE);
1590       data.result = NULL;
1591
1592       g_dbus_connection_close (connection, cancellable, sync_close_cb, &data);
1593       g_main_loop_run (data.loop);
1594       ret = g_dbus_connection_close_finish (connection, data.result, error);
1595
1596       g_object_unref (data.result);
1597       g_main_loop_unref (data.loop);
1598       g_main_context_pop_thread_default (context);
1599       g_main_context_unref (context);
1600     }
1601
1602   return ret;
1603 }
1604
1605 /* ---------------------------------------------------------------------------------------------------- */
1606
1607 /**
1608  * g_dbus_request_name:
1609  * @connection: a #GDBusConnection
1610  * @name: well-known bus name (name to request)
1611  * @flags: a set of flags from the GBusNameOwnerFlags enumeration
1612  * @error: return location for error or %NULL
1613  *
1614  * Synchronously acquires name on the bus and returns status code.
1615  *
1616  * The calling thread is blocked until a reply is received.
1617  *
1618  * Returns: status code or %G_BUS_REQUEST_NAME_FLAGS_ERROR
1619  *     if @error is set.
1620  *
1621  * Since: 2.4x
1622  */
1623 GBusRequestNameReplyFlags
1624 g_dbus_request_name (GDBusConnection     *connection,
1625                      const gchar         *name,
1626                      GBusNameOwnerFlags   flags,
1627                      GError             **error)
1628 {
1629   GVariant *result;
1630   guint32 request_name_reply;
1631
1632   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_BUS_RELEASE_NAME_FLAGS_ERROR);
1633   g_return_val_if_fail (g_dbus_is_name (name) && !g_dbus_is_unique_name (name), G_BUS_RELEASE_NAME_FLAGS_ERROR);
1634   g_return_val_if_fail (error == NULL || *error == NULL, G_BUS_RELEASE_NAME_FLAGS_ERROR);
1635
1636   if (connection->kdbus_worker)
1637     result = _g_kdbus_RequestName (connection->kdbus_worker, name, flags, error);
1638   else
1639     result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/org/freedesktop/DBus",
1640                                           "org.freedesktop.DBus", "RequestName",
1641                                           g_variant_new ("(su)", name, flags), G_VARIANT_TYPE ("(u)"),
1642                                           G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1643
1644   if (result != NULL)
1645     {
1646       g_variant_get (result, "(u)", &request_name_reply);
1647       g_variant_unref (result);
1648     }
1649   else
1650     request_name_reply = G_BUS_REQUEST_NAME_FLAGS_ERROR;
1651
1652   return (GBusRequestNameReplyFlags) request_name_reply;
1653 }
1654
1655 /**
1656  * g_dbus_release_name:
1657  * @connection: a #GDBusConnection
1658  * @name: well-known bus name (name to release)
1659  * @error: return location for error or %NULL
1660  *
1661  * Synchronously releases name on the bus and returns status code.
1662  *
1663  * The calling thread is blocked until a reply is received.
1664  *
1665  * Returns: status code or %G_BUS_RELEASE_NAME_FLAGS_ERROR
1666  *     if @error is set.
1667  *
1668  * Since: 2.4x
1669  */
1670 GBusReleaseNameReplyFlags
1671 g_dbus_release_name (GDBusConnection     *connection,
1672                      const gchar         *name,
1673                      GError             **error)
1674 {
1675   GVariant *result;
1676   guint32 release_name_reply;
1677
1678   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_BUS_RELEASE_NAME_FLAGS_ERROR);
1679   g_return_val_if_fail (g_dbus_is_name (name) && !g_dbus_is_unique_name (name), G_BUS_RELEASE_NAME_FLAGS_ERROR);
1680   g_return_val_if_fail (error == NULL || *error == NULL, G_BUS_RELEASE_NAME_FLAGS_ERROR);
1681
1682   if (connection->kdbus_worker)
1683     result = _g_kdbus_ReleaseName (connection->kdbus_worker, name, error);
1684   else
1685     result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/org/freedesktop/DBus",
1686                                           "org.freedesktop.DBus", "ReleaseName",
1687                                           g_variant_new ("(s)", name), G_VARIANT_TYPE ("(u)"),
1688                                           G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1689
1690   if (result != NULL)
1691     {
1692       g_variant_get (result, "(u)", &release_name_reply);
1693       g_variant_unref (result);
1694     }
1695   else
1696     release_name_reply = G_BUS_RELEASE_NAME_FLAGS_ERROR;
1697
1698   return (GBusReleaseNameReplyFlags) release_name_reply;
1699 }
1700
1701 /**
1702  * g_dbus_get_bus_id:
1703  * @connection: a #GDBusConnection
1704  * @error: return location for error or %NULL
1705  *
1706  * Synchronously returns the unique ID of the bus.
1707  *
1708  * The calling thread is blocked until a reply is received.
1709  *
1710  * Returns: the unique ID of the bus or %NULL if @error is set.
1711  *     Free with g_free().
1712  *
1713  * Since: 2.4x
1714  */
1715 gchar *
1716 g_dbus_get_bus_id (GDBusConnection  *connection,
1717                    GError          **error)
1718 {
1719   GVariant *result;
1720   gchar *bus_id;
1721
1722   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1723   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1724
1725   result = NULL;
1726   bus_id = NULL;
1727
1728   if (connection->kdbus_worker)
1729     {
1730       result = _g_kdbus_GetBusId (connection->kdbus_worker, error);
1731     }
1732   else
1733     {
1734       result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1735                                             "org.freedesktop.DBus", "GetId",
1736                                             NULL, G_VARIANT_TYPE ("(s)"),
1737                                             G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1738     }
1739
1740   if (result != NULL)
1741     {
1742       g_variant_get (result, "(s)", &bus_id);
1743       g_variant_unref (result);
1744     }
1745
1746   return bus_id;
1747 }
1748
1749 typedef enum
1750 {
1751   LIST_NAMES,
1752   LIST_ACTIVATABLE_NAMES,
1753   LIST_QUEUED_OWNERS
1754 } GDBusListNameType;
1755
1756 static gchar **
1757 _g_dbus_get_list_internal (GDBusConnection    *connection,
1758                            const gchar        *name,
1759                            GDBusListNameType   list_name_type,
1760                            GError            **error)
1761 {
1762   gchar **strv;
1763   GVariant *result;
1764   GVariantIter *iter;
1765   gchar *str;
1766   gsize n, i;
1767
1768   result = NULL;
1769   strv = NULL;
1770
1771   if (list_name_type == LIST_QUEUED_OWNERS)
1772     {
1773       if (connection->kdbus_worker)
1774         result = _g_kdbus_GetListQueuedOwners (connection->kdbus_worker, name, error);
1775       else
1776         result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1777                                               "org.freedesktop.DBus", "ListQueuedOwners",
1778                                               g_variant_new ("(s)", name), G_VARIANT_TYPE ("(as)"),
1779                                               G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1780     }
1781   else
1782     {
1783       gchar *method_name;
1784
1785       if (list_name_type == LIST_NAMES)
1786         method_name = "ListNames";
1787       else
1788         method_name = "ListActivatableNames";
1789
1790       if (connection->kdbus_worker)
1791         result = _g_kdbus_GetListNames (connection->kdbus_worker, list_name_type, error);
1792       else
1793         result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1794                                               "org.freedesktop.DBus", method_name,
1795                                               NULL, G_VARIANT_TYPE ("(as)"),
1796                                               G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1797     }
1798
1799   if (result != NULL)
1800     {
1801       g_variant_get (result, "(as)", &iter);
1802       n = g_variant_iter_n_children (iter);
1803       strv = g_new (gchar *, n + 1);
1804
1805       i = 0;
1806       while (g_variant_iter_loop (iter, "s", &str))
1807         {
1808           strv[i] = g_strdup (str);
1809           i++;
1810         }
1811       strv[i] = NULL;
1812
1813       g_variant_iter_free (iter);
1814       g_variant_unref (result);
1815     }
1816
1817   return strv;
1818 }
1819
1820 /**
1821  * g_dbus_get_list_names:
1822  * @connection: a #GDBusConnection
1823  * @error: return location for error or %NULL
1824  *
1825  * Synchronously returns a list of all currently-owned names on the bus.
1826  *
1827  * The calling thread is blocked until a reply is received.
1828  *
1829  * Returns: a list of all currently-owned names on the bus or %NULL if
1830  *     @error is set. Free with g_strfreev().
1831  *
1832  * Since: 2.4x
1833  */
1834 gchar **
1835 g_dbus_get_list_names (GDBusConnection  *connection,
1836                        GError          **error)
1837 {
1838   gchar **strv;
1839
1840   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1841   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1842
1843   strv = _g_dbus_get_list_internal (connection, NULL, LIST_NAMES, error);
1844
1845   return strv;
1846 }
1847
1848 /**
1849  * g_dbus_get_list_activatable_names:
1850  * @connection: a #GDBusConnection
1851  * @error: return location for error or %NULL
1852  *
1853  * Synchronously returns a list of all names that can be activated on the bus.
1854  *
1855  * The calling thread is blocked until a reply is received.
1856  *
1857  * Returns: a list of all names that can be activated on the bus or %NULL if
1858  *     @error is set. Free with g_strfreev().
1859  *
1860  * Since: 2.4x
1861  */
1862 gchar **
1863 g_dbus_get_list_activatable_names (GDBusConnection  *connection,
1864                                    GError          **error)
1865 {
1866   gchar **strv;
1867
1868   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1869   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1870
1871   strv = _g_dbus_get_list_internal (connection, NULL, LIST_ACTIVATABLE_NAMES, error);
1872
1873   return strv;
1874 }
1875
1876 /**
1877  * g_dbus_get_list_queued_names:
1878  * @connection: a #GDBusConnection
1879  * @name: a unique or well-known bus name
1880  * @error: return location for error or %NULL
1881  *
1882  * Synchronously returns the unique bus names of connections currently queued
1883  * for the @name.
1884  *
1885  * If @name contains a value not compatible with the D-Bus syntax and naming
1886  * conventions for bus names, the operation returns %NULL and @error is set.
1887  *
1888  * The calling thread is blocked until a reply is received.
1889  *
1890  * Returns: the unique bus names of connections currently queued for the @name
1891  *     or %NULL if @error is set. Free with g_strfreev().
1892  *
1893  * Since: 2.4x
1894  */
1895 gchar **
1896 g_dbus_get_list_queued_owners (GDBusConnection  *connection,
1897                                const gchar      *name,
1898                                GError          **error)
1899 {
1900   gchar **strv;
1901
1902   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1903   g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
1904   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1905
1906   strv = _g_dbus_get_list_internal (connection, name, LIST_QUEUED_OWNERS, error);
1907
1908   return strv;
1909 }
1910
1911 /**
1912  * g_dbus_get_name_owner:
1913  * @connection: a #GDBusConnection
1914  * @name: well-known bus name to get the owner of
1915  * @error: return location for error or %NULL
1916  *
1917  * Synchronously returns the unique connection name of the primary owner of
1918  * the name given. If the requested name doesn't have an owner, an @error is
1919  * returned.
1920  *
1921  * If @name contains a value not compatible with the D-Bus syntax and naming
1922  * conventions for bus names, the operation returns %NULL and @error is set.
1923  *
1924  * The calling thread is blocked until a reply is received.
1925  *
1926  * Returns: the unique connection name of the primary owner of the
1927  *     name given. If the requested name doesn't have an owner, function
1928  *     returns %NULL and @error is set. Free with g_free().
1929  *
1930  * Since: 2.4x
1931  */
1932 gchar *
1933 g_dbus_get_name_owner (GDBusConnection  *connection,
1934                        const gchar      *name,
1935                        GError          **error)
1936 {
1937   GVariant *result;
1938   gchar *name_owner;
1939
1940   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1941   g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
1942   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1943
1944   name_owner = NULL;
1945   result = NULL;
1946
1947   if (connection->kdbus_worker)
1948     result = _g_kdbus_GetNameOwner (connection->kdbus_worker, name, error);
1949   else
1950     result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1951                                           "org.freedesktop.DBus", "GetNameOwner",
1952                                           g_variant_new ("(s)", name), G_VARIANT_TYPE ("(s)"),
1953                                           G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1954   if (result != NULL)
1955     {
1956       g_variant_get (result, "(s)", &name_owner);
1957       g_variant_unref (result);
1958     }
1959   else
1960     name_owner = NULL;
1961
1962   return name_owner;
1963 }
1964
1965 /**
1966  * g_dbus_get_connection_pid:
1967  * @connection: a #GDBusConnection
1968  * @name: a unique or well-known bus name of the connection to query
1969  * @error: return location for error or %NULL
1970  *
1971  * Synchronously returns the Unix process ID of the process connected to the
1972  * bus. If unable to determine it, an @error is returned.
1973  *
1974  * If @name contains a value not compatible with the D-Bus syntax and naming
1975  * conventions for bus names, the operation returns (guint32) -1 and @error
1976  * is set.
1977  *
1978  * The calling thread is blocked until a reply is received.
1979  *
1980  * Returns: the Unix process ID of the process connected to the bus or
1981  *     (guint32) -1 if @error is set.
1982  *
1983  * Since: 2.4x
1984  */
1985 guint32
1986 g_dbus_get_connection_pid (GDBusConnection  *connection,
1987                            const gchar      *name,
1988                            GError          **error)
1989 {
1990   GVariant *result;
1991   guint32 pid;
1992
1993   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), -1);
1994   g_return_val_if_fail (name == NULL || g_dbus_is_name (name), -1);
1995   g_return_val_if_fail (error == NULL || *error == NULL, -1);
1996
1997   result = NULL;
1998   pid = -1;
1999
2000   if (connection->kdbus_worker)
2001     result = _g_kdbus_GetConnectionUnixProcessID (connection->kdbus_worker, name, error);
2002   else
2003     result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
2004                                           "org.freedesktop.DBus", "GetConnectionUnixProcessID",
2005                                           g_variant_new ("(s)", name), G_VARIANT_TYPE ("(u)"),
2006                                           G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
2007   if (result != NULL)
2008     {
2009       g_variant_get (result, "(u)", &pid);
2010       g_variant_unref (result);
2011     }
2012
2013   return pid;
2014 }
2015
2016 /**
2017  * g_dbus_get_connection_uid:
2018  * @connection: a #GDBusConnection
2019  * @name: a unique or well-known bus name of the connection to query
2020  * @error: return location for error or %NULL
2021  *
2022  * Synchronously returns the Unix user ID of the process connected to the
2023  * bus. If unable to determine it, an @error is returned.
2024  *
2025  * If @name contains a value not compatible with the D-Bus syntax and naming
2026  * conventions for bus names, the operation returns (guint32) -1 and @error
2027  * is set.
2028  *
2029  * The calling thread is blocked until a reply is received.
2030  *
2031  * Returns: the Unix user ID of the process connected to the bus or
2032  *     (guint32) -1 if @error is set.
2033  *
2034  * Since: 2.4x
2035  */
2036 guint32
2037 g_dbus_get_connection_uid (GDBusConnection  *connection,
2038                            const gchar      *name,
2039                            GError          **error)
2040 {
2041   GVariant *result;
2042   guint32 uid;
2043
2044   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), -1);
2045   g_return_val_if_fail (name == NULL || g_dbus_is_name (name), -1);
2046   g_return_val_if_fail (error == NULL || *error == NULL, -1);
2047
2048   result = NULL;
2049   uid = -1;
2050
2051   if (connection->kdbus_worker)
2052     result = _g_kdbus_GetConnectionUnixUser (connection->kdbus_worker, name, error);
2053   else
2054     result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
2055                                           "org.freedesktop.DBus", "GetConnectionUnixUser",
2056                                           g_variant_new ("(s)", name), G_VARIANT_TYPE ("(u)"),
2057                                           G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
2058   if (result != NULL)
2059     {
2060       g_variant_get (result, "(u)", &uid);
2061       g_variant_unref (result);
2062     }
2063
2064   return uid;
2065 }
2066
2067 /* ---------------------------------------------------------------------------------------------------- */
2068
2069 /**
2070  * g_dbus_connection_get_last_serial:
2071  * @connection: a #GDBusConnection
2072  *
2073  * Retrieves the last serial number assigned to a #GDBusMessage on
2074  * the current thread. This includes messages sent via both low-level
2075  * API such as g_dbus_connection_send_message() as well as
2076  * high-level API such as g_dbus_connection_emit_signal(),
2077  * g_dbus_connection_call() or g_dbus_proxy_call().
2078  *
2079  * Returns: the last used serial or zero when no message has been sent
2080  *     within the current thread
2081  *
2082  * Since: 2.34
2083  */
2084 guint32
2085 g_dbus_connection_get_last_serial (GDBusConnection *connection)
2086 {
2087   guint32 ret;
2088
2089   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2090
2091   CONNECTION_LOCK (connection);
2092   ret = GPOINTER_TO_UINT (g_hash_table_lookup (connection->map_thread_to_last_serial,
2093                                                g_thread_self ()));
2094   CONNECTION_UNLOCK (connection);
2095
2096   return ret;
2097 }
2098
2099 /* ---------------------------------------------------------------------------------------------------- */
2100 #include "gkdbus.h"
2101 /* Can be called by any thread, with the connection lock held */
2102 static gboolean
2103 g_dbus_connection_send_message_unlocked (GDBusConnection   *connection,
2104                                          GDBusMessage      *message,
2105                                          GDBusSendMessageFlags flags,
2106                                          volatile guint32  *out_serial,
2107                                          GError           **error)
2108 {
2109   guchar *blob;
2110   gsize blob_size;
2111   guint32 serial_to_use;
2112   gboolean ret;
2113
2114   CONNECTION_ENSURE_LOCK (connection);
2115
2116   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2117   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2118
2119   /* TODO: check all necessary headers are present */
2120
2121   ret = FALSE;
2122   blob = NULL;
2123
2124   if (out_serial != NULL)
2125     *out_serial = 0;
2126
2127   /* If we're in initable_init(), don't check for being initialized, to avoid
2128    * chicken-and-egg problems. initable_init() is responsible for setting up
2129    * our prerequisites (mainly connection->worker), and only calling us
2130    * from its own thread (so no memory barrier is needed).
2131    */
2132   if (!check_unclosed (connection,
2133                        (flags & SEND_MESSAGE_FLAGS_INITIALIZING) ? MAY_BE_UNINITIALIZED : 0,
2134                        error))
2135     goto out;
2136
2137   if (!(flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL))
2138     g_dbus_message_set_serial (message, ++connection->last_serial);
2139
2140   serial_to_use = g_dbus_message_get_serial (message);
2141
2142   /*
2143    * serializes message to a blob
2144    */
2145   if (connection->worker)
2146     {
2147       blob = g_dbus_message_to_blob (message,
2148                                      &blob_size,
2149                                      connection->capabilities,
2150                                      error);
2151       if (blob == NULL)
2152         goto out;
2153
2154       switch (blob[0])
2155         {
2156         case 'l':
2157           ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
2158           break;
2159         case 'B':
2160           ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
2161           break;
2162         default:
2163           g_assert_not_reached ();
2164           break;
2165         }
2166     }
2167
2168   g_dbus_message_lock (message);
2169
2170 #if 0
2171   g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
2172               blob_size, serial_to_use, connection);
2173   g_printerr ("----\n");
2174   hexdump (blob, blob_size);
2175   g_printerr ("----\n");
2176 #endif
2177
2178   /* TODO: use connection->auth to encode the blob */
2179
2180   if (out_serial != NULL)
2181     *out_serial = serial_to_use;
2182
2183   /* store used serial for the current thread */
2184   /* TODO: watch the thread disposal and remove associated record
2185    *       from hashtable
2186    *  - see https://bugzilla.gnome.org/show_bug.cgi?id=676825#c7
2187    */
2188   g_hash_table_replace (connection->map_thread_to_last_serial,
2189                         g_thread_self (),
2190                         GUINT_TO_POINTER (serial_to_use));
2191
2192   ret = TRUE;
2193
2194   if (connection->worker)
2195     _g_dbus_worker_send_message (connection->worker,
2196                                  message,
2197                                  (gchar*) blob,
2198                                  blob_size);
2199   else
2200     ret = g_kdbus_worker_send_message (connection->kdbus_worker, message, error);
2201
2202   blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
2203
2204  out:
2205   g_free (blob);
2206
2207   return ret;
2208 }
2209
2210 /**
2211  * g_dbus_connection_send_message:
2212  * @connection: a #GDBusConnection
2213  * @message: a #GDBusMessage
2214  * @flags: flags affecting how the message is sent
2215  * @out_serial: (out) (allow-none): return location for serial number assigned
2216  *     to @message when sending it or %NULL
2217  * @error: Return location for error or %NULL
2218  *
2219  * Asynchronously sends @message to the peer represented by @connection.
2220  *
2221  * Unless @flags contain the
2222  * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2223  * will be assigned by @connection and set on @message via
2224  * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2225  * serial number used will be written to this location prior to
2226  * submitting the message to the underlying transport.
2227  *
2228  * If @connection is closed then the operation will fail with
2229  * %G_IO_ERROR_CLOSED. If @message is not well-formed,
2230  * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2231  *
2232  * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2233  * for an example of how to use this low-level API to send and receive
2234  * UNIX file descriptors.
2235  *
2236  * Note that @message must be unlocked, unless @flags contain the
2237  * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2238  *
2239  * Returns: %TRUE if the message was well-formed and queued for
2240  *     transmission, %FALSE if @error is set
2241  *
2242  * Since: 2.26
2243  */
2244 gboolean
2245 g_dbus_connection_send_message (GDBusConnection        *connection,
2246                                 GDBusMessage           *message,
2247                                 GDBusSendMessageFlags   flags,
2248                                 volatile guint32       *out_serial,
2249                                 GError                **error)
2250 {
2251   gboolean ret;
2252
2253   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2254   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2255   g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
2256   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
2257
2258   CONNECTION_LOCK (connection);
2259   ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
2260   CONNECTION_UNLOCK (connection);
2261   return ret;
2262 }
2263
2264 /* ---------------------------------------------------------------------------------------------------- */
2265
2266 typedef struct
2267 {
2268   volatile gint ref_count;
2269   GDBusConnection *connection;
2270   guint32 serial;
2271   GSimpleAsyncResult *simple;
2272
2273   GMainContext *main_context;
2274
2275   GCancellable *cancellable;
2276
2277   gulong cancellable_handler_id;
2278
2279   GSource *timeout_source;
2280
2281   gboolean delivered;
2282 } SendMessageData;
2283
2284 /* Can be called from any thread with or without lock held */
2285 static SendMessageData *
2286 send_message_data_ref (SendMessageData *data)
2287 {
2288   g_atomic_int_inc (&data->ref_count);
2289   return data;
2290 }
2291
2292 /* Can be called from any thread with or without lock held */
2293 static void
2294 send_message_data_unref (SendMessageData *data)
2295 {
2296   if (g_atomic_int_dec_and_test (&data->ref_count))
2297     {
2298       g_assert (data->timeout_source == NULL);
2299       g_assert (data->simple == NULL);
2300       g_assert (data->cancellable_handler_id == 0);
2301       g_object_unref (data->connection);
2302       if (data->cancellable != NULL)
2303         g_object_unref (data->cancellable);
2304       g_main_context_unref (data->main_context);
2305       g_free (data);
2306     }
2307 }
2308
2309 /* ---------------------------------------------------------------------------------------------------- */
2310
2311 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
2312 static void
2313 send_message_with_reply_deliver (SendMessageData *data, gboolean remove)
2314 {
2315   CONNECTION_ENSURE_LOCK (data->connection);
2316
2317   g_assert (!data->delivered);
2318
2319   data->delivered = TRUE;
2320
2321   g_simple_async_result_complete_in_idle (data->simple);
2322   g_object_unref (data->simple);
2323   data->simple = NULL;
2324
2325   if (data->timeout_source != NULL)
2326     {
2327       g_source_destroy (data->timeout_source);
2328       data->timeout_source = NULL;
2329     }
2330   if (data->cancellable_handler_id > 0)
2331     {
2332       g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
2333       data->cancellable_handler_id = 0;
2334     }
2335
2336   if (remove)
2337     {
2338       g_warn_if_fail (g_hash_table_remove (data->connection->map_method_serial_to_send_message_data,
2339                                            GUINT_TO_POINTER (data->serial)));
2340     }
2341
2342   send_message_data_unref (data);
2343 }
2344
2345 /* ---------------------------------------------------------------------------------------------------- */
2346
2347 /* Can be called from any thread with lock held */
2348 static void
2349 send_message_data_deliver_reply_unlocked (SendMessageData *data,
2350                                           GDBusMessage    *reply)
2351 {
2352   if (data->delivered)
2353     goto out;
2354
2355   g_simple_async_result_set_op_res_gpointer (data->simple,
2356                                              g_object_ref (reply),
2357                                              g_object_unref);
2358
2359   send_message_with_reply_deliver (data, TRUE);
2360
2361  out:
2362   ;
2363 }
2364
2365 /* ---------------------------------------------------------------------------------------------------- */
2366
2367 /* Called from a user thread, lock is not held */
2368 static gboolean
2369 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
2370 {
2371   SendMessageData *data = user_data;
2372
2373   CONNECTION_LOCK (data->connection);
2374   if (data->delivered)
2375     goto out;
2376
2377   g_simple_async_result_set_error (data->simple,
2378                                    G_IO_ERROR,
2379                                    G_IO_ERROR_CANCELLED,
2380                                    _("Operation was cancelled"));
2381
2382   send_message_with_reply_deliver (data, TRUE);
2383
2384  out:
2385   CONNECTION_UNLOCK (data->connection);
2386   return FALSE;
2387 }
2388
2389 /* Can be called from any thread with or without lock held */
2390 static void
2391 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
2392                                       gpointer      user_data)
2393 {
2394   SendMessageData *data = user_data;
2395   GSource *idle_source;
2396
2397   /* postpone cancellation to idle handler since we may be called directly
2398    * via g_cancellable_connect() (e.g. holding lock)
2399    */
2400   idle_source = g_idle_source_new ();
2401   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
2402   g_source_set_callback (idle_source,
2403                          send_message_with_reply_cancelled_idle_cb,
2404                          send_message_data_ref (data),
2405                          (GDestroyNotify) send_message_data_unref);
2406   g_source_set_name (idle_source, "[gio] send_message_with_reply_cancelled_idle_cb");
2407   g_source_attach (idle_source, data->main_context);
2408   g_source_unref (idle_source);
2409 }
2410
2411 /* ---------------------------------------------------------------------------------------------------- */
2412
2413 /* Called from a user thread, lock is not held */
2414 static gboolean
2415 send_message_with_reply_timeout_cb (gpointer user_data)
2416 {
2417   SendMessageData *data = user_data;
2418
2419   CONNECTION_LOCK (data->connection);
2420   if (data->delivered)
2421     goto out;
2422
2423   g_simple_async_result_set_error (data->simple,
2424                                    G_IO_ERROR,
2425                                    G_IO_ERROR_TIMED_OUT,
2426                                    _("Timeout was reached"));
2427
2428   send_message_with_reply_deliver (data, TRUE);
2429
2430  out:
2431   CONNECTION_UNLOCK (data->connection);
2432
2433   return FALSE;
2434 }
2435
2436 /* ---------------------------------------------------------------------------------------------------- */
2437
2438 /* Called from a user thread, connection's lock is held */
2439 static void
2440 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection     *connection,
2441                                                     GDBusMessage        *message,
2442                                                     GDBusSendMessageFlags flags,
2443                                                     gint                 timeout_msec,
2444                                                     volatile guint32    *out_serial,
2445                                                     GCancellable        *cancellable,
2446                                                     GAsyncReadyCallback  callback,
2447                                                     gpointer             user_data)
2448 {
2449   GSimpleAsyncResult *simple;
2450   SendMessageData *data;
2451   GError *error;
2452   volatile guint32 serial;
2453
2454   data = NULL;
2455
2456   if (out_serial == NULL)
2457     out_serial = &serial;
2458
2459   if (timeout_msec == -1)
2460     timeout_msec = 25 * 1000;
2461
2462   simple = g_simple_async_result_new (G_OBJECT (connection),
2463                                       callback,
2464                                       user_data,
2465                                       g_dbus_connection_send_message_with_reply);
2466   g_simple_async_result_set_check_cancellable (simple, cancellable);
2467
2468   if (g_cancellable_is_cancelled (cancellable))
2469     {
2470       g_simple_async_result_set_error (simple,
2471                                        G_IO_ERROR,
2472                                        G_IO_ERROR_CANCELLED,
2473                                        _("Operation was cancelled"));
2474       g_simple_async_result_complete_in_idle (simple);
2475       g_object_unref (simple);
2476       goto out;
2477     }
2478
2479   error = NULL;
2480   if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
2481     {
2482       g_simple_async_result_take_error (simple, error);
2483       g_simple_async_result_complete_in_idle (simple);
2484       g_object_unref (simple);
2485       goto out;
2486     }
2487
2488   data = g_new0 (SendMessageData, 1);
2489   data->ref_count = 1;
2490   data->connection = g_object_ref (connection);
2491   data->simple = simple;
2492   data->serial = *out_serial;
2493   data->main_context = g_main_context_ref_thread_default ();
2494
2495   if (cancellable != NULL)
2496     {
2497       data->cancellable = g_object_ref (cancellable);
2498       data->cancellable_handler_id = g_cancellable_connect (cancellable,
2499                                                             G_CALLBACK (send_message_with_reply_cancelled_cb),
2500                                                             send_message_data_ref (data),
2501                                                             (GDestroyNotify) send_message_data_unref);
2502     }
2503
2504   if (timeout_msec != G_MAXINT)
2505     {
2506       data->timeout_source = g_timeout_source_new (timeout_msec);
2507       g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
2508       g_source_set_callback (data->timeout_source,
2509                              send_message_with_reply_timeout_cb,
2510                              send_message_data_ref (data),
2511                              (GDestroyNotify) send_message_data_unref);
2512       g_source_attach (data->timeout_source, data->main_context);
2513       g_source_unref (data->timeout_source);
2514     }
2515
2516   g_hash_table_insert (connection->map_method_serial_to_send_message_data,
2517                        GUINT_TO_POINTER (*out_serial),
2518                        data);
2519
2520  out:
2521   ;
2522 }
2523
2524 /**
2525  * g_dbus_connection_send_message_with_reply:
2526  * @connection: a #GDBusConnection
2527  * @message: a #GDBusMessage
2528  * @flags: flags affecting how the message is sent
2529  * @timeout_msec: the timeout in milliseconds, -1 to use the default
2530  *     timeout or %G_MAXINT for no timeout
2531  * @out_serial: (out) (allow-none): return location for serial number assigned
2532  *     to @message when sending it or %NULL
2533  * @cancellable: (allow-none): a #GCancellable or %NULL
2534  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
2535  *     is satisfied or %NULL if you don't care about the result
2536  * @user_data: The data to pass to @callback
2537  *
2538  * Asynchronously sends @message to the peer represented by @connection.
2539  *
2540  * Unless @flags contain the
2541  * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2542  * will be assigned by @connection and set on @message via
2543  * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2544  * serial number used will be written to this location prior to
2545  * submitting the message to the underlying transport.
2546  *
2547  * If @connection is closed then the operation will fail with
2548  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2549  * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2550  * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2551  *
2552  * This is an asynchronous method. When the operation is finished, @callback
2553  * will be invoked in the
2554  * [thread-default main context][g-main-context-push-thread-default]
2555  * of the thread you are calling this method from. You can then call
2556  * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
2557  * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
2558  *
2559  * Note that @message must be unlocked, unless @flags contain the
2560  * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2561  *
2562  * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2563  * for an example of how to use this low-level API to send and receive
2564  * UNIX file descriptors.
2565  *
2566  * Since: 2.26
2567  */
2568 void
2569 g_dbus_connection_send_message_with_reply (GDBusConnection       *connection,
2570                                            GDBusMessage          *message,
2571                                            GDBusSendMessageFlags  flags,
2572                                            gint                   timeout_msec,
2573                                            volatile guint32      *out_serial,
2574                                            GCancellable          *cancellable,
2575                                            GAsyncReadyCallback    callback,
2576                                            gpointer               user_data)
2577 {
2578   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2579   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2580   g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
2581   g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
2582
2583   CONNECTION_LOCK (connection);
2584   g_dbus_connection_send_message_with_reply_unlocked (connection,
2585                                                       message,
2586                                                       flags,
2587                                                       timeout_msec,
2588                                                       out_serial,
2589                                                       cancellable,
2590                                                       callback,
2591                                                       user_data);
2592   CONNECTION_UNLOCK (connection);
2593 }
2594
2595 /**
2596  * g_dbus_connection_send_message_with_reply_finish:
2597  * @connection: a #GDBusConnection
2598  * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
2599  *     g_dbus_connection_send_message_with_reply()
2600  * @error: teturn location for error or %NULL
2601  *
2602  * Finishes an operation started with g_dbus_connection_send_message_with_reply().
2603  *
2604  * Note that @error is only set if a local in-process error
2605  * occurred. That is to say that the returned #GDBusMessage object may
2606  * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2607  * g_dbus_message_to_gerror() to transcode this to a #GError.
2608  *
2609  * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2610  * for an example of how to use this low-level API to send and receive
2611  * UNIX file descriptors.
2612  *
2613  * Returns: (transfer full): a locked #GDBusMessage or %NULL if @error is set
2614  *
2615  * Since: 2.26
2616  */
2617 GDBusMessage *
2618 g_dbus_connection_send_message_with_reply_finish (GDBusConnection  *connection,
2619                                                   GAsyncResult     *res,
2620                                                   GError          **error)
2621 {
2622   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2623   GDBusMessage *reply;
2624
2625   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2626   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2627
2628   reply = NULL;
2629
2630   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
2631
2632   if (g_simple_async_result_propagate_error (simple, error))
2633     goto out;
2634
2635   reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
2636
2637  out:
2638   return reply;
2639 }
2640
2641 /* ---------------------------------------------------------------------------------------------------- */
2642
2643 typedef struct
2644 {
2645   GAsyncResult *res;
2646   GMainContext *context;
2647   GMainLoop *loop;
2648 } SendMessageSyncData;
2649
2650 /* Called from a user thread, lock is not held */
2651 static void
2652 send_message_with_reply_sync_cb (GDBusConnection *connection,
2653                                  GAsyncResult    *res,
2654                                  gpointer         user_data)
2655 {
2656   SendMessageSyncData *data = user_data;
2657   data->res = g_object_ref (res);
2658   g_main_loop_quit (data->loop);
2659 }
2660
2661 /**
2662  * g_dbus_connection_send_message_with_reply_sync:
2663  * @connection: a #GDBusConnection
2664  * @message: a #GDBusMessage
2665  * @flags: flags affecting how the message is sent.
2666  * @timeout_msec: the timeout in milliseconds, -1 to use the default
2667  *     timeout or %G_MAXINT for no timeout
2668  * @out_serial: (out) (allow-none): return location for serial number
2669  *     assigned to @message when sending it or %NULL
2670  * @cancellable: (allow-none): a #GCancellable or %NULL
2671  * @error: return location for error or %NULL
2672  *
2673  * Synchronously sends @message to the peer represented by @connection
2674  * and blocks the calling thread until a reply is received or the
2675  * timeout is reached. See g_dbus_connection_send_message_with_reply()
2676  * for the asynchronous version of this method.
2677  *
2678  * Unless @flags contain the
2679  * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2680  * will be assigned by @connection and set on @message via
2681  * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2682  * serial number used will be written to this location prior to
2683  * submitting the message to the underlying transport.
2684  *
2685  * If @connection is closed then the operation will fail with
2686  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2687  * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2688  * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2689  *
2690  * Note that @error is only set if a local in-process error
2691  * occurred. That is to say that the returned #GDBusMessage object may
2692  * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2693  * g_dbus_message_to_gerror() to transcode this to a #GError.
2694  *
2695  * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2696  * for an example of how to use this low-level API to send and receive
2697  * UNIX file descriptors.
2698  *
2699  * Note that @message must be unlocked, unless @flags contain the
2700  * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2701  *
2702  * Returns: (transfer full): a locked #GDBusMessage that is the reply
2703  *     to @message or %NULL if @error is set
2704  *
2705  * Since: 2.26
2706  */
2707 GDBusMessage *
2708 g_dbus_connection_send_message_with_reply_sync (GDBusConnection        *connection,
2709                                                 GDBusMessage           *message,
2710                                                 GDBusSendMessageFlags   flags,
2711                                                 gint                    timeout_msec,
2712                                                 volatile guint32       *out_serial,
2713                                                 GCancellable           *cancellable,
2714                                                 GError                **error)
2715 {
2716   SendMessageSyncData *data;
2717   GDBusMessage *reply;
2718
2719   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2720   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2721   g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), NULL);
2722   g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
2723   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2724
2725   data = g_new0 (SendMessageSyncData, 1);
2726
2727   if (connection->kdbus_worker)
2728     data->context = g_main_context_ref_thread_default ();
2729   else
2730      data->context = g_main_context_new ();
2731
2732   data->loop = g_main_loop_new (data->context, FALSE);
2733
2734   g_main_context_push_thread_default (data->context);
2735
2736   g_dbus_connection_send_message_with_reply (connection,
2737                                              message,
2738                                              flags,
2739                                              timeout_msec,
2740                                              out_serial,
2741                                              cancellable,
2742                                              (GAsyncReadyCallback) send_message_with_reply_sync_cb,
2743                                              data);
2744   g_main_loop_run (data->loop);
2745   reply = g_dbus_connection_send_message_with_reply_finish (connection,
2746                                                             data->res,
2747                                                             error);
2748
2749   g_main_context_pop_thread_default (data->context);
2750
2751   g_main_context_unref (data->context);
2752   g_main_loop_unref (data->loop);
2753   g_object_unref (data->res);
2754   g_free (data);
2755
2756   return reply;
2757 }
2758
2759 /* ---------------------------------------------------------------------------------------------------- */
2760
2761 typedef struct
2762 {
2763   GDBusMessageFilterFunction func;
2764   gpointer user_data;
2765 } FilterCallback;
2766
2767 typedef struct
2768 {
2769   guint                       id;
2770   GDBusMessageFilterFunction  filter_function;
2771   gpointer                    user_data;
2772   GDestroyNotify              user_data_free_func;
2773 } FilterData;
2774
2775 /* Called in GDBusWorker's thread - we must not block - with no lock held */
2776 static void
2777 on_worker_message_received (GDBusMessage *message,
2778                             gpointer      user_data)
2779 {
2780   GDBusConnection *connection;
2781   FilterCallback *filters;
2782   guint num_filters;
2783   guint n;
2784   gboolean alive;
2785
2786   G_LOCK (message_bus_lock);
2787   alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2788   if (!alive)
2789     {
2790       G_UNLOCK (message_bus_lock);
2791       return;
2792     }
2793   connection = G_DBUS_CONNECTION (user_data);
2794   g_object_ref (connection);
2795   G_UNLOCK (message_bus_lock);
2796
2797   //g_debug ("in on_worker_message_received");
2798
2799   g_object_ref (message);
2800   g_dbus_message_lock (message);
2801
2802   //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
2803
2804   /* First collect the set of callback functions */
2805   CONNECTION_LOCK (connection);
2806   num_filters = connection->filters->len;
2807   filters = g_new0 (FilterCallback, num_filters);
2808   for (n = 0; n < num_filters; n++)
2809     {
2810       FilterData *data = connection->filters->pdata[n];
2811       filters[n].func = data->filter_function;
2812       filters[n].user_data = data->user_data;
2813     }
2814   CONNECTION_UNLOCK (connection);
2815
2816   /* then call the filters in order (without holding the lock) */
2817   for (n = 0; n < num_filters; n++)
2818     {
2819       message = filters[n].func (connection,
2820                                  message,
2821                                  TRUE,
2822                                  filters[n].user_data);
2823       if (message == NULL)
2824         break;
2825       g_dbus_message_lock (message);
2826     }
2827
2828   /* Standard dispatch unless the filter ate the message - no need to
2829    * do anything if the message was altered
2830    */
2831   if (message != NULL)
2832     {
2833       GDBusMessageType message_type;
2834
2835       message_type = g_dbus_message_get_message_type (message);
2836       if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
2837         {
2838           guint32 reply_serial;
2839           SendMessageData *send_message_data;
2840
2841           reply_serial = g_dbus_message_get_reply_serial (message);
2842           CONNECTION_LOCK (connection);
2843           send_message_data = g_hash_table_lookup (connection->map_method_serial_to_send_message_data,
2844                                                    GUINT_TO_POINTER (reply_serial));
2845           if (send_message_data != NULL)
2846             {
2847               //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
2848               send_message_data_deliver_reply_unlocked (send_message_data, message);
2849             }
2850           else
2851             {
2852               //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
2853             }
2854           CONNECTION_UNLOCK (connection);
2855         }
2856       else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
2857         {
2858           CONNECTION_LOCK (connection);
2859           distribute_signals (connection, message);
2860           CONNECTION_UNLOCK (connection);
2861         }
2862       else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
2863         {
2864           CONNECTION_LOCK (connection);
2865           distribute_method_call (connection, message);
2866           CONNECTION_UNLOCK (connection);
2867         }
2868     }
2869
2870   if (message != NULL)
2871     g_object_unref (message);
2872   g_object_unref (connection);
2873   g_free (filters);
2874 }
2875
2876 /* Called in GDBusWorker's thread, lock is not held */
2877 static GDBusMessage *
2878 on_worker_message_about_to_be_sent (GDBusMessage *message,
2879                                     gpointer      user_data)
2880 {
2881   GDBusConnection *connection;
2882   FilterCallback *filters;
2883   guint num_filters;
2884   guint n;
2885   gboolean alive;
2886
2887   G_LOCK (message_bus_lock);
2888   alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2889   if (!alive)
2890     {
2891       G_UNLOCK (message_bus_lock);
2892       return message;
2893     }
2894   connection = G_DBUS_CONNECTION (user_data);
2895   g_object_ref (connection);
2896   G_UNLOCK (message_bus_lock);
2897
2898   //g_debug ("in on_worker_message_about_to_be_sent");
2899
2900   /* First collect the set of callback functions */
2901   CONNECTION_LOCK (connection);
2902   num_filters = connection->filters->len;
2903   filters = g_new0 (FilterCallback, num_filters);
2904   for (n = 0; n < num_filters; n++)
2905     {
2906       FilterData *data = connection->filters->pdata[n];
2907       filters[n].func = data->filter_function;
2908       filters[n].user_data = data->user_data;
2909     }
2910   CONNECTION_UNLOCK (connection);
2911
2912   /* then call the filters in order (without holding the lock) */
2913   for (n = 0; n < num_filters; n++)
2914     {
2915       g_dbus_message_lock (message);
2916       message = filters[n].func (connection,
2917                                  message,
2918                                  FALSE,
2919                                  filters[n].user_data);
2920       if (message == NULL)
2921         break;
2922     }
2923
2924   g_object_unref (connection);
2925   g_free (filters);
2926
2927   return message;
2928 }
2929
2930 /* called with connection lock held, in GDBusWorker thread */
2931 static gboolean
2932 cancel_method_on_close (gpointer key, gpointer value, gpointer user_data)
2933 {
2934   SendMessageData *data = value;
2935
2936   if (data->delivered)
2937     return FALSE;
2938
2939   g_simple_async_result_set_error (data->simple,
2940                                    G_IO_ERROR,
2941                                    G_IO_ERROR_CLOSED,
2942                                    _("The connection is closed"));
2943
2944   /* Ask send_message_with_reply_deliver not to remove the element from the
2945    * hash table - we're in the middle of a foreach; that would be unsafe.
2946    * Instead, return TRUE from this function so that it gets removed safely.
2947    */
2948   send_message_with_reply_deliver (data, FALSE);
2949   return TRUE;
2950 }
2951
2952 /* Called in GDBusWorker's thread - we must not block - without lock held */
2953 static void
2954 on_worker_closed (gboolean  remote_peer_vanished,
2955                   GError   *error,
2956                   gpointer  user_data)
2957 {
2958   GDBusConnection *connection;
2959   gboolean alive;
2960   guint old_atomic_flags;
2961
2962   G_LOCK (message_bus_lock);
2963   alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2964   if (!alive)
2965     {
2966       G_UNLOCK (message_bus_lock);
2967       return;
2968     }
2969   connection = G_DBUS_CONNECTION (user_data);
2970   g_object_ref (connection);
2971   G_UNLOCK (message_bus_lock);
2972
2973   //g_debug ("in on_worker_closed: %s", error->message);
2974
2975   CONNECTION_LOCK (connection);
2976   /* Even though this is atomic, we do it inside the lock to avoid breaking
2977    * assumptions in remove_match_rule(). We'd need the lock in a moment
2978    * anyway, so, no loss.
2979    */
2980   old_atomic_flags = g_atomic_int_or (&connection->atomic_flags, FLAG_CLOSED);
2981
2982   if (!(old_atomic_flags & FLAG_CLOSED))
2983     {
2984       g_hash_table_foreach_remove (connection->map_method_serial_to_send_message_data, cancel_method_on_close, NULL);
2985       schedule_closed_unlocked (connection, remote_peer_vanished, error);
2986     }
2987   CONNECTION_UNLOCK (connection);
2988
2989   g_object_unref (connection);
2990 }
2991
2992 /* ---------------------------------------------------------------------------------------------------- */
2993
2994 /* Determines the biggest set of capabilities we can support on this
2995  * connection.
2996  *
2997  * Called with the init_lock held.
2998  */
2999 static GDBusCapabilityFlags
3000 get_offered_capabilities_max (GDBusConnection *connection)
3001 {
3002       GDBusCapabilityFlags ret;
3003       ret = G_DBUS_CAPABILITY_FLAGS_NONE;
3004 #ifdef G_OS_UNIX
3005       //if (G_IS_UNIX_CONNECTION (connection->stream))
3006         ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
3007 #endif
3008       return ret;
3009 }
3010
3011 /* Called in a user thread, lock is not held */
3012 static gboolean
3013 initable_init (GInitable     *initable,
3014                GCancellable  *cancellable,
3015                GError       **error)
3016 {
3017   GDBusConnection *connection = G_DBUS_CONNECTION (initable);
3018   gboolean initially_frozen;
3019   gboolean ret;
3020
3021   /* This method needs to be idempotent to work with the singleton
3022    * pattern. See the docs for g_initable_init(). We implement this by
3023    * locking.
3024    *
3025    * Unfortunately we can't use the main lock since the on_worker_*()
3026    * callbacks above needs the lock during initialization (for message
3027    * bus connections we do a synchronous Hello() call on the bus).
3028    */
3029   g_mutex_lock (&connection->init_lock);
3030
3031   ret = FALSE;
3032
3033   /* Make this a no-op if we're already initialized (successfully or
3034    * unsuccessfully)
3035    */
3036   if ((g_atomic_int_get (&connection->atomic_flags) & FLAG_INITIALIZED))
3037     {
3038       ret = (connection->initialization_error == NULL);
3039       goto out;
3040     }
3041
3042   /* Because of init_lock, we can't get here twice in different threads */
3043   g_assert (connection->initialization_error == NULL);
3044
3045   /* The user can pass multiple (but mutally exclusive) construct
3046    * properties:
3047    *
3048    *  - stream (of type GIOStream)
3049    *  - address (of type gchar*)
3050    *
3051    * At the end of the day we end up with a non-NULL GIOStream
3052    * object in connection->stream.
3053    */
3054   if (connection->address != NULL)
3055     {
3056       GObject *ret;
3057
3058       g_assert (connection->stream == NULL);
3059
3060       if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
3061           (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
3062         {
3063           g_set_error_literal (&connection->initialization_error,
3064                                G_IO_ERROR,
3065                                G_IO_ERROR_INVALID_ARGUMENT,
3066                                _("Unsupported flags encountered when constructing a client-side connection"));
3067           goto out;
3068         }
3069
3070       ret = g_dbus_address_get_stream_internal (connection->address, TRUE,
3071                                                 NULL, /* TODO: out_guid */
3072                                                 cancellable, &connection->initialization_error);
3073       if (ret == NULL)
3074         goto out;
3075
3076       if (G_IS_IO_STREAM (ret))
3077         connection->stream = G_IO_STREAM (ret);
3078       else if (G_IS_KDBUS_WORKER (ret))
3079         connection->kdbus_worker = G_KDBUS_WORKER (ret);
3080       else
3081         g_assert_not_reached ();
3082     }
3083   else if (connection->stream != NULL)
3084     {
3085       /* nothing to do */
3086     }
3087   else
3088     {
3089       g_assert_not_reached ();
3090     }
3091
3092   /* [KDBUS] Skip authentication process for kdbus transport */
3093   if (connection->kdbus_worker)
3094     {
3095       connection->capabilities |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
3096       goto authenticated;
3097     }
3098
3099   /* Authenticate the connection */
3100   if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
3101     {
3102       g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
3103       g_assert (connection->guid != NULL);
3104       connection->auth = _g_dbus_auth_new (connection->stream);
3105       if (!_g_dbus_auth_run_server (connection->auth,
3106                                     connection->authentication_observer,
3107                                     connection->guid,
3108                                     (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
3109                                     get_offered_capabilities_max (connection),
3110                                     &connection->capabilities,
3111                                     &connection->credentials,
3112                                     cancellable,
3113                                     &connection->initialization_error))
3114         goto out;
3115     }
3116   else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
3117     {
3118       g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
3119       g_assert (connection->guid == NULL);
3120       connection->auth = _g_dbus_auth_new (connection->stream);
3121       connection->guid = _g_dbus_auth_run_client (connection->auth,
3122                                                   connection->authentication_observer,
3123                                                   get_offered_capabilities_max (connection),
3124                                                   &connection->capabilities,
3125                                                   cancellable,
3126                                                   &connection->initialization_error);
3127       if (connection->guid == NULL)
3128         goto out;
3129     }
3130
3131   if (connection->authentication_observer != NULL)
3132     {
3133       g_object_unref (connection->authentication_observer);
3134       connection->authentication_observer = NULL;
3135     }
3136
3137 authenticated:
3138
3139   //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
3140
3141   //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
3142
3143 #ifdef G_OS_UNIX
3144   /* We want all IO operations to be non-blocking since they happen in
3145    * the worker thread which is shared by _all_ connections.
3146    */
3147   if (G_IS_SOCKET_CONNECTION (connection->stream))
3148     {
3149       g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
3150     }
3151 #endif
3152
3153   G_LOCK (message_bus_lock);
3154   if (alive_connections == NULL)
3155     alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
3156   g_hash_table_insert (alive_connections, connection, connection);
3157   G_UNLOCK (message_bus_lock);
3158
3159   initially_frozen = (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) != 0;
3160
3161   if (connection->kdbus_worker)
3162    g_kdbus_worker_associate (connection->kdbus_worker,
3163                              connection->capabilities,
3164                              on_worker_message_received,
3165                              on_worker_message_about_to_be_sent,
3166                              on_worker_closed,
3167                              connection);
3168   else
3169     connection->worker = _g_dbus_worker_new (connection->stream,
3170                                              connection->capabilities,
3171                                              initially_frozen,
3172                                              on_worker_message_received,
3173                                              on_worker_message_about_to_be_sent,
3174                                              on_worker_closed,
3175                                              connection);
3176
3177   /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
3178   if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3179     {
3180       GVariant *hello_result;
3181
3182       /* we could lift this restriction by adding code in gdbusprivate.c */
3183       if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
3184         {
3185           g_set_error_literal (&connection->initialization_error,
3186                                G_IO_ERROR,
3187                                G_IO_ERROR_FAILED,
3188                                "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
3189           goto out;
3190         }
3191
3192       if (connection->kdbus_worker)
3193         {
3194           hello_result = _g_kdbus_Hello (connection->kdbus_worker, &connection->initialization_error);
3195         }
3196       else
3197         {
3198           hello_result = g_dbus_connection_call_sync (connection,
3199                                                       "org.freedesktop.DBus", /* name */
3200                                                       "/org/freedesktop/DBus", /* path */
3201                                                       "org.freedesktop.DBus", /* interface */
3202                                                       "Hello",
3203                                                       NULL, /* parameters */
3204                                                       G_VARIANT_TYPE ("(s)"),
3205                                                       CALL_FLAGS_INITIALIZING,
3206                                                       -1,
3207                                                       NULL, /* TODO: cancellable */
3208                                                       &connection->initialization_error);
3209         }
3210
3211       if (hello_result == NULL)
3212         goto out;
3213
3214       g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
3215       g_variant_unref (hello_result);
3216       //g_debug ("unique name is '%s'", connection->bus_unique_name);
3217     }
3218
3219   if (connection->kdbus_worker && !initially_frozen)
3220     g_kdbus_worker_unfreeze (connection->kdbus_worker);
3221
3222   ret = TRUE;
3223  out:
3224   if (!ret)
3225     {
3226       g_assert (connection->initialization_error != NULL);
3227       g_propagate_error (error, g_error_copy (connection->initialization_error));
3228     }
3229
3230   g_atomic_int_or (&connection->atomic_flags, FLAG_INITIALIZED);
3231   g_mutex_unlock (&connection->init_lock);
3232
3233   return ret;
3234 }
3235
3236 static void
3237 initable_iface_init (GInitableIface *initable_iface)
3238 {
3239   initable_iface->init = initable_init;
3240 }
3241
3242 /* ---------------------------------------------------------------------------------------------------- */
3243
3244 static void
3245 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
3246 {
3247   /* Use default */
3248 }
3249
3250 /* ---------------------------------------------------------------------------------------------------- */
3251
3252 /**
3253  * g_dbus_connection_new:
3254  * @stream: a #GIOStream
3255  * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
3256  * @flags: flags describing how to make the connection
3257  * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3258  * @cancellable: (allow-none): a #GCancellable or %NULL
3259  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3260  * @user_data: the data to pass to @callback
3261  *
3262  * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
3263  * with the end represented by @stream.
3264  *
3265  * If @stream is a #GSocketConnection, then the corresponding #GSocket
3266  * will be put into non-blocking mode.
3267  *
3268  * The D-Bus connection will interact with @stream from a worker thread.
3269  * As a result, the caller should not interact with @stream after this
3270  * method has been called, except by calling g_object_unref() on it.
3271  *
3272  * If @observer is not %NULL it may be used to control the
3273  * authentication process.
3274  *
3275  * When the operation is finished, @callback will be invoked. You can
3276  * then call g_dbus_connection_new_finish() to get the result of the
3277  * operation.
3278  *
3279  * This is a asynchronous failable constructor. See
3280  * g_dbus_connection_new_sync() for the synchronous
3281  * version.
3282  *
3283  * Since: 2.26
3284  */
3285 void
3286 g_dbus_connection_new (GIOStream            *stream,
3287                        const gchar          *guid,
3288                        GDBusConnectionFlags  flags,
3289                        GDBusAuthObserver    *observer,
3290                        GCancellable         *cancellable,
3291                        GAsyncReadyCallback   callback,
3292                        gpointer              user_data)
3293 {
3294   g_return_if_fail (G_IS_IO_STREAM (stream));
3295   g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
3296                               G_PRIORITY_DEFAULT,
3297                               cancellable,
3298                               callback,
3299                               user_data,
3300                               "stream", stream,
3301                               "guid", guid,
3302                               "flags", flags,
3303                               "authentication-observer", observer,
3304                               NULL);
3305 }
3306
3307 /**
3308  * g_dbus_connection_new_finish:
3309  * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback
3310  *     passed to g_dbus_connection_new().
3311  * @error: return location for error or %NULL
3312  *
3313  * Finishes an operation started with g_dbus_connection_new().
3314  *
3315  * Returns: a #GDBusConnection or %NULL if @error is set. Free
3316  *     with g_object_unref().
3317  *
3318  * Since: 2.26
3319  */
3320 GDBusConnection *
3321 g_dbus_connection_new_finish (GAsyncResult  *res,
3322                               GError       **error)
3323 {
3324   GObject *object;
3325   GObject *source_object;
3326
3327   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3328   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3329
3330   source_object = g_async_result_get_source_object (res);
3331   g_assert (source_object != NULL);
3332   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
3333                                         res,
3334                                         error);
3335   g_object_unref (source_object);
3336   if (object != NULL)
3337     return G_DBUS_CONNECTION (object);
3338   else
3339     return NULL;
3340 }
3341
3342 /**
3343  * g_dbus_connection_new_sync:
3344  * @stream: a #GIOStream
3345  * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
3346  * @flags: flags describing how to make the connection
3347  * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3348  * @cancellable: (allow-none): a #GCancellable or %NULL
3349  * @error: return location for error or %NULL
3350  *
3351  * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
3352  * with the end represented by @stream.
3353  *
3354  * If @stream is a #GSocketConnection, then the corresponding #GSocket
3355  * will be put into non-blocking mode.
3356  *
3357  * The D-Bus connection will interact with @stream from a worker thread.
3358  * As a result, the caller should not interact with @stream after this
3359  * method has been called, except by calling g_object_unref() on it.
3360  *
3361  * If @observer is not %NULL it may be used to control the
3362  * authentication process.
3363  *
3364  * This is a synchronous failable constructor. See
3365  * g_dbus_connection_new() for the asynchronous version.
3366  *
3367  * Returns: a #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
3368  *
3369  * Since: 2.26
3370  */
3371 GDBusConnection *
3372 g_dbus_connection_new_sync (GIOStream             *stream,
3373                             const gchar           *guid,
3374                             GDBusConnectionFlags   flags,
3375                             GDBusAuthObserver     *observer,
3376                             GCancellable          *cancellable,
3377                             GError               **error)
3378 {
3379   g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
3380   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3381   return g_initable_new (G_TYPE_DBUS_CONNECTION,
3382                          cancellable,
3383                          error,
3384                          "stream", stream,
3385                          "guid", guid,
3386                          "flags", flags,
3387                          "authentication-observer", observer,
3388                          NULL);
3389 }
3390
3391 /* ---------------------------------------------------------------------------------------------------- */
3392
3393 /**
3394  * g_dbus_connection_new_for_address:
3395  * @address: a D-Bus address
3396  * @flags: flags describing how to make the connection
3397  * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3398  * @cancellable: (allow-none): a #GCancellable or %NULL
3399  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3400  * @user_data: the data to pass to @callback
3401  *
3402  * Asynchronously connects and sets up a D-Bus client connection for
3403  * exchanging D-Bus messages with an endpoint specified by @address
3404  * which must be in the D-Bus address format.
3405  *
3406  * This constructor can only be used to initiate client-side
3407  * connections - use g_dbus_connection_new() if you need to act as the
3408  * server. In particular, @flags cannot contain the
3409  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
3410  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
3411  *
3412  * When the operation is finished, @callback will be invoked. You can
3413  * then call g_dbus_connection_new_finish() to get the result of the
3414  * operation.
3415  *
3416  * If @observer is not %NULL it may be used to control the
3417  * authentication process.
3418  *
3419  * This is a asynchronous failable constructor. See
3420  * g_dbus_connection_new_for_address_sync() for the synchronous
3421  * version.
3422  *
3423  * Since: 2.26
3424  */
3425 void
3426 g_dbus_connection_new_for_address (const gchar          *address,
3427                                    GDBusConnectionFlags  flags,
3428                                    GDBusAuthObserver    *observer,
3429                                    GCancellable         *cancellable,
3430                                    GAsyncReadyCallback   callback,
3431                                    gpointer              user_data)
3432 {
3433   g_return_if_fail (address != NULL);
3434   g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
3435                               G_PRIORITY_DEFAULT,
3436                               cancellable,
3437                               callback,
3438                               user_data,
3439                               "address", address,
3440                               "flags", flags,
3441                               "authentication-observer", observer,
3442                               NULL);
3443 }
3444
3445 /**
3446  * g_dbus_connection_new_for_address_finish:
3447  * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
3448  *     to g_dbus_connection_new()
3449  * @error: return location for error or %NULL
3450  *
3451  * Finishes an operation started with g_dbus_connection_new_for_address().
3452  *
3453  * Returns: a #GDBusConnection or %NULL if @error is set. Free with
3454  *     g_object_unref().
3455  *
3456  * Since: 2.26
3457  */
3458 GDBusConnection *
3459 g_dbus_connection_new_for_address_finish (GAsyncResult  *res,
3460                                           GError       **error)
3461 {
3462   GObject *object;
3463   GObject *source_object;
3464
3465   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3466   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3467
3468   source_object = g_async_result_get_source_object (res);
3469   g_assert (source_object != NULL);
3470   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
3471                                         res,
3472                                         error);
3473   g_object_unref (source_object);
3474   if (object != NULL)
3475     return G_DBUS_CONNECTION (object);
3476   else
3477     return NULL;
3478 }
3479
3480 /**
3481  * g_dbus_connection_new_for_address_sync:
3482  * @address: a D-Bus address
3483  * @flags: flags describing how to make the connection
3484  * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3485  * @cancellable: (allow-none): a #GCancellable or %NULL
3486  * @error: return location for error or %NULL
3487  *
3488  * Synchronously connects and sets up a D-Bus client connection for
3489  * exchanging D-Bus messages with an endpoint specified by @address
3490  * which must be in the D-Bus address format.
3491  *
3492  * This constructor can only be used to initiate client-side
3493  * connections - use g_dbus_connection_new_sync() if you need to act
3494  * as the server. In particular, @flags cannot contain the
3495  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
3496  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
3497  *
3498  * This is a synchronous failable constructor. See
3499  * g_dbus_connection_new_for_address() for the asynchronous version.
3500  *
3501  * If @observer is not %NULL it may be used to control the
3502  * authentication process.
3503  *
3504  * Returns: a #GDBusConnection or %NULL if @error is set. Free with
3505  *     g_object_unref().
3506  *
3507  * Since: 2.26
3508  */
3509 GDBusConnection *
3510 g_dbus_connection_new_for_address_sync (const gchar           *address,
3511                                         GDBusConnectionFlags   flags,
3512                                         GDBusAuthObserver     *observer,
3513                                         GCancellable          *cancellable,
3514                                         GError               **error)
3515 {
3516   g_return_val_if_fail (address != NULL, NULL);
3517   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3518   return g_initable_new (G_TYPE_DBUS_CONNECTION,
3519                          cancellable,
3520                          error,
3521                          "address", address,
3522                          "flags", flags,
3523                          "authentication-observer", observer,
3524                          NULL);
3525 }
3526
3527 /* ---------------------------------------------------------------------------------------------------- */
3528
3529 /**
3530  * g_dbus_connection_set_exit_on_close:
3531  * @connection: a #GDBusConnection
3532  * @exit_on_close: whether the process should be terminated
3533  *     when @connection is closed by the remote peer
3534  *
3535  * Sets whether the process should be terminated when @connection is
3536  * closed by the remote peer. See #GDBusConnection:exit-on-close for
3537  * more details.
3538  *
3539  * Note that this function should be used with care. Most modern UNIX
3540  * desktops tie the notion of a user session the session bus, and expect
3541  * all of a users applications to quit when their bus connection goes away.
3542  * If you are setting @exit_on_close to %FALSE for the shared session
3543  * bus connection, you should make sure that your application exits
3544  * when the user session ends.
3545  *
3546  * Since: 2.26
3547  */
3548 void
3549 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
3550                                      gboolean         exit_on_close)
3551 {
3552   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3553
3554   if (exit_on_close)
3555     g_atomic_int_or (&connection->atomic_flags, FLAG_EXIT_ON_CLOSE);
3556   else
3557     g_atomic_int_and (&connection->atomic_flags, ~FLAG_EXIT_ON_CLOSE);
3558
3559 }
3560
3561 /**
3562  * g_dbus_connection_get_exit_on_close:
3563  * @connection: a #GDBusConnection
3564  *
3565  * Gets whether the process is terminated when @connection is
3566  * closed by the remote peer. See
3567  * #GDBusConnection:exit-on-close for more details.
3568  *
3569  * Returns: whether the process is terminated when @connection is
3570  *     closed by the remote peer
3571  *
3572  * Since: 2.26
3573  */
3574 gboolean
3575 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
3576 {
3577   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3578
3579   if (g_atomic_int_get (&connection->atomic_flags) & FLAG_EXIT_ON_CLOSE)
3580     return TRUE;
3581   else
3582     return FALSE;
3583 }
3584
3585 /**
3586  * g_dbus_connection_get_guid:
3587  * @connection: a #GDBusConnection
3588  *
3589  * The GUID of the peer performing the role of server when
3590  * authenticating. See #GDBusConnection:guid for more details.
3591  *
3592  * Returns: The GUID. Do not free this string, it is owned by
3593  *     @connection.
3594  *
3595  * Since: 2.26
3596  */
3597 const gchar *
3598 g_dbus_connection_get_guid (GDBusConnection *connection)
3599 {
3600   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3601   return connection->guid;
3602 }
3603
3604 /**
3605  * g_dbus_connection_get_unique_name:
3606  * @connection: a #GDBusConnection
3607  *
3608  * Gets the unique name of @connection as assigned by the message
3609  * bus. This can also be used to figure out if @connection is a
3610  * message bus connection.
3611  *
3612  * Returns: the unique name or %NULL if @connection is not a message
3613  *     bus connection. Do not free this string, it is owned by
3614  *     @connection.
3615  *
3616  * Since: 2.26
3617  */
3618 const gchar *
3619 g_dbus_connection_get_unique_name (GDBusConnection *connection)
3620 {
3621   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3622
3623   /* do not use g_return_val_if_fail(), we want the memory barrier */
3624   if (!check_initialized (connection))
3625     return NULL;
3626
3627   return connection->bus_unique_name;
3628 }
3629
3630 /**
3631  * g_dbus_connection_get_peer_credentials:
3632  * @connection: a #GDBusConnection
3633  *
3634  * Gets the credentials of the authenticated peer. This will always
3635  * return %NULL unless @connection acted as a server
3636  * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
3637  * when set up and the client passed credentials as part of the
3638  * authentication process.
3639  *
3640  * In a message bus setup, the message bus is always the server and
3641  * each application is a client. So this method will always return
3642  * %NULL for message bus clients.
3643  *
3644  * Returns: (transfer none): a #GCredentials or %NULL if not available.
3645  *     Do not free this object, it is owned by @connection.
3646  *
3647  * Since: 2.26
3648  */
3649 GCredentials *
3650 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
3651 {
3652   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3653
3654   /* do not use g_return_val_if_fail(), we want the memory barrier */
3655   if (!check_initialized (connection))
3656     return NULL;
3657
3658   return connection->credentials;
3659 }
3660
3661 /* ---------------------------------------------------------------------------------------------------- */
3662
3663 static guint _global_filter_id = 1;
3664
3665 /**
3666  * g_dbus_connection_add_filter:
3667  * @connection: a #GDBusConnection
3668  * @filter_function: a filter function
3669  * @user_data: user data to pass to @filter_function
3670  * @user_data_free_func: function to free @user_data with when filter
3671  *     is removed or %NULL
3672  *
3673  * Adds a message filter. Filters are handlers that are run on all
3674  * incoming and outgoing messages, prior to standard dispatch. Filters
3675  * are run in the order that they were added.  The same handler can be
3676  * added as a filter more than once, in which case it will be run more
3677  * than once.  Filters added during a filter callback won't be run on
3678  * the message being processed. Filter functions are allowed to modify
3679  * and even drop messages.
3680  *
3681  * Note that filters are run in a dedicated message handling thread so
3682  * they can't block and, generally, can't do anything but signal a
3683  * worker thread. Also note that filters are rarely needed - use API
3684  * such as g_dbus_connection_send_message_with_reply(),
3685  * g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
3686  *
3687  * If a filter consumes an incoming message the message is not
3688  * dispatched anywhere else - not even the standard dispatch machinery
3689  * (that API such as g_dbus_connection_signal_subscribe() and
3690  * g_dbus_connection_send_message_with_reply() relies on) will see the
3691  * message. Similary, if a filter consumes an outgoing message, the
3692  * message will not be sent to the other peer.
3693  *
3694  * Returns: a filter identifier that can be used with
3695  *     g_dbus_connection_remove_filter()
3696  *
3697  * Since: 2.26
3698  */
3699 guint
3700 g_dbus_connection_add_filter (GDBusConnection            *connection,
3701                               GDBusMessageFilterFunction  filter_function,
3702                               gpointer                    user_data,
3703                               GDestroyNotify              user_data_free_func)
3704 {
3705   FilterData *data;
3706
3707   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3708   g_return_val_if_fail (filter_function != NULL, 0);
3709   g_return_val_if_fail (check_initialized (connection), 0);
3710
3711   CONNECTION_LOCK (connection);
3712   data = g_new0 (FilterData, 1);
3713   data->id = _global_filter_id++; /* TODO: overflow etc. */
3714   data->filter_function = filter_function;
3715   data->user_data = user_data;
3716   data->user_data_free_func = user_data_free_func;
3717   g_ptr_array_add (connection->filters, data);
3718   CONNECTION_UNLOCK (connection);
3719
3720   return data->id;
3721 }
3722
3723 /* only called from finalize(), removes all filters */
3724 static void
3725 purge_all_filters (GDBusConnection *connection)
3726 {
3727   guint n;
3728   for (n = 0; n < connection->filters->len; n++)
3729     {
3730       FilterData *data = connection->filters->pdata[n];
3731       if (data->user_data_free_func != NULL)
3732         data->user_data_free_func (data->user_data);
3733       g_free (data);
3734     }
3735 }
3736
3737 /**
3738  * g_dbus_connection_remove_filter:
3739  * @connection: a #GDBusConnection
3740  * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
3741  *
3742  * Removes a filter.
3743  *
3744  * Since: 2.26
3745  */
3746 void
3747 g_dbus_connection_remove_filter (GDBusConnection *connection,
3748                                  guint            filter_id)
3749 {
3750   guint n;
3751   FilterData *to_destroy;
3752
3753   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3754   g_return_if_fail (check_initialized (connection));
3755
3756   CONNECTION_LOCK (connection);
3757   to_destroy = NULL;
3758   for (n = 0; n < connection->filters->len; n++)
3759     {
3760       FilterData *data = connection->filters->pdata[n];
3761       if (data->id == filter_id)
3762         {
3763           g_ptr_array_remove_index (connection->filters, n);
3764           to_destroy = data;
3765           break;
3766         }
3767     }
3768   CONNECTION_UNLOCK (connection);
3769
3770   /* do free without holding lock */
3771   if (to_destroy != NULL)
3772     {
3773       if (to_destroy->user_data_free_func != NULL)
3774         to_destroy->user_data_free_func (to_destroy->user_data);
3775       g_free (to_destroy);
3776     }
3777   else
3778     {
3779       g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
3780     }
3781 }
3782
3783 /* ---------------------------------------------------------------------------------------------------- */
3784
3785 typedef struct
3786 {
3787   gchar *rule;
3788   gchar *sender;
3789   gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
3790   gchar *interface_name;
3791   gchar *member;
3792   gchar *object_path;
3793   gchar *arg0;
3794   GDBusSignalFlags flags;
3795   GArray *subscribers;
3796 } SignalData;
3797
3798 typedef struct
3799 {
3800   GDBusSignalCallback callback;
3801   gpointer user_data;
3802   GDestroyNotify user_data_free_func;
3803   guint id;
3804   GMainContext *context;
3805 } SignalSubscriber;
3806
3807 static void
3808 signal_data_free (SignalData *signal_data)
3809 {
3810   g_free (signal_data->rule);
3811   g_free (signal_data->sender);
3812   g_free (signal_data->sender_unique_name);
3813   g_free (signal_data->interface_name);
3814   g_free (signal_data->member);
3815   g_free (signal_data->object_path);
3816   g_free (signal_data->arg0);
3817   g_array_free (signal_data->subscribers, TRUE);
3818   g_free (signal_data);
3819 }
3820
3821 static gchar *
3822 args_to_rule (const gchar      *sender,
3823               const gchar      *interface_name,
3824               const gchar      *member,
3825               const gchar      *object_path,
3826               const gchar      *arg0,
3827               GDBusSignalFlags  flags)
3828 {
3829   GString *rule;
3830
3831   rule = g_string_new ("type='signal'");
3832   if (flags & G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE)
3833     g_string_prepend_c (rule, '-');
3834   if (sender != NULL)
3835     g_string_append_printf (rule, ",sender='%s'", sender);
3836   if (interface_name != NULL)
3837     g_string_append_printf (rule, ",interface='%s'", interface_name);
3838   if (member != NULL)
3839     g_string_append_printf (rule, ",member='%s'", member);
3840   if (object_path != NULL)
3841     g_string_append_printf (rule, ",path='%s'", object_path);
3842
3843   if (arg0 != NULL)
3844     {
3845       if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
3846         g_string_append_printf (rule, ",arg0path='%s'", arg0);
3847       else if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
3848         g_string_append_printf (rule, ",arg0namespace='%s'", arg0);
3849       else
3850         g_string_append_printf (rule, ",arg0='%s'", arg0);
3851     }
3852
3853   return g_string_free (rule, FALSE);
3854 }
3855
3856 static guint _global_subscriber_id = 1;
3857 static guint _global_registration_id = 1;
3858 static guint _global_subtree_registration_id = 1;
3859
3860 /* ---------------------------------------------------------------------------------------------------- */
3861
3862 /* Called in a user thread, lock is held */
3863 static void
3864 add_match_rule (GDBusConnection *connection,
3865                 const gchar     *match_rule)
3866 {
3867   GError *error;
3868   GDBusMessage *message;
3869
3870   if (match_rule[0] == '-')
3871     return;
3872
3873   message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3874                                             "/org/freedesktop/DBus", /* path */
3875                                             "org.freedesktop.DBus", /* interface */
3876                                             "AddMatch");
3877   g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3878   error = NULL;
3879   if (!g_dbus_connection_send_message_unlocked (connection,
3880                                                 message,
3881                                                 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3882                                                 NULL,
3883                                                 &error))
3884     {
3885       g_critical ("Error while sending AddMatch() message: %s", error->message);
3886       g_error_free (error);
3887     }
3888   g_object_unref (message);
3889 }
3890
3891 /* ---------------------------------------------------------------------------------------------------- */
3892
3893 /* Called in a user thread, lock is held */
3894 static void
3895 remove_match_rule (GDBusConnection *connection,
3896                    const gchar     *match_rule)
3897 {
3898   GError *error;
3899   GDBusMessage *message;
3900
3901   if (match_rule[0] == '-')
3902     return;
3903
3904   message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3905                                             "/org/freedesktop/DBus", /* path */
3906                                             "org.freedesktop.DBus", /* interface */
3907                                             "RemoveMatch");
3908   g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3909
3910   error = NULL;
3911   if (!g_dbus_connection_send_message_unlocked (connection,
3912                                                 message,
3913                                                 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3914                                                 NULL,
3915                                                 &error))
3916     {
3917       /* If we could get G_IO_ERROR_CLOSED here, it wouldn't be reasonable to
3918        * critical; but we're holding the lock, and our caller checked whether
3919        * we were already closed, so we can't get that error.
3920        */
3921       g_critical ("Error while sending RemoveMatch() message: %s", error->message);
3922       g_error_free (error);
3923     }
3924   g_object_unref (message);
3925 }
3926
3927 /* ---------------------------------------------------------------------------------------------------- */
3928
3929 static gboolean
3930 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
3931 {
3932   return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
3933          g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
3934          g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
3935          (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
3936           g_strcmp0 (signal_data->member, "NameAcquired") == 0);
3937 }
3938
3939 /* ---------------------------------------------------------------------------------------------------- */
3940
3941 /**
3942  * g_dbus_connection_signal_subscribe:
3943  * @connection: a #GDBusConnection
3944  * @sender: (allow-none): sender name to match on (unique or well-known name)
3945  *     or %NULL to listen from all senders
3946  * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
3947  *     match on all interfaces
3948  * @member: (allow-none): D-Bus signal name to match on or %NULL to match on
3949  *     all signals
3950  * @object_path: (allow-none): object path to match on or %NULL to match on
3951  *     all object paths
3952  * @arg0: (allow-none): contents of first string argument to match on or %NULL
3953  *     to match on all kinds of arguments
3954  * @flags: flags describing how to subscribe to the signal (currently unused)
3955  * @callback: callback to invoke when there is a signal matching the requested data
3956  * @user_data: user data to pass to @callback
3957  * @user_data_free_func: (allow-none): function to free @user_data with when
3958  *     subscription is removed or %NULL
3959  *
3960  * Subscribes to signals on @connection and invokes @callback with a whenever
3961  * the signal is received. Note that @callback will be invoked in the
3962  * [thread-default main context][g-main-context-push-thread-default]
3963  * of the thread you are calling this method from.
3964  *
3965  * If @connection is not a message bus connection, @sender must be
3966  * %NULL.
3967  *
3968  * If @sender is a well-known name note that @callback is invoked with
3969  * the unique name for the owner of @sender, not the well-known name
3970  * as one would expect. This is because the message bus rewrites the
3971  * name. As such, to avoid certain race conditions, users should be
3972  * tracking the name owner of the well-known name and use that when
3973  * processing the received signal.
3974  *
3975  * If one of %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE or
3976  * %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH are given, @arg0 is
3977  * interpreted as part of a namespace or path.  The first argument
3978  * of a signal is matched against that part as specified by D-Bus.
3979  *
3980  * Returns: a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe()
3981  *
3982  * Since: 2.26
3983  */
3984 guint
3985 g_dbus_connection_signal_subscribe (GDBusConnection     *connection,
3986                                     const gchar         *sender,
3987                                     const gchar         *interface_name,
3988                                     const gchar         *member,
3989                                     const gchar         *object_path,
3990                                     const gchar         *arg0,
3991                                     GDBusSignalFlags     flags,
3992                                     GDBusSignalCallback  callback,
3993                                     gpointer             user_data,
3994                                     GDestroyNotify       user_data_free_func)
3995 {
3996   gchar *rule;
3997   SignalData *signal_data;
3998   SignalSubscriber subscriber;
3999   GPtrArray *signal_data_array;
4000   const gchar *sender_unique_name;
4001
4002   /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
4003    * an OOM condition. We might want to change that but that would involve making
4004    * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
4005    * handle that. And there's really no sensible way of handling this short of retrying
4006    * to add the match rule... and then there's the little thing that, hey, maybe there's
4007    * a reason the bus in an OOM condition.
4008    *
4009    * Doable, but not really sure it's worth it...
4010    */
4011
4012   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
4013   g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
4014   g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
4015   g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
4016   g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
4017   g_return_val_if_fail (callback != NULL, 0);
4018   g_return_val_if_fail (check_initialized (connection), 0);
4019   g_return_val_if_fail (!((flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH) && (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)), 0);
4020   g_return_val_if_fail (!(arg0 == NULL && (flags & (G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH | G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE))), 0);
4021
4022   CONNECTION_LOCK (connection);
4023
4024   /* If G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE was specified, we will end up
4025    * with a '-' character to prefix the rule (which will otherwise be
4026    * normal).
4027    *
4028    * This allows us to hash the rule and do our lifecycle tracking in
4029    * the usual way, but the '-' prevents the match rule from ever
4030    * actually being send to the bus (either for add or remove).
4031    */
4032   rule = args_to_rule (sender, interface_name, member, object_path, arg0, flags);
4033
4034   if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
4035     sender_unique_name = sender;
4036   else
4037     sender_unique_name = "";
4038
4039   subscriber.callback = callback;
4040   subscriber.user_data = user_data;
4041   subscriber.user_data_free_func = user_data_free_func;
4042   subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
4043   subscriber.context = g_main_context_ref_thread_default ();
4044
4045   /* see if we've already have this rule */
4046   signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
4047   if (signal_data != NULL)
4048     {
4049       g_array_append_val (signal_data->subscribers, subscriber);
4050       g_free (rule);
4051       goto out;
4052     }
4053
4054   signal_data = g_new0 (SignalData, 1);
4055   signal_data->rule                  = rule;
4056   signal_data->sender                = g_strdup (sender);
4057   signal_data->sender_unique_name    = g_strdup (sender_unique_name);
4058   signal_data->interface_name        = g_strdup (interface_name);
4059   signal_data->member                = g_strdup (member);
4060   signal_data->object_path           = g_strdup (object_path);
4061   signal_data->arg0                  = g_strdup (arg0);
4062   signal_data->flags                 = flags;
4063   signal_data->subscribers           = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
4064   g_array_append_val (signal_data->subscribers, subscriber);
4065
4066   g_hash_table_insert (connection->map_rule_to_signal_data,
4067                        signal_data->rule,
4068                        signal_data);
4069
4070   /* Add the match rule to the bus...
4071    *
4072    * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
4073    * always send such messages to us.
4074    */
4075   if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
4076     {
4077       if (connection->kdbus_worker)
4078         {
4079           if (g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
4080               g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
4081               g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
4082               (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
4083                g_strcmp0 (signal_data->member, "NameAcquired") == 0 ||
4084                g_strcmp0 (signal_data->member, "NameOwnerChanged") == 0))
4085             {
4086               if (g_strcmp0 (signal_data->member, "NameAcquired") == 0)
4087                 _g_kdbus_subscribe_name_acquired (connection->kdbus_worker, arg0, (guint64) subscriber.id);
4088               else if (g_strcmp0 (signal_data->member, "NameLost") == 0)
4089                 _g_kdbus_subscribe_name_lost (connection->kdbus_worker, arg0, (guint64) subscriber.id);
4090               else if (g_strcmp0 (signal_data->member, "NameOwnerChanged") == 0)
4091                 _g_kdbus_subscribe_name_owner_changed (connection->kdbus_worker, arg0, (guint64) subscriber.id);
4092             }
4093           else
4094             _g_kdbus_AddMatch (connection->kdbus_worker, signal_data->rule, subscriber.id);
4095         }
4096       else
4097         {
4098           if (!is_signal_data_for_name_lost_or_acquired (signal_data))
4099             add_match_rule (connection, signal_data->rule);
4100         }
4101     }
4102
4103   signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
4104                                            signal_data->sender_unique_name);
4105   if (signal_data_array == NULL)
4106     {
4107       signal_data_array = g_ptr_array_new ();
4108       g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
4109                            g_strdup (signal_data->sender_unique_name),
4110                            signal_data_array);
4111     }
4112   g_ptr_array_add (signal_data_array, signal_data);
4113
4114  out:
4115   g_hash_table_insert (connection->map_id_to_signal_data,
4116                        GUINT_TO_POINTER (subscriber.id),
4117                        signal_data);
4118
4119   CONNECTION_UNLOCK (connection);
4120
4121   return subscriber.id;
4122 }
4123
4124 /* ---------------------------------------------------------------------------------------------------- */
4125
4126 /* called in any thread */
4127 /* must hold lock when calling this (except if connection->finalizing is TRUE) */
4128 static void
4129 unsubscribe_id_internal (GDBusConnection *connection,
4130                          guint            subscription_id,
4131                          GArray          *out_removed_subscribers)
4132 {
4133   SignalData *signal_data;
4134   GPtrArray *signal_data_array;
4135   guint n;
4136
4137   signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
4138                                      GUINT_TO_POINTER (subscription_id));
4139   if (signal_data == NULL)
4140     {
4141       /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
4142       goto out;
4143     }
4144
4145   for (n = 0; n < signal_data->subscribers->len; n++)
4146     {
4147       SignalSubscriber *subscriber;
4148
4149       subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
4150       if (subscriber->id != subscription_id)
4151         continue;
4152
4153       g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
4154                                            GUINT_TO_POINTER (subscription_id)));
4155       g_array_append_val (out_removed_subscribers, *subscriber);
4156       g_array_remove_index (signal_data->subscribers, n);
4157
4158       if (signal_data->subscribers->len == 0)
4159         {
4160           g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
4161
4162           signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
4163                                                    signal_data->sender_unique_name);
4164           g_warn_if_fail (signal_data_array != NULL);
4165           g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
4166
4167           if (signal_data_array->len == 0)
4168             {
4169               g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
4170                                                    signal_data->sender_unique_name));
4171             }
4172
4173           /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
4174           if ((connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION) &&
4175               !g_dbus_connection_is_closed (connection) &&
4176               !connection->finalizing)
4177             {
4178               /* The check for g_dbus_connection_is_closed() means that
4179                * sending the RemoveMatch message can't fail with
4180                * G_IO_ERROR_CLOSED, because we're holding the lock,
4181                * so on_worker_closed() can't happen between the check we just
4182                * did, and releasing the lock later.
4183                */
4184               if (connection->kdbus_worker)
4185                 _g_kdbus_RemoveMatch (connection->kdbus_worker, subscription_id);
4186               else
4187                 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
4188                   remove_match_rule (connection, signal_data->rule);
4189             }
4190
4191           signal_data_free (signal_data);
4192         }
4193
4194       goto out;
4195     }
4196
4197   g_assert_not_reached ();
4198
4199  out:
4200   ;
4201 }
4202
4203 /**
4204  * g_dbus_connection_signal_unsubscribe:
4205  * @connection: a #GDBusConnection
4206  * @subscription_id: a subscription id obtained from
4207  *     g_dbus_connection_signal_subscribe()
4208  *
4209  * Unsubscribes from signals.
4210  *
4211  * Since: 2.26
4212  */
4213 void
4214 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
4215                                       guint            subscription_id)
4216 {
4217   GArray *subscribers;
4218   guint n;
4219
4220   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
4221   g_return_if_fail (check_initialized (connection));
4222
4223   subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
4224
4225   CONNECTION_LOCK (connection);
4226   unsubscribe_id_internal (connection,
4227                            subscription_id,
4228                            subscribers);
4229   CONNECTION_UNLOCK (connection);
4230
4231   /* invariant */
4232   g_assert (subscribers->len == 0 || subscribers->len == 1);
4233
4234   /* call GDestroyNotify without lock held */
4235   for (n = 0; n < subscribers->len; n++)
4236     {
4237       SignalSubscriber *subscriber;
4238       subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
4239       call_destroy_notify (subscriber->context,
4240                            subscriber->user_data_free_func,
4241                            subscriber->user_data);
4242       g_main_context_unref (subscriber->context);
4243     }
4244
4245   g_array_free (subscribers, TRUE);
4246 }
4247
4248 /* ---------------------------------------------------------------------------------------------------- */
4249
4250 typedef struct
4251 {
4252   guint                subscription_id;
4253   GDBusSignalCallback  callback;
4254   gpointer             user_data;
4255   GDBusMessage        *message;
4256   GDBusConnection     *connection;
4257   const gchar         *sender;
4258   const gchar         *path;
4259   const gchar         *interface;
4260   const gchar         *member;
4261 } SignalInstance;
4262
4263 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
4264  * no locks held
4265  */
4266 static gboolean
4267 emit_signal_instance_in_idle_cb (gpointer data)
4268 {
4269   SignalInstance *signal_instance = data;
4270   GVariant *parameters;
4271   gboolean has_subscription;
4272
4273   parameters = g_dbus_message_get_body (signal_instance->message);
4274   if (parameters == NULL)
4275     {
4276       parameters = g_variant_new ("()");
4277       g_variant_ref_sink (parameters);
4278     }
4279   else
4280     {
4281       g_variant_ref (parameters);
4282     }
4283
4284 #if 0
4285   g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
4286            signal_instance->subscription_id,
4287            signal_instance->sender,
4288            signal_instance->path,
4289            signal_instance->interface,
4290            signal_instance->member,
4291            g_variant_print (parameters, TRUE));
4292 #endif
4293
4294   /* Careful here, don't do the callback if we no longer has the subscription */
4295   CONNECTION_LOCK (signal_instance->connection);
4296   has_subscription = FALSE;
4297   if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
4298                            GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
4299     has_subscription = TRUE;
4300   CONNECTION_UNLOCK (signal_instance->connection);
4301
4302   if (has_subscription)
4303     signal_instance->callback (signal_instance->connection,
4304                                signal_instance->sender,
4305                                signal_instance->path,
4306                                signal_instance->interface,
4307                                signal_instance->member,
4308                                parameters,
4309                                signal_instance->user_data);
4310
4311   g_variant_unref (parameters);
4312
4313   return FALSE;
4314 }
4315
4316 static void
4317 signal_instance_free (SignalInstance *signal_instance)
4318 {
4319   g_object_unref (signal_instance->message);
4320   g_object_unref (signal_instance->connection);
4321   g_free (signal_instance);
4322 }
4323
4324 static gboolean
4325 namespace_rule_matches (const gchar *namespace,
4326                         const gchar *name)
4327 {
4328   gint len_namespace;
4329   gint len_name;
4330
4331   len_namespace = strlen (namespace);
4332   len_name = strlen (name);
4333
4334   if (len_name < len_namespace)
4335     return FALSE;
4336
4337   if (memcmp (namespace, name, len_namespace) != 0)
4338     return FALSE;
4339
4340   return len_namespace == len_name || name[len_namespace] == '.';
4341 }
4342
4343 static gboolean
4344 path_rule_matches (const gchar *path_a,
4345                    const gchar *path_b)
4346 {
4347   gint len_a, len_b;
4348
4349   len_a = strlen (path_a);
4350   len_b = strlen (path_b);
4351
4352   if (len_a < len_b && path_a[len_a - 1] != '/')
4353     return FALSE;
4354
4355   if (len_b < len_a && path_b[len_b - 1] != '/')
4356     return FALSE;
4357
4358   return memcmp (path_a, path_b, MIN (len_a, len_b)) == 0;
4359 }
4360
4361 /* called in GDBusWorker thread WITH lock held */
4362 static void
4363 schedule_callbacks (GDBusConnection *connection,
4364                     GPtrArray       *signal_data_array,
4365                     GDBusMessage    *message,
4366                     const gchar     *sender)
4367 {
4368   guint n, m;
4369   const gchar *interface;
4370   const gchar *member;
4371   const gchar *path;
4372   const gchar *arg0;
4373
4374   interface = NULL;
4375   member = NULL;
4376   path = NULL;
4377   arg0 = NULL;
4378
4379   interface = g_dbus_message_get_interface (message);
4380   member = g_dbus_message_get_member (message);
4381   path = g_dbus_message_get_path (message);
4382   arg0 = g_dbus_message_get_arg0 (message);
4383
4384 #if 0
4385   g_print ("In schedule_callbacks:\n"
4386            "  sender    = '%s'\n"
4387            "  interface = '%s'\n"
4388            "  member    = '%s'\n"
4389            "  path      = '%s'\n"
4390            "  arg0      = '%s'\n",
4391            sender,
4392            interface,
4393            member,
4394            path,
4395            arg0);
4396 #endif
4397
4398   /* TODO: if this is slow, then we can change signal_data_array into
4399    *       map_object_path_to_signal_data_array or something.
4400    */
4401   for (n = 0; n < signal_data_array->len; n++)
4402     {
4403       SignalData *signal_data = signal_data_array->pdata[n];
4404
4405       if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
4406         continue;
4407
4408       if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
4409         continue;
4410
4411       if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
4412         continue;
4413
4414       if (signal_data->arg0 != NULL)
4415         {
4416           if (arg0 == NULL)
4417             continue;
4418
4419           if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
4420             {
4421               if (!namespace_rule_matches (signal_data->arg0, arg0))
4422                 continue;
4423             }
4424           else if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
4425             {
4426               if (!path_rule_matches (signal_data->arg0, arg0))
4427                 continue;
4428             }
4429           else if (!g_str_equal (signal_data->arg0, arg0))
4430             continue;
4431         }
4432
4433       for (m = 0; m < signal_data->subscribers->len; m++)
4434         {
4435           SignalSubscriber *subscriber;
4436           GSource *idle_source;
4437           SignalInstance *signal_instance;
4438
4439           subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
4440
4441           signal_instance = g_new0 (SignalInstance, 1);
4442           signal_instance->subscription_id = subscriber->id;
4443           signal_instance->callback = subscriber->callback;
4444           signal_instance->user_data = subscriber->user_data;
4445           signal_instance->message = g_object_ref (message);
4446           signal_instance->connection = g_object_ref (connection);
4447           signal_instance->sender = sender;
4448           signal_instance->path = path;
4449           signal_instance->interface = interface;
4450           signal_instance->member = member;
4451
4452           idle_source = g_idle_source_new ();
4453           g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4454           g_source_set_callback (idle_source,
4455                                  emit_signal_instance_in_idle_cb,
4456                                  signal_instance,
4457                                  (GDestroyNotify) signal_instance_free);
4458           g_source_set_name (idle_source, "[gio] emit_signal_instance_in_idle_cb");
4459           g_source_attach (idle_source, subscriber->context);
4460           g_source_unref (idle_source);
4461         }
4462     }
4463 }
4464
4465 /* called in GDBusWorker thread with lock held */
4466 static void
4467 distribute_signals (GDBusConnection *connection,
4468                     GDBusMessage    *message)
4469 {
4470   GPtrArray *signal_data_array;
4471   const gchar *sender;
4472
4473   sender = g_dbus_message_get_sender (message);
4474
4475   if (G_UNLIKELY (_g_dbus_debug_signal ()))
4476     {
4477       _g_dbus_debug_print_lock ();
4478       g_print ("========================================================================\n"
4479                "GDBus-debug:Signal:\n"
4480                " <<<< RECEIVED SIGNAL %s.%s\n"
4481                "      on object %s\n"
4482                "      sent by name %s\n",
4483                g_dbus_message_get_interface (message),
4484                g_dbus_message_get_member (message),
4485                g_dbus_message_get_path (message),
4486                sender != NULL ? sender : "(none)");
4487       _g_dbus_debug_print_unlock ();
4488     }
4489
4490   /* collect subscribers that match on sender */
4491   if (sender != NULL)
4492     {
4493       signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
4494       if (signal_data_array != NULL)
4495         schedule_callbacks (connection, signal_data_array, message, sender);
4496     }
4497
4498   /* collect subscribers not matching on sender */
4499   signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
4500   if (signal_data_array != NULL)
4501     schedule_callbacks (connection, signal_data_array, message, sender);
4502 }
4503
4504 /* ---------------------------------------------------------------------------------------------------- */
4505
4506 /* only called from finalize(), removes all subscriptions */
4507 static void
4508 purge_all_signal_subscriptions (GDBusConnection *connection)
4509 {
4510   GHashTableIter iter;
4511   gpointer key;
4512   GArray *ids;
4513   GArray *subscribers;
4514   guint n;
4515
4516   ids = g_array_new (FALSE, FALSE, sizeof (guint));
4517   g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
4518   while (g_hash_table_iter_next (&iter, &key, NULL))
4519     {
4520       guint subscription_id = GPOINTER_TO_UINT (key);
4521       g_array_append_val (ids, subscription_id);
4522     }
4523
4524   subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
4525   for (n = 0; n < ids->len; n++)
4526     {
4527       guint subscription_id = g_array_index (ids, guint, n);
4528       unsubscribe_id_internal (connection,
4529                                subscription_id,
4530                                subscribers);
4531     }
4532   g_array_free (ids, TRUE);
4533
4534   /* call GDestroyNotify without lock held */
4535   for (n = 0; n < subscribers->len; n++)
4536     {
4537       SignalSubscriber *subscriber;
4538       subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
4539       call_destroy_notify (subscriber->context,
4540                            subscriber->user_data_free_func,
4541                            subscriber->user_data);
4542       g_main_context_unref (subscriber->context);
4543     }
4544
4545   g_array_free (subscribers, TRUE);
4546 }
4547
4548 /* ---------------------------------------------------------------------------------------------------- */
4549
4550 static GDBusInterfaceVTable *
4551 _g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
4552 {
4553   /* Don't waste memory by copying padding - remember to update this
4554    * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
4555    */
4556   return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
4557 }
4558
4559 static void
4560 _g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
4561 {
4562   g_free (vtable);
4563 }
4564
4565 /* ---------------------------------------------------------------------------------------------------- */
4566
4567 static GDBusSubtreeVTable *
4568 _g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
4569 {
4570   /* Don't waste memory by copying padding - remember to update this
4571    * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
4572    */
4573   return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
4574 }
4575
4576 static void
4577 _g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
4578 {
4579   g_free (vtable);
4580 }
4581
4582 /* ---------------------------------------------------------------------------------------------------- */
4583
4584 struct ExportedObject
4585 {
4586   gchar *object_path;
4587   GDBusConnection *connection;
4588
4589   /* maps gchar* -> ExportedInterface* */
4590   GHashTable *map_if_name_to_ei;
4591 };
4592
4593 /* only called with lock held */
4594 static void
4595 exported_object_free (ExportedObject *eo)
4596 {
4597   g_free (eo->object_path);
4598   g_hash_table_unref (eo->map_if_name_to_ei);
4599   g_free (eo);
4600 }
4601
4602 typedef struct
4603 {
4604   ExportedObject *eo;
4605
4606   guint                       id;
4607   gchar                      *interface_name;
4608   GDBusInterfaceVTable       *vtable;
4609   GDBusInterfaceInfo         *interface_info;
4610
4611   GMainContext               *context;
4612   gpointer                    user_data;
4613   GDestroyNotify              user_data_free_func;
4614 } ExportedInterface;
4615
4616 /* called with lock held */
4617 static void
4618 exported_interface_free (ExportedInterface *ei)
4619 {
4620   g_dbus_interface_info_cache_release (ei->interface_info);
4621   g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
4622
4623   call_destroy_notify (ei->context,
4624                        ei->user_data_free_func,
4625                        ei->user_data);
4626
4627   g_main_context_unref (ei->context);
4628
4629   g_free (ei->interface_name);
4630   _g_dbus_interface_vtable_free (ei->vtable);
4631   g_free (ei);
4632 }
4633
4634 /* ---------------------------------------------------------------------------------------------------- */
4635
4636 /* Convenience function to check if @registration_id (if not zero) or
4637  * @subtree_registration_id (if not zero) has been unregistered. If
4638  * so, returns %TRUE.
4639  *
4640  * May be called by any thread. Caller must *not* hold lock.
4641  */
4642 static gboolean
4643 has_object_been_unregistered (GDBusConnection  *connection,
4644                               guint             registration_id,
4645                               guint             subtree_registration_id)
4646 {
4647   gboolean ret;
4648
4649   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4650
4651   ret = FALSE;
4652
4653   CONNECTION_LOCK (connection);
4654   if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
4655                                                    GUINT_TO_POINTER (registration_id)) == NULL)
4656     {
4657       ret = TRUE;
4658     }
4659   else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
4660                                                                 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
4661     {
4662       ret = TRUE;
4663     }
4664   CONNECTION_UNLOCK (connection);
4665
4666   return ret;
4667 }
4668
4669 /* ---------------------------------------------------------------------------------------------------- */
4670
4671 typedef struct
4672 {
4673   GDBusConnection *connection;
4674   GDBusMessage *message;
4675   gpointer user_data;
4676   const gchar *property_name;
4677   const GDBusInterfaceVTable *vtable;
4678   GDBusInterfaceInfo *interface_info;
4679   const GDBusPropertyInfo *property_info;
4680   guint registration_id;
4681   guint subtree_registration_id;
4682 } PropertyData;
4683
4684 static void
4685 property_data_free (PropertyData *data)
4686 {
4687   g_object_unref (data->connection);
4688   g_object_unref (data->message);
4689   g_free (data);
4690 }
4691
4692 /* called in thread where object was registered - no locks held */
4693 static gboolean
4694 invoke_get_property_in_idle_cb (gpointer _data)
4695 {
4696   PropertyData *data = _data;
4697   GVariant *value;
4698   GError *error;
4699   GDBusMessage *reply;
4700
4701   if (has_object_been_unregistered (data->connection,
4702                                     data->registration_id,
4703                                     data->subtree_registration_id))
4704     {
4705       reply = g_dbus_message_new_method_error (data->message,
4706                                                "org.freedesktop.DBus.Error.UnknownMethod",
4707                                                _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
4708                                                g_dbus_message_get_path (data->message));
4709       g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4710       g_object_unref (reply);
4711       goto out;
4712     }
4713
4714   error = NULL;
4715   value = data->vtable->get_property (data->connection,
4716                                       g_dbus_message_get_sender (data->message),
4717                                       g_dbus_message_get_path (data->message),
4718                                       data->interface_info->name,
4719                                       data->property_name,
4720                                       &error,
4721                                       data->user_data);
4722
4723
4724   if (value != NULL)
4725     {
4726       g_assert_no_error (error);
4727
4728       g_variant_take_ref (value);
4729       reply = g_dbus_message_new_method_reply (data->message);
4730       g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
4731       g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4732       g_variant_unref (value);
4733       g_object_unref (reply);
4734     }
4735   else
4736     {
4737       gchar *dbus_error_name;
4738       g_assert (error != NULL);
4739       dbus_error_name = g_dbus_error_encode_gerror (error);
4740       reply = g_dbus_message_new_method_error_literal (data->message,
4741                                                        dbus_error_name,
4742                                                        error->message);
4743       g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4744       g_free (dbus_error_name);
4745       g_error_free (error);
4746       g_object_unref (reply);
4747     }
4748
4749  out:
4750   return FALSE;
4751 }
4752
4753 /* called in thread where object was registered - no locks held */
4754 static gboolean
4755 invoke_set_property_in_idle_cb (gpointer _data)
4756 {
4757   PropertyData *data = _data;
4758   GError *error;
4759   GDBusMessage *reply;
4760   GVariant *value;
4761
4762   error = NULL;
4763   value = NULL;
4764
4765   g_variant_get (g_dbus_message_get_body (data->message),
4766                  "(ssv)",
4767                  NULL,
4768                  NULL,
4769                  &value);
4770
4771   if (!data->vtable->set_property (data->connection,
4772                                    g_dbus_message_get_sender (data->message),
4773                                    g_dbus_message_get_path (data->message),
4774                                    data->interface_info->name,
4775                                    data->property_name,
4776                                    value,
4777                                    &error,
4778                                    data->user_data))
4779     {
4780       gchar *dbus_error_name;
4781       g_assert (error != NULL);
4782       dbus_error_name = g_dbus_error_encode_gerror (error);
4783       reply = g_dbus_message_new_method_error_literal (data->message,
4784                                                        dbus_error_name,
4785                                                        error->message);
4786       g_free (dbus_error_name);
4787       g_error_free (error);
4788     }
4789   else
4790     {
4791       reply = g_dbus_message_new_method_reply (data->message);
4792     }
4793
4794   g_assert (reply != NULL);
4795   g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4796   g_object_unref (reply);
4797   g_variant_unref (value);
4798
4799   return FALSE;
4800 }
4801
4802 /* called in any thread with connection's lock held */
4803 static gboolean
4804 validate_and_maybe_schedule_property_getset (GDBusConnection            *connection,
4805                                              GDBusMessage               *message,
4806                                              guint                       registration_id,
4807                                              guint                       subtree_registration_id,
4808                                              gboolean                    is_get,
4809                                              GDBusInterfaceInfo         *interface_info,
4810                                              const GDBusInterfaceVTable *vtable,
4811                                              GMainContext               *main_context,
4812                                              gpointer                    user_data)
4813 {
4814   gboolean handled;
4815   const char *interface_name;
4816   const char *property_name;
4817   const GDBusPropertyInfo *property_info;
4818   GSource *idle_source;
4819   PropertyData *property_data;
4820   GDBusMessage *reply;
4821
4822   handled = FALSE;
4823
4824   if (is_get)
4825     g_variant_get (g_dbus_message_get_body (message),
4826                    "(&s&s)",
4827                    &interface_name,
4828                    &property_name);
4829   else
4830     g_variant_get (g_dbus_message_get_body (message),
4831                    "(&s&sv)",
4832                    &interface_name,
4833                    &property_name,
4834                    NULL);
4835
4836   if (vtable == NULL)
4837     goto out;
4838
4839   /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
4840    */
4841   property_info = NULL;
4842
4843   /* TODO: the cost of this is O(n) - it might be worth caching the result */
4844   property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
4845   if (property_info == NULL)
4846     {
4847       reply = g_dbus_message_new_method_error (message,
4848                                                "org.freedesktop.DBus.Error.InvalidArgs",
4849                                                _("No such property '%s'"),
4850                                                property_name);
4851       g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4852       g_object_unref (reply);
4853       handled = TRUE;
4854       goto out;
4855     }
4856
4857   if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4858     {
4859       reply = g_dbus_message_new_method_error (message,
4860                                                "org.freedesktop.DBus.Error.InvalidArgs",
4861                                                _("Property '%s' is not readable"),
4862                                                property_name);
4863       g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4864       g_object_unref (reply);
4865       handled = TRUE;
4866       goto out;
4867     }
4868   else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
4869     {
4870       reply = g_dbus_message_new_method_error (message,
4871                                                "org.freedesktop.DBus.Error.InvalidArgs",
4872                                                _("Property '%s' is not writable"),
4873                                                property_name);
4874       g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4875       g_object_unref (reply);
4876       handled = TRUE;
4877       goto out;
4878     }
4879
4880   if (!is_get)
4881     {
4882       GVariant *value;
4883
4884       /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
4885        * of the given value is wrong
4886        */
4887       g_variant_get_child (g_dbus_message_get_body (message), 2, "v", &value);
4888       if (g_strcmp0 (g_variant_get_type_string (value), property_info->signature) != 0)
4889         {
4890           reply = g_dbus_message_new_method_error (message,
4891                                                    "org.freedesktop.DBus.Error.InvalidArgs",
4892                                                    _("Error setting property '%s': Expected type '%s' but got '%s'"),
4893                                                    property_name, property_info->signature,
4894                                                    g_variant_get_type_string (value));
4895           g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4896           g_variant_unref (value);
4897           g_object_unref (reply);
4898           handled = TRUE;
4899           goto out;
4900         }
4901
4902       g_variant_unref (value);
4903     }
4904
4905   /* If the vtable pointer for get_property() resp. set_property() is
4906    * NULL then dispatch the call via the method_call() handler.
4907    */
4908   if (is_get)
4909     {
4910       if (vtable->get_property == NULL)
4911         {
4912           schedule_method_call (connection, message, registration_id, subtree_registration_id,
4913                                 interface_info, NULL, property_info, g_dbus_message_get_body (message),
4914                                 vtable, main_context, user_data);
4915           handled = TRUE;
4916           goto out;
4917         }
4918     }
4919   else
4920     {
4921       if (vtable->set_property == NULL)
4922         {
4923           schedule_method_call (connection, message, registration_id, subtree_registration_id,
4924                                 interface_info, NULL, property_info, g_dbus_message_get_body (message),
4925                                 vtable, main_context, user_data);
4926           handled = TRUE;
4927           goto out;
4928         }
4929     }
4930
4931   /* ok, got the property info - call user code in an idle handler */
4932   property_data = g_new0 (PropertyData, 1);
4933   property_data->connection = g_object_ref (connection);
4934   property_data->message = g_object_ref (message);
4935   property_data->user_data = user_data;
4936   property_data->property_name = property_name;
4937   property_data->vtable = vtable;
4938   property_data->interface_info = interface_info;
4939   property_data->property_info = property_info;
4940   property_data->registration_id = registration_id;
4941   property_data->subtree_registration_id = subtree_registration_id;
4942
4943   idle_source = g_idle_source_new ();
4944   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4945   g_source_set_callback (idle_source,
4946                          is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
4947                          property_data,
4948                          (GDestroyNotify) property_data_free);
4949   if (is_get)
4950     g_source_set_name (idle_source, "[gio] invoke_get_property_in_idle_cb");
4951   else
4952     g_source_set_name (idle_source, "[gio] invoke_set_property_in_idle_cb");
4953   g_source_attach (idle_source, main_context);
4954   g_source_unref (idle_source);
4955
4956   handled = TRUE;
4957
4958  out:
4959   return handled;
4960 }
4961
4962 /* called in GDBusWorker thread with connection's lock held */
4963 static gboolean
4964 handle_getset_property (GDBusConnection *connection,
4965                         ExportedObject  *eo,
4966                         GDBusMessage    *message,
4967                         gboolean         is_get)
4968 {
4969   ExportedInterface *ei;
4970   gboolean handled;
4971   const char *interface_name;
4972   const char *property_name;
4973
4974   handled = FALSE;
4975
4976   if (is_get)
4977     g_variant_get (g_dbus_message_get_body (message),
4978                    "(&s&s)",
4979                    &interface_name,
4980                    &property_name);
4981   else
4982     g_variant_get (g_dbus_message_get_body (message),
4983                    "(&s&sv)",
4984                    &interface_name,
4985                    &property_name,
4986                    NULL);
4987
4988   /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4989    * no such interface registered
4990    */
4991   ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4992   if (ei == NULL)
4993     {
4994       GDBusMessage *reply;
4995       reply = g_dbus_message_new_method_error (message,
4996                                                "org.freedesktop.DBus.Error.InvalidArgs",
4997                                                _("No such interface '%s'"),
4998                                                interface_name);
4999       g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5000       g_object_unref (reply);
5001       handled = TRUE;
5002       goto out;
5003     }
5004
5005   handled = validate_and_maybe_schedule_property_getset (eo->connection,
5006                                                          message,
5007                                                          ei->id,
5008                                                          0,
5009                                                          is_get,
5010                                                          ei->interface_info,
5011                                                          ei->vtable,
5012                                                          ei->context,
5013                                                          ei->user_data);
5014  out:
5015   return handled;
5016 }
5017
5018 /* ---------------------------------------------------------------------------------------------------- */
5019
5020 typedef struct
5021 {
5022   GDBusConnection *connection;
5023   GDBusMessage *message;
5024   gpointer user_data;
5025   const GDBusInterfaceVTable *vtable;
5026   GDBusInterfaceInfo *interface_info;
5027   guint registration_id;
5028   guint subtree_registration_id;
5029 } PropertyGetAllData;
5030
5031 static void
5032 property_get_all_data_free (PropertyData *data)
5033 {
5034   g_object_unref (data->connection);
5035   g_object_unref (data->message);
5036   g_free (data);
5037 }
5038
5039 /* called in thread where object was registered - no locks held */
5040 static gboolean
5041 invoke_get_all_properties_in_idle_cb (gpointer _data)
5042 {
5043   PropertyGetAllData *data = _data;
5044   GVariantBuilder builder;
5045   GDBusMessage *reply;
5046   guint n;
5047
5048   if (has_object_been_unregistered (data->connection,
5049                                     data->registration_id,
5050                                     data->subtree_registration_id))
5051     {
5052       reply = g_dbus_message_new_method_error (data->message,
5053                                                "org.freedesktop.DBus.Error.UnknownMethod",
5054                                                _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
5055                                                g_dbus_message_get_path (data->message));
5056       g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5057       g_object_unref (reply);
5058       goto out;
5059     }
5060
5061   /* TODO: Right now we never fail this call - we just omit values if
5062    *       a get_property() call is failing.
5063    *
5064    *       We could fail the whole call if just a single get_property() call
5065    *       returns an error. We need clarification in the D-Bus spec about this.
5066    */
5067   g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
5068   g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
5069   for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
5070     {
5071       const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
5072       GVariant *value;
5073
5074       if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
5075         continue;
5076
5077       value = data->vtable->get_property (data->connection,
5078                                           g_dbus_message_get_sender (data->message),
5079                                           g_dbus_message_get_path (data->message),
5080                                           data->interface_info->name,
5081                                           property_info->name,
5082                                           NULL,
5083                                           data->user_data);
5084
5085       if (value == NULL)
5086         continue;
5087
5088       g_variant_take_ref (value);
5089       g_variant_builder_add (&builder,
5090                              "{sv}",
5091                              property_info->name,
5092                              value);
5093       g_variant_unref (value);
5094     }
5095   g_variant_builder_close (&builder);
5096
5097   reply = g_dbus_message_new_method_reply (data->message);
5098   g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
5099   g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5100   g_object_unref (reply);
5101
5102  out:
5103   return FALSE;
5104 }
5105
5106 static gboolean
5107 interface_has_readable_properties (GDBusInterfaceInfo *interface_info)
5108 {
5109   gint i;
5110
5111   if (!interface_info->properties)
5112     return FALSE;
5113
5114   for (i = 0; interface_info->properties[i]; i++)
5115     if (interface_info->properties[i]->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)
5116       return TRUE;
5117
5118   return FALSE;
5119 }
5120
5121 /* called in any thread with connection's lock held */
5122 static gboolean
5123 validate_and_maybe_schedule_property_get_all (GDBusConnection            *connection,
5124                                               GDBusMessage               *message,
5125                                               guint                       registration_id,
5126                                               guint                       subtree_registration_id,
5127                                               GDBusInterfaceInfo         *interface_info,
5128                                               const GDBusInterfaceVTable *vtable,
5129                                               GMainContext               *main_context,
5130                                               gpointer                    user_data)
5131 {
5132   gboolean handled;
5133   GSource *idle_source;
5134   PropertyGetAllData *property_get_all_data;
5135
5136   handled = FALSE;
5137
5138   if (vtable == NULL)
5139     goto out;
5140
5141   /* If the vtable pointer for get_property() is NULL but we have a
5142    * non-zero number of readable properties, then dispatch the call via
5143    * the method_call() handler.
5144    */
5145   if (vtable->get_property == NULL && interface_has_readable_properties (interface_info))
5146     {
5147       schedule_method_call (connection, message, registration_id, subtree_registration_id,
5148                             interface_info, NULL, NULL, g_dbus_message_get_body (message),
5149                             vtable, main_context, user_data);
5150       handled = TRUE;
5151       goto out;
5152     }
5153
5154   /* ok, got the property info - call user in an idle handler */
5155   property_get_all_data = g_new0 (PropertyGetAllData, 1);
5156   property_get_all_data->connection = g_object_ref (connection);
5157   property_get_all_data->message = g_object_ref (message);
5158   property_get_all_data->user_data = user_data;
5159   property_get_all_data->vtable = vtable;
5160   property_get_all_data->interface_info = interface_info;
5161   property_get_all_data->registration_id = registration_id;
5162   property_get_all_data->subtree_registration_id = subtree_registration_id;
5163
5164   idle_source = g_idle_source_new ();
5165   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
5166   g_source_set_callback (idle_source,
5167                          invoke_get_all_properties_in_idle_cb,
5168                          property_get_all_data,
5169                          (GDestroyNotify) property_get_all_data_free);
5170   g_source_set_name (idle_source, "[gio] invoke_get_all_properties_in_idle_cb");
5171   g_source_attach (idle_source, main_context);
5172   g_source_unref (idle_source);
5173
5174   handled = TRUE;
5175
5176  out:
5177   return handled;
5178 }
5179
5180 /* called in GDBusWorker thread with connection's lock held */
5181 static gboolean
5182 handle_get_all_properties (GDBusConnection *connection,
5183                            ExportedObject  *eo,
5184                            GDBusMessage    *message)
5185 {
5186   ExportedInterface *ei;
5187   gboolean handled;
5188   const char *interface_name;
5189
5190   handled = FALSE;
5191
5192   g_variant_get (g_dbus_message_get_body (message),
5193                  "(&s)",
5194                  &interface_name);
5195
5196   /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
5197    * no such interface registered
5198    */
5199   ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
5200   if (ei == NULL)
5201     {
5202       GDBusMessage *reply;
5203       reply = g_dbus_message_new_method_error (message,
5204                                                "org.freedesktop.DBus.Error.InvalidArgs",
5205                                                _("No such interface"),
5206                                                interface_name);
5207       g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5208       g_object_unref (reply);
5209       handled = TRUE;
5210       goto out;
5211     }
5212
5213   handled = validate_and_maybe_schedule_property_get_all (eo->connection,
5214                                                           message,
5215                                                           ei->id,
5216                                                           0,
5217                                                           ei->interface_info,
5218                                                           ei->vtable,
5219                                                           ei->context,
5220                                                           ei->user_data);
5221  out:
5222   return handled;
5223 }
5224
5225 /* ---------------------------------------------------------------------------------------------------- */
5226
5227 static const gchar introspect_header[] =
5228   "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
5229   "                      \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
5230   "<!-- GDBus " PACKAGE_VERSION " -->\n"
5231   "<node>\n";
5232
5233 static const gchar introspect_tail[] =
5234   "</node>\n";
5235
5236 static const gchar introspect_properties_interface[] =
5237   "  <interface name=\"org.freedesktop.DBus.Properties\">\n"
5238   "    <method name=\"Get\">\n"
5239   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5240   "      <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
5241   "      <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
5242   "    </method>\n"
5243   "    <method name=\"GetAll\">\n"
5244   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5245   "      <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
5246   "    </method>\n"
5247   "    <method name=\"Set\">\n"
5248   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5249   "      <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
5250   "      <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
5251   "    </method>\n"
5252   "    <signal name=\"PropertiesChanged\">\n"
5253   "      <arg type=\"s\" name=\"interface_name\"/>\n"
5254   "      <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
5255   "      <arg type=\"as\" name=\"invalidated_properties\"/>\n"
5256   "    </signal>\n"
5257   "  </interface>\n";
5258
5259 static const gchar introspect_introspectable_interface[] =
5260   "  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
5261   "    <method name=\"Introspect\">\n"
5262   "      <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
5263   "    </method>\n"
5264   "  </interface>\n"
5265   "  <interface name=\"org.freedesktop.DBus.Peer\">\n"
5266   "    <method name=\"Ping\"/>\n"
5267   "    <method name=\"GetMachineId\">\n"
5268   "      <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
5269   "    </method>\n"
5270   "  </interface>\n";
5271
5272 static void
5273 introspect_append_header (GString *s)
5274 {
5275   g_string_append (s, introspect_header);
5276 }
5277
5278 static void
5279 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
5280 {
5281   if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
5282     {
5283       const gchar *begin;
5284       const gchar *end;
5285       gchar *s;
5286
5287       begin = object_path + path_len;
5288       end = strchr (begin, '/');
5289       if (end != NULL)
5290         s = g_strndup (begin, end - begin);
5291       else
5292         s = g_strdup (begin);
5293
5294       if (g_hash_table_lookup (set, s) == NULL)
5295         g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
5296       else
5297         g_free (s);
5298     }
5299 }
5300
5301 /* TODO: we want a nicer public interface for this */
5302 /* called in any thread with connection's lock held */
5303 static gchar **
5304 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
5305                                             const gchar     *path)
5306 {
5307   GPtrArray *p;
5308   gchar **ret;
5309   GHashTableIter hash_iter;
5310   const gchar *object_path;
5311   gsize path_len;
5312   GHashTable *set;
5313   GList *keys;
5314   GList *l;
5315
5316   CONNECTION_ENSURE_LOCK (connection);
5317
5318   path_len = strlen (path);
5319   if (path_len > 1)
5320     path_len++;
5321
5322   set = g_hash_table_new (g_str_hash, g_str_equal);
5323
5324   g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
5325   while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
5326     maybe_add_path (path, path_len, object_path, set);
5327
5328   g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
5329   while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
5330     maybe_add_path (path, path_len, object_path, set);
5331
5332   p = g_ptr_array_new ();
5333   keys = g_hash_table_get_keys (set);
5334   for (l = keys; l != NULL; l = l->next)
5335     g_ptr_array_add (p, l->data);
5336   g_hash_table_unref (set);
5337   g_list_free (keys);
5338
5339   g_ptr_array_add (p, NULL);
5340   ret = (gchar **) g_ptr_array_free (p, FALSE);
5341   return ret;
5342 }
5343
5344 /* called in any thread with connection's lock not held */
5345 static gchar **
5346 g_dbus_connection_list_registered (GDBusConnection *connection,
5347                                    const gchar     *path)
5348 {
5349   gchar **ret;
5350   CONNECTION_LOCK (connection);
5351   ret = g_dbus_connection_list_registered_unlocked (connection, path);
5352   CONNECTION_UNLOCK (connection);
5353   return ret;
5354 }
5355
5356 /* called in GDBusWorker thread with connection's lock held */
5357 static gboolean
5358 handle_introspect (GDBusConnection *connection,
5359                    ExportedObject  *eo,
5360                    GDBusMessage    *message)
5361 {
5362   guint n;
5363   GString *s;
5364   GDBusMessage *reply;
5365   GHashTableIter hash_iter;
5366   ExportedInterface *ei;
5367   gchar **registered;
5368
5369   /* first the header with the standard interfaces */
5370   s = g_string_sized_new (sizeof (introspect_header) +
5371                           sizeof (introspect_properties_interface) +
5372                           sizeof (introspect_introspectable_interface) +
5373                           sizeof (introspect_tail));
5374   introspect_append_header (s);
5375   if (!g_hash_table_lookup (eo->map_if_name_to_ei,
5376                             "org.freedesktop.DBus.Properties"))
5377     g_string_append (s, introspect_properties_interface);
5378
5379   if (!g_hash_table_lookup (eo->map_if_name_to_ei,
5380                             "org.freedesktop.DBus.Introspectable"))
5381     g_string_append (s, introspect_introspectable_interface);
5382
5383   /* then include the registered interfaces */
5384   g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
5385   while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
5386     g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
5387
5388   /* finally include nodes registered below us */
5389   registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
5390   for (n = 0; registered != NULL && registered[n] != NULL; n++)
5391     g_string_append_printf (s, "  <node name=\"%s\"/>\n", registered[n]);
5392   g_strfreev (registered);
5393   g_string_append (s, introspect_tail);
5394
5395   reply = g_dbus_message_new_method_reply (message);
5396   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5397   g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5398   g_object_unref (reply);
5399   g_string_free (s, TRUE);
5400
5401   return TRUE;
5402 }
5403
5404 /* called in thread where object was registered - no locks held */
5405 static gboolean
5406 call_in_idle_cb (gpointer user_data)
5407 {
5408   GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
5409   GDBusInterfaceVTable *vtable;
5410   guint registration_id;
5411   guint subtree_registration_id;
5412
5413   registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
5414   subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
5415
5416   if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
5417                                     registration_id,
5418                                     subtree_registration_id))
5419     {
5420       GDBusMessage *reply;
5421       reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
5422                                                "org.freedesktop.DBus.Error.UnknownMethod",
5423                                                _("No such interface '%s' on object at path %s"),
5424                                                g_dbus_method_invocation_get_interface_name (invocation),
5425                                                g_dbus_method_invocation_get_object_path (invocation));
5426       g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5427       g_object_unref (reply);
5428       goto out;
5429     }
5430
5431   vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
5432   g_assert (vtable != NULL && vtable->method_call != NULL);
5433
5434   vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
5435                        g_dbus_method_invocation_get_sender (invocation),
5436                        g_dbus_method_invocation_get_object_path (invocation),
5437                        g_dbus_method_invocation_get_interface_name (invocation),
5438                        g_dbus_method_invocation_get_method_name (invocation),
5439                        g_dbus_method_invocation_get_parameters (invocation),
5440                        g_object_ref (invocation),
5441                        g_dbus_method_invocation_get_user_data (invocation));
5442
5443  out:
5444   return FALSE;
5445 }
5446
5447 /* called in GDBusWorker thread with connection's lock held */
5448 static void
5449 schedule_method_call (GDBusConnection            *connection,
5450                       GDBusMessage               *message,
5451                       guint                       registration_id,
5452                       guint                       subtree_registration_id,
5453                       const GDBusInterfaceInfo   *interface_info,
5454                       const GDBusMethodInfo      *method_info,
5455                       const GDBusPropertyInfo    *property_info,
5456                       GVariant                   *parameters,
5457                       const GDBusInterfaceVTable *vtable,
5458                       GMainContext               *main_context,
5459                       gpointer                    user_data)
5460 {
5461   GDBusMethodInvocation *invocation;
5462   GSource *idle_source;
5463
5464   invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
5465                                               g_dbus_message_get_path (message),
5466                                               g_dbus_message_get_interface (message),
5467                                               g_dbus_message_get_member (message),
5468                                               method_info,
5469                                               property_info,
5470                                               connection,
5471                                               message,
5472                                               parameters,
5473                                               user_data);
5474
5475   /* TODO: would be nicer with a real MethodData like we already
5476    * have PropertyData and PropertyGetAllData... */
5477   g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
5478   g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
5479   g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
5480
5481   idle_source = g_idle_source_new ();
5482   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
5483   g_source_set_callback (idle_source,
5484                          call_in_idle_cb,
5485                          invocation,
5486                          g_object_unref);
5487   g_source_set_name (idle_source, "[gio] call_in_idle_cb");
5488   g_source_attach (idle_source, main_context);
5489   g_source_unref (idle_source);
5490 }
5491
5492 /* called in GDBusWorker thread with connection's lock held */
5493 static gboolean
5494 validate_and_maybe_schedule_method_call (GDBusConnection            *connection,
5495                                          GDBusMessage               *message,
5496                                          guint                       registration_id,
5497                                          guint                       subtree_registration_id,
5498                                          GDBusInterfaceInfo         *interface_info,
5499                                          const GDBusInterfaceVTable *vtable,
5500                                          GMainContext               *main_context,
5501                                          gpointer                    user_data)
5502 {
5503   GDBusMethodInfo *method_info;
5504   GDBusMessage *reply;
5505   GVariant *parameters;
5506   gboolean handled;
5507   GVariantType *in_type;
5508
5509   handled = FALSE;
5510
5511   /* TODO: the cost of this is O(n) - it might be worth caching the result */
5512   method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
5513
5514   /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
5515    * error to the caller
5516    */
5517   if (method_info == NULL)
5518     {
5519       reply = g_dbus_message_new_method_error (message,
5520                                                "org.freedesktop.DBus.Error.UnknownMethod",
5521                                                _("No such method '%s'"),
5522                                                g_dbus_message_get_member (message));
5523       g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5524       g_object_unref (reply);
5525       handled = TRUE;
5526       goto out;
5527     }
5528
5529   parameters = g_dbus_message_get_body (message);
5530   if (parameters == NULL)
5531     {
5532       parameters = g_variant_new ("()");
5533       g_variant_ref_sink (parameters);
5534     }
5535   else
5536     {
5537       g_variant_ref (parameters);
5538     }
5539
5540   /* Check that the incoming args are of the right type - if they are not, return
5541    * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
5542    */
5543   in_type = _g_dbus_compute_complete_signature (method_info->in_args);
5544   if (!g_variant_is_of_type (parameters, in_type))
5545     {
5546       gchar *type_string;
5547
5548       type_string = g_variant_type_dup_string (in_type);
5549
5550       reply = g_dbus_message_new_method_error (message,
5551                                                "org.freedesktop.DBus.Error.InvalidArgs",
5552                                                _("Type of message, '%s', does not match expected type '%s'"),
5553                                                g_variant_get_type_string (parameters),
5554                                                type_string);
5555       g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5556       g_variant_type_free (in_type);
5557       g_variant_unref (parameters);
5558       g_object_unref (reply);
5559       g_free (type_string);
5560       handled = TRUE;
5561       goto out;
5562     }
5563   g_variant_type_free (in_type);
5564
5565   /* schedule the call in idle */
5566   schedule_method_call (connection, message, registration_id, subtree_registration_id,
5567                         interface_info, method_info, NULL, parameters,
5568                         vtable, main_context, user_data);
5569   g_variant_unref (parameters);
5570   handled = TRUE;
5571
5572  out:
5573   return handled;
5574 }
5575
5576 /* ---------------------------------------------------------------------------------------------------- */
5577
5578 /* called in GDBusWorker thread with connection's lock held */
5579 static gboolean
5580 obj_message_func (GDBusConnection *connection,
5581                   ExportedObject  *eo,
5582                   GDBusMessage    *message)
5583 {
5584   const gchar *interface_name;
5585   const gchar *member;
5586   const gchar *signature;
5587   gboolean handled;
5588
5589   handled = FALSE;
5590
5591   interface_name = g_dbus_message_get_interface (message);
5592   member = g_dbus_message_get_member (message);
5593   signature = g_dbus_message_get_signature (message);
5594
5595   /* see if we have an interface for handling this call */
5596   if (interface_name != NULL)
5597     {
5598       ExportedInterface *ei;
5599       ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
5600       if (ei != NULL)
5601         {
5602           /* we do - invoke the handler in idle in the right thread */
5603
5604           /* handle no vtable or handler being present */
5605           if (ei->vtable == NULL || ei->vtable->method_call == NULL)
5606             goto out;
5607
5608           handled = validate_and_maybe_schedule_method_call (connection,
5609                                                              message,
5610                                                              ei->id,
5611                                                              0,
5612                                                              ei->interface_info,
5613                                                              ei->vtable,
5614                                                              ei->context,
5615                                                              ei->user_data);
5616           goto out;
5617         }
5618     }
5619
5620   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
5621       g_strcmp0 (member, "Introspect") == 0 &&
5622       g_strcmp0 (signature, "") == 0)
5623     {
5624       handled = handle_introspect (connection, eo, message);
5625       goto out;
5626     }
5627   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5628            g_strcmp0 (member, "Get") == 0 &&
5629            g_strcmp0 (signature, "ss") == 0)
5630     {
5631       handled = handle_getset_property (connection, eo, message, TRUE);
5632       goto out;
5633     }
5634   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5635            g_strcmp0 (member, "Set") == 0 &&
5636            g_strcmp0 (signature, "ssv") == 0)
5637     {
5638       handled = handle_getset_property (connection, eo, message, FALSE);
5639       goto out;
5640     }
5641   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5642            g_strcmp0 (member, "GetAll") == 0 &&
5643            g_strcmp0 (signature, "s") == 0)
5644     {
5645       handled = handle_get_all_properties (connection, eo, message);
5646       goto out;
5647     }
5648
5649  out:
5650   return handled;
5651 }
5652
5653 /**
5654  * g_dbus_connection_register_object:
5655  * @connection: a #GDBusConnection
5656  * @object_path: the object path to register at
5657  * @interface_info: introspection data for the interface
5658  * @vtable: (allow-none): a #GDBusInterfaceVTable to call into or %NULL
5659  * @user_data: (allow-none): data to pass to functions in @vtable
5660  * @user_data_free_func: function to call when the object path is unregistered
5661  * @error: return location for error or %NULL
5662  *
5663  * Registers callbacks for exported objects at @object_path with the
5664  * D-Bus interface that is described in @interface_info.
5665  *
5666  * Calls to functions in @vtable (and @user_data_free_func) will happen
5667  * in the
5668  * [thread-default main context][g-main-context-push-thread-default]
5669  * of the thread you are calling this method from.
5670  *
5671  * Note that all #GVariant values passed to functions in @vtable will match
5672  * the signature given in @interface_info - if a remote caller passes
5673  * incorrect values, the `org.freedesktop.DBus.Error.InvalidArgs`
5674  * is returned to the remote caller.
5675  *
5676  * Additionally, if the remote caller attempts to invoke methods or
5677  * access properties not mentioned in @interface_info the
5678  * `org.freedesktop.DBus.Error.UnknownMethod` resp.
5679  * `org.freedesktop.DBus.Error.InvalidArgs` errors
5680  * are returned to the caller.
5681  *
5682  * It is considered a programming error if the
5683  * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
5684  * #GVariant of incorrect type.
5685  *
5686  * If an existing callback is already registered at @object_path and
5687  * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
5688  *
5689  * GDBus automatically implements the standard D-Bus interfaces
5690  * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
5691  * and org.freedesktop.Peer, so you don't have to implement those for the
5692  * objects you export. You can implement org.freedesktop.DBus.Properties
5693  * yourself, e.g. to handle getting and setting of properties asynchronously.
5694  *
5695  * Note that the reference count on @interface_info will be
5696  * incremented by 1 (unless allocated statically, e.g. if the
5697  * reference count is -1, see g_dbus_interface_info_ref()) for as long
5698  * as the object is exported. Also note that @vtable will be copied.
5699  *
5700  * See this [server][gdbus-server] for an example of how to use this method.
5701  *
5702  * Returns: 0 if @error is set, otherwise a registration id (never 0)
5703  *     that can be used with g_dbus_connection_unregister_object()
5704  *
5705  * Since: 2.26
5706  */
5707 guint
5708 g_dbus_connection_register_object (GDBusConnection             *connection,
5709                                    const gchar                 *object_path,
5710                                    GDBusInterfaceInfo          *interface_info,
5711                                    const GDBusInterfaceVTable  *vtable,
5712                                    gpointer                     user_data,
5713                                    GDestroyNotify               user_data_free_func,
5714                                    GError                     **error)
5715 {
5716   ExportedObject *eo;
5717   ExportedInterface *ei;
5718   guint ret;
5719
5720   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
5721   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
5722   g_return_val_if_fail (interface_info != NULL, 0);
5723   g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
5724   g_return_val_if_fail (error == NULL || *error == NULL, 0);
5725   g_return_val_if_fail (check_initialized (connection), 0);
5726
5727   ret = 0;
5728
5729   CONNECTION_LOCK (connection);
5730
5731   eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
5732   if (eo == NULL)
5733     {
5734       eo = g_new0 (ExportedObject, 1);
5735       eo->object_path = g_strdup (object_path);
5736       eo->connection = connection;
5737       eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
5738                                                      g_str_equal,
5739                                                      NULL,
5740                                                      (GDestroyNotify) exported_interface_free);
5741       g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
5742     }
5743
5744   ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
5745   if (ei != NULL)
5746     {
5747       g_set_error (error,
5748                    G_IO_ERROR,
5749                    G_IO_ERROR_EXISTS,
5750                    _("An object is already exported for the interface %s at %s"),
5751                    interface_info->name,
5752                    object_path);
5753       goto out;
5754     }
5755
5756   ei = g_new0 (ExportedInterface, 1);
5757   ei->id = _global_registration_id++; /* TODO: overflow etc. */
5758   ei->eo = eo;
5759   ei->user_data = user_data;
5760   ei->user_data_free_func = user_data_free_func;
5761   ei->vtable = _g_dbus_interface_vtable_copy (vtable);
5762   ei->interface_info = g_dbus_interface_info_ref (interface_info);
5763   g_dbus_interface_info_cache_build (ei->interface_info);
5764   ei->interface_name = g_strdup (interface_info->name);
5765   ei->context = g_main_context_ref_thread_default ();
5766
5767   g_hash_table_insert (eo->map_if_name_to_ei,
5768                        (gpointer) ei->interface_name,
5769                        ei);
5770   g_hash_table_insert (connection->map_id_to_ei,
5771                        GUINT_TO_POINTER (ei->id),
5772                        ei);
5773
5774   ret = ei->id;
5775
5776  out:
5777   CONNECTION_UNLOCK (connection);
5778
5779   return ret;
5780 }
5781
5782 /**
5783  * g_dbus_connection_unregister_object:
5784  * @connection: a #GDBusConnection
5785  * @registration_id: a registration id obtained from
5786  *     g_dbus_connection_register_object()
5787  *
5788  * Unregisters an object.
5789  *
5790  * Returns: %TRUE if the object was unregistered, %FALSE otherwise
5791  *
5792  * Since: 2.26
5793  */
5794 gboolean
5795 g_dbus_connection_unregister_object (GDBusConnection *connection,
5796                                      guint            registration_id)
5797 {
5798   ExportedInterface *ei;
5799   ExportedObject *eo;
5800   gboolean ret;
5801
5802   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5803   g_return_val_if_fail (check_initialized (connection), FALSE);
5804
5805   ret = FALSE;
5806
5807   CONNECTION_LOCK (connection);
5808
5809   ei = g_hash_table_lookup (connection->map_id_to_ei,
5810                             GUINT_TO_POINTER (registration_id));
5811   if (ei == NULL)
5812     goto out;
5813
5814   eo = ei->eo;
5815
5816   g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
5817   g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
5818   /* unregister object path if we have no more exported interfaces */
5819   if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
5820     g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
5821                                          eo->object_path));
5822
5823   ret = TRUE;
5824
5825  out:
5826   CONNECTION_UNLOCK (connection);
5827
5828   return ret;
5829 }
5830
5831 /* ---------------------------------------------------------------------------------------------------- */
5832
5833 /**
5834  * g_dbus_connection_emit_signal:
5835  * @connection: a #GDBusConnection
5836  * @destination_bus_name: (allow-none): the unique bus name for the destination
5837  *     for the signal or %NULL to emit to all listeners
5838  * @object_path: path of remote object
5839  * @interface_name: D-Bus interface to emit a signal on
5840  * @signal_name: the name of the signal to emit
5841  * @parameters: (allow-none): a #GVariant tuple with parameters for the signal
5842  *              or %NULL if not passing parameters
5843  * @error: Return location for error or %NULL
5844  *
5845  * Emits a signal.
5846  *
5847  * If the parameters GVariant is floating, it is consumed.
5848  *
5849  * This can only fail if @parameters is not compatible with the D-Bus protocol.
5850  *
5851  * Returns: %TRUE unless @error is set
5852  *
5853  * Since: 2.26
5854  */
5855 gboolean
5856 g_dbus_connection_emit_signal (GDBusConnection  *connection,
5857                                const gchar      *destination_bus_name,
5858                                const gchar      *object_path,
5859                                const gchar      *interface_name,
5860                                const gchar      *signal_name,
5861                                GVariant         *parameters,
5862                                GError          **error)
5863 {
5864   GDBusMessage *message;
5865   gboolean ret;
5866
5867   message = NULL;
5868   ret = FALSE;
5869
5870   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5871   g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
5872   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
5873   g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
5874   g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
5875   g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
5876   g_return_val_if_fail (check_initialized (connection), FALSE);
5877
5878   if (G_UNLIKELY (_g_dbus_debug_emission ()))
5879     {
5880       _g_dbus_debug_print_lock ();
5881       g_print ("========================================================================\n"
5882                "GDBus-debug:Emission:\n"
5883                " >>>> SIGNAL EMISSION %s.%s()\n"
5884                "      on object %s\n"
5885                "      destination %s\n",
5886                interface_name, signal_name,
5887                object_path,
5888                destination_bus_name != NULL ? destination_bus_name : "(none)");
5889       _g_dbus_debug_print_unlock ();
5890     }
5891
5892   message = g_dbus_message_new_signal (object_path,
5893                                        interface_name,
5894                                        signal_name);
5895
5896   if (destination_bus_name != NULL)
5897     g_dbus_message_set_header (message,
5898                                G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
5899                                g_variant_new_string (destination_bus_name));
5900
5901   if (parameters != NULL)
5902     g_dbus_message_set_body (message, parameters);
5903
5904   ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
5905   g_object_unref (message);
5906
5907   return ret;
5908 }
5909
5910 static void
5911 add_call_flags (GDBusMessage           *message,
5912                          GDBusCallFlags  flags)
5913 {
5914   if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
5915     g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
5916 }
5917
5918 static GVariant *
5919 decode_method_reply (GDBusMessage        *reply,
5920                      const gchar         *method_name,
5921                      const GVariantType  *reply_type,
5922                      GUnixFDList        **out_fd_list,
5923                      GError             **error)
5924 {
5925   GVariant *result;
5926
5927   result = NULL;
5928   switch (g_dbus_message_get_message_type (reply))
5929     {
5930     case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
5931       result = g_dbus_message_get_body (reply);
5932       if (result == NULL)
5933         {
5934           result = g_variant_new ("()");
5935           g_variant_ref_sink (result);
5936         }
5937       else
5938         {
5939           g_variant_ref (result);
5940         }
5941
5942       if (!g_variant_is_of_type (result, reply_type))
5943         {
5944           gchar *type_string = g_variant_type_dup_string (reply_type);
5945
5946           g_set_error (error,
5947                        G_IO_ERROR,
5948                        G_IO_ERROR_INVALID_ARGUMENT,
5949                        _("Method '%s' returned type '%s', but expected '%s'"),
5950                        method_name, g_variant_get_type_string (result), type_string);
5951
5952           g_variant_unref (result);
5953           g_free (type_string);
5954           result = NULL;
5955         }
5956
5957 #ifdef G_OS_UNIX
5958       if (result != NULL)
5959         {
5960           if (out_fd_list != NULL)
5961             {
5962               *out_fd_list = g_dbus_message_get_unix_fd_list (reply);
5963               if (*out_fd_list != NULL)
5964                 g_object_ref (*out_fd_list);
5965             }
5966         }
5967 #endif
5968       break;
5969
5970     case G_DBUS_MESSAGE_TYPE_ERROR:
5971       g_dbus_message_to_gerror (reply, error);
5972       break;
5973
5974     default:
5975       g_assert_not_reached ();
5976       break;
5977     }
5978
5979   return result;
5980 }
5981
5982
5983 typedef struct
5984 {
5985   GSimpleAsyncResult *simple;
5986   GVariantType *reply_type;
5987   gchar *method_name; /* for error message */
5988   guint32 serial;
5989
5990   GVariant *value;
5991   GUnixFDList *fd_list;
5992 } CallState;
5993
5994 static void
5995 call_state_free (CallState *state)
5996 {
5997   g_variant_type_free (state->reply_type);
5998   g_free (state->method_name);
5999
6000   if (state->value != NULL)
6001     g_variant_unref (state->value);
6002   if (state->fd_list != NULL)
6003     g_object_unref (state->fd_list);
6004   g_slice_free (CallState, state);
6005 }
6006
6007 /* called in any thread, with the connection's lock not held */
6008 static void
6009 g_dbus_connection_call_done (GObject      *source,
6010                              GAsyncResult *result,
6011                              gpointer      user_data)
6012 {
6013   GSimpleAsyncResult *simple;
6014   GDBusConnection *connection = G_DBUS_CONNECTION (source);
6015   CallState *state = user_data;
6016   GError *error;
6017   GDBusMessage *reply;
6018
6019   error = NULL;
6020   reply = g_dbus_connection_send_message_with_reply_finish (connection,
6021                                                             result,
6022                                                             &error);
6023
6024   if (G_UNLIKELY (_g_dbus_debug_call ()))
6025     {
6026       _g_dbus_debug_print_lock ();
6027       g_print ("========================================================================\n"
6028                "GDBus-debug:Call:\n"
6029                " <<<< ASYNC COMPLETE %s() (serial %d)\n"
6030                "      ",
6031                state->method_name,
6032                state->serial);
6033       if (reply != NULL)
6034         {
6035           g_print ("SUCCESS\n");
6036         }
6037       else
6038         {
6039           g_print ("FAILED: %s\n",
6040                    error->message);
6041         }
6042       _g_dbus_debug_print_unlock ();
6043     }
6044
6045   if (reply != NULL)
6046     state->value = decode_method_reply (reply, state->method_name, state->reply_type, &state->fd_list, &error);
6047
6048   simple = state->simple; /* why? because state is freed before we unref simple.. */
6049   if (error != NULL)
6050     {
6051       g_simple_async_result_take_error (state->simple, error);
6052       g_simple_async_result_complete (state->simple);
6053       call_state_free (state);
6054     }
6055   else
6056     {
6057       g_simple_async_result_set_op_res_gpointer (state->simple, state, (GDestroyNotify) call_state_free);
6058       g_simple_async_result_complete (state->simple);
6059     }
6060   g_clear_object (&reply);
6061   g_object_unref (simple);
6062 }
6063
6064 /* called in any thread, with the connection's lock not held */
6065 static void
6066 g_dbus_connection_call_internal (GDBusConnection        *connection,
6067                                  const gchar            *bus_name,
6068                                  const gchar            *object_path,
6069                                  const gchar            *interface_name,
6070                                  const gchar            *method_name,
6071                                  GVariant               *parameters,
6072                                  const GVariantType     *reply_type,
6073                                  GDBusCallFlags          flags,
6074                                  gint                    timeout_msec,
6075                                  GUnixFDList            *fd_list,
6076                                  GCancellable           *cancellable,
6077                                  GAsyncReadyCallback     callback,
6078                                  gpointer                user_data)
6079 {
6080   GDBusMessage *message;
6081   guint32 serial;
6082
6083   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
6084   g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
6085   g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
6086   g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
6087   g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
6088   g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
6089   g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
6090   g_return_if_fail (check_initialized (connection));
6091 #ifdef G_OS_UNIX
6092   g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
6093 #else
6094   g_return_if_fail (fd_list == NULL);
6095 #endif
6096
6097   message = g_dbus_message_new_method_call (bus_name,
6098                                             object_path,
6099                                             interface_name,
6100                                             method_name);
6101   add_call_flags (message, flags);
6102   if (parameters != NULL)
6103     g_dbus_message_set_body (message, parameters);
6104
6105 #ifdef G_OS_UNIX
6106   if (fd_list != NULL)
6107     g_dbus_message_set_unix_fd_list (message, fd_list);
6108 #endif
6109
6110   /* If the user has no callback then we can just send the message with
6111    * the G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set and skip all
6112    * the logic for processing the reply.  If the service sends the reply
6113    * anyway then it will just be ignored.
6114    */
6115   if (callback != NULL)
6116     {
6117       CallState *state;
6118
6119       state = g_slice_new0 (CallState);
6120       state->simple = g_simple_async_result_new (G_OBJECT (connection),
6121                                                  callback, user_data,
6122                                                  g_dbus_connection_call_internal);
6123       g_simple_async_result_set_check_cancellable (state->simple, cancellable);
6124       state->method_name = g_strjoin (".", interface_name, method_name, NULL);
6125
6126       if (reply_type == NULL)
6127         reply_type = G_VARIANT_TYPE_ANY;
6128
6129       state->reply_type = g_variant_type_copy (reply_type);
6130
6131       g_dbus_connection_send_message_with_reply (connection,
6132                                                  message,
6133                                                  G_DBUS_SEND_MESSAGE_FLAGS_NONE,
6134                                                  timeout_msec,
6135                                                  &state->serial,
6136                                                  cancellable,
6137                                                  g_dbus_connection_call_done,
6138                                                  state);
6139       serial = state->serial;
6140     }
6141   else
6142     {
6143       GDBusMessageFlags flags;
6144
6145       flags = g_dbus_message_get_flags (message);
6146       flags |= G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
6147       g_dbus_message_set_flags (message, flags);
6148
6149       g_dbus_connection_send_message (connection,
6150                                       message,
6151                                       G_DBUS_SEND_MESSAGE_FLAGS_NONE,
6152                                       &serial, NULL);
6153     }
6154
6155   if (G_UNLIKELY (_g_dbus_debug_call ()))
6156     {
6157       _g_dbus_debug_print_lock ();
6158       g_print ("========================================================================\n"
6159                "GDBus-debug:Call:\n"
6160                " >>>> ASYNC %s.%s()\n"
6161                "      on object %s\n"
6162                "      owned by name %s (serial %d)\n",
6163                interface_name,
6164                method_name,
6165                object_path,
6166                bus_name != NULL ? bus_name : "(none)",
6167                serial);
6168       _g_dbus_debug_print_unlock ();
6169     }
6170
6171   if (message != NULL)
6172     g_object_unref (message);
6173 }
6174
6175 /* called in any thread, with the connection's lock not held */
6176 static GVariant *
6177 g_dbus_connection_call_finish_internal (GDBusConnection  *connection,
6178                                         GUnixFDList     **out_fd_list,
6179                                         GAsyncResult     *res,
6180                                         GError          **error)
6181 {
6182   GSimpleAsyncResult *simple;
6183   CallState *state;
6184
6185   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
6186   g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
6187                                                         g_dbus_connection_call_internal), NULL);
6188   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6189
6190   simple = G_SIMPLE_ASYNC_RESULT (res);
6191
6192   if (g_simple_async_result_propagate_error (simple, error))
6193     return NULL;
6194
6195   state = g_simple_async_result_get_op_res_gpointer (simple);
6196   if (out_fd_list != NULL)
6197     *out_fd_list = state->fd_list != NULL ? g_object_ref (state->fd_list) : NULL;
6198   return g_variant_ref (state->value);
6199 }
6200
6201 /* called in any user thread, with the connection's lock not held */
6202 static GVariant *
6203 g_dbus_connection_call_sync_internal (GDBusConnection         *connection,
6204                                       const gchar             *bus_name,
6205                                       const gchar             *object_path,
6206                                       const gchar             *interface_name,
6207                                       const gchar             *method_name,
6208                                       GVariant                *parameters,
6209                                       const GVariantType      *reply_type,
6210                                       GDBusCallFlags           flags,
6211                                       gint                     timeout_msec,
6212                                       GUnixFDList             *fd_list,
6213                                       GUnixFDList            **out_fd_list,
6214                                       GCancellable            *cancellable,
6215                                       GError                 **error)
6216 {
6217   GDBusMessage *message;
6218   GDBusMessage *reply;
6219   GVariant *result;
6220   GError *local_error;
6221   GDBusSendMessageFlags send_flags;
6222
6223   message = NULL;
6224   reply = NULL;
6225   result = NULL;
6226
6227   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
6228   g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
6229   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
6230   g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
6231   g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
6232   g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
6233   g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
6234 #ifdef G_OS_UNIX
6235   g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
6236 #else
6237   g_return_val_if_fail (fd_list == NULL, NULL);
6238 #endif
6239   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6240
6241   if (!(flags & CALL_FLAGS_INITIALIZING))
6242     g_return_val_if_fail (check_initialized (connection), FALSE);
6243
6244   if (reply_type == NULL)
6245     reply_type = G_VARIANT_TYPE_ANY;
6246
6247   message = g_dbus_message_new_method_call (bus_name,
6248                                             object_path,
6249                                             interface_name,
6250                                             method_name);
6251   add_call_flags (message, flags);
6252   if (parameters != NULL)
6253     g_dbus_message_set_body (message, parameters);
6254
6255 #ifdef G_OS_UNIX
6256   if (fd_list != NULL)
6257     g_dbus_message_set_unix_fd_list (message, fd_list);
6258 #endif
6259
6260   if (G_UNLIKELY (_g_dbus_debug_call ()))
6261     {
6262       _g_dbus_debug_print_lock ();
6263       g_print ("========================================================================\n"
6264                "GDBus-debug:Call:\n"
6265                " >>>> SYNC %s.%s()\n"
6266                "      on object %s\n"
6267                "      owned by name %s\n",
6268                interface_name,
6269                method_name,
6270                object_path,
6271                bus_name != NULL ? bus_name : "(none)");
6272       _g_dbus_debug_print_unlock ();
6273     }
6274
6275   local_error = NULL;
6276
6277   send_flags = G_DBUS_SEND_MESSAGE_FLAGS_NONE;
6278
6279   /* translate from one flavour of flags to another... */
6280   if (flags & CALL_FLAGS_INITIALIZING)
6281     send_flags |= SEND_MESSAGE_FLAGS_INITIALIZING;
6282
6283   reply = g_dbus_connection_send_message_with_reply_sync (connection,
6284                                                           message,
6285                                                           send_flags,
6286                                                           timeout_msec,
6287                                                           NULL, /* volatile guint32 *out_serial */
6288                                                           cancellable,
6289                                                           &local_error);
6290
6291   if (G_UNLIKELY (_g_dbus_debug_call ()))
6292     {
6293       _g_dbus_debug_print_lock ();
6294       g_print ("========================================================================\n"
6295                "GDBus-debug:Call:\n"
6296                " <<<< SYNC COMPLETE %s.%s()\n"
6297                "      ",
6298                interface_name,
6299                method_name);
6300       if (reply != NULL)
6301         {
6302           g_print ("SUCCESS\n");
6303         }
6304       else
6305         {
6306           g_print ("FAILED: %s\n",
6307                    local_error->message);
6308         }
6309       _g_dbus_debug_print_unlock ();
6310     }
6311
6312   if (reply == NULL)
6313     {
6314       if (error != NULL)
6315         *error = local_error;
6316       else
6317         g_error_free (local_error);
6318       goto out;
6319     }
6320
6321   result = decode_method_reply (reply, method_name, reply_type, out_fd_list, error);
6322
6323  out:
6324   if (message != NULL)
6325     g_object_unref (message);
6326   if (reply != NULL)
6327     g_object_unref (reply);
6328
6329   return result;
6330 }
6331
6332 /* ---------------------------------------------------------------------------------------------------- */
6333
6334 /**
6335  * g_dbus_connection_call:
6336  * @connection: a #GDBusConnection
6337  * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6338  *     @connection is not a message bus connection
6339  * @object_path: path of remote object
6340  * @interface_name: D-Bus interface to invoke method on
6341  * @method_name: the name of the method to invoke
6342  * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6343  *     or %NULL if not passing parameters
6344  * @reply_type: (allow-none): the expected type of the reply, or %NULL
6345  * @flags: flags from the #GDBusCallFlags enumeration
6346  * @timeout_msec: the timeout in milliseconds, -1 to use the default
6347  *     timeout or %G_MAXINT for no timeout
6348  * @cancellable: (allow-none): a #GCancellable or %NULL
6349  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
6350  *     is satisfied or %NULL if you don't care about the result of the
6351  *     method invocation
6352  * @user_data: the data to pass to @callback
6353  *
6354  * Asynchronously invokes the @method_name method on the
6355  * @interface_name D-Bus interface on the remote object at
6356  * @object_path owned by @bus_name.
6357  *
6358  * If @connection is closed then the operation will fail with
6359  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
6360  * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
6361  * not compatible with the D-Bus protocol, the operation fails with
6362  * %G_IO_ERROR_INVALID_ARGUMENT.
6363  *
6364  * If @reply_type is non-%NULL then the reply will be checked for having this type and an
6365  * error will be raised if it does not match.  Said another way, if you give a @reply_type
6366  * then any non-%NULL return value will be of this type.
6367  *
6368  * If the @parameters #GVariant is floating, it is consumed. This allows
6369  * convenient 'inline' use of g_variant_new(), e.g.:
6370  * |[<!-- language="C" -->
6371  *  g_dbus_connection_call (connection,
6372  *                          "org.freedesktop.StringThings",
6373  *                          "/org/freedesktop/StringThings",
6374  *                          "org.freedesktop.StringThings",
6375  *                          "TwoStrings",
6376  *                          g_variant_new ("(ss)",
6377  *                                         "Thing One",
6378  *                                         "Thing Two"),
6379  *                          NULL,
6380  *                          G_DBUS_CALL_FLAGS_NONE,
6381  *                          -1,
6382  *                          NULL,
6383  *                          (GAsyncReadyCallback) two_strings_done,
6384  *                          NULL);
6385  * ]|
6386  *
6387  * This is an asynchronous method. When the operation is finished,
6388  * @callback will be invoked in the
6389  * [thread-default main context][g-main-context-push-thread-default]
6390  * of the thread you are calling this method from. You can then call
6391  * g_dbus_connection_call_finish() to get the result of the operation.
6392  * See g_dbus_connection_call_sync() for the synchronous version of this
6393  * function.
6394  *
6395  * If @callback is %NULL then the D-Bus method call message will be sent with
6396  * the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
6397  *
6398  * Since: 2.26
6399  */
6400 void
6401 g_dbus_connection_call (GDBusConnection     *connection,
6402                         const gchar         *bus_name,
6403                         const gchar         *object_path,
6404                         const gchar         *interface_name,
6405                         const gchar         *method_name,
6406                         GVariant            *parameters,
6407                         const GVariantType  *reply_type,
6408                         GDBusCallFlags       flags,
6409                         gint                 timeout_msec,
6410                         GCancellable        *cancellable,
6411                         GAsyncReadyCallback  callback,
6412                         gpointer             user_data)
6413 {
6414   g_dbus_connection_call_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, NULL, cancellable, callback, user_data);
6415 }
6416
6417 /**
6418  * g_dbus_connection_call_finish:
6419  * @connection: a #GDBusConnection
6420  * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call()
6421  * @error: return location for error or %NULL
6422  *
6423  * Finishes an operation started with g_dbus_connection_call().
6424  *
6425  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6426  *     return values. Free with g_variant_unref().
6427  *
6428  * Since: 2.26
6429  */
6430 GVariant *
6431 g_dbus_connection_call_finish (GDBusConnection  *connection,
6432                                GAsyncResult     *res,
6433                                GError          **error)
6434 {
6435   return g_dbus_connection_call_finish_internal (connection, NULL, res, error);
6436 }
6437
6438 /**
6439  * g_dbus_connection_call_sync:
6440  * @connection: a #GDBusConnection
6441  * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6442  *     @connection is not a message bus connection
6443  * @object_path: path of remote object
6444  * @interface_name: D-Bus interface to invoke method on
6445  * @method_name: the name of the method to invoke
6446  * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6447  *     or %NULL if not passing parameters
6448  * @reply_type: (allow-none): the expected type of the reply, or %NULL
6449  * @flags: flags from the #GDBusCallFlags enumeration
6450  * @timeout_msec: the timeout in milliseconds, -1 to use the default
6451  *     timeout or %G_MAXINT for no timeout
6452  * @cancellable: (allow-none): a #GCancellable or %NULL
6453  * @error: return location for error or %NULL
6454  *
6455  * Synchronously invokes the @method_name method on the
6456  * @interface_name D-Bus interface on the remote object at
6457  * @object_path owned by @bus_name.
6458  *
6459  * If @connection is closed then the operation will fail with
6460  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
6461  * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
6462  * contains a value not compatible with the D-Bus protocol, the operation
6463  * fails with %G_IO_ERROR_INVALID_ARGUMENT.
6464
6465  * If @reply_type is non-%NULL then the reply will be checked for having
6466  * this type and an error will be raised if it does not match.  Said
6467  * another way, if you give a @reply_type then any non-%NULL return
6468  * value will be of this type.
6469  *
6470  * If the @parameters #GVariant is floating, it is consumed.
6471  * This allows convenient 'inline' use of g_variant_new(), e.g.:
6472  * |[<!-- language="C" -->
6473  *  g_dbus_connection_call_sync (connection,
6474  *                               "org.freedesktop.StringThings",
6475  *                               "/org/freedesktop/StringThings",
6476  *                               "org.freedesktop.StringThings",
6477  *                               "TwoStrings",
6478  *                               g_variant_new ("(ss)",
6479  *                                              "Thing One",
6480  *                                              "Thing Two"),
6481  *                               NULL,
6482  *                               G_DBUS_CALL_FLAGS_NONE,
6483  *                               -1,
6484  *                               NULL,
6485  *                               &error);
6486  * ]|
6487  *
6488  * The calling thread is blocked until a reply is received. See
6489  * g_dbus_connection_call() for the asynchronous version of
6490  * this method.
6491  *
6492  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6493  *     return values. Free with g_variant_unref().
6494  *
6495  * Since: 2.26
6496  */
6497 GVariant *
6498 g_dbus_connection_call_sync (GDBusConnection     *connection,
6499                              const gchar         *bus_name,
6500                              const gchar         *object_path,
6501                              const gchar         *interface_name,
6502                              const gchar         *method_name,
6503                              GVariant            *parameters,
6504                              const GVariantType  *reply_type,
6505                              GDBusCallFlags       flags,
6506                              gint                 timeout_msec,
6507                              GCancellable        *cancellable,
6508                              GError             **error)
6509 {
6510   return g_dbus_connection_call_sync_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, NULL, NULL, cancellable, error);
6511 }
6512
6513 /* ---------------------------------------------------------------------------------------------------- */
6514
6515 #ifdef G_OS_UNIX
6516
6517 /**
6518  * g_dbus_connection_call_with_unix_fd_list:
6519  * @connection: a #GDBusConnection
6520  * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6521  *     @connection is not a message bus connection
6522  * @object_path: path of remote object
6523  * @interface_name: D-Bus interface to invoke method on
6524  * @method_name: the name of the method to invoke
6525  * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6526  *     or %NULL if not passing parameters
6527  * @reply_type: (allow-none): the expected type of the reply, or %NULL
6528  * @flags: flags from the #GDBusCallFlags enumeration
6529  * @timeout_msec: the timeout in milliseconds, -1 to use the default
6530  *     timeout or %G_MAXINT for no timeout
6531  * @fd_list: (allow-none): a #GUnixFDList or %NULL
6532  * @cancellable: (allow-none): a #GCancellable or %NULL
6533  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
6534  *     satisfied or %NULL if you don't * care about the result of the
6535  *     method invocation
6536  * @user_data: The data to pass to @callback.
6537  *
6538  * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
6539  *
6540  * This method is only available on UNIX.
6541  *
6542  * Since: 2.30
6543  */
6544 void
6545 g_dbus_connection_call_with_unix_fd_list (GDBusConnection     *connection,
6546                                           const gchar         *bus_name,
6547                                           const gchar         *object_path,
6548                                           const gchar         *interface_name,
6549                                           const gchar         *method_name,
6550                                           GVariant            *parameters,
6551                                           const GVariantType  *reply_type,
6552                                           GDBusCallFlags       flags,
6553                                           gint                 timeout_msec,
6554                                           GUnixFDList         *fd_list,
6555                                           GCancellable        *cancellable,
6556                                           GAsyncReadyCallback  callback,
6557                                           gpointer             user_data)
6558 {
6559   g_dbus_connection_call_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, fd_list, cancellable, callback, user_data);
6560 }
6561
6562 /**
6563  * g_dbus_connection_call_with_unix_fd_list_finish:
6564  * @connection: a #GDBusConnection
6565  * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
6566  * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
6567  *     g_dbus_connection_call_with_unix_fd_list()
6568  * @error: return location for error or %NULL
6569  *
6570  * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
6571  *
6572  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6573  *     return values. Free with g_variant_unref().
6574  *
6575  * Since: 2.30
6576  */
6577 GVariant *
6578 g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection  *connection,
6579                                                  GUnixFDList     **out_fd_list,
6580                                                  GAsyncResult     *res,
6581                                                  GError          **error)
6582 {
6583   return g_dbus_connection_call_finish_internal (connection, out_fd_list, res, error);
6584 }
6585
6586 /**
6587  * g_dbus_connection_call_with_unix_fd_list_sync:
6588  * @connection: a #GDBusConnection
6589  * @bus_name: (allow-none): a unique or well-known bus name or %NULL
6590  *     if @connection is not a message bus connection
6591  * @object_path: path of remote object
6592  * @interface_name: D-Bus interface to invoke method on
6593  * @method_name: the name of the method to invoke
6594  * @parameters: (allow-none): a #GVariant tuple with parameters for
6595  *     the method or %NULL if not passing parameters
6596  * @reply_type: (allow-none): the expected type of the reply, or %NULL
6597  * @flags: flags from the #GDBusCallFlags enumeration
6598  * @timeout_msec: the timeout in milliseconds, -1 to use the default
6599  *     timeout or %G_MAXINT for no timeout
6600  * @fd_list: (allow-none): a #GUnixFDList or %NULL
6601  * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
6602  * @cancellable: (allow-none): a #GCancellable or %NULL
6603  * @error: return location for error or %NULL
6604  *
6605  * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
6606  *
6607  * This method is only available on UNIX.
6608  *
6609  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6610  *     return values. Free with g_variant_unref().
6611  *
6612  * Since: 2.30
6613  */
6614 GVariant *
6615 g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection     *connection,
6616                                                const gchar         *bus_name,
6617                                                const gchar         *object_path,
6618                                                const gchar         *interface_name,
6619                                                const gchar         *method_name,
6620                                                GVariant            *parameters,
6621                                                const GVariantType  *reply_type,
6622                                                GDBusCallFlags       flags,
6623                                                gint                 timeout_msec,
6624                                                GUnixFDList         *fd_list,
6625                                                GUnixFDList        **out_fd_list,
6626                                                GCancellable        *cancellable,
6627                                                GError             **error)
6628 {
6629   return g_dbus_connection_call_sync_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, fd_list, out_fd_list, cancellable, error);
6630 }
6631
6632 #endif /* G_OS_UNIX */
6633
6634 /* ---------------------------------------------------------------------------------------------------- */
6635
6636 struct ExportedSubtree
6637 {
6638   guint                     id;
6639   gchar                    *object_path;
6640   GDBusConnection          *connection;
6641   GDBusSubtreeVTable       *vtable;
6642   GDBusSubtreeFlags         flags;
6643
6644   GMainContext             *context;
6645   gpointer                  user_data;
6646   GDestroyNotify            user_data_free_func;
6647 };
6648
6649 static void
6650 exported_subtree_free (ExportedSubtree *es)
6651 {
6652   call_destroy_notify (es->context,
6653                        es->user_data_free_func,
6654                        es->user_data);
6655
6656   g_main_context_unref (es->context);
6657
6658   _g_dbus_subtree_vtable_free (es->vtable);
6659   g_free (es->object_path);
6660   g_free (es);
6661 }
6662
6663 /* called without lock held in the thread where the caller registered
6664  * the subtree
6665  */
6666 static gboolean
6667 handle_subtree_introspect (GDBusConnection *connection,
6668                            ExportedSubtree *es,
6669                            GDBusMessage    *message)
6670 {
6671   GString *s;
6672   gboolean handled;
6673   GDBusMessage *reply;
6674   gchar **children;
6675   gboolean is_root;
6676   const gchar *sender;
6677   const gchar *requested_object_path;
6678   const gchar *requested_node;
6679   GDBusInterfaceInfo **interfaces;
6680   guint n;
6681   gchar **subnode_paths;
6682   gboolean has_properties_interface;
6683   gboolean has_introspectable_interface;
6684
6685   handled = FALSE;
6686
6687   requested_object_path = g_dbus_message_get_path (message);
6688   sender = g_dbus_message_get_sender (message);
6689   is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6690
6691   s = g_string_new (NULL);
6692   introspect_append_header (s);
6693
6694   /* Strictly we don't need the children in dynamic mode, but we avoid the
6695    * conditionals to preserve code clarity
6696    */
6697   children = es->vtable->enumerate (es->connection,
6698                                     sender,
6699                                     es->object_path,
6700                                     es->user_data);
6701
6702   if (!is_root)
6703     {
6704       requested_node = strrchr (requested_object_path, '/') + 1;
6705
6706       /* Assert existence of object if we are not dynamic */
6707       if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
6708           !_g_strv_has_string ((const gchar * const *) children, requested_node))
6709         goto out;
6710     }
6711   else
6712     {
6713       requested_node = NULL;
6714     }
6715
6716   interfaces = es->vtable->introspect (es->connection,
6717                                        sender,
6718                                        es->object_path,
6719                                        requested_node,
6720                                        es->user_data);
6721   if (interfaces != NULL)
6722     {
6723       has_properties_interface = FALSE;
6724       has_introspectable_interface = FALSE;
6725
6726       for (n = 0; interfaces[n] != NULL; n++)
6727         {
6728           if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Properties") == 0)
6729             has_properties_interface = TRUE;
6730           else if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Introspectable") == 0)
6731             has_introspectable_interface = TRUE;
6732         }
6733       if (!has_properties_interface)
6734         g_string_append (s, introspect_properties_interface);
6735       if (!has_introspectable_interface)
6736         g_string_append (s, introspect_introspectable_interface);
6737
6738       for (n = 0; interfaces[n] != NULL; n++)
6739         {
6740           g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
6741           g_dbus_interface_info_unref (interfaces[n]);
6742         }
6743       g_free (interfaces);
6744     }
6745
6746   /* then include <node> entries from the Subtree for the root */
6747   if (is_root)
6748     {
6749       for (n = 0; children != NULL && children[n] != NULL; n++)
6750         g_string_append_printf (s, "  <node name=\"%s\"/>\n", children[n]);
6751     }
6752
6753   /* finally include nodes registered below us */
6754   subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
6755   for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
6756     g_string_append_printf (s, "  <node name=\"%s\"/>\n", subnode_paths[n]);
6757   g_strfreev (subnode_paths);
6758
6759   g_string_append (s, "</node>\n");
6760
6761   reply = g_dbus_message_new_method_reply (message);
6762   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6763   g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6764   g_object_unref (reply);
6765
6766   handled = TRUE;
6767
6768  out:
6769   g_string_free (s, TRUE);
6770   g_strfreev (children);
6771   return handled;
6772 }
6773
6774 /* called without lock held in the thread where the caller registered
6775  * the subtree
6776  */
6777 static gboolean
6778 handle_subtree_method_invocation (GDBusConnection *connection,
6779                                   ExportedSubtree *es,
6780                                   GDBusMessage    *message)
6781 {
6782   gboolean handled;
6783   const gchar *sender;
6784   const gchar *interface_name;
6785   const gchar *member;
6786   const gchar *signature;
6787   const gchar *requested_object_path;
6788   const gchar *requested_node;
6789   gboolean is_root;
6790   GDBusInterfaceInfo *interface_info;
6791   const GDBusInterfaceVTable *interface_vtable;
6792   gpointer interface_user_data;
6793   guint n;
6794   GDBusInterfaceInfo **interfaces;
6795   gboolean is_property_get;
6796   gboolean is_property_set;
6797   gboolean is_property_get_all;
6798
6799   handled = FALSE;
6800   interfaces = NULL;
6801
6802   requested_object_path = g_dbus_message_get_path (message);
6803   sender = g_dbus_message_get_sender (message);
6804   interface_name = g_dbus_message_get_interface (message);
6805   member = g_dbus_message_get_member (message);
6806   signature = g_dbus_message_get_signature (message);
6807   is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6808
6809   is_property_get = FALSE;
6810   is_property_set = FALSE;
6811   is_property_get_all = FALSE;
6812   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
6813     {
6814       if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
6815         is_property_get = TRUE;
6816       else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
6817         is_property_set = TRUE;
6818       else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
6819         is_property_get_all = TRUE;
6820     }
6821
6822   if (!is_root)
6823     {
6824       requested_node = strrchr (requested_object_path, '/') + 1;
6825
6826       if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
6827         {
6828           /* We don't want to dispatch to unenumerated
6829            * nodes, so ensure that the child exists.
6830            */
6831           gchar **children;
6832           gboolean exists;
6833
6834           children = es->vtable->enumerate (es->connection,
6835                                             sender,
6836                                             es->object_path,
6837                                             es->user_data);
6838
6839           exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
6840           g_strfreev (children);
6841
6842           if (!exists)
6843             goto out;
6844         }
6845     }
6846   else
6847     {
6848       requested_node = NULL;
6849     }
6850
6851   /* get introspection data for the node */
6852   interfaces = es->vtable->introspect (es->connection,
6853                                        sender,
6854                                        requested_object_path,
6855                                        requested_node,
6856                                        es->user_data);
6857
6858   if (interfaces == NULL)
6859     goto out;
6860
6861   interface_info = NULL;
6862   for (n = 0; interfaces[n] != NULL; n++)
6863     {
6864       if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6865         interface_info = interfaces[n];
6866     }
6867
6868   /* dispatch the call if the user wants to handle it */
6869   if (interface_info != NULL)
6870     {
6871       /* figure out where to dispatch the method call */
6872       interface_user_data = NULL;
6873       interface_vtable = es->vtable->dispatch (es->connection,
6874                                                sender,
6875                                                es->object_path,
6876                                                interface_name,
6877                                                requested_node,
6878                                                &interface_user_data,
6879                                                es->user_data);
6880       if (interface_vtable == NULL)
6881         goto out;
6882
6883       CONNECTION_LOCK (connection);
6884       handled = validate_and_maybe_schedule_method_call (es->connection,
6885                                                          message,
6886                                                          0,
6887                                                          es->id,
6888                                                          interface_info,
6889                                                          interface_vtable,
6890                                                          es->context,
6891                                                          interface_user_data);
6892       CONNECTION_UNLOCK (connection);
6893     }
6894   /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
6895   else if (is_property_get || is_property_set || is_property_get_all)
6896     {
6897       if (is_property_get)
6898         g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
6899       else if (is_property_set)
6900         g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
6901       else if (is_property_get_all)
6902         g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
6903       else
6904         g_assert_not_reached ();
6905
6906       /* see if the object supports this interface at all */
6907       for (n = 0; interfaces[n] != NULL; n++)
6908         {
6909           if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6910             interface_info = interfaces[n];
6911         }
6912
6913       /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
6914        * claims it won't support the interface
6915        */
6916       if (interface_info == NULL)
6917         {
6918           GDBusMessage *reply;
6919           reply = g_dbus_message_new_method_error (message,
6920                                                    "org.freedesktop.DBus.Error.InvalidArgs",
6921                                                    _("No such interface '%s'"),
6922                                                    interface_name);
6923           g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6924           g_object_unref (reply);
6925           handled = TRUE;
6926           goto out;
6927         }
6928
6929       /* figure out where to dispatch the property get/set/getall calls */
6930       interface_user_data = NULL;
6931       interface_vtable = es->vtable->dispatch (es->connection,
6932                                                sender,
6933                                                es->object_path,
6934                                                interface_name,
6935                                                requested_node,
6936                                                &interface_user_data,
6937                                                es->user_data);
6938       if (interface_vtable == NULL)
6939         {
6940           g_warning ("The subtree introspection function indicates that '%s' "
6941                      "is a valid interface name, but calling the dispatch "
6942                      "function on that interface gave us NULL", interface_name);
6943           goto out;
6944         }
6945
6946       if (is_property_get || is_property_set)
6947         {
6948           CONNECTION_LOCK (connection);
6949           handled = validate_and_maybe_schedule_property_getset (es->connection,
6950                                                                  message,
6951                                                                  0,
6952                                                                  es->id,
6953                                                                  is_property_get,
6954                                                                  interface_info,
6955                                                                  interface_vtable,
6956                                                                  es->context,
6957                                                                  interface_user_data);
6958           CONNECTION_UNLOCK (connection);
6959         }
6960       else if (is_property_get_all)
6961         {
6962           CONNECTION_LOCK (connection);
6963           handled = validate_and_maybe_schedule_property_get_all (es->connection,
6964                                                                   message,
6965                                                                   0,
6966                                                                   es->id,
6967                                                                   interface_info,
6968                                                                   interface_vtable,
6969                                                                   es->context,
6970                                                                   interface_user_data);
6971           CONNECTION_UNLOCK (connection);
6972         }
6973     }
6974
6975  out:
6976   if (interfaces != NULL)
6977     {
6978       for (n = 0; interfaces[n] != NULL; n++)
6979         g_dbus_interface_info_unref (interfaces[n]);
6980       g_free (interfaces);
6981     }
6982
6983   return handled;
6984 }
6985
6986 typedef struct
6987 {
6988   GDBusMessage *message;
6989   ExportedSubtree *es;
6990 } SubtreeDeferredData;
6991
6992 static void
6993 subtree_deferred_data_free (SubtreeDeferredData *data)
6994 {
6995   g_object_unref (data->message);
6996   g_free (data);
6997 }
6998
6999 /* called without lock held in the thread where the caller registered the subtree */
7000 static gboolean
7001 process_subtree_vtable_message_in_idle_cb (gpointer _data)
7002 {
7003   SubtreeDeferredData *data = _data;
7004   gboolean handled;
7005
7006   handled = FALSE;
7007
7008   if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
7009       g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
7010       g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
7011     handled = handle_subtree_introspect (data->es->connection,
7012                                          data->es,
7013                                          data->message);
7014   else
7015     handled = handle_subtree_method_invocation (data->es->connection,
7016                                                 data->es,
7017                                                 data->message);
7018
7019   if (!handled)
7020     {
7021       CONNECTION_LOCK (data->es->connection);
7022       handled = handle_generic_unlocked (data->es->connection, data->message);
7023       CONNECTION_UNLOCK (data->es->connection);
7024     }
7025
7026   /* if we couldn't handle the request, just bail with the UnknownMethod error */
7027   if (!handled)
7028     {
7029       GDBusMessage *reply;
7030       reply = g_dbus_message_new_method_error (data->message,
7031                                                "org.freedesktop.DBus.Error.UnknownMethod",
7032                                                _("Method '%s' on interface '%s' with signature '%s' does not exist"),
7033                                                g_dbus_message_get_member (data->message),
7034                                                g_dbus_message_get_interface (data->message),
7035                                                g_dbus_message_get_signature (data->message));
7036       g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7037       g_object_unref (reply);
7038     }
7039
7040   return FALSE;
7041 }
7042
7043 /* called in GDBusWorker thread with connection's lock held */
7044 static gboolean
7045 subtree_message_func (GDBusConnection *connection,
7046                       ExportedSubtree *es,
7047                       GDBusMessage    *message)
7048 {
7049   GSource *idle_source;
7050   SubtreeDeferredData *data;
7051
7052   data = g_new0 (SubtreeDeferredData, 1);
7053   data->message = g_object_ref (message);
7054   data->es = es;
7055
7056   /* defer this call to an idle handler in the right thread */
7057   idle_source = g_idle_source_new ();
7058   g_source_set_priority (idle_source, G_PRIORITY_HIGH);
7059   g_source_set_callback (idle_source,
7060                          process_subtree_vtable_message_in_idle_cb,
7061                          data,
7062                          (GDestroyNotify) subtree_deferred_data_free);
7063   g_source_set_name (idle_source, "[gio] process_subtree_vtable_message_in_idle_cb");
7064   g_source_attach (idle_source, es->context);
7065   g_source_unref (idle_source);
7066
7067   /* since we own the entire subtree, handlers for objects not in the subtree have been
7068    * tried already by libdbus-1 - so we just need to ensure that we're always going
7069    * to reply to the message
7070    */
7071   return TRUE;
7072 }
7073
7074 /**
7075  * g_dbus_connection_register_subtree:
7076  * @connection: a #GDBusConnection
7077  * @object_path: the object path to register the subtree at
7078  * @vtable: a #GDBusSubtreeVTable to enumerate, introspect and
7079  *     dispatch nodes in the subtree
7080  * @flags: flags used to fine tune the behavior of the subtree
7081  * @user_data: data to pass to functions in @vtable
7082  * @user_data_free_func: function to call when the subtree is unregistered
7083  * @error: return location for error or %NULL
7084  *
7085  * Registers a whole subtree of dynamic objects.
7086  *
7087  * The @enumerate and @introspection functions in @vtable are used to
7088  * convey, to remote callers, what nodes exist in the subtree rooted
7089  * by @object_path.
7090  *
7091  * When handling remote calls into any node in the subtree, first the
7092  * @enumerate function is used to check if the node exists. If the node exists
7093  * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
7094  * the @introspection function is used to check if the node supports the
7095  * requested method. If so, the @dispatch function is used to determine
7096  * where to dispatch the call. The collected #GDBusInterfaceVTable and
7097  * #gpointer will be used to call into the interface vtable for processing
7098  * the request.
7099  *
7100  * All calls into user-provided code will be invoked in the
7101  * [thread-default main context][g-main-context-push-thread-default]
7102  * of the thread you are calling this method from.
7103  *
7104  * If an existing subtree is already registered at @object_path or
7105  * then @error is set to #G_IO_ERROR_EXISTS.
7106  *
7107  * Note that it is valid to register regular objects (using
7108  * g_dbus_connection_register_object()) in a subtree registered with
7109  * g_dbus_connection_register_subtree() - if so, the subtree handler
7110  * is tried as the last resort. One way to think about a subtree
7111  * handler is to consider it a fallback handler for object paths not
7112  * registered via g_dbus_connection_register_object() or other bindings.
7113  *
7114  * Note that @vtable will be copied so you cannot change it after
7115  * registration.
7116  *
7117  * See this [server][gdbus-subtree-server] for an example of how to use
7118  * this method.
7119  *
7120  * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
7121  * that can be used with g_dbus_connection_unregister_subtree() .
7122  *
7123  * Since: 2.26
7124  */
7125 guint
7126 g_dbus_connection_register_subtree (GDBusConnection           *connection,
7127                                     const gchar               *object_path,
7128                                     const GDBusSubtreeVTable  *vtable,
7129                                     GDBusSubtreeFlags          flags,
7130                                     gpointer                   user_data,
7131                                     GDestroyNotify             user_data_free_func,
7132                                     GError                   **error)
7133 {
7134   guint ret;
7135   ExportedSubtree *es;
7136
7137   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
7138   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
7139   g_return_val_if_fail (vtable != NULL, 0);
7140   g_return_val_if_fail (error == NULL || *error == NULL, 0);
7141   g_return_val_if_fail (check_initialized (connection), 0);
7142
7143   ret = 0;
7144
7145   CONNECTION_LOCK (connection);
7146
7147   es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
7148   if (es != NULL)
7149     {
7150       g_set_error (error,
7151                    G_IO_ERROR,
7152                    G_IO_ERROR_EXISTS,
7153                    _("A subtree is already exported for %s"),
7154                    object_path);
7155       goto out;
7156     }
7157
7158   es = g_new0 (ExportedSubtree, 1);
7159   es->object_path = g_strdup (object_path);
7160   es->connection = connection;
7161
7162   es->vtable = _g_dbus_subtree_vtable_copy (vtable);
7163   es->flags = flags;
7164   es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
7165   es->user_data = user_data;
7166   es->user_data_free_func = user_data_free_func;
7167   es->context = g_main_context_ref_thread_default ();
7168
7169   g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
7170   g_hash_table_insert (connection->map_id_to_es,
7171                        GUINT_TO_POINTER (es->id),
7172                        es);
7173
7174   ret = es->id;
7175
7176  out:
7177   CONNECTION_UNLOCK (connection);
7178
7179   return ret;
7180 }
7181
7182 /* ---------------------------------------------------------------------------------------------------- */
7183
7184 /**
7185  * g_dbus_connection_unregister_subtree:
7186  * @connection: a #GDBusConnection
7187  * @registration_id: a subtree registration id obtained from
7188  *     g_dbus_connection_register_subtree()
7189  *
7190  * Unregisters a subtree.
7191  *
7192  * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise
7193  *
7194  * Since: 2.26
7195  */
7196 gboolean
7197 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
7198                                       guint            registration_id)
7199 {
7200   ExportedSubtree *es;
7201   gboolean ret;
7202
7203   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
7204   g_return_val_if_fail (check_initialized (connection), FALSE);
7205
7206   ret = FALSE;
7207
7208   CONNECTION_LOCK (connection);
7209
7210   es = g_hash_table_lookup (connection->map_id_to_es,
7211                             GUINT_TO_POINTER (registration_id));
7212   if (es == NULL)
7213     goto out;
7214
7215   g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
7216   g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
7217
7218   ret = TRUE;
7219
7220  out:
7221   CONNECTION_UNLOCK (connection);
7222
7223   return ret;
7224 }
7225
7226 /* ---------------------------------------------------------------------------------------------------- */
7227
7228 /* may be called in any thread, with connection's lock held */
7229 static void
7230 handle_generic_ping_unlocked (GDBusConnection *connection,
7231                               const gchar     *object_path,
7232                               GDBusMessage    *message)
7233 {
7234   GDBusMessage *reply;
7235   reply = g_dbus_message_new_method_reply (message);
7236   g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7237   g_object_unref (reply);
7238 }
7239
7240 /* may be called in any thread, with connection's lock held */
7241 static void
7242 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
7243                                         const gchar     *object_path,
7244                                         GDBusMessage    *message)
7245 {
7246   GDBusMessage *reply;
7247
7248   reply = NULL;
7249   if (connection->machine_id == NULL)
7250     {
7251       GError *error;
7252
7253       error = NULL;
7254       connection->machine_id = _g_dbus_get_machine_id (&error);
7255       if (connection->machine_id == NULL)
7256         {
7257           reply = g_dbus_message_new_method_error_literal (message,
7258                                                            "org.freedesktop.DBus.Error.Failed",
7259                                                            error->message);
7260           g_error_free (error);
7261         }
7262     }
7263
7264   if (reply == NULL)
7265     {
7266       reply = g_dbus_message_new_method_reply (message);
7267       g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
7268     }
7269   g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7270   g_object_unref (reply);
7271 }
7272
7273 /* may be called in any thread, with connection's lock held */
7274 static void
7275 handle_generic_introspect_unlocked (GDBusConnection *connection,
7276                                     const gchar     *object_path,
7277                                     GDBusMessage    *message)
7278 {
7279   guint n;
7280   GString *s;
7281   gchar **registered;
7282   GDBusMessage *reply;
7283
7284   /* first the header */
7285   s = g_string_new (NULL);
7286   introspect_append_header (s);
7287
7288   registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
7289   for (n = 0; registered != NULL && registered[n] != NULL; n++)
7290       g_string_append_printf (s, "  <node name=\"%s\"/>\n", registered[n]);
7291   g_strfreev (registered);
7292   g_string_append (s, "</node>\n");
7293
7294   reply = g_dbus_message_new_method_reply (message);
7295   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
7296   g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7297   g_object_unref (reply);
7298   g_string_free (s, TRUE);
7299 }
7300
7301 /* may be called in any thread, with connection's lock held */
7302 static gboolean
7303 handle_generic_unlocked (GDBusConnection *connection,
7304                          GDBusMessage    *message)
7305 {
7306   gboolean handled;
7307   const gchar *interface_name;
7308   const gchar *member;
7309   const gchar *signature;
7310   const gchar *path;
7311
7312   CONNECTION_ENSURE_LOCK (connection);
7313
7314   handled = FALSE;
7315
7316   interface_name = g_dbus_message_get_interface (message);
7317   member = g_dbus_message_get_member (message);
7318   signature = g_dbus_message_get_signature (message);
7319   path = g_dbus_message_get_path (message);
7320
7321   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
7322       g_strcmp0 (member, "Introspect") == 0 &&
7323       g_strcmp0 (signature, "") == 0)
7324     {
7325       handle_generic_introspect_unlocked (connection, path, message);
7326       handled = TRUE;
7327     }
7328   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
7329            g_strcmp0 (member, "Ping") == 0 &&
7330            g_strcmp0 (signature, "") == 0)
7331     {
7332       handle_generic_ping_unlocked (connection, path, message);
7333       handled = TRUE;
7334     }
7335   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
7336            g_strcmp0 (member, "GetMachineId") == 0 &&
7337            g_strcmp0 (signature, "") == 0)
7338     {
7339       handle_generic_get_machine_id_unlocked (connection, path, message);
7340       handled = TRUE;
7341     }
7342
7343   return handled;
7344 }
7345
7346 /* ---------------------------------------------------------------------------------------------------- */
7347
7348 /* called in GDBusWorker thread with connection's lock held */
7349 static void
7350 distribute_method_call (GDBusConnection *connection,
7351                         GDBusMessage    *message)
7352 {
7353   GDBusMessage *reply;
7354   ExportedObject *eo;
7355   ExportedSubtree *es;
7356   const gchar *object_path;
7357   const gchar *interface_name;
7358   const gchar *member;
7359   const gchar *path;
7360   gchar *subtree_path;
7361   gchar *needle;
7362
7363   g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
7364
7365   interface_name = g_dbus_message_get_interface (message);
7366   member = g_dbus_message_get_member (message);
7367   path = g_dbus_message_get_path (message);
7368   subtree_path = g_strdup (path);
7369   needle = strrchr (subtree_path, '/');
7370   if (needle != NULL && needle != subtree_path)
7371     {
7372       *needle = '\0';
7373     }
7374   else
7375     {
7376       g_free (subtree_path);
7377       subtree_path = NULL;
7378     }
7379
7380
7381   if (G_UNLIKELY (_g_dbus_debug_incoming ()))
7382     {
7383       _g_dbus_debug_print_lock ();
7384       g_print ("========================================================================\n"
7385                "GDBus-debug:Incoming:\n"
7386                " <<<< METHOD INVOCATION %s.%s()\n"
7387                "      on object %s\n"
7388                "      invoked by name %s\n"
7389                "      serial %d\n",
7390                interface_name, member,
7391                path,
7392                g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
7393                g_dbus_message_get_serial (message));
7394       _g_dbus_debug_print_unlock ();
7395     }
7396
7397   object_path = g_dbus_message_get_path (message);
7398   g_assert (object_path != NULL);
7399
7400   eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
7401   if (eo != NULL)
7402     {
7403       if (obj_message_func (connection, eo, message))
7404         goto out;
7405     }
7406
7407   es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
7408   if (es != NULL)
7409     {
7410       if (subtree_message_func (connection, es, message))
7411         goto out;
7412     }
7413
7414   if (subtree_path != NULL)
7415     {
7416       es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
7417       if (es != NULL)
7418         {
7419           if (subtree_message_func (connection, es, message))
7420             goto out;
7421         }
7422     }
7423
7424   if (handle_generic_unlocked (connection, message))
7425     goto out;
7426
7427   /* if we end up here, the message has not been not handled - so return an error saying this */
7428   reply = g_dbus_message_new_method_error (message,
7429                                            "org.freedesktop.DBus.Error.UnknownMethod",
7430                                            _("No such interface '%s' on object at path %s"),
7431                                            interface_name,
7432                                            object_path);
7433   g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7434   g_object_unref (reply);
7435
7436  out:
7437   g_free (subtree_path);
7438 }
7439
7440 /* ---------------------------------------------------------------------------------------------------- */
7441
7442 /* Called in any user thread, with the message_bus_lock held. */
7443 static GWeakRef *
7444 message_bus_get_singleton (GBusType   bus_type,
7445                            GError   **error)
7446 {
7447   GWeakRef *ret;
7448   const gchar *starter_bus;
7449
7450   ret = NULL;
7451
7452   switch (bus_type)
7453     {
7454     case G_BUS_TYPE_SESSION:
7455       ret = &the_session_bus;
7456       break;
7457
7458     case G_BUS_TYPE_SYSTEM:
7459       ret = &the_system_bus;
7460       break;
7461
7462     case G_BUS_TYPE_USER:
7463       ret = &the_user_bus;
7464       break;
7465
7466     case G_BUS_TYPE_MACHINE:
7467       ret = &the_machine_bus;
7468       break;
7469
7470     case G_BUS_TYPE_STARTER:
7471       starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
7472       if (g_strcmp0 (starter_bus, "session") == 0)
7473         {
7474           ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
7475           goto out;
7476         }
7477       else if (g_strcmp0 (starter_bus, "system") == 0)
7478         {
7479           ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
7480           goto out;
7481         }
7482       else
7483         {
7484           if (starter_bus != NULL)
7485             {
7486               g_set_error (error,
7487                            G_IO_ERROR,
7488                            G_IO_ERROR_INVALID_ARGUMENT,
7489                            _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
7490                              " - unknown value '%s'"),
7491                            starter_bus);
7492             }
7493           else
7494             {
7495               g_set_error_literal (error,
7496                                    G_IO_ERROR,
7497                                    G_IO_ERROR_INVALID_ARGUMENT,
7498                                    _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
7499                                      "variable is not set"));
7500             }
7501         }
7502       break;
7503
7504     default:
7505       g_assert_not_reached ();
7506       break;
7507     }
7508
7509  out:
7510   return ret;
7511 }
7512
7513 /* Called in any user thread, without holding locks. */
7514 static GDBusConnection *
7515 get_uninitialized_connection (GBusType       bus_type,
7516                               GCancellable  *cancellable,
7517                               GError       **error)
7518 {
7519   GWeakRef *singleton;
7520   GDBusConnection *ret;
7521
7522   ret = NULL;
7523
7524   G_LOCK (message_bus_lock);
7525   singleton = message_bus_get_singleton (bus_type, error);
7526   if (singleton == NULL)
7527     goto out;
7528
7529   ret = g_weak_ref_get (singleton);
7530
7531   if (ret == NULL)
7532     {
7533       gchar *address;
7534       address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
7535       if (address == NULL)
7536         goto out;
7537       ret = g_object_new (G_TYPE_DBUS_CONNECTION,
7538                           "address", address,
7539                           "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
7540                                    G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
7541                           "exit-on-close", TRUE,
7542                           NULL);
7543
7544       g_weak_ref_set (singleton, ret);
7545       g_free (address);
7546     }
7547
7548   g_assert (ret != NULL);
7549
7550  out:
7551   G_UNLOCK (message_bus_lock);
7552   return ret;
7553 }
7554
7555 /* May be called from any thread. Must not hold message_bus_lock. */
7556 GDBusConnection *
7557 _g_bus_get_singleton_if_exists (GBusType bus_type)
7558 {
7559   GWeakRef *singleton;
7560   GDBusConnection *ret = NULL;
7561
7562   G_LOCK (message_bus_lock);
7563   singleton = message_bus_get_singleton (bus_type, NULL);
7564   if (singleton == NULL)
7565     goto out;
7566
7567   ret = g_weak_ref_get (singleton);
7568
7569  out:
7570   G_UNLOCK (message_bus_lock);
7571   return ret;
7572 }
7573
7574 /**
7575  * g_bus_get_sync:
7576  * @bus_type: a #GBusType
7577  * @cancellable: (allow-none): a #GCancellable or %NULL
7578  * @error: return location for error or %NULL
7579  *
7580  * Synchronously connects to the message bus specified by @bus_type.
7581  * Note that the returned object may shared with other callers,
7582  * e.g. if two separate parts of a process calls this function with
7583  * the same @bus_type, they will share the same object.
7584  *
7585  * This is a synchronous failable function. See g_bus_get() and
7586  * g_bus_get_finish() for the asynchronous version.
7587  *
7588  * The returned object is a singleton, that is, shared with other
7589  * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
7590  * event that you need a private message bus connection, use
7591  * g_dbus_address_get_for_bus_sync() and
7592  * g_dbus_connection_new_for_address().
7593  *
7594  * Note that the returned #GDBusConnection object will (usually) have
7595  * the #GDBusConnection:exit-on-close property set to %TRUE.
7596  *
7597  * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
7598  *     Free with g_object_unref().
7599  *
7600  * Since: 2.26
7601  */
7602 GDBusConnection *
7603 g_bus_get_sync (GBusType       bus_type,
7604                 GCancellable  *cancellable,
7605                 GError       **error)
7606 {
7607   GDBusConnection *connection;
7608
7609   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
7610
7611   connection = get_uninitialized_connection (bus_type, cancellable, error);
7612   if (connection == NULL)
7613     goto out;
7614
7615   if (!g_initable_init (G_INITABLE (connection), cancellable, error))
7616     {
7617       g_object_unref (connection);
7618       connection = NULL;
7619     }
7620
7621  out:
7622   return connection;
7623 }
7624
7625 static void
7626 bus_get_async_initable_cb (GObject      *source_object,
7627                            GAsyncResult *res,
7628                            gpointer      user_data)
7629 {
7630   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
7631   GError *error;
7632
7633   error = NULL;
7634   if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
7635                                      res,
7636                                      &error))
7637     {
7638       g_assert (error != NULL);
7639       g_simple_async_result_take_error (simple, error);
7640       g_object_unref (source_object);
7641     }
7642   else
7643     {
7644       g_simple_async_result_set_op_res_gpointer (simple,
7645                                                  source_object,
7646                                                  g_object_unref);
7647     }
7648   g_simple_async_result_complete_in_idle (simple);
7649   g_object_unref (simple);
7650 }
7651
7652 /**
7653  * g_bus_get:
7654  * @bus_type: a #GBusType
7655  * @cancellable: (allow-none): a #GCancellable or %NULL
7656  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7657  * @user_data: the data to pass to @callback
7658  *
7659  * Asynchronously connects to the message bus specified by @bus_type.
7660  *
7661  * When the operation is finished, @callback will be invoked. You can
7662  * then call g_bus_get_finish() to get the result of the operation.
7663  *
7664  * This is a asynchronous failable function. See g_bus_get_sync() for
7665  * the synchronous version.
7666  *
7667  * Since: 2.26
7668  */
7669 void
7670 g_bus_get (GBusType             bus_type,
7671            GCancellable        *cancellable,
7672            GAsyncReadyCallback  callback,
7673            gpointer             user_data)
7674 {
7675   GDBusConnection *connection;
7676   GSimpleAsyncResult *simple;
7677   GError *error;
7678
7679   simple = g_simple_async_result_new (NULL,
7680                                       callback,
7681                                       user_data,
7682                                       g_bus_get);
7683   g_simple_async_result_set_check_cancellable (simple, cancellable);
7684
7685   error = NULL;
7686   connection = get_uninitialized_connection (bus_type, cancellable, &error);
7687   if (connection == NULL)
7688     {
7689       g_assert (error != NULL);
7690       g_simple_async_result_take_error (simple, error);
7691       g_simple_async_result_complete_in_idle (simple);
7692       g_object_unref (simple);
7693     }
7694   else
7695     {
7696       g_async_initable_init_async (G_ASYNC_INITABLE (connection),
7697                                    G_PRIORITY_DEFAULT,
7698                                    cancellable,
7699                                    bus_get_async_initable_cb,
7700                                    simple);
7701     }
7702 }
7703
7704 /**
7705  * g_bus_get_finish:
7706  * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
7707  *     to g_bus_get()
7708  * @error: return location for error or %NULL
7709  *
7710  * Finishes an operation started with g_bus_get().
7711  *
7712  * The returned object is a singleton, that is, shared with other
7713  * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
7714  * event that you need a private message bus connection, use
7715  * g_dbus_address_get_for_bus_sync() and
7716  * g_dbus_connection_new_for_address().
7717  *
7718  * Note that the returned #GDBusConnection object will (usually) have
7719  * the #GDBusConnection:exit-on-close property set to %TRUE.
7720  *
7721  * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
7722  *     Free with g_object_unref().
7723  *
7724  * Since: 2.26
7725  */
7726 GDBusConnection *
7727 g_bus_get_finish (GAsyncResult  *res,
7728                   GError       **error)
7729 {
7730   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
7731   GObject *object;
7732   GDBusConnection *ret;
7733
7734   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
7735
7736   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
7737
7738   ret = NULL;
7739
7740   if (g_simple_async_result_propagate_error (simple, error))
7741     goto out;
7742
7743   object = g_simple_async_result_get_op_res_gpointer (simple);
7744   g_assert (object != NULL);
7745   ret = g_object_ref (G_DBUS_CONNECTION (object));
7746
7747  out:
7748   return ret;
7749 }
7750
7751 /* ---------------------------------------------------------------------------------------------------- */