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