gio/gdbusconnection.c

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