gdbusinterfaceskeleton.c 34.4 KB
Newer Older
1 2 3 4 5 6 7
/* GDBus - GLib D-Bus Library
 *
 * Copyright (C) 2008-2010 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
16
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18 19 20 21 22 23
 *
 * Author: David Zeuthen <davidz@redhat.com>
 */

#include "config.h"

#include "gdbusinterface.h"
24 25
#include "gdbusinterfaceskeleton.h"
#include "gdbusobjectskeleton.h"
26 27 28 29
#include "gioenumtypes.h"
#include "gdbusprivate.h"
#include "gdbusmethodinvocation.h"
#include "gdbusconnection.h"
30
#include "gmarshal-internal.h"
31
#include "gtask.h"
32 33 34 35 36
#include "gioerror.h"

#include "glibintl.h"

/**
37
 * SECTION:gdbusinterfaceskeleton
38 39 40 41 42 43
 * @short_description: Service-side D-Bus interface
 * @include: gio/gio.h
 *
 * Abstract base class for D-Bus interfaces on the service side.
 */

44
struct _GDBusInterfaceSkeletonPrivate
45
{
46
  GMutex                      lock;
47

48
  GDBusObject                *object;
49
  GDBusInterfaceSkeletonFlags flags;
50

51 52 53
  GSList                     *connections;   /* List of ConnectionData */
  gchar                      *object_path;   /* The object path for this skeleton */
  GDBusInterfaceVTable       *hooked_vtable;
54 55
};

56 57 58 59 60 61
typedef struct
{
  GDBusConnection *connection;
  guint            registration_id;
} ConnectionData;

62 63 64 65 66 67 68 69 70 71 72 73 74 75
enum
{
  G_AUTHORIZE_METHOD_SIGNAL,
  LAST_SIGNAL
};

enum
{
  PROP_0,
  PROP_G_FLAGS
};

static guint signals[LAST_SIGNAL] = {0};

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
static void     dbus_interface_interface_init                      (GDBusInterfaceIface    *iface);

static void     set_object_path_locked                             (GDBusInterfaceSkeleton *interface_,
                                                                    const gchar            *object_path);
static void     remove_connection_locked                           (GDBusInterfaceSkeleton *interface_,
                                                                    GDBusConnection        *connection);
static void     skeleton_intercept_handle_method_call              (GDBusConnection        *connection,
                                                                    const gchar            *sender,
                                                                    const gchar            *object_path,
                                                                    const gchar            *interface_name,
                                                                    const gchar            *method_name,
                                                                    GVariant               *parameters,
                                                                    GDBusMethodInvocation  *invocation,
                                                                    gpointer                user_data);

91

92
G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GDBusInterfaceSkeleton, g_dbus_interface_skeleton, G_TYPE_OBJECT,
93 94
                                  G_ADD_PRIVATE (GDBusInterfaceSkeleton)
                                  G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_INTERFACE, dbus_interface_interface_init))
95 96

static void
97
g_dbus_interface_skeleton_finalize (GObject *object)
98
{
99
  GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object);
100

101
  /* Hold the lock just in case any code we call verifies that the lock is held */
102 103 104 105 106 107 108 109 110 111 112 113 114 115
  g_mutex_lock (&interface->priv->lock);

  /* unexport from all connections if we're exported anywhere */
  while (interface->priv->connections != NULL)
    {
      ConnectionData *data = interface->priv->connections->data;
      remove_connection_locked (interface, data->connection);
    }

  set_object_path_locked (interface, NULL);

  g_mutex_unlock (&interface->priv->lock);

  g_free (interface->priv->hooked_vtable);
116

117 118
  if (interface->priv->object != NULL)
    g_object_remove_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object);
119

120
  g_mutex_clear (&interface->priv->lock);
121

122
  G_OBJECT_CLASS (g_dbus_interface_skeleton_parent_class)->finalize (object);
123 124 125
}

static void
126 127 128 129
g_dbus_interface_skeleton_get_property (GObject      *object,
                                        guint         prop_id,
                                        GValue       *value,
                                        GParamSpec   *pspec)
130
{
131
  GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object);
132 133 134 135

  switch (prop_id)
    {
    case PROP_G_FLAGS:
136
      g_value_set_flags (value, g_dbus_interface_skeleton_get_flags (interface));
137 138 139 140 141 142 143 144 145
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
146 147 148 149
g_dbus_interface_skeleton_set_property (GObject      *object,
                                        guint         prop_id,
                                        const GValue *value,
                                        GParamSpec   *pspec)
150
{
151
  GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object);
152 153 154 155

  switch (prop_id)
    {
    case PROP_G_FLAGS:
156
      g_dbus_interface_skeleton_set_flags (interface, g_value_get_flags (value));
157 158 159 160 161 162 163 164 165
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static gboolean
166 167
g_dbus_interface_skeleton_g_authorize_method_default (GDBusInterfaceSkeleton    *interface,
                                                      GDBusMethodInvocation *invocation)
168 169 170 171 172
{
  return TRUE;
}

static void
173
g_dbus_interface_skeleton_class_init (GDBusInterfaceSkeletonClass *klass)
174 175 176 177
{
  GObjectClass *gobject_class;

  gobject_class = G_OBJECT_CLASS (klass);
178 179 180
  gobject_class->finalize     = g_dbus_interface_skeleton_finalize;
  gobject_class->set_property = g_dbus_interface_skeleton_set_property;
  gobject_class->get_property = g_dbus_interface_skeleton_get_property;
181

182
  klass->g_authorize_method = g_dbus_interface_skeleton_g_authorize_method_default;
183 184

  /**
185
   * GDBusInterfaceSkeleton:g-flags:
186
   *
187
   * Flags from the #GDBusInterfaceSkeletonFlags enumeration.
188 189
   *
   * Since: 2.30
190 191 192 193 194
   */
  g_object_class_install_property (gobject_class,
                                   PROP_G_FLAGS,
                                   g_param_spec_flags ("g-flags",
                                                       "g-flags",
195 196 197
                                                       "Flags for the interface skeleton",
                                                       G_TYPE_DBUS_INTERFACE_SKELETON_FLAGS,
                                                       G_DBUS_INTERFACE_SKELETON_FLAGS_NONE,
198 199 200 201 202
                                                       G_PARAM_READABLE |
                                                       G_PARAM_WRITABLE |
                                                       G_PARAM_STATIC_STRINGS));

  /**
203 204
   * GDBusInterfaceSkeleton::g-authorize-method:
   * @interface: The #GDBusInterfaceSkeleton emitting the signal.
205 206 207 208 209 210 211
   * @invocation: A #GDBusMethodInvocation.
   *
   * Emitted when a method is invoked by a remote caller and used to
   * determine if the method call is authorized.
   *
   * Note that this signal is emitted in a thread dedicated to
   * handling the method call so handlers are allowed to perform
212 213 214 215 216
   * blocking IO. This means that it is appropriate to call e.g.
   * [polkit_authority_check_authorization_sync()](http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#polkit-authority-check-authorization-sync)
   * with the
   * [POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION](http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#POLKIT-CHECK-AUTHORIZATION-FLAGS-ALLOW-USER-INTERACTION:CAPS)
   * flag set.
217 218
   *
   * If %FALSE is returned then no further handlers are run and the
219
   * signal handler must take a reference to @invocation and finish
220 221 222 223 224
   * handling the call (e.g. return an error via
   * g_dbus_method_invocation_return_error()).
   *
   * Otherwise, if %TRUE is returned, signal emission continues. If no
   * handlers return %FALSE, then the method is dispatched. If
225 226 227
   * @interface has an enclosing #GDBusObjectSkeleton, then the
   * #GDBusObjectSkeleton::authorize-method signal handlers run before
   * the handlers for this signal.
228 229 230 231 232 233
   *
   * The default class handler just returns %TRUE.
   *
   * Please note that the common case is optimized: if no signals
   * handlers are connected and the default class handler isn't
   * overridden (for both @interface and the enclosing
234
   * #GDBusObjectSkeleton, if any) and #GDBusInterfaceSkeleton:g-flags does
235
   * not have the
236
   * %G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD
237 238 239 240 241
   * flags set, no dedicated thread is ever used and the call will be
   * handled in the same thread as the object that @interface belongs
   * to was exported in.
   *
   * Returns: %TRUE if the call is authorized, %FALSE otherwise.
242 243
   *
   * Since: 2.30
244 245
   */
  signals[G_AUTHORIZE_METHOD_SIGNAL] =
246
    g_signal_new (I_("g-authorize-method"),
247
                  G_TYPE_DBUS_INTERFACE_SKELETON,
248
                  G_SIGNAL_RUN_LAST,
249
                  G_STRUCT_OFFSET (GDBusInterfaceSkeletonClass, g_authorize_method),
250 251
                  _g_signal_accumulator_false_handled,
                  NULL,
252
                  _g_cclosure_marshal_BOOLEAN__OBJECT,
253 254 255
                  G_TYPE_BOOLEAN,
                  1,
                  G_TYPE_DBUS_METHOD_INVOCATION);
256 257 258
  g_signal_set_va_marshaller (signals[G_AUTHORIZE_METHOD_SIGNAL],
                              G_TYPE_FROM_CLASS (klass),
                              _g_cclosure_marshal_BOOLEAN__OBJECTv);
259 260 261
}

static void
262
g_dbus_interface_skeleton_init (GDBusInterfaceSkeleton *interface)
263
{
264
  interface->priv = g_dbus_interface_skeleton_get_instance_private (interface);
265
  g_mutex_init (&interface->priv->lock);
266 267 268 269 270
}

/* ---------------------------------------------------------------------------------------------------- */

/**
271 272
 * g_dbus_interface_skeleton_get_flags:
 * @interface_: A #GDBusInterfaceSkeleton.
273
 *
274
 * Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior
275
 * of @interface_
276
 *
277
 * Returns: One or more flags from the #GDBusInterfaceSkeletonFlags enumeration.
278 279
 *
 * Since: 2.30
280
 */
281 282
GDBusInterfaceSkeletonFlags
g_dbus_interface_skeleton_get_flags (GDBusInterfaceSkeleton  *interface_)
283
{
284
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), G_DBUS_INTERFACE_SKELETON_FLAGS_NONE);
285
  return interface_->priv->flags;
286 287 288
}

/**
289 290 291
 * g_dbus_interface_skeleton_set_flags:
 * @interface_: A #GDBusInterfaceSkeleton.
 * @flags: Flags from the #GDBusInterfaceSkeletonFlags enumeration.
292
 *
293
 * Sets flags describing what the behavior of @skeleton should be.
294 295
 *
 * Since: 2.30
296 297
 */
void
298 299
g_dbus_interface_skeleton_set_flags (GDBusInterfaceSkeleton      *interface_,
                                     GDBusInterfaceSkeletonFlags  flags)
300
{
301
  g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_));
302
  g_mutex_lock (&interface_->priv->lock);
303
  if (interface_->priv->flags != flags)
304
    {
305
      interface_->priv->flags = flags;
306
      g_mutex_unlock (&interface_->priv->lock);
307
      g_object_notify (G_OBJECT (interface_), "g-flags");
308
    }
309 310
  else
    {
311
      g_mutex_unlock (&interface_->priv->lock);
312
    }
313 314 315
}

/**
316 317
 * g_dbus_interface_skeleton_get_info:
 * @interface_: A #GDBusInterfaceSkeleton.
318 319
 *
 * Gets D-Bus introspection information for the D-Bus interface
320
 * implemented by @interface_.
321 322
 *
 * Returns: (transfer none): A #GDBusInterfaceInfo (never %NULL). Do not free.
323 324
 *
 * Since: 2.30
325 326
 */
GDBusInterfaceInfo *
327
g_dbus_interface_skeleton_get_info (GDBusInterfaceSkeleton *interface_)
328 329
{
  GDBusInterfaceInfo *ret;
330 331
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
  ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_info (interface_);
332 333 334 335 336
  g_warn_if_fail (ret != NULL);
  return ret;
}

/**
337
 * g_dbus_interface_skeleton_get_vtable: (skip)
338
 * @interface_: A #GDBusInterfaceSkeleton.
339 340
 *
 * Gets the interface vtable for the D-Bus interface implemented by
341
 * @interface_. The returned function pointers should expect @interface_
342 343 344
 * itself to be passed as @user_data.
 *
 * Returns: A #GDBusInterfaceVTable (never %NULL).
345 346
 *
 * Since: 2.30
347 348
 */
GDBusInterfaceVTable *
349
g_dbus_interface_skeleton_get_vtable (GDBusInterfaceSkeleton *interface_)
350 351
{
  GDBusInterfaceVTable *ret;
352 353
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
  ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_vtable (interface_);
354 355 356 357 358
  g_warn_if_fail (ret != NULL);
  return ret;
}

/**
359 360
 * g_dbus_interface_skeleton_get_properties:
 * @interface_: A #GDBusInterfaceSkeleton.
361
 *
362
 * Gets all D-Bus properties for @interface_.
363
 *
364 365 366
 * Returns: (transfer full): A #GVariant of type
 * ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS].
 * Free with g_variant_unref().
367 368
 *
 * Since: 2.30
369 370
 */
GVariant *
371
g_dbus_interface_skeleton_get_properties (GDBusInterfaceSkeleton *interface_)
372 373
{
  GVariant *ret;
374 375
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
  ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_properties (interface_);
376
  return g_variant_take_ref (ret);
377 378 379
}

/**
380 381
 * g_dbus_interface_skeleton_flush:
 * @interface_: A #GDBusInterfaceSkeleton.
382
 *
383
 * If @interface_ has outstanding changes, request for these changes to be
384 385 386 387
 * emitted immediately.
 *
 * For example, an exported D-Bus interface may queue up property
 * changes and emit the
388
 * `org.freedesktop.DBus.Properties.PropertiesChanged`
389 390
 * signal later (e.g. in an idle handler). This technique is useful
 * for collapsing multiple property changes into one.
391 392
 *
 * Since: 2.30
393 394
 */
void
395
g_dbus_interface_skeleton_flush (GDBusInterfaceSkeleton *interface_)
396
{
397 398
  g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_));
  G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->flush (interface_);
399 400 401 402 403
}

/* ---------------------------------------------------------------------------------------------------- */

static GDBusInterfaceInfo *
404
_g_dbus_interface_skeleton_get_info (GDBusInterface *interface_)
405
{
406 407
  GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_);
  return g_dbus_interface_skeleton_get_info (interface);
408 409 410
}

static GDBusObject *
411
g_dbus_interface_skeleton_get_object (GDBusInterface *interface_)
412
{
413
  GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_);
414
  GDBusObject *ret;
415
  g_mutex_lock (&interface->priv->lock);
416
  ret = interface->priv->object;
417
  g_mutex_unlock (&interface->priv->lock);
418
  return ret;
419 420
}

421 422 423 424 425 426 427 428 429 430 431 432 433
static GDBusObject *
g_dbus_interface_skeleton_dup_object (GDBusInterface *interface_)
{
  GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_);
  GDBusObject *ret;
  g_mutex_lock (&interface->priv->lock);
  ret = interface->priv->object;
  if (ret != NULL)
    g_object_ref (ret);
  g_mutex_unlock (&interface->priv->lock);
  return ret;
}

434
static void
435 436
g_dbus_interface_skeleton_set_object (GDBusInterface *interface_,
                                      GDBusObject    *object)
437
{
438
  GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_);
439
  g_mutex_lock (&interface->priv->lock);
440 441 442
  if (interface->priv->object != NULL)
    g_object_remove_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object);
  interface->priv->object = object;
443
  if (object != NULL)
444
    g_object_add_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object);
445
  g_mutex_unlock (&interface->priv->lock);
446 447 448 449 450
}

static void
dbus_interface_interface_init (GDBusInterfaceIface *iface)
{
451 452
  iface->get_info    = _g_dbus_interface_skeleton_get_info;
  iface->get_object  = g_dbus_interface_skeleton_get_object;
453
  iface->dup_object  = g_dbus_interface_skeleton_dup_object;
454
  iface->set_object  = g_dbus_interface_skeleton_set_object;
455 456 457 458 459 460 461
}

/* ---------------------------------------------------------------------------------------------------- */

typedef struct
{
  volatile gint ref_count;
462
  GDBusInterfaceSkeleton       *interface;
463 464 465 466 467 468 469 470
  GDBusInterfaceMethodCallFunc  method_call_func;
  GDBusMethodInvocation        *invocation;
} DispatchData;

static void
dispatch_data_unref (DispatchData *data)
{
  if (g_atomic_int_dec_and_test (&data->ref_count))
471
    g_slice_free (DispatchData, data);
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
}

static DispatchData *
dispatch_data_ref (DispatchData *data)
{
  g_atomic_int_inc (&data->ref_count);
  return data;
}

static gboolean
dispatch_invoke_in_context_func (gpointer user_data)
{
  DispatchData *data = user_data;
  data->method_call_func (g_dbus_method_invocation_get_connection (data->invocation),
                          g_dbus_method_invocation_get_sender (data->invocation),
                          g_dbus_method_invocation_get_object_path (data->invocation),
                          g_dbus_method_invocation_get_interface_name (data->invocation),
                          g_dbus_method_invocation_get_method_name (data->invocation),
                          g_dbus_method_invocation_get_parameters (data->invocation),
                          data->invocation,
                          g_dbus_method_invocation_get_user_data (data->invocation));
  return FALSE;
}

496 497 498 499 500
static void
dispatch_in_thread_func (GTask        *task,
                         gpointer      source_object,
                         gpointer      task_data,
                         GCancellable *cancellable)
501
{
502
  DispatchData *data = task_data;
503 504
  GDBusInterfaceSkeletonFlags flags;
  GDBusObject *object;
505 506
  gboolean authorized;

507
  g_mutex_lock (&data->interface->priv->lock);
508 509 510 511
  flags = data->interface->priv->flags;
  object = data->interface->priv->object;
  if (object != NULL)
    g_object_ref (object);
512
  g_mutex_unlock (&data->interface->priv->lock);
513

514 515
  /* first check on the enclosing object (if any), then the interface */
  authorized = TRUE;
516
  if (object != NULL)
517
    {
518
      g_signal_emit_by_name (object,
519
                             "authorize-method",
520
                             data->interface,
521 522 523 524 525
                             data->invocation,
                             &authorized);
    }
  if (authorized)
    {
526
      g_signal_emit (data->interface,
527 528 529 530 531 532 533 534 535
                     signals[G_AUTHORIZE_METHOD_SIGNAL],
                     0,
                     data->invocation,
                     &authorized);
    }

  if (authorized)
    {
      gboolean run_in_thread;
536
      run_in_thread = (flags & G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD);
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
      if (run_in_thread)
        {
          /* might as well just re-use the existing thread */
          data->method_call_func (g_dbus_method_invocation_get_connection (data->invocation),
                                  g_dbus_method_invocation_get_sender (data->invocation),
                                  g_dbus_method_invocation_get_object_path (data->invocation),
                                  g_dbus_method_invocation_get_interface_name (data->invocation),
                                  g_dbus_method_invocation_get_method_name (data->invocation),
                                  g_dbus_method_invocation_get_parameters (data->invocation),
                                  data->invocation,
                                  g_dbus_method_invocation_get_user_data (data->invocation));
        }
      else
        {
          /* bah, back to original context */
552 553
          g_main_context_invoke_full (g_task_get_context (task),
                                      g_task_get_priority (task),
554 555 556 557 558 559 560 561 562 563
                                      dispatch_invoke_in_context_func,
                                      dispatch_data_ref (data),
                                      (GDestroyNotify) dispatch_data_unref);
        }
    }
  else
    {
      /* do nothing */
    }

564 565
  if (object != NULL)
    g_object_unref (object);
566 567 568
}

static void
569
g_dbus_interface_method_dispatch_helper (GDBusInterfaceSkeleton       *interface,
570 571 572 573 574 575 576
                                         GDBusInterfaceMethodCallFunc  method_call_func,
                                         GDBusMethodInvocation        *invocation)
{
  gboolean has_handlers;
  gboolean has_default_class_handler;
  gboolean emit_authorized_signal;
  gboolean run_in_thread;
577 578
  GDBusInterfaceSkeletonFlags flags;
  GDBusObject *object;
579

580
  g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface));
581 582 583
  g_return_if_fail (method_call_func != NULL);
  g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));

584
  g_mutex_lock (&interface->priv->lock);
585 586 587 588
  flags = interface->priv->flags;
  object = interface->priv->object;
  if (object != NULL)
    g_object_ref (object);
589
  g_mutex_unlock (&interface->priv->lock);
590

591 592 593 594 595
  /* optimization for the common case where
   *
   *  a) no handler is connected and class handler is not overridden (both interface and object); and
   *  b) method calls are not dispatched in a thread
   */
596
  has_handlers = g_signal_has_handler_pending (interface,
597 598 599
                                               signals[G_AUTHORIZE_METHOD_SIGNAL],
                                               0,
                                               TRUE);
600 601
  has_default_class_handler = (G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface)->g_authorize_method ==
                               g_dbus_interface_skeleton_g_authorize_method_default);
602 603 604 605

  emit_authorized_signal = (has_handlers || !has_default_class_handler);
  if (!emit_authorized_signal)
    {
606 607
      if (object != NULL)
        emit_authorized_signal = _g_dbus_object_skeleton_has_authorize_method_handlers (G_DBUS_OBJECT_SKELETON (object));
608 609
    }

610
  run_in_thread = (flags & G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD);
611 612 613 614 615 616 617 618 619 620 621 622 623
  if (!emit_authorized_signal && !run_in_thread)
    {
      method_call_func (g_dbus_method_invocation_get_connection (invocation),
                        g_dbus_method_invocation_get_sender (invocation),
                        g_dbus_method_invocation_get_object_path (invocation),
                        g_dbus_method_invocation_get_interface_name (invocation),
                        g_dbus_method_invocation_get_method_name (invocation),
                        g_dbus_method_invocation_get_parameters (invocation),
                        invocation,
                        g_dbus_method_invocation_get_user_data (invocation));
    }
  else
    {
624
      GTask *task;
625
      DispatchData *data;
626 627

      data = g_slice_new0 (DispatchData);
628
      data->interface = interface;
629 630 631
      data->method_call_func = method_call_func;
      data->invocation = invocation;
      data->ref_count = 1;
632 633

      task = g_task_new (interface, NULL, NULL, NULL);
634
      g_task_set_source_tag (task, g_dbus_interface_method_dispatch_helper);
635 636 637
      g_task_set_task_data (task, data, (GDestroyNotify) dispatch_data_unref);
      g_task_run_in_thread (task, dispatch_in_thread_func);
      g_object_unref (task);
638
    }
639 640 641

  if (object != NULL)
    g_object_unref (object);
642 643 644
}

static void
645 646 647 648 649 650 651 652
skeleton_intercept_handle_method_call (GDBusConnection       *connection,
                                       const gchar           *sender,
                                       const gchar           *object_path,
                                       const gchar           *interface_name,
                                       const gchar           *method_name,
                                       GVariant              *parameters,
                                       GDBusMethodInvocation *invocation,
                                       gpointer               user_data)
653
{
654
  GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (user_data);
655
  g_dbus_interface_method_dispatch_helper (interface,
656
                                           g_dbus_interface_skeleton_get_vtable (interface)->method_call,
657 658 659 660 661
                                           invocation);
}

/* ---------------------------------------------------------------------------------------------------- */

662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
static ConnectionData *
new_connection (GDBusConnection *connection,
                guint            registration_id)
{
  ConnectionData *data;

  data = g_slice_new0 (ConnectionData);
  data->connection      = g_object_ref (connection);
  data->registration_id = registration_id;

  return data;
}

static void
free_connection (ConnectionData *data)
{
  if (data != NULL)
    {
      g_object_unref (data->connection);
      g_slice_free (ConnectionData, data);
    }
}

static gboolean
add_connection_locked (GDBusInterfaceSkeleton *interface_,
                       GDBusConnection        *connection,
                       GError                **error)
{
  ConnectionData *data;
  guint registration_id;
  gboolean ret = FALSE;

  if (interface_->priv->hooked_vtable == NULL)
    {
      /* Hook the vtable since we need to intercept method calls for
       * ::g-authorize-method and for dispatching in thread vs
       * context
       *
       * We need to wait until subclasses have had time to initialize
       * properly before building the hooked_vtable, so we create it
       * once at the last minute.
       */
      interface_->priv->hooked_vtable = g_memdup (g_dbus_interface_skeleton_get_vtable (interface_), sizeof (GDBusInterfaceVTable));
      interface_->priv->hooked_vtable->method_call = skeleton_intercept_handle_method_call;
    }

  registration_id = g_dbus_connection_register_object (connection,
                                                       interface_->priv->object_path,
                                                       g_dbus_interface_skeleton_get_info (interface_),
                                                       interface_->priv->hooked_vtable,
                                                       interface_,
                                                       NULL, /* user_data_free_func */
                                                       error);

  if (registration_id > 0)
    {
      data = new_connection (connection, registration_id);
      interface_->priv->connections = g_slist_append (interface_->priv->connections, data);
      ret = TRUE;
    }

  return ret;
}

static void
remove_connection_locked (GDBusInterfaceSkeleton *interface_,
                          GDBusConnection        *connection)
{
  ConnectionData *data;
  GSList *l;

  /* Get the connection in the list and unregister ... */
  for (l = interface_->priv->connections; l != NULL; l = l->next)
    {
      data = l->data;
      if (data->connection == connection)
        {
          g_warn_if_fail (g_dbus_connection_unregister_object (data->connection, data->registration_id));
          free_connection (data);
          interface_->priv->connections = g_slist_delete_link (interface_->priv->connections, l);
          /* we are guaranteed that the connection is only added once, so bail out early */
          goto out;
        }
    }
 out:
  ;
}

static void
set_object_path_locked (GDBusInterfaceSkeleton *interface_,
                        const gchar            *object_path)
{
  if (g_strcmp0 (interface_->priv->object_path, object_path) != 0)
    {
      g_free (interface_->priv->object_path);
      interface_->priv->object_path = g_strdup (object_path);
    }
}

/* ---------------------------------------------------------------------------------------------------- */

763
/**
764 765
 * g_dbus_interface_skeleton_get_connection:
 * @interface_: A #GDBusInterfaceSkeleton.
766
 *
767
 * Gets the first connection that @interface_ is exported on, if any.
768
 *
769 770
 * Returns: (transfer none): A #GDBusConnection or %NULL if @interface_ is
 * not exported anywhere. Do not free, the object belongs to @interface_.
771 772
 *
 * Since: 2.30
773 774
 */
GDBusConnection *
775
g_dbus_interface_skeleton_get_connection (GDBusInterfaceSkeleton *interface_)
776
{
777
  ConnectionData  *data;
778
  GDBusConnection *ret;
779

780
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
781
  g_mutex_lock (&interface_->priv->lock);
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838

  ret = NULL;
  if (interface_->priv->connections != NULL)
    {
      data = interface_->priv->connections->data;
      if (data != NULL)
        ret = data->connection;
    }

  g_mutex_unlock (&interface_->priv->lock);

  return ret;
}

/**
 * g_dbus_interface_skeleton_get_connections:
 * @interface_: A #GDBusInterfaceSkeleton.
 *
 * Gets a list of the connections that @interface_ is exported on.
 *
 * Returns: (element-type GDBusConnection) (transfer full): A list of
 *   all the connections that @interface_ is exported on. The returned
 *   list should be freed with g_list_free() after each element has
 *   been freed with g_object_unref().
 *
 * Since: 2.32
 */
GList *
g_dbus_interface_skeleton_get_connections (GDBusInterfaceSkeleton *interface_)
{
  GList           *connections;
  GSList          *l;
  ConnectionData  *data;

  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);

  g_mutex_lock (&interface_->priv->lock);
  connections = NULL;

  for (l = interface_->priv->connections; l != NULL; l = l->next)
    {
      data        = l->data;
      connections = g_list_prepend (connections,
                                    /* Return a reference to each connection */
                                    g_object_ref (data->connection));
    }

  g_mutex_unlock (&interface_->priv->lock);

  return g_list_reverse (connections);
}

/**
 * g_dbus_interface_skeleton_has_connection:
 * @interface_: A #GDBusInterfaceSkeleton.
 * @connection: A #GDBusConnection.
 *
839
 * Checks if @interface_ is exported on @connection.
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
 *
 * Returns: %TRUE if @interface_ is exported on @connection, %FALSE otherwise.
 *
 * Since: 2.32
 */
gboolean
g_dbus_interface_skeleton_has_connection (GDBusInterfaceSkeleton     *interface_,
                                          GDBusConnection            *connection)
{
  GSList *l;
  gboolean ret = FALSE;

  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), FALSE);
  g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);

  g_mutex_lock (&interface_->priv->lock);

  for (l = interface_->priv->connections; l != NULL; l = l->next)
    {
      ConnectionData *data = l->data;
      if (data->connection == connection)
        {
          ret = TRUE;
          goto out;
        }
    }

 out:
868
  g_mutex_unlock (&interface_->priv->lock);
869
  return ret;
870 871 872
}

/**
873 874
 * g_dbus_interface_skeleton_get_object_path:
 * @interface_: A #GDBusInterfaceSkeleton.
875
 *
876
 * Gets the object path that @interface_ is exported on, if any.
877
 *
878 879
 * Returns: A string owned by @interface_ or %NULL if @interface_ is not exported
 * anywhere. Do not free, the string belongs to @interface_.
880 881
 *
 * Since: 2.30
882 883
 */
const gchar *
884
g_dbus_interface_skeleton_get_object_path (GDBusInterfaceSkeleton *interface_)
885
{
886
  const gchar *ret;
887
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
888
  g_mutex_lock (&interface_->priv->lock);
889
  ret = interface_->priv->object_path;
890
  g_mutex_unlock (&interface_->priv->lock);
891
  return ret;
892 893 894
}

/**
895
 * g_dbus_interface_skeleton_export:
896 897
 * @interface_: The D-Bus interface to export.
 * @connection: A #GDBusConnection to export @interface_ on.
898 899 900
 * @object_path: The path to export the interface at.
 * @error: Return location for error or %NULL.
 *
901
 * Exports @interface_ at @object_path on @connection.
902
 *
903 904 905 906
 * This can be called multiple times to export the same @interface_
 * onto multiple connections however the @object_path provided must be
 * the same for all connections.
 *
907
 * Use g_dbus_interface_skeleton_unexport() to unexport the object.
908
 *
909
 * Returns: %TRUE if the interface was exported on @connection, otherwise %FALSE with
910
 * @error set.
911 912
 *
 * Since: 2.30
913 914
 */
gboolean
915 916 917 918
g_dbus_interface_skeleton_export (GDBusInterfaceSkeleton  *interface_,
                                  GDBusConnection         *connection,
                                  const gchar             *object_path,
                                  GError                 **error)
919
{
920
  gboolean ret = FALSE;
921

922 923 924 925
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), FALSE);
  g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
  g_return_val_if_fail (g_variant_is_object_path (object_path), FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
926

927 928 929
  /* Assert that the object path is the same for multiple connections here */
  g_return_val_if_fail (interface_->priv->object_path == NULL ||
                        g_strcmp0 (interface_->priv->object_path, object_path) == 0, FALSE);
930

931
  g_mutex_lock (&interface_->priv->lock);
932

933 934
  /* Set the object path */
  set_object_path_locked (interface_, object_path);
935

936 937
  /* Add the connection */
  ret = add_connection_locked (interface_, connection, error);
938

939
  g_mutex_unlock (&interface_->priv->lock);
940 941 942 943
  return ret;
}

/**
944 945
 * g_dbus_interface_skeleton_unexport:
 * @interface_: A #GDBusInterfaceSkeleton.
946
 *
947 948 949
 * Stops exporting @interface_ on all connections it is exported on.
 *
 * To unexport @interface_ from only a single connection, use
950
 * g_dbus_interface_skeleton_unexport_from_connection()
951 952
 *
 * Since: 2.30
953 954
 */
void
955
g_dbus_interface_skeleton_unexport (GDBusInterfaceSkeleton *interface_)
956
{
957
  g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_));
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
  g_return_if_fail (interface_->priv->connections != NULL);

  g_mutex_lock (&interface_->priv->lock);

  g_assert (interface_->priv->object_path != NULL);
  g_assert (interface_->priv->hooked_vtable != NULL);

  /* Remove all connections */
  while (interface_->priv->connections != NULL)
    {
      ConnectionData *data = interface_->priv->connections->data;
      remove_connection_locked (interface_, data->connection);
    }

  /* Unset the object path since there are no connections left */
  set_object_path_locked (interface_, NULL);

  g_mutex_unlock (&interface_->priv->lock);
}


/**
 * g_dbus_interface_skeleton_unexport_from_connection:
 * @interface_: A #GDBusInterfaceSkeleton.
 * @connection: A #GDBusConnection.
 *
 * Stops exporting @interface_ on @connection.
 *
 * To stop exporting on all connections the interface is exported on,
 * use g_dbus_interface_skeleton_unexport().
 *
 * Since: 2.32
 */
void
g_dbus_interface_skeleton_unexport_from_connection (GDBusInterfaceSkeleton *interface_,
                                                    GDBusConnection        *connection)
{
  g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_));
  g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
  g_return_if_fail (interface_->priv->connections != NULL);
998

999
  g_mutex_lock (&interface_->priv->lock);
1000

1001 1002 1003
  g_assert (interface_->priv->object_path != NULL);
  g_assert (interface_->priv->hooked_vtable != NULL);

1004
  remove_connection_locked (interface_, connection);
1005

1006 1007 1008
  /* Reset the object path if we removed the last connection */
  if (interface_->priv->connections == NULL)
    set_object_path_locked (interface_, NULL);
1009

1010
  g_mutex_unlock (&interface_->priv->lock);
1011 1012 1013
}

/* ---------------------------------------------------------------------------------------------------- */