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