gio/gdbusconnection.c

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