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_bus_watch_proxy() 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;          /* gchar* -> SignalData */
 269   GHashTable *map_id_to_signal_data;            /* guint  -> SignalData */
 270   GHashTable *map_sender_to_signal_data_array;  /* 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_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_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_init_thread (GSimpleAsyncResult *res,
1886                    GObject            *object,
1887                    GCancellable       *cancellable)
1888 {
1889   GError *error = NULL;
1890
1891   if (!g_initable_init (G_INITABLE (object), cancellable, &error))
1892     {
1893       g_simple_async_result_set_from_error (res, error);
1894       g_error_free (error);
1895     }
1896 }
1897
1898 static void
1899 async_initable_init_async (GAsyncInitable      *initable,
1900                            gint                 io_priority,
1901                            GCancellable        *cancellable,
1902                            GAsyncReadyCallback  callback,
1903                            gpointer             user_data)
1904 {
1905   GSimpleAsyncResult *res;
1906
1907   g_return_if_fail (G_IS_INITABLE (initable));
1908
1909   res = g_simple_async_result_new (G_OBJECT (initable), callback, user_data,
1910                                    async_initable_init_async);
1911   g_simple_async_result_run_in_thread (res, async_init_thread,
1912                                        io_priority, cancellable);
1913   g_object_unref (res);
1914 }
1915
1916 static gboolean
1917 async_initable_init_finish (GAsyncInitable  *initable,
1918                             GAsyncResult    *res,
1919                             GError         **error)
1920 {
1921   return TRUE; /* Errors handled by base impl */
1922 }
1923
1924 static void
1925 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
1926 {
1927   /* We basically just want to use GIO's default implementation - though that one is
1928    * unfortunately broken, see #615111. So we copy-paste a fixed-up version.
1929    */
1930   async_initable_iface->init_async = async_initable_init_async;
1931   async_initable_iface->init_finish = async_initable_init_finish;
1932 }
1933
1934 /* ---------------------------------------------------------------------------------------------------- */
1935
1936 /**
1937  * g_dbus_connection_new:
1938  * @stream: A #GIOStream.
1939  * @guid: The GUID to use if a authenticating as a server or %NULL.
1940  * @flags: Flags describing how to make the connection.
1941  * @observer: A #GDBusAuthObserver or %NULL.
1942  * @cancellable: A #GCancellable or %NULL.
1943  * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
1944  * @user_data: The data to pass to @callback.
1945  *
1946  * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
1947  * with the end represented by @stream.
1948  *
1949  * If @observer is not %NULL it may be used to control the
1950  * authentication process.
1951  *
1952  * When the operation is finished, @callback will be invoked. You can
1953  * then call g_dbus_connection_new_finish() to get the result of the
1954  * operation.
1955  *
1956  * This is a asynchronous failable constructor. See
1957  * g_dbus_connection_new_sync() for the synchronous
1958  * version.
1959  *
1960  * Since: 2.26
1961  */
1962 void
1963 g_dbus_connection_new (GIOStream            *stream,
1964                        const gchar          *guid,
1965                        GDBusConnectionFlags  flags,
1966                        GDBusAuthObserver    *observer,
1967                        GCancellable         *cancellable,
1968                        GAsyncReadyCallback   callback,
1969                        gpointer              user_data)
1970 {
1971   g_return_if_fail (G_IS_IO_STREAM (stream));
1972   g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
1973                               G_PRIORITY_DEFAULT,
1974                               cancellable,
1975                               callback,
1976                               user_data,
1977                               "stream", stream,
1978                               "guid", guid,
1979                               "flags", flags,
1980                               "authentication-observer", observer,
1981                               NULL);
1982 }
1983
1984 /**
1985  * g_dbus_connection_new_finish:
1986  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
1987  * @error: Return location for error or %NULL.
1988  *
1989  * Finishes an operation started with g_dbus_connection_new().
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_finish (GAsyncResult  *res,
1997                               GError       **error)
1998 {
1999   GObject *object;
2000   GObject *source_object;
2001
2002   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2003   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2004
2005   source_object = g_async_result_get_source_object (res);
2006   g_assert (source_object != NULL);
2007   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2008                                         res,
2009                                         error);
2010   g_object_unref (source_object);
2011   if (object != NULL)
2012     return G_DBUS_CONNECTION (object);
2013   else
2014     return NULL;
2015 }
2016
2017 /**
2018  * g_dbus_connection_new_sync:
2019  * @stream: A #GIOStream.
2020  * @guid: The GUID to use if a authenticating as a server or %NULL.
2021  * @flags: Flags describing how to make the connection.
2022  * @observer: A #GDBusAuthObserver or %NULL.
2023  * @cancellable: A #GCancellable or %NULL.
2024  * @error: Return location for error or %NULL.
2025  *
2026  * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
2027  * with the end represented by @stream.
2028  *
2029  * If @observer is not %NULL it may be used to control the
2030  * authentication process.
2031  *
2032  * This is a synchronous failable constructor. See
2033  * g_dbus_connection_new() for the asynchronous version.
2034  *
2035  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2036  *
2037  * Since: 2.26
2038  */
2039 GDBusConnection *
2040 g_dbus_connection_new_sync (GIOStream             *stream,
2041                             const gchar           *guid,
2042                             GDBusConnectionFlags   flags,
2043                             GDBusAuthObserver     *observer,
2044                             GCancellable          *cancellable,
2045                             GError               **error)
2046 {
2047   g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
2048   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2049   return g_initable_new (G_TYPE_DBUS_CONNECTION,
2050                          cancellable,
2051                          error,
2052                          "stream", stream,
2053                          "guid", guid,
2054                          "flags", flags,
2055                          "authentication-observer", observer,
2056                          NULL);
2057 }
2058
2059 /* ---------------------------------------------------------------------------------------------------- */
2060
2061 /**
2062  * g_dbus_connection_new_for_address:
2063  * @address: A D-Bus address.
2064  * @flags: Flags describing how to make the connection.
2065  * @observer: A #GDBusAuthObserver or %NULL.
2066  * @cancellable: A #GCancellable or %NULL.
2067  * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2068  * @user_data: The data to pass to @callback.
2069  *
2070  * Asynchronously connects and sets up a D-Bus client connection for
2071  * exchanging D-Bus messages with an endpoint specified by @address
2072  * which must be in the D-Bus address format.
2073  *
2074  * This constructor can only be used to initiate client-side
2075  * connections - use g_dbus_connection_new() if you need to act as the
2076  * server. In particular, @flags cannot contain the
2077  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2078  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2079  *
2080  * When the operation is finished, @callback will be invoked. You can
2081  * then call g_dbus_connection_new_finish() to get the result of the
2082  * operation.
2083  *
2084  * If @observer is not %NULL it may be used to control the
2085  * authentication process.
2086  *
2087  * This is a asynchronous failable constructor. See
2088  * g_dbus_connection_new_for_address_sync() for the synchronous
2089  * version.
2090  *
2091  * Since: 2.26
2092  */
2093 void
2094 g_dbus_connection_new_for_address (const gchar          *address,
2095                                    GDBusConnectionFlags  flags,
2096                                    GDBusAuthObserver    *observer,
2097                                    GCancellable         *cancellable,
2098                                    GAsyncReadyCallback   callback,
2099                                    gpointer              user_data)
2100 {
2101   g_return_if_fail (address != NULL);
2102   g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2103                               G_PRIORITY_DEFAULT,
2104                               cancellable,
2105                               callback,
2106                               user_data,
2107                               "address", address,
2108                               "flags", flags,
2109                               "authentication-observer", observer,
2110                               NULL);
2111 }
2112
2113 /**
2114  * g_dbus_connection_new_for_address_finish:
2115  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2116  * @error: Return location for error or %NULL.
2117  *
2118  * Finishes an operation started with g_dbus_connection_new_for_address().
2119  *
2120  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2121  *
2122  * Since: 2.26
2123  */
2124 GDBusConnection *
2125 g_dbus_connection_new_for_address_finish (GAsyncResult  *res,
2126                                           GError       **error)
2127 {
2128   GObject *object;
2129   GObject *source_object;
2130
2131   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2132   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2133
2134   source_object = g_async_result_get_source_object (res);
2135   g_assert (source_object != NULL);
2136   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2137                                         res,
2138                                         error);
2139   g_object_unref (source_object);
2140   if (object != NULL)
2141     return G_DBUS_CONNECTION (object);
2142   else
2143     return NULL;
2144 }
2145
2146 /**
2147  * g_dbus_connection_new_for_address_sync:
2148  * @address: A D-Bus address.
2149  * @flags: Flags describing how to make the connection.
2150  * @observer: A #GDBusAuthObserver or %NULL.
2151  * @cancellable: A #GCancellable or %NULL.
2152  * @error: Return location for error or %NULL.
2153  *
2154  * Synchronously connects and sets up a D-Bus client connection for
2155  * exchanging D-Bus messages with an endpoint specified by @address
2156  * which must be in the D-Bus address format.
2157  *
2158  * This constructor can only be used to initiate client-side
2159  * connections - use g_dbus_connection_new_sync() if you need to act
2160  * as the server. In particular, @flags cannot contain the
2161  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2162  * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2163  *
2164  * This is a synchronous failable constructor. See
2165  * g_dbus_connection_new_for_address() for the asynchronous version.
2166  *
2167  * If @observer is not %NULL it may be used to control the
2168  * authentication process.
2169  *
2170  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2171  *
2172  * Since: 2.26
2173  */
2174 GDBusConnection *
2175 g_dbus_connection_new_for_address_sync (const gchar           *address,
2176                                         GDBusConnectionFlags   flags,
2177                                         GDBusAuthObserver     *observer,
2178                                         GCancellable          *cancellable,
2179                                         GError               **error)
2180 {
2181   g_return_val_if_fail (address != NULL, NULL);
2182   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2183   return g_initable_new (G_TYPE_DBUS_CONNECTION,
2184                          cancellable,
2185                          error,
2186                          "address", address,
2187                          "flags", flags,
2188                          "authentication-observer", observer,
2189                          NULL);
2190 }
2191
2192 /* ---------------------------------------------------------------------------------------------------- */
2193
2194 /**
2195  * g_dbus_connection_set_exit_on_close:
2196  * @connection: A #GDBusConnection.
2197  * @exit_on_close: Whether the process should be terminated
2198  * when @connection is closed by the remote peer.
2199  *
2200  * Sets whether the process should be terminated when @connection is
2201  * closed by the remote peer. See #GDBusConnection:exit-on-close for
2202  * more details.
2203  *
2204  * Since: 2.26
2205  */
2206 void
2207 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
2208                                      gboolean         exit_on_close)
2209 {
2210   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2211   connection->priv->exit_on_close = exit_on_close;
2212 }
2213
2214 /**
2215  * g_dbus_connection_get_exit_on_close:
2216  * @connection: A #GDBusConnection.
2217  *
2218  * Gets whether the process is terminated when @connection is
2219  * closed by the remote peer. See
2220  * #GDBusConnection:exit-on-close for more details.
2221  *
2222  * Returns: Whether the process is terminated when @connection is
2223  * closed by the remote peer.
2224  *
2225  * Since: 2.26
2226  */
2227 gboolean
2228 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
2229 {
2230   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2231   return connection->priv->exit_on_close;
2232 }
2233
2234 /**
2235  * g_dbus_connection_get_guid:
2236  * @connection: A #GDBusConnection.
2237  *
2238  * The GUID of the peer performing the role of server when
2239  * authenticating. See #GDBusConnection:guid for more details.
2240  *
2241  * Returns: The GUID. Do not free this string, it is owned by
2242  * @connection.
2243  *
2244  * Since: 2.26
2245  */
2246 const gchar *
2247 g_dbus_connection_get_guid (GDBusConnection *connection)
2248 {
2249   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2250   return connection->priv->guid;
2251 }
2252
2253 /**
2254  * g_dbus_connection_get_unique_name:
2255  * @connection: A #GDBusConnection.
2256  *
2257  * Gets the unique name of @connection as assigned by the message
2258  * bus. This can also be used to figure out if @connection is a
2259  * message bus connection.
2260  *
2261  * Returns: The unique name or %NULL if @connection is not a message
2262  * bus connection. Do not free this string, it is owned by
2263  * @connection.
2264  *
2265  * Since: 2.26
2266  */
2267 const gchar *
2268 g_dbus_connection_get_unique_name (GDBusConnection *connection)
2269 {
2270   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2271   return connection->priv->bus_unique_name;
2272 }
2273
2274 /**
2275  * g_dbus_connection_get_peer_credentials:
2276  * @connection: A #GDBusConnection.
2277  *
2278  * Gets the credentials of the authenticated peer. This will always
2279  * return %NULL unless @connection acted as a server
2280  * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
2281  * when set up and the client passed credentials as part of the
2282  * authentication process.
2283  *
2284  * In a message bus setup, the message bus is always the server and
2285  * each application is a client. So this method will always return
2286  * %NULL for message bus clients.
2287  *
2288  * Returns: A #GCredentials or %NULL if not available. Do not free
2289  * this object, it is owned by @connection.
2290  *
2291  * Since: 2.26
2292  */
2293 GCredentials *
2294 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
2295 {
2296   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2297   return connection->priv->crendentials;
2298 }
2299
2300 /* ---------------------------------------------------------------------------------------------------- */
2301
2302 static guint _global_filter_id = 1;
2303
2304 /**
2305  * g_dbus_connection_add_filter:
2306  * @connection: A #GDBusConnection.
2307  * @filter_function: A filter function.
2308  * @user_data: User data to pass to @filter_function.
2309  * @user_data_free_func: Function to free @user_data with when filter
2310  * is removed or %NULL.
2311  *
2312  * Adds a message filter. Filters are handlers that are run on all
2313  * incoming messages, prior to standard dispatch. Filters are run in
2314  * the order that they were added.  The same handler can be added as a
2315  * filter more than once, in which case it will be run more than once.
2316  * Filters added during a filter callback won't be run on the message
2317  * being processed.
2318  *
2319  * Note that filters are run in a dedicated message handling thread so
2320  * they can't block and, generally, can't do anything but signal a
2321  * worker thread. Also note that filters are rarely needed - use API
2322  * such as g_dbus_connection_send_message_with_reply(),
2323  * g_dbus_connection_signal_subscribe() or
2324  * g_dbus_connection_call() instead.
2325  *
2326  * Returns: A filter identifier that can be used with
2327  * g_dbus_connection_remove_filter().
2328  *
2329  * Since: 2.26
2330  */
2331 guint
2332 g_dbus_connection_add_filter (GDBusConnection            *connection,
2333                               GDBusMessageFilterFunction  filter_function,
2334                               gpointer                    user_data,
2335                               GDestroyNotify              user_data_free_func)
2336 {
2337   FilterData *data;
2338
2339   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2340   g_return_val_if_fail (filter_function != NULL, 0);
2341
2342   CONNECTION_LOCK (connection);
2343   data = g_new0 (FilterData, 1);
2344   data->id = _global_filter_id++; /* TODO: overflow etc. */
2345   data->filter_function = filter_function;
2346   data->user_data = user_data;
2347   data->user_data_free_func = user_data_free_func;
2348   g_ptr_array_add (connection->priv->filters, data);
2349   CONNECTION_UNLOCK (connection);
2350
2351   return data->id;
2352 }
2353
2354 /* only called from finalize(), removes all filters */
2355 static void
2356 purge_all_filters (GDBusConnection *connection)
2357 {
2358   guint n;
2359   for (n = 0; n < connection->priv->filters->len; n++)
2360     {
2361       FilterData *data = connection->priv->filters->pdata[n];
2362       if (data->user_data_free_func != NULL)
2363         data->user_data_free_func (data->user_data);
2364       g_free (data);
2365     }
2366 }
2367
2368 /**
2369  * g_dbus_connection_remove_filter:
2370  * @connection: a #GDBusConnection
2371  * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
2372  *
2373  * Removes a filter.
2374  *
2375  * Since: 2.26
2376  */
2377 void
2378 g_dbus_connection_remove_filter (GDBusConnection *connection,
2379                                  guint            filter_id)
2380 {
2381   guint n;
2382   FilterData *to_destroy;
2383
2384   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2385
2386   CONNECTION_LOCK (connection);
2387   to_destroy = NULL;
2388   for (n = 0; n < connection->priv->filters->len; n++)
2389     {
2390       FilterData *data = connection->priv->filters->pdata[n];
2391       if (data->id == filter_id)
2392         {
2393           g_ptr_array_remove_index (connection->priv->filters, n);
2394           to_destroy = data;
2395           break;
2396         }
2397     }
2398   CONNECTION_UNLOCK (connection);
2399
2400   /* do free without holding lock */
2401   if (to_destroy != NULL)
2402     {
2403       if (to_destroy->user_data_free_func != NULL)
2404         to_destroy->user_data_free_func (to_destroy->user_data);
2405       g_free (to_destroy);
2406     }
2407   else
2408     {
2409       g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
2410     }
2411 }
2412
2413 /* ---------------------------------------------------------------------------------------------------- */
2414
2415 typedef struct
2416 {
2417   gchar *rule;
2418   gchar *sender;
2419   gchar *interface_name;
2420   gchar *member;
2421   gchar *object_path;
2422   gchar *arg0;
2423   GArray *subscribers;
2424 } SignalData;
2425
2426 typedef struct
2427 {
2428   GDBusSignalCallback callback;
2429   gpointer user_data;
2430   GDestroyNotify user_data_free_func;
2431   guint id;
2432   GMainContext *context;
2433 } SignalSubscriber;
2434
2435 static void
2436 signal_data_free (SignalData *data)
2437 {
2438   g_free (data->rule);
2439   g_free (data->sender);
2440   g_free (data->interface_name);
2441   g_free (data->member);
2442   g_free (data->object_path);
2443   g_free (data->arg0);
2444   g_array_free (data->subscribers, TRUE);
2445   g_free (data);
2446 }
2447
2448 static gchar *
2449 args_to_rule (const gchar *sender,
2450               const gchar *interface_name,
2451               const gchar *member,
2452               const gchar *object_path,
2453               const gchar *arg0)
2454 {
2455   GString *rule;
2456
2457   rule = g_string_new ("type='signal'");
2458   if (sender != NULL)
2459     g_string_append_printf (rule, ",sender='%s'", sender);
2460   if (interface_name != NULL)
2461     g_string_append_printf (rule, ",interface='%s'", interface_name);
2462   if (member != NULL)
2463     g_string_append_printf (rule, ",member='%s'", member);
2464   if (object_path != NULL)
2465     g_string_append_printf (rule, ",path='%s'", object_path);
2466   if (arg0 != NULL)
2467     g_string_append_printf (rule, ",arg0='%s'", arg0);
2468
2469   return g_string_free (rule, FALSE);
2470 }
2471
2472 static guint _global_subscriber_id = 1;
2473 static guint _global_registration_id = 1;
2474 static guint _global_subtree_registration_id = 1;
2475
2476 /* ---------------------------------------------------------------------------------------------------- */
2477
2478 /* must hold lock when calling */
2479 static void
2480 add_match_rule (GDBusConnection *connection,
2481                 const gchar     *match_rule)
2482 {
2483   GError *error;
2484   GDBusMessage *message;
2485
2486   message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
2487                                             "/org/freedesktop/DBus", /* path */
2488                                             "org.freedesktop.DBus", /* interface */
2489                                             "AddMatch");
2490   g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
2491
2492   error = NULL;
2493   if (!g_dbus_connection_send_message_unlocked (connection,
2494                                                 message,
2495                                                 NULL,
2496                                                 &error))
2497     {
2498       g_critical ("Error while sending AddMatch() message: %s", error->message);
2499       g_error_free (error);
2500     }
2501   g_object_unref (message);
2502 }
2503
2504 /* ---------------------------------------------------------------------------------------------------- */
2505
2506 /* must hold lock when calling */
2507 static void
2508 remove_match_rule (GDBusConnection *connection,
2509                    const gchar     *match_rule)
2510 {
2511   GError *error;
2512   GDBusMessage *message;
2513
2514   message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
2515                                             "/org/freedesktop/DBus", /* path */
2516                                             "org.freedesktop.DBus", /* interface */
2517                                             "RemoveMatch");
2518   g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
2519
2520   error = NULL;
2521   if (!g_dbus_connection_send_message_unlocked (connection,
2522                                                 message,
2523                                                 NULL,
2524                                                 &error))
2525     {
2526       g_critical ("Error while sending RemoveMatch() message: %s", error->message);
2527       g_error_free (error);
2528     }
2529   g_object_unref (message);
2530 }
2531
2532 /* ---------------------------------------------------------------------------------------------------- */
2533
2534 static gboolean
2535 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
2536 {
2537   return g_strcmp0 (signal_data->sender, "org.freedesktop.DBus") == 0 &&
2538          g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
2539          g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
2540          (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
2541           g_strcmp0 (signal_data->member, "NameAcquired") == 0);
2542 }
2543
2544 /* ---------------------------------------------------------------------------------------------------- */
2545
2546 /**
2547  * g_dbus_connection_signal_subscribe:
2548  * @connection: A #GDBusConnection.
2549  * @sender: Sender name to match on. Must be either <literal>org.freedesktop.DBus</literal> (for listening to signals from the message bus daemon) or a unique name or %NULL to listen from all senders.
2550  * @interface_name: D-Bus interface name to match on or %NULL to match on all interfaces.
2551  * @member: D-Bus signal name to match on or %NULL to match on all signals.
2552  * @object_path: Object path to match on or %NULL to match on all object paths.
2553  * @arg0: Contents of first string argument to match on or %NULL to match on all kinds of arguments.
2554  * @callback: Callback to invoke when there is a signal matching the requested data.
2555  * @user_data: User data to pass to @callback.
2556  * @user_data_free_func: Function to free @user_data with when subscription is removed or %NULL.
2557  *
2558  * Subscribes to signals on @connection and invokes @callback with a
2559  * whenever the signal is received. Note that @callback
2560  * will be invoked in the <link
2561  * linkend="g-main-context-push-thread-default">thread-default main
2562  * loop</link> of the thread you are calling this method from.
2563  *
2564  * It is considered a programming error to use this function if @connection is closed.
2565  *
2566  * Note that if @sender is not <literal>org.freedesktop.DBus</literal> (for listening to signals from the
2567  * message bus daemon), then it needs to be a unique bus name or %NULL (for listening to signals from any
2568  * name) - you cannot pass a name like <literal>com.example.MyApp</literal>.
2569  * Use e.g. g_bus_watch_name() to find the unique name for the owner of the name you are interested in. Also note
2570  * that this function does not remove a subscription if @sender vanishes from the bus. You have to manually
2571  * call g_dbus_connection_signal_unsubscribe() to remove a subscription.
2572  *
2573  * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
2574  *
2575  * Since: 2.26
2576  */
2577 guint
2578 g_dbus_connection_signal_subscribe (GDBusConnection     *connection,
2579                                     const gchar         *sender,
2580                                     const gchar         *interface_name,
2581                                     const gchar         *member,
2582                                     const gchar         *object_path,
2583                                     const gchar         *arg0,
2584                                     GDBusSignalCallback  callback,
2585                                     gpointer             user_data,
2586                                     GDestroyNotify       user_data_free_func)
2587 {
2588   gchar *rule;
2589   SignalData *signal_data;
2590   SignalSubscriber subscriber;
2591   GPtrArray *signal_data_array;
2592
2593   /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
2594    * an OOM condition. We might want to change that but that would involve making
2595    * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
2596    * handle that. And there's really no sensible way of handling this short of retrying
2597    * to add the match rule... and then there's the little thing that, hey, maybe there's
2598    * a reason the bus in an OOM condition.
2599    *
2600    * Doable, but not really sure it's worth it...
2601    */
2602
2603   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2604   g_return_val_if_fail (!g_dbus_connection_is_closed (connection), 0);
2605   g_return_val_if_fail (sender == NULL || ((strcmp (sender, "org.freedesktop.DBus") == 0 || sender[0] == ':') &&
2606                                            (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
2607   g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
2608   g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
2609   g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
2610   g_return_val_if_fail (callback != NULL, 0);
2611
2612   CONNECTION_LOCK (connection);
2613
2614   rule = args_to_rule (sender, interface_name, member, object_path, arg0);
2615
2616   if (sender == NULL)
2617     sender = "";
2618
2619   subscriber.callback = callback;
2620   subscriber.user_data = user_data;
2621   subscriber.user_data_free_func = user_data_free_func;
2622   subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
2623   subscriber.context = g_main_context_get_thread_default ();
2624   if (subscriber.context != NULL)
2625     g_main_context_ref (subscriber.context);
2626
2627   /* see if we've already have this rule */
2628   signal_data = g_hash_table_lookup (connection->priv->map_rule_to_signal_data, rule);
2629   if (signal_data != NULL)
2630     {
2631       g_array_append_val (signal_data->subscribers, subscriber);
2632       g_free (rule);
2633       goto out;
2634     }
2635
2636   signal_data = g_new0 (SignalData, 1);
2637   signal_data->rule           = rule;
2638   signal_data->sender         = g_strdup (sender);
2639   signal_data->interface_name = g_strdup (interface_name);
2640   signal_data->member         = g_strdup (member);
2641   signal_data->object_path    = g_strdup (object_path);
2642   signal_data->arg0           = g_strdup (arg0);
2643   signal_data->subscribers    = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
2644   g_array_append_val (signal_data->subscribers, subscriber);
2645
2646   g_hash_table_insert (connection->priv->map_rule_to_signal_data,
2647                        signal_data->rule,
2648                        signal_data);
2649
2650   /* Add the match rule to the bus...
2651    *
2652    * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
2653    * always send such messages to us.
2654    */
2655   if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2656     {
2657       if (!is_signal_data_for_name_lost_or_acquired (signal_data))
2658         add_match_rule (connection, signal_data->rule);
2659     }
2660
2661  out:
2662   g_hash_table_insert (connection->priv->map_id_to_signal_data,
2663                        GUINT_TO_POINTER (subscriber.id),
2664                        signal_data);
2665
2666   signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array,
2667                                            signal_data->sender);
2668   if (signal_data_array == NULL)
2669     {
2670       signal_data_array = g_ptr_array_new ();
2671       g_hash_table_insert (connection->priv->map_sender_to_signal_data_array,
2672                            g_strdup (signal_data->sender),
2673                            signal_data_array);
2674     }
2675   g_ptr_array_add (signal_data_array, signal_data);
2676
2677   CONNECTION_UNLOCK (connection);
2678
2679   return subscriber.id;
2680 }
2681
2682 /* ---------------------------------------------------------------------------------------------------- */
2683
2684 /* must hold lock when calling this */
2685 static void
2686 unsubscribe_id_internal (GDBusConnection *connection,
2687                          guint            subscription_id,
2688                          GArray          *out_removed_subscribers)
2689 {
2690   SignalData *signal_data;
2691   GPtrArray *signal_data_array;
2692   guint n;
2693
2694   signal_data = g_hash_table_lookup (connection->priv->map_id_to_signal_data,
2695                                      GUINT_TO_POINTER (subscription_id));
2696   if (signal_data == NULL)
2697     {
2698       /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
2699       goto out;
2700     }
2701
2702   for (n = 0; n < signal_data->subscribers->len; n++)
2703     {
2704       SignalSubscriber *subscriber;
2705
2706       subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
2707       if (subscriber->id != subscription_id)
2708         continue;
2709
2710       g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_signal_data,
2711                                            GUINT_TO_POINTER (subscription_id)));
2712       g_array_append_val (out_removed_subscribers, *subscriber);
2713       g_array_remove_index (signal_data->subscribers, n);
2714
2715       if (signal_data->subscribers->len == 0)
2716         g_warn_if_fail (g_hash_table_remove (connection->priv->map_rule_to_signal_data, signal_data->rule));
2717
2718       signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array,
2719                                                signal_data->sender);
2720       g_warn_if_fail (signal_data_array != NULL);
2721       g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
2722
2723       if (signal_data_array->len == 0)
2724         {
2725           g_warn_if_fail (g_hash_table_remove (connection->priv->map_sender_to_signal_data_array, signal_data->sender));
2726
2727           /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
2728           if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2729             {
2730               if (!is_signal_data_for_name_lost_or_acquired (signal_data))
2731                 remove_match_rule (connection, signal_data->rule);
2732             }
2733
2734           signal_data_free (signal_data);
2735         }
2736
2737       goto out;
2738     }
2739
2740   g_assert_not_reached ();
2741
2742  out:
2743   ;
2744 }
2745
2746 /**
2747  * g_dbus_connection_signal_unsubscribe:
2748  * @connection: A #GDBusConnection.
2749  * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
2750  *
2751  * Unsubscribes from signals.
2752  *
2753  * Since: 2.26
2754  */
2755 void
2756 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
2757                                       guint            subscription_id)
2758 {
2759   GArray *subscribers;
2760   guint n;
2761
2762   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2763
2764   subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
2765
2766   CONNECTION_LOCK (connection);
2767   unsubscribe_id_internal (connection,
2768                            subscription_id,
2769                            subscribers);
2770   CONNECTION_UNLOCK (connection);
2771
2772   /* invariant */
2773   g_assert (subscribers->len == 0 || subscribers->len == 1);
2774
2775   /* call GDestroyNotify without lock held */
2776   for (n = 0; n < subscribers->len; n++)
2777     {
2778       SignalSubscriber *subscriber;
2779       subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
2780       if (subscriber->user_data_free_func != NULL)
2781         subscriber->user_data_free_func (subscriber->user_data);
2782       if (subscriber->context != NULL)
2783         g_main_context_unref (subscriber->context);
2784     }
2785
2786   g_array_free (subscribers, TRUE);
2787 }
2788
2789 /* ---------------------------------------------------------------------------------------------------- */
2790
2791 typedef struct
2792 {
2793   guint                subscription_id;
2794   GDBusSignalCallback  callback;
2795   gpointer             user_data;
2796   GDBusMessage        *message;
2797   GDBusConnection     *connection;
2798   const gchar         *sender;
2799   const gchar         *path;
2800   const gchar         *interface;
2801   const gchar         *member;
2802 } SignalInstance;
2803
2804 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
2805  * no locks held
2806  */
2807 static gboolean
2808 emit_signal_instance_in_idle_cb (gpointer data)
2809 {
2810   SignalInstance *signal_instance = data;
2811   GVariant *parameters;
2812   gboolean has_subscription;
2813
2814   parameters = g_dbus_message_get_body (signal_instance->message);
2815   if (parameters == NULL)
2816     {
2817       parameters = g_variant_new ("()");
2818       g_variant_ref_sink (parameters);
2819     }
2820   else
2821     {
2822       g_variant_ref_sink (parameters);
2823     }
2824
2825 #if 0
2826   g_debug ("in emit_signal_instance_in_idle_cb (sender=%s path=%s interface=%s member=%s params=%s)",
2827            signal_instance->sender,
2828            signal_instance->path,
2829            signal_instance->interface,
2830            signal_instance->member,
2831            g_variant_print (parameters, TRUE));
2832 #endif
2833
2834   /* Careful here, don't do the callback if we no longer has the subscription */
2835   CONNECTION_LOCK (signal_instance->connection);
2836   has_subscription = FALSE;
2837   if (g_hash_table_lookup (signal_instance->connection->priv->map_id_to_signal_data,
2838                            GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
2839     has_subscription = TRUE;
2840   CONNECTION_UNLOCK (signal_instance->connection);
2841
2842   if (has_subscription)
2843     signal_instance->callback (signal_instance->connection,
2844                                signal_instance->sender,
2845                                signal_instance->path,
2846                                signal_instance->interface,
2847                                signal_instance->member,
2848                                parameters,
2849                                signal_instance->user_data);
2850
2851   if (parameters != NULL)
2852     g_variant_unref (parameters);
2853
2854   return FALSE;
2855 }
2856
2857 static void
2858 signal_instance_free (SignalInstance *signal_instance)
2859 {
2860   g_object_unref (signal_instance->message);
2861   g_object_unref (signal_instance->connection);
2862   g_free (signal_instance);
2863 }
2864
2865 /* called in message handler thread WITH lock held */
2866 static void
2867 schedule_callbacks (GDBusConnection *connection,
2868                     GPtrArray       *signal_data_array,
2869                     GDBusMessage    *message,
2870                     const gchar     *sender)
2871 {
2872   guint n, m;
2873   const gchar *interface;
2874   const gchar *member;
2875   const gchar *path;
2876   const gchar *arg0;
2877
2878   interface = NULL;
2879   member = NULL;
2880   path = NULL;
2881   arg0 = NULL;
2882
2883   interface = g_dbus_message_get_interface (message);
2884   member = g_dbus_message_get_member (message);
2885   path = g_dbus_message_get_path (message);
2886   arg0 = g_dbus_message_get_arg0 (message);
2887
2888 #if 0
2889   g_debug ("sender    = `%s'", sender);
2890   g_debug ("interface = `%s'", interface);
2891   g_debug ("member    = `%s'", member);
2892   g_debug ("path      = `%s'", path);
2893   g_debug ("arg0      = `%s'", arg0);
2894 #endif
2895
2896   /* TODO: if this is slow, then we can change signal_data_array into
2897    *       map_object_path_to_signal_data_array or something.
2898    */
2899   for (n = 0; n < signal_data_array->len; n++)
2900     {
2901       SignalData *signal_data = signal_data_array->pdata[n];
2902
2903       if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
2904         continue;
2905
2906       if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
2907         continue;
2908
2909       if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
2910         continue;
2911
2912       if (signal_data->arg0 != NULL && g_strcmp0 (signal_data->arg0, arg0) != 0)
2913         continue;
2914
2915       for (m = 0; m < signal_data->subscribers->len; m++)
2916         {
2917           SignalSubscriber *subscriber;
2918           GSource *idle_source;
2919           SignalInstance *signal_instance;
2920
2921           subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
2922
2923           signal_instance = g_new0 (SignalInstance, 1);
2924           signal_instance->subscription_id = subscriber->id;
2925           signal_instance->callback = subscriber->callback;
2926           signal_instance->user_data = subscriber->user_data;
2927           signal_instance->message = g_object_ref (message);
2928           signal_instance->connection = g_object_ref (connection);
2929           signal_instance->sender = sender;
2930           signal_instance->path = path;
2931           signal_instance->interface = interface;
2932           signal_instance->member = member;
2933
2934           idle_source = g_idle_source_new ();
2935           g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
2936           g_source_set_callback (idle_source,
2937                                  emit_signal_instance_in_idle_cb,
2938                                  signal_instance,
2939                                  (GDestroyNotify) signal_instance_free);
2940           g_source_attach (idle_source, subscriber->context);
2941           g_source_unref (idle_source);
2942         }
2943     }
2944 }
2945
2946 /* called in message handler thread with lock held */
2947 static void
2948 distribute_signals (GDBusConnection *connection,
2949                     GDBusMessage    *message)
2950 {
2951   GPtrArray *signal_data_array;
2952   const gchar *sender;
2953
2954   sender = g_dbus_message_get_sender (message);
2955
2956   /* collect subscribers that match on sender */
2957   if (sender != NULL)
2958     {
2959       signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array, sender);
2960       if (signal_data_array != NULL)
2961         schedule_callbacks (connection, signal_data_array, message, sender);
2962     }
2963
2964   /* collect subscribers not matching on sender */
2965   signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array, "");
2966   if (signal_data_array != NULL)
2967     schedule_callbacks (connection, signal_data_array, message, sender);
2968 }
2969
2970 /* ---------------------------------------------------------------------------------------------------- */
2971
2972 /* only called from finalize(), removes all subscriptions */
2973 static void
2974 purge_all_signal_subscriptions (GDBusConnection *connection)
2975 {
2976   GHashTableIter iter;
2977   gpointer key;
2978   GArray *ids;
2979   GArray *subscribers;
2980   guint n;
2981
2982   ids = g_array_new (FALSE, FALSE, sizeof (guint));
2983   g_hash_table_iter_init (&iter, connection->priv->map_id_to_signal_data);
2984   while (g_hash_table_iter_next (&iter, &key, NULL))
2985     {
2986       guint subscription_id = GPOINTER_TO_UINT (key);
2987       g_array_append_val (ids, subscription_id);
2988     }
2989
2990   subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
2991   for (n = 0; n < ids->len; n++)
2992     {
2993       guint subscription_id = g_array_index (ids, guint, n);
2994       unsubscribe_id_internal (connection,
2995                                subscription_id,
2996                                subscribers);
2997     }
2998   g_array_free (ids, TRUE);
2999
3000   /* call GDestroyNotify without lock held */
3001   for (n = 0; n < subscribers->len; n++)
3002     {
3003       SignalSubscriber *subscriber;
3004       subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3005       if (subscriber->user_data_free_func != NULL)
3006         subscriber->user_data_free_func (subscriber->user_data);
3007       if (subscriber->context != NULL)
3008         g_main_context_unref (subscriber->context);
3009     }
3010
3011   g_array_free (subscribers, TRUE);
3012 }
3013
3014 /* ---------------------------------------------------------------------------------------------------- */
3015
3016 struct ExportedObject
3017 {
3018   gchar *object_path;
3019   GDBusConnection *connection;
3020
3021   /* maps gchar* -> ExportedInterface* */
3022   GHashTable *map_if_name_to_ei;
3023 };
3024
3025 /* only called with lock held */
3026 static void
3027 exported_object_free (ExportedObject *eo)
3028 {
3029   g_free (eo->object_path);
3030   g_hash_table_unref (eo->map_if_name_to_ei);
3031   g_free (eo);
3032 }
3033
3034 typedef struct
3035 {
3036   ExportedObject *eo;
3037
3038   guint                       id;
3039   gchar                      *interface_name;
3040   const GDBusInterfaceVTable *vtable;
3041   const GDBusInterfaceInfo   *introspection_data;
3042
3043   GMainContext               *context;
3044   gpointer                    user_data;
3045   GDestroyNotify              user_data_free_func;
3046 } ExportedInterface;
3047
3048 /* called with lock held */
3049 static void
3050 exported_interface_free (ExportedInterface *ei)
3051 {
3052   if (ei->user_data_free_func != NULL)
3053     /* TODO: push to thread-default mainloop */
3054     ei->user_data_free_func (ei->user_data);
3055
3056   if (ei->context != NULL)
3057     g_main_context_unref (ei->context);
3058
3059   g_free (ei->interface_name);
3060   g_free (ei);
3061 }
3062
3063 /* ---------------------------------------------------------------------------------------------------- */
3064
3065 typedef struct
3066 {
3067   GDBusConnection *connection;
3068   GDBusMessage *message;
3069   gpointer user_data;
3070   const char *property_name;
3071   const GDBusInterfaceVTable *vtable;
3072   const GDBusInterfaceInfo *interface_info;
3073   const GDBusPropertyInfo *property_info;
3074 } PropertyData;
3075
3076 static void
3077 property_data_free (PropertyData *data)
3078 {
3079   g_object_unref (data->connection);
3080   g_object_unref (data->message);
3081   g_free (data);
3082 }
3083
3084 /* called in thread where object was registered - no locks held */
3085 static gboolean
3086 invoke_get_property_in_idle_cb (gpointer _data)
3087 {
3088   PropertyData *data = _data;
3089   GVariant *value;
3090   GError *error;
3091   GDBusMessage *reply;
3092
3093   error = NULL;
3094   value = data->vtable->get_property (data->connection,
3095                                       g_dbus_message_get_sender (data->message),
3096                                       g_dbus_message_get_path (data->message),
3097                                       data->interface_info->name,
3098                                       data->property_name,
3099                                       &error,
3100                                       data->user_data);
3101
3102
3103   if (value != NULL)
3104     {
3105       g_assert_no_error (error);
3106
3107       g_variant_ref_sink (value);
3108       reply = g_dbus_message_new_method_reply (data->message);
3109       g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
3110       g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3111       g_variant_unref (value);
3112       g_object_unref (reply);
3113     }
3114   else
3115     {
3116       gchar *dbus_error_name;
3117
3118       g_assert (error != NULL);
3119
3120       dbus_error_name = g_dbus_error_encode_gerror (error);
3121       reply = g_dbus_message_new_method_error_literal (data->message,
3122                                                        dbus_error_name,
3123                                                        error->message);
3124       g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3125       g_free (dbus_error_name);
3126       g_error_free (error);
3127       g_object_unref (reply);
3128     }
3129
3130   return FALSE;
3131 }
3132
3133 /* called in thread where object was registered - no locks held */
3134 static gboolean
3135 invoke_set_property_in_idle_cb (gpointer _data)
3136 {
3137   PropertyData *data = _data;
3138   GError *error;
3139   GDBusMessage *reply;
3140   GVariant *value;
3141
3142   error = NULL;
3143   value = NULL;
3144
3145   g_variant_get (g_dbus_message_get_body (data->message),
3146                  "(ssv)",
3147                  NULL,
3148                  NULL,
3149                  &value);
3150
3151   /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
3152    * of the given value is wrong
3153    */
3154   if (g_strcmp0 (g_variant_get_type_string (value), data->property_info->signature) != 0)
3155     {
3156       reply = g_dbus_message_new_method_error (data->message,
3157                                                "org.freedesktop.DBus.Error.InvalidArgs",
3158                                                _("Error setting property `%s': Expected type `%s' but got `%s'"),
3159                                                data->property_info->name,
3160                                                data->property_info->signature,
3161                                                g_variant_get_type_string (value));
3162       goto out;
3163     }
3164
3165   if (!data->vtable->set_property (data->connection,
3166                                    g_dbus_message_get_sender (data->message),
3167                                    g_dbus_message_get_path (data->message),
3168                                    data->interface_info->name,
3169                                    data->property_name,
3170                                    value,
3171                                    &error,
3172                                    data->user_data))
3173     {
3174       gchar *dbus_error_name;
3175       g_assert (error != NULL);
3176       dbus_error_name = g_dbus_error_encode_gerror (error);
3177       reply = g_dbus_message_new_method_error_literal (data->message,
3178                                                        dbus_error_name,
3179                                                        error->message);
3180       g_free (dbus_error_name);
3181       g_error_free (error);
3182     }
3183   else
3184     {
3185       reply = g_dbus_message_new_method_reply (data->message);
3186     }
3187
3188  out:
3189   g_assert (reply != NULL);
3190   g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3191   g_object_unref (reply);
3192
3193   return FALSE;
3194 }
3195
3196 /* called with lock held */
3197 static gboolean
3198 validate_and_maybe_schedule_property_getset (GDBusConnection            *connection,
3199                                              GDBusMessage               *message,
3200                                              gboolean                    is_get,
3201                                              const GDBusInterfaceInfo   *introspection_data,
3202                                              const GDBusInterfaceVTable *vtable,
3203                                              GMainContext               *main_context,
3204                                              gpointer                    user_data)
3205 {
3206   gboolean handled;
3207   const char *interface_name;
3208   const char *property_name;
3209   const GDBusPropertyInfo *property_info;
3210   GSource *idle_source;
3211   PropertyData *property_data;
3212   GDBusMessage *reply;
3213
3214   handled = FALSE;
3215
3216   if (is_get)
3217     g_variant_get (g_dbus_message_get_body (message),
3218                    "(&s&s)",
3219                    &interface_name,
3220                    &property_name);
3221   else
3222     g_variant_get (g_dbus_message_get_body (message),
3223                    "(&s&sv)",
3224                    &interface_name,
3225                    &property_name,
3226                    NULL);
3227
3228
3229   if (is_get)
3230     {
3231       if (vtable == NULL || vtable->get_property == NULL)
3232         goto out;
3233     }
3234   else
3235     {
3236       if (vtable == NULL || vtable->set_property == NULL)
3237         goto out;
3238     }
3239
3240   /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
3241    */
3242   property_info = NULL;
3243
3244   /* TODO: the cost of this is O(n) - it might be worth caching the result */
3245   property_info = g_dbus_interface_info_lookup_property (introspection_data, property_name);
3246   if (property_info == NULL)
3247     {
3248       reply = g_dbus_message_new_method_error (message,
3249                                                "org.freedesktop.DBus.Error.InvalidArgs",
3250                                                _("No such property `%s'"),
3251                                                property_name);
3252       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3253       g_object_unref (reply);
3254       handled = TRUE;
3255       goto out;
3256     }
3257
3258   if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
3259     {
3260       reply = g_dbus_message_new_method_error (message,
3261                                                "org.freedesktop.DBus.Error.InvalidArgs",
3262                                                _("Property `%s' is not readable"),
3263                                                property_name);
3264       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3265       g_object_unref (reply);
3266       handled = TRUE;
3267       goto out;
3268     }
3269   else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
3270     {
3271       reply = g_dbus_message_new_method_error (message,
3272                                                "org.freedesktop.DBus.Error.InvalidArgs",
3273                                                _("Property `%s' is not writable"),
3274                                                property_name);
3275       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3276       g_object_unref (reply);
3277       handled = TRUE;
3278       goto out;
3279     }
3280
3281   /* ok, got the property info - call user code in an idle handler */
3282   property_data = g_new0 (PropertyData, 1);
3283   property_data->connection = g_object_ref (connection);
3284   property_data->message = g_object_ref (message);
3285   property_data->user_data = user_data;
3286   property_data->property_name = property_name;
3287   property_data->vtable = vtable;
3288   property_data->interface_info = introspection_data;
3289   property_data->property_info = property_info;
3290
3291   idle_source = g_idle_source_new ();
3292   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3293   g_source_set_callback (idle_source,
3294                          is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
3295                          property_data,
3296                          (GDestroyNotify) property_data_free);
3297   g_source_attach (idle_source, main_context);
3298   g_source_unref (idle_source);
3299
3300   handled = TRUE;
3301
3302  out:
3303   return handled;
3304 }
3305
3306 /* called with lock held */
3307 static gboolean
3308 handle_getset_property (GDBusConnection *connection,
3309                         ExportedObject  *eo,
3310                         GDBusMessage    *message,
3311                         gboolean         is_get)
3312 {
3313   ExportedInterface *ei;
3314   gboolean handled;
3315   const char *interface_name;
3316   const char *property_name;
3317
3318   handled = FALSE;
3319
3320   if (is_get)
3321     g_variant_get (g_dbus_message_get_body (message),
3322                    "(&s&s)",
3323                    &interface_name,
3324                    &property_name);
3325   else
3326     g_variant_get (g_dbus_message_get_body (message),
3327                    "(&s&sv)",
3328                    &interface_name,
3329                    &property_name,
3330                    NULL);
3331
3332   /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
3333    * no such interface registered
3334    */
3335   ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3336   if (ei == NULL)
3337     {
3338       GDBusMessage *reply;
3339       reply = g_dbus_message_new_method_error (message,
3340                                                "org.freedesktop.DBus.Error.InvalidArgs",
3341                                                _("No such interface `%s'"),
3342                                                interface_name);
3343       g_dbus_connection_send_message_unlocked (eo->connection, reply, NULL, NULL);
3344       g_object_unref (reply);
3345       handled = TRUE;
3346       goto out;
3347     }
3348
3349   handled = validate_and_maybe_schedule_property_getset (eo->connection,
3350                                                          message,
3351                                                          is_get,
3352                                                          ei->introspection_data,
3353                                                          ei->vtable,
3354                                                          ei->context,
3355                                                          ei->user_data);
3356  out:
3357   return handled;
3358 }
3359
3360 /* ---------------------------------------------------------------------------------------------------- */
3361
3362 typedef struct
3363 {
3364   GDBusConnection *connection;
3365   GDBusMessage *message;
3366   gpointer user_data;
3367   const GDBusInterfaceVTable *vtable;
3368   const GDBusInterfaceInfo *interface_info;
3369 } PropertyGetAllData;
3370
3371 static void
3372 property_get_all_data_free (PropertyData *data)
3373 {
3374   g_object_unref (data->connection);
3375   g_object_unref (data->message);
3376   g_free (data);
3377 }
3378
3379 /* called in thread where object was registered - no locks held */
3380 static gboolean
3381 invoke_get_all_properties_in_idle_cb (gpointer _data)
3382 {
3383   PropertyGetAllData *data = _data;
3384   GVariantBuilder builder;
3385   GError *error;
3386   GDBusMessage *reply;
3387   guint n;
3388
3389   error = NULL;
3390
3391   /* TODO: Right now we never fail this call - we just omit values if
3392    *       a get_property() call is failing.
3393    *
3394    *       We could fail the whole call if just a single get_property() call
3395    *       returns an error. We need clarification in the D-Bus spec about this.
3396    */
3397   g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
3398   g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
3399   for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
3400     {
3401       const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
3402       GVariant *value;
3403
3404       if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
3405         continue;
3406
3407       value = data->vtable->get_property (data->connection,
3408                                           g_dbus_message_get_sender (data->message),
3409                                           g_dbus_message_get_path (data->message),
3410                                           data->interface_info->name,
3411                                           property_info->name,
3412                                           NULL,
3413                                           data->user_data);
3414
3415       if (value == NULL)
3416         continue;
3417
3418       g_variant_builder_add (&builder,
3419                              "{sv}",
3420                              property_info->name,
3421                              value);
3422     }
3423   g_variant_builder_close (&builder);
3424
3425   reply = g_dbus_message_new_method_reply (data->message);
3426   g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
3427   g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3428   g_object_unref (reply);
3429
3430   return FALSE;
3431 }
3432
3433 /* called with lock held */
3434 static gboolean
3435 validate_and_maybe_schedule_property_get_all (GDBusConnection            *connection,
3436                                               GDBusMessage               *message,
3437                                               const GDBusInterfaceInfo   *introspection_data,
3438                                               const GDBusInterfaceVTable *vtable,
3439                                               GMainContext               *main_context,
3440                                               gpointer                    user_data)
3441 {
3442   gboolean handled;
3443   const char *interface_name;
3444   GSource *idle_source;
3445   PropertyGetAllData *property_get_all_data;
3446
3447   handled = FALSE;
3448
3449   g_variant_get (g_dbus_message_get_body (message),
3450                  "(&s)",
3451                  &interface_name);
3452
3453   if (vtable == NULL || vtable->get_property == NULL)
3454     goto out;
3455
3456   /* ok, got the property info - call user in an idle handler */
3457   property_get_all_data = g_new0 (PropertyGetAllData, 1);
3458   property_get_all_data->connection = g_object_ref (connection);
3459   property_get_all_data->message = g_object_ref (message);
3460   property_get_all_data->user_data = user_data;
3461   property_get_all_data->vtable = vtable;
3462   property_get_all_data->interface_info = introspection_data;
3463
3464   idle_source = g_idle_source_new ();
3465   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3466   g_source_set_callback (idle_source,
3467                          invoke_get_all_properties_in_idle_cb,
3468                          property_get_all_data,
3469                          (GDestroyNotify) property_get_all_data_free);
3470   g_source_attach (idle_source, main_context);
3471   g_source_unref (idle_source);
3472
3473   handled = TRUE;
3474
3475  out:
3476   return handled;
3477 }
3478
3479 /* called with lock held */
3480 static gboolean
3481 handle_get_all_properties (GDBusConnection *connection,
3482                            ExportedObject  *eo,
3483                            GDBusMessage    *message)
3484 {
3485   ExportedInterface *ei;
3486   gboolean handled;
3487   const char *interface_name;
3488
3489   handled = FALSE;
3490
3491   g_variant_get (g_dbus_message_get_body (message),
3492                  "(&s)",
3493                  &interface_name);
3494
3495   /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
3496    * no such interface registered
3497    */
3498   ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3499   if (ei == NULL)
3500     {
3501       GDBusMessage *reply;
3502       reply = g_dbus_message_new_method_error (message,
3503                                                "org.freedesktop.DBus.Error.InvalidArgs",
3504                                                _("No such interface"),
3505                                                interface_name);
3506       g_dbus_connection_send_message_unlocked (eo->connection, reply, NULL, NULL);
3507       g_object_unref (reply);
3508       handled = TRUE;
3509       goto out;
3510     }
3511
3512   handled = validate_and_maybe_schedule_property_get_all (eo->connection,
3513                                                           message,
3514                                                           ei->introspection_data,
3515                                                           ei->vtable,
3516                                                           ei->context,
3517                                                           ei->user_data);
3518  out:
3519   return handled;
3520 }
3521
3522 /* ---------------------------------------------------------------------------------------------------- */
3523
3524 static const gchar introspect_header[] =
3525   "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
3526   "                      \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
3527   "<!-- GDBus " PACKAGE_VERSION " -->\n"
3528   "<node>\n";
3529
3530 static const gchar introspect_tail[] =
3531   "</node>\n";
3532
3533 static const gchar introspect_standard_interfaces[] =
3534   "  <interface name=\"org.freedesktop.DBus.Properties\">\n"
3535   "    <method name=\"Get\">\n"
3536   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3537   "      <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
3538   "      <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
3539   "    </method>\n"
3540   "    <method name=\"GetAll\">\n"
3541   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3542   "      <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
3543   "    </method>\n"
3544   "    <method name=\"Set\">\n"
3545   "      <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3546   "      <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
3547   "      <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
3548   "    </method>\n"
3549   "    <signal name=\"PropertiesChanged\">\n"
3550   "      <arg type=\"s\" name=\"interface_name\"/>\n"
3551   "      <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
3552   "      <arg type=\"as\" name=\"invalidated_properties\"/>\n"
3553   "    </signal>\n"
3554   "  </interface>\n"
3555   "  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
3556   "    <method name=\"Introspect\">\n"
3557   "      <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
3558   "    </method>\n"
3559   "  </interface>\n"
3560   "  <interface name=\"org.freedesktop.DBus.Peer\">\n"
3561   "    <method name=\"Ping\"/>\n"
3562   "    <method name=\"GetMachineId\">\n"
3563   "      <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
3564   "    </method>\n"
3565   "  </interface>\n";
3566
3567 static void
3568 introspect_append_header (GString *s)
3569 {
3570   g_string_append (s, introspect_header);
3571 }
3572
3573 static void
3574 introspect_append_standard_interfaces (GString *s)
3575 {
3576   g_string_append (s, introspect_standard_interfaces);
3577 }
3578
3579 static void
3580 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
3581 {
3582   if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len)
3583     {
3584       const gchar *begin;
3585       const gchar *end;
3586       gchar *s;
3587
3588       begin = object_path + path_len;
3589       end = strchr (begin, '/');
3590
3591       if (end != NULL)
3592         s = g_strndup (begin, end - begin);
3593       else
3594         s = g_strdup (begin);
3595
3596       if (g_hash_table_lookup (set, s) == NULL)
3597         g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
3598       else
3599         g_free (s);
3600     }
3601 }
3602
3603 /* TODO: we want a nicer public interface for this */
3604 static gchar **
3605 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
3606                                             const gchar     *path)
3607 {
3608   GPtrArray *p;
3609   gchar **ret;
3610   GHashTableIter hash_iter;
3611   const gchar *object_path;
3612   gsize path_len;
3613   GHashTable *set;
3614   GList *keys;
3615   GList *l;
3616
3617   CONNECTION_ENSURE_LOCK (connection);
3618
3619   path_len = strlen (path);
3620   if (path_len > 1)
3621     path_len++;
3622
3623   set = g_hash_table_new (g_str_hash, g_str_equal);
3624
3625   g_hash_table_iter_init (&hash_iter, connection->priv->map_object_path_to_eo);
3626   while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
3627     maybe_add_path (path, path_len, object_path, set);
3628
3629   g_hash_table_iter_init (&hash_iter, connection->priv->map_object_path_to_es);
3630   while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
3631     maybe_add_path (path, path_len, object_path, set);
3632
3633   p = g_ptr_array_new ();
3634   keys = g_hash_table_get_keys (set);
3635   for (l = keys; l != NULL; l = l->next)
3636     g_ptr_array_add (p, l->data);
3637   g_hash_table_unref (set);
3638   g_list_free (keys);
3639
3640   g_ptr_array_add (p, NULL);
3641   ret = (gchar **) g_ptr_array_free (p, FALSE);
3642   return ret;
3643 }
3644
3645 static gchar **
3646 g_dbus_connection_list_registered (GDBusConnection *connection,
3647                                    const gchar     *path)
3648 {
3649   gchar **ret;
3650   CONNECTION_LOCK (connection);
3651   ret = g_dbus_connection_list_registered_unlocked (connection, path);
3652   CONNECTION_UNLOCK (connection);
3653   return ret;
3654 }
3655
3656 /* called in message handler thread with lock held */
3657 static gboolean
3658 handle_introspect (GDBusConnection *connection,
3659                    ExportedObject  *eo,
3660                    GDBusMessage    *message)
3661 {
3662   guint n;
3663   GString *s;
3664   GDBusMessage *reply;
3665   GHashTableIter hash_iter;
3666   ExportedInterface *ei;
3667   gchar **registered;
3668
3669   /* first the header with the standard interfaces */
3670   s = g_string_sized_new (sizeof (introspect_header) +
3671                           sizeof (introspect_standard_interfaces) +
3672                           sizeof (introspect_tail));
3673   introspect_append_header (s);
3674   introspect_append_standard_interfaces (s);
3675
3676   /* then include the registered interfaces */
3677   g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
3678   while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
3679     g_dbus_interface_info_generate_xml (ei->introspection_data, 2, s);
3680
3681   /* finally include nodes registered below us */
3682   registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
3683   for (n = 0; registered != NULL && registered[n] != NULL; n++)
3684     g_string_append_printf (s, "  <node name=\"%s\"/>\n", registered[n]);
3685   g_strfreev (registered);
3686   g_string_append (s, introspect_tail);
3687
3688   reply = g_dbus_message_new_method_reply (message);
3689   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
3690   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3691   g_object_unref (reply);
3692   g_string_free (s, TRUE);
3693
3694   return TRUE;
3695 }
3696
3697 /* called in thread where object was registered - no locks held */
3698 static gboolean
3699 call_in_idle_cb (gpointer user_data)
3700 {
3701   GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
3702   GDBusInterfaceVTable *vtable;
3703
3704   vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
3705   g_assert (vtable != NULL && vtable->method_call != NULL);
3706
3707   vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
3708                        g_dbus_method_invocation_get_sender (invocation),
3709                        g_dbus_method_invocation_get_object_path (invocation),
3710                        g_dbus_method_invocation_get_interface_name (invocation),
3711                        g_dbus_method_invocation_get_method_name (invocation),
3712                        g_dbus_method_invocation_get_parameters (invocation),
3713                        g_object_ref (invocation),
3714                        g_dbus_method_invocation_get_user_data (invocation));
3715
3716   return FALSE;
3717 }
3718
3719 /* called in message handler thread with lock held */
3720 static gboolean
3721 validate_and_maybe_schedule_method_call (GDBusConnection            *connection,
3722                                          GDBusMessage               *message,
3723                                          const GDBusInterfaceInfo   *introspection_data,
3724                                          const GDBusInterfaceVTable *vtable,
3725                                          GMainContext               *main_context,
3726                                          gpointer                    user_data)
3727 {
3728   GDBusMethodInvocation *invocation;
3729   const GDBusMethodInfo *method_info;
3730   GDBusMessage *reply;
3731   GVariant *parameters;
3732   GSource *idle_source;
3733   gboolean handled;
3734   GVariantType *in_type;
3735
3736   handled = FALSE;
3737
3738   /* TODO: the cost of this is O(n) - it might be worth caching the result */
3739   method_info = g_dbus_interface_info_lookup_method (introspection_data, g_dbus_message_get_member (message));
3740
3741   /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
3742    * error to the caller
3743    */
3744   if (method_info == NULL)
3745     {
3746       reply = g_dbus_message_new_method_error (message,
3747                                                "org.freedesktop.DBus.Error.UnknownMethod",
3748                                                _("No such method `%s'"),
3749                                                g_dbus_message_get_member (message));
3750       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3751       g_object_unref (reply);
3752       handled = TRUE;
3753       goto out;
3754     }
3755
3756   parameters = g_dbus_message_get_body (message);
3757   if (parameters == NULL)
3758     {
3759       parameters = g_variant_new ("()");
3760       g_variant_ref_sink (parameters);
3761     }
3762   else
3763     {
3764       g_variant_ref (parameters);
3765     }
3766
3767   /* Check that the incoming args are of the right type - if they are not, return
3768    * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
3769    */
3770   in_type = _g_dbus_compute_complete_signature (method_info->in_args);
3771   if (!g_variant_is_of_type (parameters, in_type))
3772     {
3773       gchar *type_string;
3774
3775       type_string = g_variant_type_dup_string (in_type);
3776
3777       reply = g_dbus_message_new_method_error (message,
3778                                                "org.freedesktop.DBus.Error.InvalidArgs",
3779                                                _("Type of message, `%s', does not match expected type `%s'"),
3780                                                g_variant_get_type_string (parameters),
3781                                                type_string);
3782       g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3783       g_variant_type_free (in_type);
3784       g_variant_unref (parameters);
3785       g_object_unref (reply);
3786       g_free (type_string);
3787       handled = TRUE;
3788       goto out;
3789     }
3790   g_variant_type_free (in_type);
3791
3792   /* schedule the call in idle */
3793   invocation = g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
3794                                              g_dbus_message_get_path (message),
3795                                              g_dbus_message_get_interface (message),
3796                                              g_dbus_message_get_member (message),
3797                                              method_info,
3798                                              connection,
3799                                              message,
3800                                              parameters,
3801                                              user_data);
3802   g_variant_unref (parameters);
3803   g_object_set_data (G_OBJECT (invocation),
3804                      "g-dbus-interface-vtable",
3805                      (gpointer) vtable);
3806
3807   idle_source = g_idle_source_new ();
3808   g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3809   g_source_set_callback (idle_source,
3810                          call_in_idle_cb,
3811                          invocation,
3812                          g_object_unref);
3813   g_source_attach (idle_source, main_context);
3814   g_source_unref (idle_source);
3815
3816   handled = TRUE;
3817
3818  out:
3819   return handled;
3820 }
3821
3822 /* ---------------------------------------------------------------------------------------------------- */
3823
3824 /* called in message handler thread with lock held */
3825 static gboolean
3826 obj_message_func (GDBusConnection *connection,
3827                   ExportedObject  *eo,
3828                   GDBusMessage    *message)
3829 {
3830   const gchar *interface_name;
3831   const gchar *member;
3832   const gchar *signature;
3833   gboolean handled;
3834
3835   handled = FALSE;
3836
3837   interface_name = g_dbus_message_get_interface (message);
3838   member = g_dbus_message_get_member (message);
3839   signature = g_dbus_message_get_signature (message);
3840
3841   /* see if we have an interface for handling this call */
3842   if (interface_name != NULL)
3843     {
3844       ExportedInterface *ei;
3845       ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3846       if (ei != NULL)
3847         {
3848           /* we do - invoke the handler in idle in the right thread */
3849
3850           /* handle no vtable or handler being present */
3851           if (ei->vtable == NULL || ei->vtable->method_call == NULL)
3852             goto out;
3853
3854           handled = validate_and_maybe_schedule_method_call (connection,
3855                                                              message,
3856                                                              ei->introspection_data,
3857                                                              ei->vtable,
3858                                                              ei->context,
3859                                                              ei->user_data);
3860           goto out;
3861         }
3862     }
3863
3864   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
3865       g_strcmp0 (member, "Introspect") == 0 &&
3866       g_strcmp0 (signature, "") == 0)
3867     {
3868       handled = handle_introspect (connection, eo, message);
3869       goto out;
3870     }
3871   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
3872            g_strcmp0 (member, "Get") == 0 &&
3873            g_strcmp0 (signature, "ss") == 0)
3874     {
3875       handled = handle_getset_property (connection, eo, message, TRUE);
3876       goto out;
3877     }
3878   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
3879            g_strcmp0 (member, "Set") == 0 &&
3880            g_strcmp0 (signature, "ssv") == 0)
3881     {
3882       handled = handle_getset_property (connection, eo, message, FALSE);
3883       goto out;
3884     }
3885   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
3886            g_strcmp0 (member, "GetAll") == 0 &&
3887            g_strcmp0 (signature, "s") == 0)
3888     {
3889       handled = handle_get_all_properties (connection, eo, message);
3890       goto out;
3891     }
3892
3893  out:
3894   return handled;
3895 }
3896
3897 /**
3898  * g_dbus_connection_register_object:
3899  * @connection: A #GDBusConnection.
3900  * @object_path: The object path to register at.
3901  * @introspection_data: Introspection data for the interface.
3902  * @vtable: A #GDBusInterfaceVTable to call into or %NULL.
3903  * @user_data: Data to pass to functions in @vtable.
3904  * @user_data_free_func: Function to call when the object path is unregistered.
3905  * @error: Return location for error or %NULL.
3906  *
3907  * Registers callbacks for exported objects at @object_path with the
3908  * D-Bus interface that is described in @introspection_data.
3909  *
3910  * Calls to functions in @vtable (and @user_data_free_func) will
3911  * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
3912  * loop</link> of the thread you are calling this method from.
3913  *
3914  * Note that all #GVariant values passed to functions in @vtable will match
3915  * the signature given in @introspection_data - if a remote caller passes
3916  * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
3917  * is returned to the remote caller.
3918  *
3919  * Additionally, if the remote caller attempts to invoke methods or
3920  * access properties not mentioned in @introspection_data the
3921  * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
3922  * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
3923  * are returned to the caller.
3924  *
3925  * It is considered a programming error if the
3926  * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
3927  * #GVariant of incorrect type.
3928  *
3929  * If an existing callback is already registered at @object_path and
3930  * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
3931  *
3932  * Note that @vtable is not copied, so the struct you pass must exist until
3933  * the path is unregistered. One possibility is to free @vtable at the
3934  * same time as @user_data when @user_data_free_func is called.
3935  *
3936  * GDBus automatically implements the standard D-Bus interfaces
3937  * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
3938  * and org.freedesktop.Peer, so you don't have to implement those for
3939  * the objects you export. You <emphasis>can</emphasis> implement
3940  * org.freedesktop.DBus.Properties yourself, e.g. to handle getting
3941  * and setting of properties asynchronously.
3942  *
3943  * See <xref linkend="gdbus-server"/> for an example of how to use this method.
3944  *
3945  * Returns: 0 if @error is set, otherwise a registration id (never 0)
3946  * that can be used with g_dbus_connection_unregister_object() .
3947  *
3948  * Since: 2.26
3949  */
3950 guint
3951 g_dbus_connection_register_object (GDBusConnection            *connection,
3952                                    const gchar                *object_path,
3953                                    const GDBusInterfaceInfo   *introspection_data,
3954                                    const GDBusInterfaceVTable *vtable,
3955                                    gpointer                    user_data,
3956                                    GDestroyNotify              user_data_free_func,
3957                                    GError                    **error)
3958 {
3959   ExportedObject *eo;
3960   ExportedInterface *ei;
3961   guint ret;
3962
3963   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3964   g_return_val_if_fail (!g_dbus_connection_is_closed (connection), 0);
3965   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
3966   g_return_val_if_fail (introspection_data != NULL, 0);
3967   g_return_val_if_fail (g_dbus_is_interface_name (introspection_data->name), 0);
3968   g_return_val_if_fail (error == NULL || *error == NULL, 0);
3969
3970   ret = 0;
3971
3972   CONNECTION_LOCK (connection);
3973
3974   eo = g_hash_table_lookup (connection->priv->map_object_path_to_eo, object_path);
3975   if (eo == NULL)
3976     {
3977       eo = g_new0 (ExportedObject, 1);
3978       eo->object_path = g_strdup (object_path);
3979       eo->connection = connection;
3980       eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
3981                                                      g_str_equal,
3982                                                      NULL,
3983                                                      (GDestroyNotify) exported_interface_free);
3984       g_hash_table_insert (connection->priv->map_object_path_to_eo, eo->object_path, eo);
3985     }
3986
3987   ei = g_hash_table_lookup (eo->map_if_name_to_ei, introspection_data->name);
3988   if (ei != NULL)
3989     {
3990       g_set_error (error,
3991                    G_IO_ERROR,
3992                    G_IO_ERROR_EXISTS,
3993                    _("An object is already exported for the interface %s at %s"),
3994                    introspection_data->name,
3995                    object_path);
3996       goto out;
3997     }
3998
3999   ei = g_new0 (ExportedInterface, 1);
4000   ei->id = _global_registration_id++; /* TODO: overflow etc. */
4001   ei->eo = eo;
4002   ei->user_data = user_data;
4003   ei->user_data_free_func = user_data_free_func;
4004   ei->vtable = vtable;
4005   ei->introspection_data = introspection_data;
4006   ei->interface_name = g_strdup (introspection_data->name);
4007   ei->context = g_main_context_get_thread_default ();
4008   if (ei->context != NULL)
4009     g_main_context_ref (ei->context);
4010
4011   g_hash_table_insert (eo->map_if_name_to_ei,
4012                        (gpointer) ei->interface_name,
4013                        ei);
4014   g_hash_table_insert (connection->priv->map_id_to_ei,
4015                        GUINT_TO_POINTER (ei->id),
4016                        ei);
4017
4018   ret = ei->id;
4019
4020  out:
4021   CONNECTION_UNLOCK (connection);
4022
4023   return ret;
4024 }
4025
4026 /**
4027  * g_dbus_connection_unregister_object:
4028  * @connection: A #GDBusConnection.
4029  * @registration_id: A registration id obtained from g_dbus_connection_register_object().
4030  *
4031  * Unregisters an object.
4032  *
4033  * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
4034  *
4035  * Since: 2.26
4036  */
4037 gboolean
4038 g_dbus_connection_unregister_object (GDBusConnection *connection,
4039                                      guint            registration_id)
4040 {
4041   ExportedInterface *ei;
4042   ExportedObject *eo;
4043   gboolean ret;
4044
4045   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4046
4047   ret = FALSE;
4048
4049   CONNECTION_LOCK (connection);
4050
4051   ei = g_hash_table_lookup (connection->priv->map_id_to_ei,
4052                             GUINT_TO_POINTER (registration_id));
4053   if (ei == NULL)
4054     goto out;
4055
4056   eo = ei->eo;
4057
4058   g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
4059   g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
4060   /* unregister object path if we have no more exported interfaces */
4061   if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
4062     g_warn_if_fail (g_hash_table_remove (connection->priv->map_object_path_to_eo,
4063                                          eo->object_path));
4064
4065   ret = TRUE;
4066
4067  out:
4068   CONNECTION_UNLOCK (connection);
4069
4070   return ret;
4071 }
4072
4073 /* ---------------------------------------------------------------------------------------------------- */
4074
4075 /**
4076  * g_dbus_connection_emit_signal:
4077  * @connection: A #GDBusConnection.
4078  * @destination_bus_name: The unique bus name for the destination for the signal or %NULL to emit to all listeners.
4079  * @object_path: Path of remote object.
4080  * @interface_name: D-Bus interface to emit a signal on.
4081  * @signal_name: The name of the signal to emit.
4082  * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
4083  * @error: Return location for error or %NULL.
4084  *
4085  * Emits a signal.
4086  *
4087  * If the parameters GVariant is floating, it is consumed.
4088  *
4089  * This can only fail if @parameters is not compatible with the D-Bus protocol.
4090  *
4091  * Returns: %TRUE unless @error is set.
4092  *
4093  * Since: 2.26
4094  */
4095 gboolean
4096 g_dbus_connection_emit_signal (GDBusConnection  *connection,
4097                                const gchar      *destination_bus_name,
4098                                const gchar      *object_path,
4099                                const gchar      *interface_name,
4100                                const gchar      *signal_name,
4101                                GVariant         *parameters,
4102                                GError          **error)
4103 {
4104   GDBusMessage *message;
4105   gboolean ret;
4106
4107   message = NULL;
4108   ret = FALSE;
4109
4110   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4111   g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
4112   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
4113   g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
4114   g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
4115   g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
4116
4117   message = g_dbus_message_new_signal (object_path,
4118                                        interface_name,
4119                                        signal_name);
4120
4121   if (destination_bus_name != NULL)
4122     g_dbus_message_set_header (message,
4123                                G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
4124                                g_variant_new_string (destination_bus_name));
4125
4126   if (parameters != NULL)
4127     g_dbus_message_set_body (message, parameters);
4128
4129   ret = g_dbus_connection_send_message (connection, message, NULL, error);
4130   g_object_unref (message);
4131
4132   return ret;
4133 }
4134
4135 static void
4136 add_call_flags (GDBusMessage           *message,
4137                          GDBusCallFlags  flags)
4138 {
4139   if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
4140     g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
4141 }
4142
4143 static GVariant *
4144 decode_method_reply (GDBusMessage        *reply,
4145                      const gchar         *method_name,
4146                      const GVariantType  *reply_type,
4147                      GError             **error)
4148 {
4149   GVariant *result;
4150
4151   result = NULL;
4152   switch (g_dbus_message_get_message_type (reply))
4153     {
4154     case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
4155       result = g_dbus_message_get_body (reply);
4156       if (result == NULL)
4157         {
4158           result = g_variant_new ("()");
4159           g_variant_ref_sink (result);
4160         }
4161       else
4162         {
4163           g_variant_ref (result);
4164         }
4165
4166       if (!g_variant_is_of_type (result, reply_type))
4167         {
4168           gchar *type_string = g_variant_type_dup_string (reply_type);
4169
4170           g_set_error (error,
4171                        G_IO_ERROR,
4172                        G_IO_ERROR_INVALID_ARGUMENT,
4173                        _("Method `%s' returned type `%s', but expected `%s'"),
4174                        method_name, g_variant_get_type_string (result), type_string);
4175
4176           g_variant_unref (result);
4177           g_free (type_string);
4178           result = NULL;
4179         }
4180       break;
4181
4182     case G_DBUS_MESSAGE_TYPE_ERROR:
4183       g_dbus_message_to_gerror (reply, error);
4184       break;
4185
4186     default:
4187       g_assert_not_reached ();
4188       break;
4189     }
4190
4191   return result;
4192 }
4193
4194
4195 typedef struct
4196 {
4197   GSimpleAsyncResult *simple;
4198   GVariantType *reply_type;
4199   gchar *method_name; /* for error message */
4200 } CallState;
4201
4202 static void
4203 g_dbus_connection_call_done (GObject      *source,
4204                              GAsyncResult *result,
4205                              gpointer      user_data)
4206 {
4207   GDBusConnection *connection = G_DBUS_CONNECTION (source);
4208   CallState *state = user_data;
4209   GError *error = NULL;
4210   GDBusMessage *reply;
4211   GVariant *value;
4212
4213   reply = g_dbus_connection_send_message_with_reply_finish (connection,
4214                                                             result, &error);
4215
4216   if (reply != NULL)
4217     {
4218       value = decode_method_reply (reply, state->method_name,
4219                                    state->reply_type, &error);
4220       g_object_unref (reply);
4221     }
4222   else
4223     value = NULL;
4224
4225   if (value == NULL)
4226     {
4227       g_simple_async_result_set_from_error (state->simple, error);
4228       g_error_free (error);
4229     }
4230   else
4231     g_simple_async_result_set_op_res_gpointer (state->simple, value,
4232                                                (GDestroyNotify) g_variant_unref);
4233
4234   g_simple_async_result_complete (state->simple);
4235   g_variant_type_free (state->reply_type);
4236   g_object_unref (state->simple);
4237   g_free (state->method_name);
4238
4239   g_slice_free (CallState, state);
4240 }
4241
4242 /**
4243  * g_dbus_connection_call:
4244  * @connection: A #GDBusConnection.
4245  * @bus_name: A unique or well-known bus name or %NULL if @connection is not a message bus connection.
4246  * @object_path: Path of remote object.
4247  * @interface_name: D-Bus interface to invoke method on.
4248  * @method_name: The name of the method to invoke.
4249  * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
4250  * @reply_type: The expected type of the reply, or %NULL.
4251  * @flags: Flags from the #GDBusCallFlags enumeration.
4252  * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
4253  * @cancellable: A #GCancellable or %NULL.
4254  * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
4255  * care about the result of the method invocation.
4256  * @user_data: The data to pass to @callback.
4257  *
4258  * Asynchronously invokes the @method_name method on the
4259  * @interface_name D-Bus interface on the remote object at
4260  * @object_path owned by @bus_name.
4261  *
4262  * If @connection is closed then the operation will fail with
4263  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
4264  * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
4265  * not compatible with the D-Bus protocol, the operation fails with
4266  * %G_IO_ERROR_INVALID_ARGUMENT.
4267  *
4268  * If @reply_type is non-%NULL then the reply will be checked for having this type and an
4269  * error will be raised if it does not match.  Said another way, if you give a @reply_type
4270  * then any non-%NULL return value will be of this type.
4271  *
4272  * If the @parameters #GVariant is floating, it is consumed. This allows
4273  * convenient 'inline' use of g_variant_new(), e.g.:
4274  * |[
4275  *  g_dbus_connection_call (connection,
4276  *                          "org.freedesktop.StringThings",
4277  *                          "/org/freedesktop/StringThings",
4278  *                          "org.freedesktop.StringThings",
4279  *                          "TwoStrings",
4280  *                          g_variant_new ("(ss)",
4281  *                                         "Thing One",
4282  *                                         "Thing Two"),
4283  *                          NULL,
4284  *                          G_DBUS_CALL_FLAGS_NONE,
4285  *                          -1,
4286  *                          NULL,
4287  *                          (GAsyncReadyCallback) two_strings_done,
4288  *                          NULL);
4289  * ]|
4290  *
4291  * This is an asynchronous method. When the operation is finished, @callback will be invoked
4292  * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
4293  * of the thread you are calling this method from. You can then call
4294  * g_dbus_connection_call_finish() to get the result of the operation.
4295  * See g_dbus_connection_call_sync() for the synchronous version of this
4296  * function.
4297  *
4298  * Since: 2.26
4299  */
4300 void
4301 g_dbus_connection_call (GDBusConnection        *connection,
4302                         const gchar            *bus_name,
4303                         const gchar            *object_path,
4304                         const gchar            *interface_name,
4305                         const gchar            *method_name,
4306                         GVariant               *parameters,
4307                         const GVariantType     *reply_type,
4308                         GDBusCallFlags          flags,
4309                         gint                    timeout_msec,
4310                         GCancellable           *cancellable,
4311                         GAsyncReadyCallback     callback,
4312                         gpointer                user_data)
4313 {
4314   GDBusMessage *message;
4315   CallState *state;
4316
4317   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
4318   g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
4319   g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
4320   g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
4321   g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
4322   g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
4323   g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
4324
4325   state = g_slice_new (CallState);
4326   state->simple = g_simple_async_result_new (G_OBJECT (connection),
4327                                              callback, user_data,
4328                                              g_dbus_connection_call);
4329   state->method_name = g_strjoin (".", interface_name, method_name, NULL);
4330
4331   if (reply_type == NULL)
4332     reply_type = G_VARIANT_TYPE_ANY;
4333
4334   state->reply_type = g_variant_type_copy (reply_type);
4335
4336   message = g_dbus_message_new_method_call (bus_name,
4337                                             object_path,
4338                                             interface_name,
4339                                             method_name);
4340   add_call_flags (message, flags);
4341   if (parameters != NULL)
4342     g_dbus_message_set_body (message, parameters);
4343
4344   g_dbus_connection_send_message_with_reply (connection,
4345                                              message,
4346                                              timeout_msec,
4347                                              NULL, /* volatile guint32 *out_serial */
4348                                              cancellable,
4349                                              g_dbus_connection_call_done,
4350                                              state);
4351
4352   if (message != NULL)
4353     g_object_unref (message);
4354 }
4355
4356 /**
4357  * g_dbus_connection_call_finish:
4358  * @connection: A #GDBusConnection.
4359  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().
4360  * @error: Return location for error or %NULL.
4361  *
4362  * Finishes an operation started with g_dbus_connection_call().
4363  *
4364  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
4365  * return values. Free with g_variant_unref().
4366  *
4367  * Since: 2.26
4368  */
4369 GVariant *
4370 g_dbus_connection_call_finish (GDBusConnection  *connection,
4371                                GAsyncResult     *res,
4372                                GError          **error)
4373 {
4374   GSimpleAsyncResult *simple;
4375
4376   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
4377   g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
4378                                                         g_dbus_connection_call), NULL);
4379   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
4380
4381   simple = G_SIMPLE_ASYNC_RESULT (res);
4382
4383   if (g_simple_async_result_propagate_error (simple, error))
4384     return FALSE;
4385
4386   return g_variant_ref (g_simple_async_result_get_op_res_gpointer (simple));
4387 }
4388
4389 /* ---------------------------------------------------------------------------------------------------- */
4390
4391 /**
4392  * g_dbus_connection_call_sync:
4393  * @connection: A #GDBusConnection.
4394  * @bus_name: A unique or well-known bus name.
4395  * @object_path: Path of remote object.
4396  * @interface_name: D-Bus interface to invoke method on.
4397  * @method_name: The name of the method to invoke.
4398  * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
4399  * @reply_type: The expected type of the reply, or %NULL.
4400  * @flags: Flags from the #GDBusCallFlags enumeration.
4401  * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
4402  * @cancellable: A #GCancellable or %NULL.
4403  * @error: Return location for error or %NULL.
4404  *
4405  * Synchronously invokes the @method_name method on the
4406  * @interface_name D-Bus interface on the remote object at
4407  * @object_path owned by @bus_name.
4408  *
4409  * If @connection is closed then the operation will fail with
4410  * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
4411  * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
4412  * contains a value not compatible with the D-Bus protocol, the operation
4413  * fails with %G_IO_ERROR_INVALID_ARGUMENT.
4414
4415  * If @reply_type is non-%NULL then the reply will be checked for having
4416  * this type and an error will be raised if it does not match.  Said
4417  * another way, if you give a @reply_type then any non-%NULL return
4418  * value will be of this type.
4419  *
4420  * If the @parameters #GVariant is floating, it is consumed.
4421  * This allows convenient 'inline' use of g_variant_new(), e.g.:
4422  * |[
4423  *  g_dbus_connection_call_sync (connection,
4424  *                               "org.freedesktop.StringThings",
4425  *                               "/org/freedesktop/StringThings",
4426  *                               "org.freedesktop.StringThings",
4427  *                               "TwoStrings",
4428  *                               g_variant_new ("(ss)",
4429  *                                              "Thing One",
4430  *                                              "Thing Two"),
4431  *                               NULL,
4432  *                               G_DBUS_CALL_FLAGS_NONE,
4433  *                               -1,
4434  *                               NULL,
4435  *                               &amp;error);
4436  * ]|
4437  *
4438  * The calling thread is blocked until a reply is received. See
4439  * g_dbus_connection_call() for the asynchronous version of
4440  * this method.
4441  *
4442  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
4443  * return values. Free with g_variant_unref().
4444  *
4445  * Since: 2.26
4446  */
4447 GVariant *
4448 g_dbus_connection_call_sync (GDBusConnection         *connection,
4449                              const gchar             *bus_name,
4450                              const gchar             *object_path,
4451                              const gchar             *interface_name,
4452                              const gchar             *method_name,
4453                              GVariant                *parameters,
4454                              const GVariantType      *reply_type,
4455                              GDBusCallFlags           flags,
4456                              gint                     timeout_msec,
4457                              GCancellable            *cancellable,
4458                              GError                 **error)
4459 {
4460   GDBusMessage *message;
4461   GDBusMessage *reply;
4462   GVariant *result;
4463
4464   message = NULL;
4465   reply = NULL;
4466   result = NULL;
4467
4468   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
4469   g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
4470   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
4471   g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
4472   g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
4473   g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
4474   g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
4475
4476   if (reply_type == NULL)
4477     reply_type = G_VARIANT_TYPE_ANY;
4478
4479   message = g_dbus_message_new_method_call (bus_name,
4480                                             object_path,
4481                                             interface_name,
4482                                             method_name);
4483   add_call_flags (message, flags);
4484   if (parameters != NULL)
4485     g_dbus_message_set_body (message, parameters);
4486
4487   reply = g_dbus_connection_send_message_with_reply_sync (connection,
4488                                                           message,
4489                                                           timeout_msec,
4490                                                           NULL, /* volatile guint32 *out_serial */
4491                                                           cancellable,
4492                                                           error);
4493
4494   if (reply == NULL)
4495     goto out;
4496
4497   result = decode_method_reply (reply, method_name, reply_type, error);
4498
4499  out:
4500   if (message != NULL)
4501     g_object_unref (message);
4502   if (reply != NULL)
4503     g_object_unref (reply);
4504
4505   return result;
4506 }
4507
4508 /* ---------------------------------------------------------------------------------------------------- */
4509
4510 struct ExportedSubtree
4511 {
4512   guint                     id;
4513   gchar                    *object_path;
4514   GDBusConnection          *connection;
4515   const GDBusSubtreeVTable *vtable;
4516   GDBusSubtreeFlags         flags;
4517
4518   GMainContext             *context;
4519   gpointer                  user_data;
4520   GDestroyNotify            user_data_free_func;
4521 };
4522
4523 static void
4524 exported_subtree_free (ExportedSubtree *es)
4525 {
4526   if (es->user_data_free_func != NULL)
4527     /* TODO: push to thread-default mainloop */
4528     es->user_data_free_func (es->user_data);
4529
4530   if (es->context != NULL)
4531     g_main_context_unref (es->context);
4532
4533   g_free (es->object_path);
4534   g_free (es);
4535 }
4536
4537 /* called without lock held */
4538 static gboolean
4539 handle_subtree_introspect (GDBusConnection *connection,
4540                            ExportedSubtree *es,
4541                            GDBusMessage    *message)
4542 {
4543   GString *s;
4544   gboolean handled;
4545   GDBusMessage *reply;
4546   gchar **children;
4547   gboolean is_root;
4548   const gchar *sender;
4549   const gchar *requested_object_path;
4550   const gchar *requested_node;
4551   GPtrArray *interfaces;
4552   guint n;
4553   gchar **subnode_paths;
4554
4555   handled = FALSE;
4556
4557   requested_object_path = g_dbus_message_get_path (message);
4558   sender = g_dbus_message_get_sender (message);
4559   is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
4560
4561   s = g_string_new (NULL);
4562   introspect_append_header (s);
4563
4564   /* Strictly we don't need the children in dynamic mode, but we avoid the
4565    * conditionals to preserve code clarity
4566    */
4567   children = es->vtable->enumerate (es->connection,
4568                                     sender,
4569                                     es->object_path,
4570                                     es->user_data);
4571
4572   if (!is_root)
4573     {
4574       requested_node = strrchr (requested_object_path, '/') + 1;
4575
4576       /* Assert existence of object if we are not dynamic */
4577       if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
4578           !_g_strv_has_string ((const gchar * const *) children, requested_node))
4579         goto out;
4580     }
4581   else
4582     {
4583       requested_node = "/";
4584     }
4585
4586   interfaces = es->vtable->introspect (es->connection,
4587                                        sender,
4588                                        es->object_path,
4589                                        requested_node,
4590                                        es->user_data);
4591   if (interfaces != NULL)
4592     {
4593       if (interfaces->len > 0)
4594         {
4595           /* we're in business */
4596           introspect_append_standard_interfaces (s);
4597
4598           for (n = 0; n < interfaces->len; n++)
4599             {
4600               const GDBusInterfaceInfo *interface_info = interfaces->pdata[n];
4601               g_dbus_interface_info_generate_xml (interface_info, 2, s);
4602             }
4603         }
4604       g_ptr_array_unref (interfaces);
4605     }
4606
4607   /* then include <node> entries from the Subtree for the root */
4608   if (is_root)
4609     {
4610       for (n = 0; children != NULL && children[n] != NULL; n++)
4611         g_string_append_printf (s, "  <node name=\"%s\"/>\n", children[n]);
4612     }
4613
4614   /* finally include nodes registered below us */
4615   subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
4616   for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
4617     g_string_append_printf (s, "  <node name=\"%s\"/>\n", subnode_paths[n]);
4618   g_strfreev (subnode_paths);
4619
4620   g_string_append (s, "</node>\n");
4621
4622   reply = g_dbus_message_new_method_reply (message);
4623   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
4624   g_dbus_connection_send_message (connection, reply, NULL, NULL);
4625   g_object_unref (reply);
4626
4627   handled = TRUE;
4628
4629  out:
4630   g_string_free (s, TRUE);
4631   g_strfreev (children);
4632   return handled;
4633 }
4634
4635 /* called without lock held */
4636 static gboolean
4637 handle_subtree_method_invocation (GDBusConnection *connection,
4638                                   ExportedSubtree *es,
4639                                   GDBusMessage    *message)
4640 {
4641   gboolean handled;;
4642   const gchar *sender;
4643   const gchar *interface_name;
4644   const gchar *member;
4645   const gchar *signature;
4646   const gchar *requested_object_path;
4647   const gchar *requested_node;
4648   gboolean is_root;
4649   gchar **children;
4650   const GDBusInterfaceInfo *introspection_data;
4651   const GDBusInterfaceVTable *interface_vtable;
4652   gpointer interface_user_data;
4653   guint n;
4654   GPtrArray *interfaces;
4655   gboolean is_property_get;
4656   gboolean is_property_set;
4657   gboolean is_property_get_all;
4658
4659   handled = FALSE;
4660   interfaces = NULL;
4661
4662   requested_object_path = g_dbus_message_get_path (message);
4663   sender = g_dbus_message_get_sender (message);
4664   interface_name = g_dbus_message_get_interface (message);
4665   member = g_dbus_message_get_member (message);
4666   signature = g_dbus_message_get_signature (message);
4667   is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
4668
4669   is_property_get = FALSE;
4670   is_property_set = FALSE;
4671   is_property_get_all = FALSE;
4672   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
4673     {
4674       if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
4675         is_property_get = TRUE;
4676       else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
4677         is_property_set = TRUE;
4678       else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
4679         is_property_get_all = TRUE;
4680     }
4681
4682   children = es->vtable->enumerate (es->connection,
4683                                     sender,
4684                                     es->object_path,
4685                                     es->user_data);
4686
4687   if (!is_root)
4688     {
4689       requested_node = strrchr (requested_object_path, '/') + 1;
4690
4691       /* If not dynamic, skip if requested node is not part of children */
4692       if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
4693           !_g_strv_has_string ((const gchar * const *) children, requested_node))
4694         goto out;
4695     }
4696   else
4697     {
4698       requested_node = "/";
4699     }
4700
4701   /* get introspection data for the node */
4702   interfaces = es->vtable->introspect (es->connection,
4703                                        sender,
4704                                        requested_object_path,
4705                                        requested_node,
4706                                        es->user_data);
4707   g_assert (interfaces != NULL);
4708   introspection_data = NULL;
4709   for (n = 0; n < interfaces->len; n++)
4710     {
4711       const GDBusInterfaceInfo *id_n = (const GDBusInterfaceInfo *) interfaces->pdata[n];
4712       if (g_strcmp0 (id_n->name, interface_name) == 0)
4713         introspection_data = id_n;
4714     }
4715
4716   /* dispatch the call if the user wants to handle it */
4717   if (introspection_data != NULL)
4718     {
4719       /* figure out where to dispatch the method call */
4720       interface_user_data = NULL;
4721       interface_vtable = es->vtable->dispatch (es->connection,
4722                                                sender,
4723                                                es->object_path,
4724                                                interface_name,
4725                                                requested_node,
4726                                                &interface_user_data,
4727                                                es->user_data);
4728       if (interface_vtable == NULL)
4729         goto out;
4730
4731       CONNECTION_LOCK (connection);
4732       handled = validate_and_maybe_schedule_method_call (es->connection,
4733                                                          message,
4734                                                          introspection_data,
4735                                                          interface_vtable,
4736                                                          es->context,
4737                                                          interface_user_data);
4738       CONNECTION_UNLOCK (connection);
4739     }
4740   /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
4741   else if (is_property_get || is_property_set || is_property_get_all)
4742     {
4743       if (is_property_get)
4744         g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
4745       else if (is_property_set)
4746         g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
4747       else if (is_property_get_all)
4748         g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
4749       else
4750         g_assert_not_reached ();
4751
4752       /* see if the object supports this interface at all */
4753       for (n = 0; n < interfaces->len; n++)
4754         {
4755           const GDBusInterfaceInfo *id_n = (const GDBusInterfaceInfo *) interfaces->pdata[n];
4756           if (g_strcmp0 (id_n->name, interface_name) == 0)
4757             introspection_data = id_n;
4758         }
4759
4760       /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
4761        * claims it won't support the interface
4762        */
4763       if (introspection_data == NULL)
4764         {
4765           GDBusMessage *reply;
4766           reply = g_dbus_message_new_method_error (message,
4767                                                    "org.freedesktop.DBus.Error.InvalidArgs",
4768                                                    _("No such interface `%s'"),
4769                                                    interface_name);
4770           g_dbus_connection_send_message (es->connection, reply, NULL, NULL);
4771           g_object_unref (reply);
4772           handled = TRUE;
4773           goto out;
4774         }
4775
4776       /* figure out where to dispatch the property get/set/getall calls */
4777       interface_user_data = NULL;
4778       interface_vtable = es->vtable->dispatch (es->connection,
4779                                                sender,
4780                                                es->object_path,
4781                                                interface_name,
4782                                                requested_node,
4783                                                &interface_user_data,
4784                                                es->user_data);
4785       if (interface_vtable == NULL)
4786         goto out;
4787
4788       if (is_property_get || is_property_set)
4789         {
4790           CONNECTION_LOCK (connection);
4791           handled = validate_and_maybe_schedule_property_getset (es->connection,
4792                                                                  message,
4793                                                                  is_property_get,
4794                                                                  introspection_data,
4795                                                                  interface_vtable,
4796                                                                  es->context,
4797                                                                  interface_user_data);
4798           CONNECTION_UNLOCK (connection);
4799         }
4800       else if (is_property_get_all)
4801         {
4802           CONNECTION_LOCK (connection);
4803           handled = validate_and_maybe_schedule_property_get_all (es->connection,
4804                                                                   message,
4805                                                                   introspection_data,
4806                                                                   interface_vtable,
4807                                                                   es->context,
4808                                                                   interface_user_data);
4809           CONNECTION_UNLOCK (connection);
4810         }
4811     }
4812
4813  out:
4814   if (interfaces != NULL)
4815     g_ptr_array_unref (interfaces);
4816   g_strfreev (children);
4817   return handled;
4818 }
4819
4820 typedef struct
4821 {
4822   GDBusMessage *message;
4823   ExportedSubtree *es;
4824 } SubtreeDeferredData;
4825
4826 static void
4827 subtree_deferred_data_free (SubtreeDeferredData *data)
4828 {
4829   g_object_unref (data->message);
4830   g_free (data);
4831 }
4832
4833 /* called without lock held in the thread where the caller registered the subtree */
4834 static gboolean
4835 process_subtree_vtable_message_in_idle_cb (gpointer _data)
4836 {
4837   SubtreeDeferredData *data = _data;
4838   gboolean handled;
4839
4840   handled = FALSE;
4841
4842   if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
4843       g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
4844       g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
4845     handled = handle_subtree_introspect (data->es->connection,
4846                                          data->es,
4847                                          data->message);
4848   else
4849     handled = handle_subtree_method_invocation (data->es->connection,
4850                                                 data->es,
4851                                                 data->message);
4852
4853   if (!handled)
4854     {
4855       CONNECTION_LOCK (data->es->connection);
4856       handled = handle_generic_unlocked (data->es->connection, data->message);
4857       CONNECTION_UNLOCK (data->es->connection);
4858     }
4859
4860   /* if we couldn't handle the request, just bail with the UnknownMethod error */
4861   if (!handled)
4862     {
4863       GDBusMessage *reply;
4864       reply = g_dbus_message_new_method_error (data->message,
4865                                                "org.freedesktop.DBus.Error.UnknownMethod",
4866                                                _("Method `%s' on interface `%s' with signature `%s' does not exist"),
4867                                                g_dbus_message_get_member (data->message),
4868                                                g_dbus_message_get_interface (data->message),
4869                                                g_dbus_message_get_signature (data->message));
4870       g_dbus_connection_send_message (data->es->connection, reply, NULL, NULL);
4871       g_object_unref (reply);
4872     }
4873
4874   return FALSE;
4875 }
4876
4877 /* called in message handler thread with lock held */
4878 static gboolean
4879 subtree_message_func (GDBusConnection *connection,
4880                       ExportedSubtree *es,
4881                       GDBusMessage    *message)
4882 {
4883   GSource *idle_source;
4884   SubtreeDeferredData *data;
4885
4886   data = g_new0 (SubtreeDeferredData, 1);
4887   data->message = g_object_ref (message);
4888   data->es = es;
4889
4890   /* defer this call to an idle handler in the right thread */
4891   idle_source = g_idle_source_new ();
4892   g_source_set_priority (idle_source, G_PRIORITY_HIGH);
4893   g_source_set_callback (idle_source,
4894                          process_subtree_vtable_message_in_idle_cb,
4895                          data,
4896                          (GDestroyNotify) subtree_deferred_data_free);
4897   g_source_attach (idle_source, es->context);
4898   g_source_unref (idle_source);
4899
4900   /* since we own the entire subtree, handlers for objects not in the subtree have been
4901    * tried already by libdbus-1 - so we just need to ensure that we're always going
4902    * to reply to the message
4903    */
4904   return TRUE;
4905 }
4906
4907 /**
4908  * g_dbus_connection_register_subtree:
4909  * @connection: A #GDBusConnection.
4910  * @object_path: The object path to register the subtree at.
4911  * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
4912  * @flags: Flags used to fine tune the behavior of the subtree.
4913  * @user_data: Data to pass to functions in @vtable.
4914  * @user_data_free_func: Function to call when the subtree is unregistered.
4915  * @error: Return location for error or %NULL.
4916  *
4917  * Registers a whole subtree of <quote>dynamic</quote> objects.
4918  *
4919  * The @enumerate and @introspection functions in @vtable are used to
4920  * convey, to remote callers, what nodes exist in the subtree rooted
4921  * by @object_path.
4922  *
4923  * When handling remote calls into any node in the subtree, first the
4924  * @enumerate function is used to check if the node exists. If the node exists
4925  * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
4926  * the @introspection function is used to check if the node supports the
4927  * requested method. If so, the @dispatch function is used to determine
4928  * where to dispatch the call. The collected #GDBusInterfaceVTable and
4929  * #gpointer will be used to call into the interface vtable for processing
4930  * the request.
4931  *
4932  * All calls into user-provided code will be invoked in the <link
4933  * linkend="g-main-context-push-thread-default">thread-default main
4934  * loop</link> of the thread you are calling this method from.
4935  *
4936  * If an existing subtree is already registered at @object_path or
4937  * then @error is set to #G_IO_ERROR_EXISTS.
4938  *
4939  * Note that it is valid to register regular objects (using
4940  * g_dbus_connection_register_object()) in a subtree registered with
4941  * g_dbus_connection_register_subtree() - if so, the subtree handler
4942  * is tried as the last resort. One way to think about a subtree
4943  * handler is to consider it a <quote>fallback handler</quote>
4944  * for object paths not registered via g_dbus_connection_register_object()
4945  * or other bindings.
4946  *
4947  * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
4948  *
4949  * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
4950  * that can be used with g_dbus_connection_unregister_subtree() .
4951  *
4952  * Since: 2.26
4953  */
4954 guint
4955 g_dbus_connection_register_subtree (GDBusConnection           *connection,
4956                                     const gchar               *object_path,
4957                                     const GDBusSubtreeVTable  *vtable,
4958                                     GDBusSubtreeFlags          flags,
4959                                     gpointer                   user_data,
4960                                     GDestroyNotify             user_data_free_func,
4961                                     GError                   **error)
4962 {
4963   guint ret;
4964   ExportedSubtree *es;
4965
4966   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
4967   g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
4968   g_return_val_if_fail (vtable != NULL, 0);
4969   g_return_val_if_fail (error == NULL || *error == NULL, 0);
4970
4971   ret = 0;
4972
4973   CONNECTION_LOCK (connection);
4974
4975   es = g_hash_table_lookup (connection->priv->map_object_path_to_es, object_path);
4976   if (es != NULL)
4977     {
4978       g_set_error (error,
4979                    G_IO_ERROR,
4980                    G_IO_ERROR_EXISTS,
4981                    _("A subtree is already exported for %s"),
4982                    object_path);
4983       goto out;
4984     }
4985
4986   es = g_new0 (ExportedSubtree, 1);
4987   es->object_path = g_strdup (object_path);
4988   es->connection = connection;
4989
4990   es->vtable = vtable;
4991   es->flags = flags;
4992   es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
4993   es->user_data = user_data;
4994   es->user_data_free_func = user_data_free_func;
4995   es->context = g_main_context_get_thread_default ();
4996   if (es->context != NULL)
4997     g_main_context_ref (es->context);
4998
4999   g_hash_table_insert (connection->priv->map_object_path_to_es, es->object_path, es);
5000   g_hash_table_insert (connection->priv->map_id_to_es,
5001                        GUINT_TO_POINTER (es->id),
5002                        es);
5003
5004   ret = es->id;
5005
5006  out:
5007   CONNECTION_UNLOCK (connection);
5008
5009   return ret;
5010 }
5011
5012 /* ---------------------------------------------------------------------------------------------------- */
5013
5014 /**
5015  * g_dbus_connection_unregister_subtree:
5016  * @connection: A #GDBusConnection.
5017  * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
5018  *
5019  * Unregisters a subtree.
5020  *
5021  * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
5022  *
5023  * Since: 2.26
5024  */
5025 gboolean
5026 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
5027                                       guint            registration_id)
5028 {
5029   ExportedSubtree *es;
5030   gboolean ret;
5031
5032   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5033
5034   ret = FALSE;
5035
5036   CONNECTION_LOCK (connection);
5037
5038   es = g_hash_table_lookup (connection->priv->map_id_to_es,
5039                             GUINT_TO_POINTER (registration_id));
5040   if (es == NULL)
5041     goto out;
5042
5043   g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_es, GUINT_TO_POINTER (es->id)));
5044   g_warn_if_fail (g_hash_table_remove (connection->priv->map_object_path_to_es, es->object_path));
5045
5046   ret = TRUE;
5047
5048  out:
5049   CONNECTION_UNLOCK (connection);
5050
5051   return ret;
5052 }
5053
5054 /* ---------------------------------------------------------------------------------------------------- */
5055
5056 /* must be called with lock held */
5057 static void
5058 handle_generic_ping_unlocked (GDBusConnection *connection,
5059                               const gchar     *object_path,
5060                               GDBusMessage    *message)
5061 {
5062   GDBusMessage *reply;
5063   reply = g_dbus_message_new_method_reply (message);
5064   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5065   g_object_unref (reply);
5066 }
5067
5068 /* must be called with lock held */
5069 static void
5070 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
5071                                         const gchar     *object_path,
5072                                         GDBusMessage    *message)
5073 {
5074   GDBusMessage *reply;
5075
5076   reply = NULL;
5077   if (connection->priv->machine_id == NULL)
5078     {
5079       GError *error;
5080       error = NULL;
5081       /* TODO: use PACKAGE_LOCALSTATEDIR ? */
5082       if (!g_file_get_contents ("/var/lib/dbus/machine-id",
5083                                 &connection->priv->machine_id,
5084                                 NULL,
5085                                 &error))
5086         {
5087           reply = g_dbus_message_new_method_error (message,
5088                                                    "org.freedesktop.DBus.Error.Failed",
5089                                                    _("Unable to load /var/lib/dbus/machine-id: %s"),
5090                                                    error->message);
5091           g_error_free (error);
5092         }
5093       else
5094         {
5095           g_strstrip (connection->priv->machine_id);
5096           /* TODO: validate value */
5097         }
5098     }
5099
5100   if (reply == NULL)
5101     {
5102       reply = g_dbus_message_new_method_reply (message);
5103       g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->priv->machine_id));
5104     }
5105   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5106   g_object_unref (reply);
5107 }
5108
5109 /* must be called with lock held */
5110 static void
5111 handle_generic_introspect_unlocked (GDBusConnection *connection,
5112                                     const gchar     *object_path,
5113                                     GDBusMessage    *message)
5114 {
5115   guint n;
5116   GString *s;
5117   gchar **registered;
5118   GDBusMessage *reply;
5119
5120   /* first the header */
5121   s = g_string_new (NULL);
5122   introspect_append_header (s);
5123
5124   registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
5125   for (n = 0; registered != NULL && registered[n] != NULL; n++)
5126       g_string_append_printf (s, "  <node name=\"%s\"/>\n", registered[n]);
5127   g_strfreev (registered);
5128   g_string_append (s, "</node>\n");
5129
5130   reply = g_dbus_message_new_method_reply (message);
5131   g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5132   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5133   g_object_unref (reply);
5134   g_string_free (s, TRUE);
5135 }
5136
5137 /* must be called with lock held */
5138 static gboolean
5139 handle_generic_unlocked (GDBusConnection *connection,
5140                          GDBusMessage    *message)
5141 {
5142   gboolean handled;
5143   const gchar *interface_name;
5144   const gchar *member;
5145   const gchar *signature;
5146   const gchar *path;
5147
5148   CONNECTION_ENSURE_LOCK (connection);
5149
5150   handled = FALSE;
5151
5152   interface_name = g_dbus_message_get_interface (message);
5153   member = g_dbus_message_get_member (message);
5154   signature = g_dbus_message_get_signature (message);
5155   path = g_dbus_message_get_path (message);
5156
5157   if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
5158       g_strcmp0 (member, "Introspect") == 0 &&
5159       g_strcmp0 (signature, "") == 0)
5160     {
5161       handle_generic_introspect_unlocked (connection, path, message);
5162       handled = TRUE;
5163     }
5164   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
5165            g_strcmp0 (member, "Ping") == 0 &&
5166            g_strcmp0 (signature, "") == 0)
5167     {
5168       handle_generic_ping_unlocked (connection, path, message);
5169       handled = TRUE;
5170     }
5171   else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
5172            g_strcmp0 (member, "GetMachineId") == 0 &&
5173            g_strcmp0 (signature, "") == 0)
5174     {
5175       handle_generic_get_machine_id_unlocked (connection, path, message);
5176       handled = TRUE;
5177     }
5178
5179   return handled;
5180 }
5181
5182 /* ---------------------------------------------------------------------------------------------------- */
5183
5184 /* called in message handler thread with lock held */
5185 static void
5186 distribute_method_call (GDBusConnection *connection,
5187                         GDBusMessage    *message)
5188 {
5189   GDBusMessage *reply;
5190   ExportedObject *eo;
5191   ExportedSubtree *es;
5192   const gchar *object_path;
5193   const gchar *interface_name;
5194   const gchar *member;
5195   const gchar *signature;
5196   const gchar *path;
5197   gchar *subtree_path;
5198   gchar *needle;
5199
5200   g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
5201
5202   interface_name = g_dbus_message_get_interface (message);
5203   member = g_dbus_message_get_member (message);
5204   signature = g_dbus_message_get_signature (message);
5205   path = g_dbus_message_get_path (message);
5206   subtree_path = g_strdup (path);
5207   needle = strrchr (subtree_path, '/');
5208   if (needle != NULL && needle != subtree_path)
5209     {
5210       *needle = '\0';
5211     }
5212   else
5213     {
5214       g_free (subtree_path);
5215       subtree_path = NULL;
5216     }
5217
5218 #if 0
5219   g_debug ("interface    = `%s'", interface_name);
5220   g_debug ("member       = `%s'", member);
5221   g_debug ("signature    = `%s'", signature);
5222   g_debug ("path         = `%s'", path);
5223   g_debug ("subtree_path = `%s'", subtree_path != NULL ? subtree_path : "N/A");
5224 #endif
5225
5226   object_path = g_dbus_message_get_path (message);
5227   g_assert (object_path != NULL);
5228
5229   eo = g_hash_table_lookup (connection->priv->map_object_path_to_eo, object_path);
5230   if (eo != NULL)
5231     {
5232       if (obj_message_func (connection, eo, message))
5233         goto out;
5234     }
5235
5236   es = g_hash_table_lookup (connection->priv->map_object_path_to_es, object_path);
5237   if (es != NULL)
5238     {
5239       if (subtree_message_func (connection, es, message))
5240         goto out;
5241     }
5242
5243   if (subtree_path != NULL)
5244     {
5245       es = g_hash_table_lookup (connection->priv->map_object_path_to_es, subtree_path);
5246       if (es != NULL)
5247         {
5248           if (subtree_message_func (connection, es, message))
5249             goto out;
5250         }
5251     }
5252
5253   if (handle_generic_unlocked (connection, message))
5254     goto out;
5255
5256   /* if we end up here, the message has not been not handled - so return an error saying this */
5257   reply = g_dbus_message_new_method_error (message,
5258                                            "org.freedesktop.DBus.Error.UnknownMethod",
5259                                            _("No such interface `%s' on object at path %s"),
5260                                            interface_name,
5261                                            object_path);
5262   g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5263   g_object_unref (reply);
5264
5265  out:
5266   g_free (subtree_path);
5267 }
5268
5269 /* ---------------------------------------------------------------------------------------------------- */
5270
5271 static GDBusConnection **
5272 message_bus_get_singleton (GBusType   bus_type,
5273                            GError   **error)
5274 {
5275   GDBusConnection **ret;
5276   const gchar *starter_bus;
5277
5278   ret = NULL;
5279
5280   switch (bus_type)
5281     {
5282     case G_BUS_TYPE_SESSION:
5283       ret = &the_session_bus;
5284       break;
5285
5286     case G_BUS_TYPE_SYSTEM:
5287       ret = &the_system_bus;
5288       break;
5289
5290     case G_BUS_TYPE_STARTER:
5291       starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
5292       if (g_strcmp0 (starter_bus, "session") == 0)
5293         {
5294           ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
5295           goto out;
5296         }
5297       else if (g_strcmp0 (starter_bus, "system") == 0)
5298         {
5299           ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
5300           goto out;
5301         }
5302       else
5303         {
5304           if (starter_bus != NULL)
5305             {
5306               g_set_error (error,
5307                            G_IO_ERROR,
5308                            G_IO_ERROR_INVALID_ARGUMENT,
5309                            _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
5310                              " - unknown value `%s'"),
5311                            starter_bus);
5312             }
5313           else
5314             {
5315               g_set_error_literal (error,
5316                                    G_IO_ERROR,
5317                                    G_IO_ERROR_INVALID_ARGUMENT,
5318                                    _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
5319                                      "variable is not set"));
5320             }
5321         }
5322       break;
5323
5324     default:
5325       g_assert_not_reached ();
5326       break;
5327     }
5328
5329  out:
5330   return ret;
5331 }
5332
5333 static GDBusConnection *
5334 get_uninitialized_connection (GBusType       bus_type,
5335                               GCancellable  *cancellable,
5336                               GError       **error)
5337 {
5338   GDBusConnection **singleton;
5339   GDBusConnection *ret;
5340
5341   ret = NULL;
5342
5343   G_LOCK (message_bus_lock);
5344   singleton = message_bus_get_singleton (bus_type, error);
5345   if (singleton == NULL)
5346     goto out;
5347
5348   if (*singleton == NULL)
5349     {
5350       gchar *address;
5351       address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
5352       if (address == NULL)
5353         goto out;
5354       ret = *singleton = g_object_new (G_TYPE_DBUS_CONNECTION,
5355                                        "address", address,
5356                                        "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
5357                                                 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
5358                                        "exit-on-close", TRUE,
5359                                        NULL);
5360       g_free (address);
5361     }
5362   else
5363     {
5364       ret = g_object_ref (*singleton);
5365     }
5366
5367   g_assert (ret != NULL);
5368
5369  out:
5370   G_UNLOCK (message_bus_lock);
5371   return ret;
5372 }
5373
5374 /**
5375  * g_bus_get_sync:
5376  * @bus_type: A #GBusType.
5377  * @cancellable: A #GCancellable or %NULL.
5378  * @error: Return location for error or %NULL.
5379  *
5380  * Synchronously connects to the message bus specified by @bus_type.
5381  * Note that the returned object may shared with other callers,
5382  * e.g. if two separate parts of a process calls this function with
5383  * the same @bus_type, they will share the same object.
5384  *
5385  * This is a synchronous failable function. See g_bus_get() and
5386  * g_bus_get_finish() for the asynchronous version.
5387  *
5388  * The returned object is a singleton, that is, shared with other
5389  * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
5390  * event that you need a private message bus connection, use
5391  * g_dbus_address_get_for_bus_sync() and
5392  * g_dbus_connection_new_for_address().
5393  *
5394  * Note that the returned #GDBusConnection object will (usually) have
5395  * the #GDBusConnection:exit-on-close property set to %TRUE.
5396  *
5397  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
5398  *
5399  * Since: 2.26
5400  */
5401 GDBusConnection *
5402 g_bus_get_sync (GBusType       bus_type,
5403                 GCancellable  *cancellable,
5404                 GError       **error)
5405 {
5406   GDBusConnection *connection;
5407
5408   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5409
5410   connection = get_uninitialized_connection (bus_type, cancellable, error);
5411   if (connection == NULL)
5412     goto out;
5413
5414   if (!g_initable_init (G_INITABLE (connection), cancellable, error))
5415     {
5416       g_object_unref (connection);
5417       connection = NULL;
5418     }
5419
5420  out:
5421   return connection;
5422 }
5423
5424 static void
5425 bus_get_async_initable_cb (GObject      *source_object,
5426                            GAsyncResult *res,
5427                            gpointer      user_data)
5428 {
5429   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
5430   GError *error;
5431
5432   error = NULL;
5433   if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
5434                                      res,
5435                                      &error))
5436     {
5437       g_assert (error != NULL);
5438       g_simple_async_result_set_from_error (simple, error);
5439       g_error_free (error);
5440       g_object_unref (source_object);
5441     }
5442   else
5443     {
5444       g_simple_async_result_set_op_res_gpointer (simple,
5445                                                  source_object,
5446                                                  g_object_unref);
5447     }
5448   g_simple_async_result_complete_in_idle (simple);
5449   g_object_unref (simple);
5450 }
5451
5452 /**
5453  * g_bus_get:
5454  * @bus_type: A #GBusType.
5455  * @cancellable: A #GCancellable or %NULL.
5456  * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
5457  * @user_data: The data to pass to @callback.
5458  *
5459  * Asynchronously connects to the message bus specified by @bus_type.
5460  *
5461  * When the operation is finished, @callback will be invoked. You can
5462  * then call g_bus_get_finish() to get the result of the operation.
5463  *
5464  * This is a asynchronous failable function. See g_bus_get_sync() for
5465  * the synchronous version.
5466  *
5467  * Since: 2.26
5468  */
5469 void
5470 g_bus_get (GBusType             bus_type,
5471            GCancellable        *cancellable,
5472            GAsyncReadyCallback  callback,
5473            gpointer             user_data)
5474 {
5475   GDBusConnection *connection;
5476   GSimpleAsyncResult *simple;
5477   GError *error;
5478
5479   simple = g_simple_async_result_new (NULL,
5480                                       callback,
5481                                       user_data,
5482                                       g_bus_get);
5483
5484   error = NULL;
5485   connection = get_uninitialized_connection (bus_type, cancellable, &error);
5486   if (connection == NULL)
5487     {
5488       g_assert (error != NULL);
5489       g_simple_async_result_set_from_error (simple, error);
5490       g_error_free (error);
5491       g_simple_async_result_complete_in_idle (simple);
5492       g_object_unref (simple);
5493     }
5494   else
5495     {
5496       g_async_initable_init_async (G_ASYNC_INITABLE (connection),
5497                                    G_PRIORITY_DEFAULT,
5498                                    cancellable,
5499                                    bus_get_async_initable_cb,
5500                                    simple);
5501     }
5502 }
5503
5504 /**
5505  * g_bus_get_finish:
5506  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
5507  * @error: Return location for error or %NULL.
5508  *
5509  * Finishes an operation started with g_bus_get().
5510  *
5511  * The returned object is a singleton, that is, shared with other
5512  * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
5513  * event that you need a private message bus connection, use
5514  * g_dbus_address_get_for_bus() and
5515  * g_dbus_connection_new_for_address().
5516  *
5517  * Note that the returned #GDBusConnection object will (usually) have
5518  * the #GDBusConnection:exit-on-close property set to %TRUE.
5519  *
5520  * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
5521  *
5522  * Since: 2.26
5523  */
5524 GDBusConnection *
5525 g_bus_get_finish (GAsyncResult  *res,
5526                   GError       **error)
5527 {
5528   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5529   GObject *object;
5530   GDBusConnection *ret;
5531
5532   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5533
5534   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
5535
5536   ret = NULL;
5537
5538   if (g_simple_async_result_propagate_error (simple, error))
5539     goto out;
5540
5541   object = g_simple_async_result_get_op_res_gpointer (simple);
5542   g_assert (object != NULL);
5543   ret = g_object_ref (G_DBUS_CONNECTION (object));
5544
5545  out:
5546   return ret;
5547 }
5548
5549 /* ---------------------------------------------------------------------------------------------------- */
5550
5551 #define __G_DBUS_CONNECTION_C__
5552 #include "gioaliasdef.c"