gio/gdbusnameowning.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 #include "config.h"
  24
  25 #include <stdlib.h>
  26
  27 #include "gdbusutils.h"
  28 #include "gdbusnameowning.h"
  29 #include "gdbuserror.h"
  30 #include "gdbusprivate.h"
  31 #include "gdbusconnection.h"
  32
  33 #include "glibintl.h"
  34 #include "gioalias.h"
  35
  36 /**
  37  * SECTION:gdbusnameowning
  38  * @title: Owning Bus Names
  39  * @short_description: Simple API for owning bus names
  40  * @include: gio/gio.h
  41  *
  42  * Convenience API for owning bus names.
  43  *
  44  * <example id="gdbus-owning-names"><title>Simple application owning a name</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-own-name.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
  45  */
  46
  47 G_LOCK_DEFINE_STATIC (lock);
  48
  49 /* ---------------------------------------------------------------------------------------------------- */
  50
  51 typedef enum
  52 {
  53   PREVIOUS_CALL_NONE = 0,
  54   PREVIOUS_CALL_ACQUIRED,
  55   PREVIOUS_CALL_LOST,
  56 } PreviousCall;
  57
  58 typedef struct
  59 {
  60   volatile gint             ref_count;
  61   guint                     id;
  62   GBusNameOwnerFlags        flags;
  63   gchar                    *name;
  64   GBusAcquiredCallback      bus_acquired_handler;
  65   GBusNameAcquiredCallback  name_acquired_handler;
  66   GBusNameLostCallback      name_lost_handler;
  67   gpointer                  user_data;
  68   GDestroyNotify            user_data_free_func;
  69   GMainContext             *main_context;
  70
  71   PreviousCall              previous_call;
  72
  73   GDBusConnection          *connection;
  74   gulong                    disconnected_signal_handler_id;
  75   guint                     name_acquired_subscription_id;
  76   guint                     name_lost_subscription_id;
  77
  78   gboolean                  cancelled;
  79
  80   gboolean                  needs_release;
  81 } Client;
  82
  83 static guint next_global_id = 1;
  84 static GHashTable *map_id_to_client = NULL;
  85
  86
  87 static Client *
  88 client_ref (Client *client)
  89 {
  90   g_atomic_int_inc (&client->ref_count);
  91   return client;
  92 }
  93
  94 static void
  95 client_unref (Client *client)
  96 {
  97   if (g_atomic_int_dec_and_test (&client->ref_count))
  98     {
  99       if (client->connection != NULL)
 100         {
 101           if (client->disconnected_signal_handler_id > 0)
 102             g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
 103           if (client->name_acquired_subscription_id > 0)
 104             g_dbus_connection_signal_unsubscribe (client->connection, client->name_acquired_subscription_id);
 105           if (client->name_lost_subscription_id > 0)
 106             g_dbus_connection_signal_unsubscribe (client->connection, client->name_lost_subscription_id);
 107           g_object_unref (client->connection);
 108         }
 109       if (client->main_context != NULL)
 110         g_main_context_unref (client->main_context);
 111       g_free (client->name);
 112       if (client->user_data_free_func != NULL)
 113         client->user_data_free_func (client->user_data);
 114       g_free (client);
 115     }
 116 }
 117
 118 /* ---------------------------------------------------------------------------------------------------- */
 119
 120
 121 typedef enum
 122 {
 123   CALL_TYPE_NAME_ACQUIRED,
 124   CALL_TYPE_NAME_LOST
 125 } CallType;
 126
 127 typedef struct
 128 {
 129   Client *client;
 130
 131   /* keep this separate because client->connection may
 132    * be set to NULL after scheduling the call
 133    */
 134   GDBusConnection *connection;
 135
 136   /* set to TRUE to call acquired */
 137   CallType call_type;
 138 } CallHandlerData;
 139
 140 static void
 141 call_handler_data_free (CallHandlerData *data)
 142 {
 143   if (data->connection != NULL)
 144     g_object_unref (data->connection);
 145   client_unref (data->client);
 146   g_free (data);
 147 }
 148
 149 static void
 150 actually_do_call (Client *client, GDBusConnection *connection, CallType call_type)
 151 {
 152   switch (call_type)
 153     {
 154     case CALL_TYPE_NAME_ACQUIRED:
 155       if (client->name_acquired_handler != NULL)
 156         {
 157           client->name_acquired_handler (connection,
 158                                          client->name,
 159                                          client->user_data);
 160         }
 161       break;
 162
 163     case CALL_TYPE_NAME_LOST:
 164       if (client->name_lost_handler != NULL)
 165         {
 166           client->name_lost_handler (connection,
 167                                      client->name,
 168                                      client->user_data);
 169         }
 170       break;
 171
 172     default:
 173       g_assert_not_reached ();
 174       break;
 175     }
 176 }
 177
 178 static gboolean
 179 call_in_idle_cb (gpointer _data)
 180 {
 181   CallHandlerData *data = _data;
 182   actually_do_call (data->client, data->connection, data->call_type);
 183   return FALSE;
 184 }
 185
 186 static void
 187 schedule_call_in_idle (Client *client, CallType  call_type)
 188 {
 189   CallHandlerData *data;
 190   GSource *idle_source;
 191
 192   data = g_new0 (CallHandlerData, 1);
 193   data->client = client_ref (client);
 194   data->connection = client->connection != NULL ? g_object_ref (client->connection) : NULL;
 195   data->call_type = call_type;
 196
 197   idle_source = g_idle_source_new ();
 198   g_source_set_priority (idle_source, G_PRIORITY_HIGH);
 199   g_source_set_callback (idle_source,
 200                          call_in_idle_cb,
 201                          data,
 202                          (GDestroyNotify) call_handler_data_free);
 203   g_source_attach (idle_source, client->main_context);
 204   g_source_unref (idle_source);
 205 }
 206
 207 static void
 208 do_call (Client *client, CallType call_type)
 209 {
 210   /* only schedule in idle if we're not in the right thread */
 211   if (g_main_context_get_thread_default () != client->main_context)
 212     schedule_call_in_idle (client, call_type);
 213   else
 214     actually_do_call (client, client->connection, call_type);
 215 }
 216
 217 static void
 218 call_acquired_handler (Client *client)
 219 {
 220   if (client->previous_call != PREVIOUS_CALL_ACQUIRED)
 221     {
 222       client->previous_call = PREVIOUS_CALL_ACQUIRED;
 223       if (!client->cancelled)
 224         {
 225           do_call (client, CALL_TYPE_NAME_ACQUIRED);
 226         }
 227     }
 228 }
 229
 230 static void
 231 call_lost_handler (Client  *client)
 232 {
 233   if (client->previous_call != PREVIOUS_CALL_LOST)
 234     {
 235       client->previous_call = PREVIOUS_CALL_LOST;
 236       if (!client->cancelled)
 237         {
 238           do_call (client, CALL_TYPE_NAME_LOST);
 239         }
 240     }
 241 }
 242
 243 /* ---------------------------------------------------------------------------------------------------- */
 244
 245 static void
 246 on_name_lost_or_acquired (GDBusConnection  *connection,
 247                           const gchar      *sender_name,
 248                           const gchar      *object_path,
 249                           const gchar      *interface_name,
 250                           const gchar      *signal_name,
 251                           GVariant         *parameters,
 252                           gpointer          user_data)
 253 {
 254   Client *client = user_data;
 255   const gchar *name;
 256
 257   if (g_strcmp0 (object_path, "/org/freedesktop/DBus") != 0 ||
 258       g_strcmp0 (interface_name, "org.freedesktop.DBus") != 0 ||
 259       g_strcmp0 (sender_name, "org.freedesktop.DBus") != 0)
 260     goto out;
 261
 262   if (g_strcmp0 (signal_name, "NameLost") == 0)
 263     {
 264       g_variant_get (parameters, "(&s)", &name);
 265       if (g_strcmp0 (name, client->name) == 0)
 266         {
 267           call_lost_handler (client);
 268         }
 269     }
 270   else if (g_strcmp0 (signal_name, "NameAcquired") == 0)
 271     {
 272       g_variant_get (parameters, "(&s)", &name);
 273       if (g_strcmp0 (name, client->name) == 0)
 274         {
 275           call_acquired_handler (client);
 276         }
 277     }
 278  out:
 279   ;
 280 }
 281
 282 /* ---------------------------------------------------------------------------------------------------- */
 283
 284 static void
 285 request_name_cb (GObject      *source_object,
 286                  GAsyncResult *res,
 287                  gpointer      user_data)
 288 {
 289   Client *client = user_data;
 290   GVariant *result;
 291   guint32 request_name_reply;
 292   gboolean subscribe;
 293
 294   request_name_reply = 0;
 295   result = NULL;
 296
 297   result = g_dbus_connection_call_finish (client->connection,
 298                                           res,
 299                                           NULL);
 300   if (result != NULL)
 301     {
 302       g_variant_get (result, "(u)", &request_name_reply);
 303       g_variant_unref (result);
 304     }
 305
 306   subscribe = FALSE;
 307
 308   switch (request_name_reply)
 309     {
 310     case 1: /* DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER */
 311       /* We got the name - now listen for NameLost and NameAcquired */
 312       call_acquired_handler (client);
 313       subscribe = TRUE;
 314       client->needs_release = TRUE;
 315       break;
 316
 317     case 2: /* DBUS_REQUEST_NAME_REPLY_IN_QUEUE */
 318       /* Waiting in line - listen for NameLost and NameAcquired */
 319       call_lost_handler (client);
 320       subscribe = TRUE;
 321       client->needs_release = TRUE;
 322       break;
 323
 324     default:
 325       /* assume we couldn't get the name - explicit fallthrough */
 326     case 3: /* DBUS_REQUEST_NAME_REPLY_EXISTS */
 327     case 4: /* DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER */
 328       /* Some other part of the process is already owning the name */
 329       call_lost_handler (client);
 330       break;
 331     }
 332
 333   if (subscribe)
 334     {
 335       /* start listening to NameLost and NameAcquired messages */
 336       client->name_lost_subscription_id =
 337         g_dbus_connection_signal_subscribe (client->connection,
 338                                             "org.freedesktop.DBus",
 339                                             "org.freedesktop.DBus",
 340                                             "NameLost",
 341                                             "/org/freedesktop/DBus",
 342                                             client->name,
 343                                             on_name_lost_or_acquired,
 344                                             client,
 345                                             NULL);
 346       client->name_acquired_subscription_id =
 347         g_dbus_connection_signal_subscribe (client->connection,
 348                                             "org.freedesktop.DBus",
 349                                             "org.freedesktop.DBus",
 350                                             "NameAcquired",
 351                                             "/org/freedesktop/DBus",
 352                                             client->name,
 353                                             on_name_lost_or_acquired,
 354                                             client,
 355                                             NULL);
 356     }
 357
 358   client_unref (client);
 359 }
 360
 361 /* ---------------------------------------------------------------------------------------------------- */
 362
 363 static void
 364 on_connection_disconnected (GDBusConnection *connection,
 365                             gboolean         remote_peer_vanished,
 366                             GError          *error,
 367                             gpointer         user_data)
 368 {
 369   Client *client = user_data;
 370
 371   if (client->disconnected_signal_handler_id > 0)
 372     g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
 373   if (client->name_acquired_subscription_id > 0)
 374     g_dbus_connection_signal_unsubscribe (client->connection, client->name_acquired_subscription_id);
 375   if (client->name_lost_subscription_id > 0)
 376     g_dbus_connection_signal_unsubscribe (client->connection, client->name_lost_subscription_id);
 377   g_object_unref (client->connection);
 378   client->disconnected_signal_handler_id = 0;
 379   client->name_acquired_subscription_id = 0;
 380   client->name_lost_subscription_id = 0;
 381   client->connection = NULL;
 382
 383   call_lost_handler (client);
 384 }
 385
 386 /* ---------------------------------------------------------------------------------------------------- */
 387
 388 static void
 389 has_connection (Client *client)
 390 {
 391   /* listen for disconnection */
 392   client->disconnected_signal_handler_id = g_signal_connect (client->connection,
 393                                                              "closed",
 394                                                              G_CALLBACK (on_connection_disconnected),
 395                                                              client);
 396
 397   /* attempt to acquire the name */
 398   g_dbus_connection_call (client->connection,
 399                           "org.freedesktop.DBus",  /* bus name */
 400                           "/org/freedesktop/DBus", /* object path */
 401                           "org.freedesktop.DBus",  /* interface name */
 402                           "RequestName",           /* method name */
 403                           g_variant_new ("(su)",
 404                                          client->name,
 405                                          client->flags),
 406                           G_VARIANT_TYPE ("(u)"),
 407                           G_DBUS_CALL_FLAGS_NONE,
 408                           -1,
 409                           NULL,
 410                           (GAsyncReadyCallback) request_name_cb,
 411                           client_ref (client));
 412 }
 413
 414
 415 static void
 416 connection_get_cb (GObject      *source_object,
 417                    GAsyncResult *res,
 418                    gpointer      user_data)
 419 {
 420   Client *client = user_data;
 421
 422   client->connection = g_bus_get_finish (res, NULL);
 423   if (client->connection == NULL)
 424     {
 425       call_lost_handler (client);
 426       goto out;
 427     }
 428
 429   /* No need to schedule this in idle as we're already in the thread
 430    * that the user called g_bus_own_name() from. This is because
 431    * g_bus_get() guarantees that.
 432    *
 433    * Also, we need to ensure that the handler is invoked *before*
 434    * we call RequestName(). Otherwise there is a race.
 435    */
 436   if (client->bus_acquired_handler != NULL)
 437     {
 438       client->bus_acquired_handler (client->connection,
 439                                     client->name,
 440                                     client->user_data);
 441     }
 442
 443   has_connection (client);
 444
 445  out:
 446   client_unref (client);
 447 }
 448
 449 /* ---------------------------------------------------------------------------------------------------- */
 450
 451 /**
 452  * g_bus_own_name_on_connection:
 453  * @connection: A #GDBusConnection.
 454  * @name: The well-known name to own.
 455  * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
 456  * @name_acquired_handler: Handler to invoke when @name is acquired or %NULL.
 457  * @name_lost_handler: Handler to invoke when @name is lost or %NULL.
 458  * @user_data: User data to pass to handlers.
 459  * @user_data_free_func: Function for freeing @user_data or %NULL.
 460  *
 461  * Like g_bus_own_name() but takes a #GDBusConnection instead of a
 462  * #GBusType.
 463  *
 464  * Returns: An identifier (never 0) that an be used with
 465  * g_bus_unown_name() to stop owning the name.
 466  *
 467  * Since: 2.26
 468  */
 469 guint
 470 g_bus_own_name_on_connection (GDBusConnection          *connection,
 471                               const gchar              *name,
 472                               GBusNameOwnerFlags        flags,
 473                               GBusNameAcquiredCallback  name_acquired_handler,
 474                               GBusNameLostCallback      name_lost_handler,
 475                               gpointer                  user_data,
 476                               GDestroyNotify            user_data_free_func)
 477 {
 478   Client *client;
 479
 480   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
 481   g_return_val_if_fail (g_dbus_is_name (name) && !g_dbus_is_unique_name (name), 0);
 482
 483   G_LOCK (lock);
 484
 485   client = g_new0 (Client, 1);
 486   client->ref_count = 1;
 487   client->id = next_global_id++; /* TODO: uh oh, handle overflow */
 488   client->name = g_strdup (name);
 489   client->flags = flags;
 490   client->name_acquired_handler = name_acquired_handler;
 491   client->name_lost_handler = name_lost_handler;
 492   client->user_data = user_data;
 493   client->user_data_free_func = user_data_free_func;
 494   client->main_context = g_main_context_get_thread_default ();
 495   if (client->main_context != NULL)
 496     g_main_context_ref (client->main_context);
 497
 498   client->connection = g_object_ref (connection);
 499
 500   if (map_id_to_client == NULL)
 501     {
 502       map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
 503     }
 504   g_hash_table_insert (map_id_to_client,
 505                        GUINT_TO_POINTER (client->id),
 506                        client);
 507
 508   G_UNLOCK (lock);
 509
 510   has_connection (client);
 511
 512   return client->id;
 513 }
 514
 515 /**
 516  * g_bus_own_name:
 517  * @bus_type: The type of bus to own a name on.
 518  * @name: The well-known name to own.
 519  * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
 520  * @bus_acquired_handler: Handler to invoke when connected to the bus of type @bus_type or %NULL.
 521  * @name_acquired_handler: Handler to invoke when @name is acquired or %NULL.
 522  * @name_lost_handler: Handler to invoke when @name is lost or %NULL.
 523  * @user_data: User data to pass to handlers.
 524  * @user_data_free_func: Function for freeing @user_data or %NULL.
 525  *
 526  * Starts acquiring @name on the bus specified by @bus_type and calls
 527  * @name_acquired_handler and @name_lost_handler when the name is
 528  * acquired respectively lost. Callbacks will be invoked in the <link
 529  * linkend="g-main-context-push-thread-default">thread-default main
 530  * loop</link> of the thread you are calling this function from.
 531  *
 532  * You are guaranteed that one of the @name_acquired_handler and @name_lost_handler
 533  * callbacks will be invoked after calling this function - there are three
 534  * possible cases:
 535  * <itemizedlist>
 536  *   <listitem><para>
 537  *     @name_lost_handler with a %NULL connection (if a connection to the bus can't be made).
 538  *   </para></listitem>
 539  *   <listitem><para>
 540  *     @bus_acquired_handler then @name_lost_handler (if the name can't be obtained)
 541  *   </para></listitem>
 542  *   <listitem><para>
 543  *     @bus_acquired_handler then @name_acquired_handler (if the name was obtained).
 544  *   </para></listitem>
 545  * </itemizedlist>
 546  * When you are done owning the name, just call g_bus_unown_name()
 547  * with the owner id this function returns.
 548  *
 549  * If the name is acquired or lost (for example another application
 550  * could acquire the name if you allow replacement or the application
 551  * currently owning the name exits), the handlers are also invoked. If the
 552  * #GDBusConnection that is used for attempting to own the name
 553  * closes, then @name_lost_handler is invoked since it is no
 554  * longer possible for other processes to access the process.
 555  *
 556  * You cannot use g_bus_own_name() several times for the same name (unless
 557  * interleaved with calls to g_bus_unown_name()) - only the first call
 558  * will work.
 559  *
 560  * Another guarantee is that invocations of @name_acquired_handler
 561  * and @name_lost_handler are guaranteed to alternate; that
 562  * is, if @name_acquired_handler is invoked then you are
 563  * guaranteed that the next time one of the handlers is invoked, it
 564  * will be @name_lost_handler. The reverse is also true.
 565  *
 566  * If you plan on exporting objects (using e.g.
 567  * g_dbus_connection_register_object()), note that it is generally too late
 568  * to export the objects in @name_acquired_handler. Instead, you can do this
 569  * in @bus_acquired_handler since you are guaranteed that this will run
 570  * before @name is requested from the bus.
 571  *
 572  * This behavior makes it very simple to write applications that wants
 573  * to own names and export objects, see <xref linkend="gdbus-owning-names"/>.
 574  * Simply register objects to be exported in @bus_acquired_handler and
 575  * unregister the objects (if any) in @name_lost_handler.
 576  *
 577  * Returns: An identifier (never 0) that an be used with
 578  * g_bus_unown_name() to stop owning the name.
 579  *
 580  * Since: 2.26
 581  */
 582 guint
 583 g_bus_own_name (GBusType                  bus_type,
 584                 const gchar              *name,
 585                 GBusNameOwnerFlags        flags,
 586                 GBusAcquiredCallback      bus_acquired_handler,
 587                 GBusNameAcquiredCallback  name_acquired_handler,
 588                 GBusNameLostCallback      name_lost_handler,
 589                 gpointer                  user_data,
 590                 GDestroyNotify            user_data_free_func)
 591 {
 592   Client *client;
 593
 594   g_return_val_if_fail (g_dbus_is_name (name) && !g_dbus_is_unique_name (name), 0);
 595
 596   G_LOCK (lock);
 597
 598   client = g_new0 (Client, 1);
 599   client->ref_count = 1;
 600   client->id = next_global_id++; /* TODO: uh oh, handle overflow */
 601   client->name = g_strdup (name);
 602   client->flags = flags;
 603   client->bus_acquired_handler = bus_acquired_handler;
 604   client->name_acquired_handler = name_acquired_handler;
 605   client->name_lost_handler = name_lost_handler;
 606   client->user_data = user_data;
 607   client->user_data_free_func = user_data_free_func;
 608   client->main_context = g_main_context_get_thread_default ();
 609   if (client->main_context != NULL)
 610     g_main_context_ref (client->main_context);
 611
 612   if (map_id_to_client == NULL)
 613     {
 614       map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
 615     }
 616   g_hash_table_insert (map_id_to_client,
 617                        GUINT_TO_POINTER (client->id),
 618                        client);
 619
 620   g_bus_get (bus_type,
 621              NULL,
 622              connection_get_cb,
 623              client_ref (client));
 624
 625   G_UNLOCK (lock);
 626
 627   return client->id;
 628 }
 629
 630 typedef struct {
 631   GClosure *bus_acquired_closure;
 632   GClosure *name_acquired_closure;
 633   GClosure *name_lost_closure;
 634 } OwnNameData;
 635
 636 static void
 637 own_with_closures_on_bus_acquired (GDBusConnection *connection,
 638                                    const gchar     *name,
 639                                    gpointer         user_data)
 640 {
 641   OwnNameData *data = user_data;
 642   GValue params[2] = { { 0, }, { 0, } };
 643
 644   g_value_init (&params[0], G_TYPE_DBUS_CONNECTION);
 645   g_value_set_object (&params[0], connection);
 646
 647   g_value_init (&params[1], G_TYPE_STRING);
 648   g_value_set_string (&params[1], name);
 649
 650   g_closure_invoke (data->bus_acquired_closure, NULL, 2, params, NULL);
 651 }
 652
 653 static void
 654 own_with_closures_on_name_acquired (GDBusConnection *connection,
 655                                     const gchar     *name,
 656                                     gpointer         user_data)
 657 {
 658   OwnNameData *data = user_data;
 659   GValue params[2] = { { 0, }, { 0, } };
 660
 661   g_value_init (&params[0], G_TYPE_DBUS_CONNECTION);
 662   g_value_set_object (&params[0], connection);
 663
 664   g_value_init (&params[1], G_TYPE_STRING);
 665   g_value_set_string (&params[1], name);
 666
 667   g_closure_invoke (data->name_acquired_closure, NULL, 2, params, NULL);
 668 }
 669
 670 static void
 671 own_with_closures_on_name_lost (GDBusConnection *connection,
 672                                 const gchar     *name,
 673                                 gpointer         user_data)
 674 {
 675   OwnNameData *data = user_data;
 676   GValue params[2] = { { 0, }, { 0, } };
 677
 678   g_value_init (&params[0], G_TYPE_DBUS_CONNECTION);
 679   g_value_set_object (&params[0], connection);
 680
 681   g_value_init (&params[1], G_TYPE_STRING);
 682   g_value_set_string (&params[1], name);
 683
 684   g_closure_invoke (data->name_lost_closure, NULL, 2, params, NULL);
 685 }
 686
 687 static void
 688 bus_own_name_free_func (gpointer user_data)
 689 {
 690   OwnNameData *data = user_data;
 691
 692   if (data->bus_acquired_closure != NULL)
 693     g_closure_unref (data->bus_acquired_closure);
 694
 695   if (data->name_acquired_closure != NULL)
 696     g_closure_unref (data->name_acquired_closure);
 697
 698   if (data->name_lost_closure != NULL)
 699     g_closure_unref (data->name_lost_closure);
 700
 701   g_free (data);
 702 }
 703
 704 /**
 705  * g_bus_own_name_with_closures:
 706  * @bus_type: The type of bus to own a name on.
 707  * @name: The well-known name to own.
 708  * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
 709  * @bus_acquired_closure: (allow-none): #GClosure to invoke when connected to
 710  * the bus of type @bus_type or %NULL.
 711  * @name_acquired_closure: (allow-none): #GClosure to invoke when @name is
 712  * acquired or %NULL.
 713  * @name_lost_closure: (allow-none): #GClosure to invoke when @name is lost or
 714  * %NULL.
 715  *
 716  * Version of g_bus_own_name() using closures instead of callbacks for
 717  * easier binding in other languages.
 718  *
 719  * Returns: An identifier (never 0) that an be used with
 720  * g_bus_unown_name() to stop owning the name.
 721  *
 722  * Rename to: g_bus_own_name
 723  *
 724  * Since: 2.26
 725  */
 726 guint
 727 g_bus_own_name_with_closures (GBusType                  bus_type,
 728                               const gchar              *name,
 729                               GBusNameOwnerFlags        flags,
 730                               GClosure                 *bus_acquired_closure,
 731                               GClosure                 *name_acquired_closure,
 732                               GClosure                 *name_lost_closure)
 733 {
 734   OwnNameData *data;
 735
 736   data = g_new0 (OwnNameData, 1);
 737
 738   if (bus_acquired_closure != NULL)
 739     {
 740       data->bus_acquired_closure = g_closure_ref (bus_acquired_closure);
 741       g_closure_sink (bus_acquired_closure);
 742     }
 743
 744   if (name_acquired_closure != NULL)
 745     {
 746       data->name_acquired_closure = g_closure_ref (name_acquired_closure);
 747       g_closure_sink (name_acquired_closure);
 748     }
 749
 750   if (name_lost_closure != NULL)
 751     {
 752       data->name_lost_closure = g_closure_ref (name_lost_closure);
 753       g_closure_sink (name_lost_closure);
 754     }
 755
 756   return g_bus_own_name (bus_type,
 757           name,
 758           flags,
 759           bus_acquired_closure != NULL ? own_with_closures_on_bus_acquired : NULL,
 760           name_acquired_closure != NULL ? own_with_closures_on_name_acquired : NULL,
 761           name_lost_closure != NULL ? own_with_closures_on_name_lost : NULL,
 762           data,
 763           bus_own_name_free_func);
 764 }
 765
 766 /**
 767  * g_bus_own_name_on_connection_with_closures:
 768  * @connection: A #GDBusConnection.
 769  * @name: The well-known name to own.
 770  * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
 771  * @name_acquired_closure: (allow-none): #GClosure to invoke when @name is
 772  * acquired or %NULL.
 773  * @name_lost_closure: (allow-none): #GClosure to invoke when @name is lost or
 774  * %NULL.
 775  *
 776  * Version of g_bus_own_name_on_connection() using closures instead of callbacks for
 777  * easier binding in other languages.
 778  *
 779  * Returns: An identifier (never 0) that an be used with
 780  * g_bus_unown_name() to stop owning the name.
 781  *
 782  * Rename to: g_bus_own_name_on_connection
 783  *
 784  * Since: 2.26
 785  */
 786 guint
 787 g_bus_own_name_on_connection_with_closures (GDBusConnection          *connection,
 788                                             const gchar              *name,
 789                                             GBusNameOwnerFlags        flags,
 790                                             GClosure                 *name_acquired_closure,
 791                                             GClosure                 *name_lost_closure)
 792 {
 793   OwnNameData *data;
 794
 795   data = g_new0 (OwnNameData, 1);
 796
 797   if (name_acquired_closure != NULL)
 798     {
 799       data->name_acquired_closure = g_closure_ref (name_acquired_closure);
 800       g_closure_sink (name_acquired_closure);
 801     }
 802
 803   if (name_lost_closure != NULL)
 804     {
 805       data->name_lost_closure = g_closure_ref (name_lost_closure);
 806       g_closure_sink (name_lost_closure);
 807     }
 808
 809   return g_bus_own_name_on_connection (connection,
 810           name,
 811           flags,
 812           name_acquired_closure != NULL ? own_with_closures_on_name_acquired : NULL,
 813           name_lost_closure != NULL ? own_with_closures_on_name_lost : NULL,
 814           data,
 815           bus_own_name_free_func);
 816 }
 817
 818 /**
 819  * g_bus_unown_name:
 820  * @owner_id: An identifier obtained from g_bus_own_name()
 821  *
 822  * Stops owning a name.
 823  *
 824  * Since: 2.26
 825  */
 826 void
 827 g_bus_unown_name (guint owner_id)
 828 {
 829   Client *client;
 830
 831   g_return_if_fail (owner_id > 0);
 832
 833   client = NULL;
 834
 835   G_LOCK (lock);
 836   if (owner_id == 0 || map_id_to_client == NULL ||
 837       (client = g_hash_table_lookup (map_id_to_client, GUINT_TO_POINTER (owner_id))) == NULL)
 838     {
 839       g_warning ("Invalid id %d passed to g_bus_unown_name()", owner_id);
 840       goto out;
 841     }
 842
 843   client->cancelled = TRUE;
 844   g_warn_if_fail (g_hash_table_remove (map_id_to_client, GUINT_TO_POINTER (owner_id)));
 845
 846  out:
 847   G_UNLOCK (lock);
 848
 849   /* do callback without holding lock */
 850   if (client != NULL)
 851     {
 852       /* Release the name if needed */
 853       if (client->needs_release && client->connection != NULL)
 854         {
 855           GVariant *result;
 856           GError *error;
 857           guint32 release_name_reply;
 858
 859           /* TODO: it kinda sucks having to do a sync call to release the name - but if
 860            * we don't, then a subsequent grab of the name will make the bus daemon return
 861            * IN_QUEUE which will trigger name_lost().
 862            *
 863            * I believe this is a bug in the bus daemon.
 864            */
 865           error = NULL;
 866           result = g_dbus_connection_call_sync (client->connection,
 867                                                 "org.freedesktop.DBus",  /* bus name */
 868                                                 "/org/freedesktop/DBus", /* object path */
 869                                                 "org.freedesktop.DBus",  /* interface name */
 870                                                 "ReleaseName",           /* method name */
 871                                                 g_variant_new ("(s)", client->name),
 872                                                 G_VARIANT_TYPE ("(u)"),
 873                                                 G_DBUS_CALL_FLAGS_NONE,
 874                                                 -1,
 875                                                 NULL,
 876                                                 &error);
 877           if (result == NULL)
 878             {
 879               g_warning ("Error releasing name %s: %s", client->name, error->message);
 880               g_error_free (error);
 881             }
 882           else
 883             {
 884               g_variant_get (result, "(u)", &release_name_reply);
 885               if (release_name_reply != 1 /* DBUS_RELEASE_NAME_REPLY_RELEASED */)
 886                 {
 887                   g_warning ("Unexpected reply %d when releasing name %s", release_name_reply, client->name);
 888                 }
 889               g_variant_unref (result);
 890             }
 891         }
 892
 893       if (client->disconnected_signal_handler_id > 0)
 894         g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
 895       if (client->name_acquired_subscription_id > 0)
 896         g_dbus_connection_signal_unsubscribe (client->connection, client->name_acquired_subscription_id);
 897       if (client->name_lost_subscription_id > 0)
 898         g_dbus_connection_signal_unsubscribe (client->connection, client->name_lost_subscription_id);
 899       client->disconnected_signal_handler_id = 0;
 900       client->name_acquired_subscription_id = 0;
 901       client->name_lost_subscription_id = 0;
 902       if (client->connection != NULL)
 903         {
 904           g_object_unref (client->connection);
 905           client->connection = NULL;
 906         }
 907
 908       client_unref (client);
 909     }
 910 }
 911
 912 #define __G_DBUS_NAME_OWNING_C__
 913 #include "gioaliasdef.c"