gio/gdbusconnection.c

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