gio/gdbusconnection.c

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