summaryrefslogtreecommitdiff
path: root/src/gdbusinterfacestub.c
blob: b573c489e1573d80321bf45ee3cc2c21c98fe8f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
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
/* 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
 * version 2 of the License, or (at your option) any later version.
 *
 * 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
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: David Zeuthen <davidz@redhat.com>
 */

#include "config.h"

#include "gdbusinterfacestub.h"
#include "gdbusobjectstub.h"
#include "gdbuscodegen-marshal.h"
#include "gdbuscodegen-enumtypes.h"
#include "gdbuscodegenprivate.h"

/**
 * SECTION:gdbusinterfacestub
 * @short_description: Service-side D-Bus interface
 * @include: gio/gio.h
 *
 * Abstract base class for D-Bus interfaces on the service side.
 */

struct _GDBusInterfaceStubPrivate
{
  GDBusObject *object;
  GDBusInterfaceStubFlags flags;
  guint registration_id;

  GDBusConnection *connection;
  gchar *object_path;
  GDBusInterfaceVTable *hooked_vtable;
};

enum
{
  G_AUTHORIZE_METHOD_SIGNAL,
  LAST_SIGNAL
};

enum
{
  PROP_0,
  PROP_G_FLAGS
};

static guint signals[LAST_SIGNAL] = {0};

static void dbus_interface_interface_init (GDBusInterfaceIface *iface);

G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GDBusInterfaceStub, g_dbus_interface_stub, G_TYPE_OBJECT,
                                  G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_INTERFACE, dbus_interface_interface_init));

static void
g_dbus_interface_stub_finalize (GObject *object)
{
  GDBusInterfaceStub *stub = G_DBUS_INTERFACE_STUB (object);
  /* unexport if already exported */
  if (stub->priv->registration_id > 0)
    g_dbus_interface_stub_unexport (stub);

  g_assert (stub->priv->connection == NULL);
  g_assert (stub->priv->object_path == NULL);
  g_assert (stub->priv->hooked_vtable == NULL);

  if (stub->priv->object != NULL)
    g_object_remove_weak_pointer (G_OBJECT (stub->priv->object), (gpointer *) &stub->priv->object);
  G_OBJECT_CLASS (g_dbus_interface_stub_parent_class)->finalize (object);
}

static void
g_dbus_interface_stub_get_property (GObject      *object,
                                    guint         prop_id,
                                    GValue       *value,
                                    GParamSpec   *pspec)
{
  GDBusInterfaceStub *stub = G_DBUS_INTERFACE_STUB (object);

  switch (prop_id)
    {
    case PROP_G_FLAGS:
      g_value_set_flags (value, g_dbus_interface_stub_get_flags (stub));
      break;

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

static void
g_dbus_interface_stub_set_property (GObject      *object,
                                    guint         prop_id,
                                    const GValue *value,
                                    GParamSpec   *pspec)
{
  GDBusInterfaceStub *stub = G_DBUS_INTERFACE_STUB (object);

  switch (prop_id)
    {
    case PROP_G_FLAGS:
      g_dbus_interface_stub_set_flags (stub, g_value_get_flags (value));
      break;

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

gboolean
_g_signal_accumulator_false_handled (GSignalInvocationHint *ihint,
                                     GValue                *return_accu,
                                     const GValue          *handler_return,
                                     gpointer               dummy)
{
  gboolean continue_emission;
  gboolean signal_return;

  signal_return = g_value_get_boolean (handler_return);
  g_value_set_boolean (return_accu, signal_return);
  continue_emission = signal_return;

  return continue_emission;
}

static gboolean
g_dbus_interface_stub_g_authorize_method_default (GDBusInterfaceStub    *stub,
                                                  GDBusMethodInvocation *invocation)
{
  return TRUE;
}

static void
g_dbus_interface_stub_class_init (GDBusInterfaceStubClass *klass)
{
  GObjectClass *gobject_class;

  gobject_class = G_OBJECT_CLASS (klass);
  gobject_class->finalize     = g_dbus_interface_stub_finalize;
  gobject_class->set_property = g_dbus_interface_stub_set_property;
  gobject_class->get_property = g_dbus_interface_stub_get_property;

  klass->g_authorize_method = g_dbus_interface_stub_g_authorize_method_default;

  /**
   * GDBusInterfaceStub:g-flags:
   *
   * Flags from the #GDBusInterfaceStubFlags enumeration.
   */
  g_object_class_install_property (gobject_class,
                                   PROP_G_FLAGS,
                                   g_param_spec_flags ("g-flags",
                                                       "g-flags",
                                                       "Flags for the interface stub",
                                                       G_TYPE_DBUS_INTERFACE_STUB_FLAGS,
                                                       G_DBUS_INTERFACE_STUB_FLAGS_NONE,
                                                       G_PARAM_READABLE |
                                                       G_PARAM_WRITABLE |
                                                       G_PARAM_STATIC_STRINGS));

  /**
   * GDBusInterfaceStub::g-authorize-method:
   * @interface: The #GDBusInterfaceStub emitting the signal.
   * @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
   * blocking IO. This means that it is appropriate to call
   * e.g. <ulink
   * url="http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#polkit-authority-check-authorization-sync">polkit_authority_check_authorization_sync()</ulink>
   * with the <ulink
   * url="http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#POLKIT-CHECK-AUTHORIZATION-FLAGS-ALLOW-USER-INTERACTION:CAPS">POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION</ulink> flag set.
   *
   * If %FALSE is returned then no further handlers are run and the
   * signal handler must take ownership of @invocation and finish
   * 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
   * @interface has an enclosing #GDBusObjectStub, then the
   * #GDBusObjectStub::authorize-method signal handlers run before the
   * handlers for this signal.
   *
   * 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
   * #GDBusObjectStub, if any) and #GDBusInterfaceStub:g-flags does
   * not have the
   * %G_DBUS_INTERFACE_STUB_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD
   * 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.
   */
  signals[G_AUTHORIZE_METHOD_SIGNAL] =
    g_signal_new ("g-authorize-method",
                  G_TYPE_DBUS_INTERFACE_STUB,
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GDBusInterfaceStubClass, g_authorize_method),
                  _g_signal_accumulator_false_handled,
                  NULL,
                  _gdbuscodegen_marshal_BOOL__OBJECT,
                  G_TYPE_BOOLEAN,
                  1,
                  G_TYPE_DBUS_METHOD_INVOCATION);

  g_type_class_add_private (klass, sizeof (GDBusInterfaceStubPrivate));
}

static void
g_dbus_interface_stub_init (GDBusInterfaceStub *stub)
{
  stub->priv = G_TYPE_INSTANCE_GET_PRIVATE (stub, G_TYPE_DBUS_INTERFACE_STUB, GDBusInterfaceStubPrivate);
}

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

/**
 * g_dbus_interface_stub_get_flags:
 * @stub: A #GDBusInterfaceStub.
 *
 * Gets the #GDBusInterfaceStubFlags that describes what the behavior
 * of @stub
 *
 * Returns: One or more flags from the #GDBusInterfaceStubFlags enumeration.
 */
GDBusInterfaceStubFlags
g_dbus_interface_stub_get_flags (GDBusInterfaceStub  *stub)
{
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_STUB (stub), G_DBUS_INTERFACE_STUB_FLAGS_NONE);
  return stub->priv->flags;
}

/**
 * g_dbus_interface_stub_set_flags:
 * @stub: A #GDBusInterfaceStub.
 * @flags: Flags from the #GDBusInterfaceStubFlags enumeration.
 *
 * Sets flags describing what the behavior of @stub should be.
 */
void
g_dbus_interface_stub_set_flags (GDBusInterfaceStub      *stub,
                                 GDBusInterfaceStubFlags  flags)
{
  g_return_if_fail (G_IS_DBUS_INTERFACE_STUB (stub));
  if (stub->priv->flags != flags)
    {
      stub->priv->flags = flags;
      g_object_notify (G_OBJECT (stub), "g-flags");
    }
}

/**
 * g_dbus_interface_stub_get_info:
 * @stub: A #GDBusInterfaceStub.
 *
 * Gets D-Bus introspection information for the D-Bus interface
 * implemented by @interface.
 *
 * Returns: (transfer none): A #GDBusInterfaceInfo (never %NULL). Do not free.
 */
GDBusInterfaceInfo *
g_dbus_interface_stub_get_info (GDBusInterfaceStub *stub)
{
  GDBusInterfaceInfo *ret;
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_STUB (stub), NULL);
  ret = G_DBUS_INTERFACE_STUB_GET_CLASS (stub)->get_info (stub);
  g_warn_if_fail (ret != NULL);
  return ret;
}

/**
 * g_dbus_interface_stub_get_vtable:
 * @stub: A #GDBusInterfaceStub.
 *
 * Gets the interface vtable for the D-Bus interface implemented by
 * @interface. The returned function pointers should expect @stub
 * itself to be passed as @user_data.
 *
 * Returns: A #GDBusInterfaceVTable (never %NULL).
 */
GDBusInterfaceVTable *
g_dbus_interface_stub_get_vtable (GDBusInterfaceStub *stub)
{
  GDBusInterfaceVTable *ret;
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_STUB (stub), NULL);
  ret = G_DBUS_INTERFACE_STUB_GET_CLASS (stub)->get_vtable (stub);
  g_warn_if_fail (ret != NULL);
  return ret;
}

/**
 * g_dbus_interface_stub_get_properties:
 * @stub: A #GDBusInterfaceStub.
 *
 * Gets all D-Bus properties for @stub.
 *
 * Returns: A new, floating, #GVariant. Free with g_variant_unref().
 */
GVariant *
g_dbus_interface_stub_get_properties (GDBusInterfaceStub *stub)
{
  GVariant *ret;
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_STUB (stub), NULL);
  ret = G_DBUS_INTERFACE_STUB_GET_CLASS (stub)->get_properties (stub);
  g_warn_if_fail (g_variant_is_floating (ret));
  return ret;
}

/**
 * g_dbus_interface_stub_flush:
 * @stub: A #GDBusInterfaceStub.
 *
 * If @stub has outstanding changes, request for these changes to be
 * emitted immediately.
 *
 * For example, an exported D-Bus interface may queue up property
 * changes and emit the
 * <literal>org.freedesktop.DBus.Properties::PropertiesChanged</literal>
 * signal later (e.g. in an idle handler). This technique is useful
 * for collapsing multiple property changes into one.
 */
void
g_dbus_interface_stub_flush (GDBusInterfaceStub *stub)
{
  g_return_if_fail (G_IS_DBUS_INTERFACE_STUB (stub));
  G_DBUS_INTERFACE_STUB_GET_CLASS (stub)->flush (stub);
}

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

static GDBusInterfaceInfo *
_g_dbus_interface_stub_get_info (GDBusInterface *interface)
{
  GDBusInterfaceStub *stub = G_DBUS_INTERFACE_STUB (interface);
  return g_dbus_interface_stub_get_info (stub);
}

static GDBusObject *
g_dbus_interface_stub_get_object (GDBusInterface *interface)
{
  GDBusInterfaceStub *stub = G_DBUS_INTERFACE_STUB (interface);
  return stub->priv->object;
}

static void
g_dbus_interface_stub_set_object (GDBusInterface *interface,
                                  GDBusObject    *object)
{
  GDBusInterfaceStub *stub = G_DBUS_INTERFACE_STUB (interface);
  if (stub->priv->object != NULL)
    g_object_remove_weak_pointer (G_OBJECT (stub->priv->object), (gpointer *) &stub->priv->object);
  stub->priv->object = object;
  if (object != NULL)
    g_object_add_weak_pointer (G_OBJECT (stub->priv->object), (gpointer *) &stub->priv->object);
}

static void
dbus_interface_interface_init (GDBusInterfaceIface *iface)
{
  iface->get_info = _g_dbus_interface_stub_get_info;
  iface->get_object  = g_dbus_interface_stub_get_object;
  iface->set_object  = g_dbus_interface_stub_set_object;
}

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

typedef struct
{
  volatile gint ref_count;
  GDBusInterfaceStub           *stub;
  GDBusInterfaceMethodCallFunc  method_call_func;
  GDBusMethodInvocation        *invocation;
  GMainContext                 *context;
} DispatchData;

static void
dispatch_data_unref (DispatchData *data)
{
  if (g_atomic_int_dec_and_test (&data->ref_count))
    {
      if (data->context != NULL)
        g_main_context_unref (data->context);
      g_free (data);
    }
}

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;
}

static gboolean
dispatch_in_thread_func (GIOSchedulerJob *job,
                         GCancellable    *cancellable,
                         gpointer         user_data)
{
  DispatchData *data = user_data;
  gboolean authorized;

  /* first check on the enclosing object (if any), then the interface */
  authorized = TRUE;
  if (data->stub->priv->object != NULL)
    {
      g_signal_emit_by_name (data->stub->priv->object,
                             "authorize-method",
                             data->stub,
                             data->invocation,
                             &authorized);
    }
  if (authorized)
    {
      g_signal_emit (data->stub,
                     signals[G_AUTHORIZE_METHOD_SIGNAL],
                     0,
                     data->invocation,
                     &authorized);
    }

  if (authorized)
    {
      gboolean run_in_thread;
      run_in_thread = (data->stub->priv->flags & G_DBUS_INTERFACE_STUB_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD);
      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 */
          g_main_context_invoke_full (data->context,
                                      G_PRIORITY_DEFAULT,
                                      dispatch_invoke_in_context_func,
                                      dispatch_data_ref (data),
                                      (GDestroyNotify) dispatch_data_unref);
        }
    }
  else
    {
      /* do nothing */
    }

  return FALSE;
}

static void
g_dbus_interface_method_dispatch_helper (GDBusInterfaceStub           *stub,
                                         GDBusInterfaceMethodCallFunc  method_call_func,
                                         GDBusMethodInvocation        *invocation)
{
  gboolean has_handlers;
  gboolean has_default_class_handler;
  gboolean emit_authorized_signal;
  gboolean run_in_thread;

  g_return_if_fail (G_IS_DBUS_INTERFACE_STUB (stub));
  g_return_if_fail (method_call_func != NULL);
  g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));

  /* 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
   */
  has_handlers = g_signal_has_handler_pending (stub,
                                               signals[G_AUTHORIZE_METHOD_SIGNAL],
                                               0,
                                               TRUE);
  has_default_class_handler = (G_DBUS_INTERFACE_STUB_GET_CLASS (stub)->g_authorize_method ==
                               g_dbus_interface_stub_g_authorize_method_default);

  emit_authorized_signal = (has_handlers || !has_default_class_handler);
  if (!emit_authorized_signal)
    {
      if (stub->priv->object != NULL)
        emit_authorized_signal = _g_dbus_object_stub_has_authorize_method_handlers (G_DBUS_OBJECT_STUB (stub->priv->object));
    }

  run_in_thread = (stub->priv->flags & G_DBUS_INTERFACE_STUB_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD);
  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
    {
      DispatchData *data;
      data = g_new0 (DispatchData, 1);
      data->stub = stub;
      data->method_call_func = method_call_func;
      data->invocation = invocation;
      data->context = g_main_context_get_thread_default ();
      data->ref_count = 1;
      if (data->context != NULL)
        g_main_context_ref (data->context);
      g_io_scheduler_push_job (dispatch_in_thread_func,
                               data,
                               (GDestroyNotify) dispatch_data_unref,
                               G_PRIORITY_DEFAULT,
                               NULL); /* GCancellable* */
    }
}

static void
stub_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)
{
  GDBusInterfaceStub *stub = G_DBUS_INTERFACE_STUB (user_data);
  g_dbus_interface_method_dispatch_helper (stub,
                                           g_dbus_interface_stub_get_vtable (stub)->method_call,
                                           invocation);
}

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

/**
 * g_dbus_interface_stub_get_connection:
 * @stub: A #GDBusInterfaceStub.
 *
 * Gets the connection that @stub is exported on, if any.
 *
 * Returns: (transfer none): A #GDBusConnection or %NULL if @stub is
 * not exported anywhere. Do not free, the object belongs to @stub.
 */
GDBusConnection *
g_dbus_interface_stub_get_connection (GDBusInterfaceStub *stub)
{
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_STUB (stub), NULL);
  return stub->priv->connection;
}

/**
 * g_dbus_interface_stub_get_object_path:
 * @stub: A #GDBusInterfaceStub.
 *
 * Gets the object that that @stub is exported on, if any.
 *
 * Returns: A string owned by @stub or %NULL if stub is not exported
 * anywhere. Do not free, the string belongs to @stub.
 */
const gchar *
g_dbus_interface_stub_get_object_path (GDBusInterfaceStub *stub)
{
  g_return_val_if_fail (G_IS_DBUS_INTERFACE_STUB (stub), NULL);
  return stub->priv->object_path;
}

/**
 * g_dbus_interface_stub_export:
 * @stub: The D-Bus interface to export.
 * @connection: A #GDBusConnection to export @stub on.
 * @object_path: The path to export the interface at.
 * @error: Return location for error or %NULL.
 *
 * Exports @stubs at @object_path on @connection.
 *
 * Use g_dbus_interface_stub_unexport() to unexport the object.
 *
 * Returns: %TRUE if the interface was exported, other %FALSE with
 * @error set.
 */
gboolean
g_dbus_interface_stub_export (GDBusInterfaceStub  *stub,
                              GDBusConnection     *connection,
                              const gchar         *object_path,
                              GError             **error)
{
  gboolean ret;

  g_return_val_if_fail (G_IS_DBUS_INTERFACE_STUB (stub), 0);
  g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
  g_return_val_if_fail (g_variant_is_object_path (object_path), 0);
  g_return_val_if_fail (error == NULL || *error == NULL, 0);

  ret = FALSE;
  if (stub->priv->registration_id > 0)
    {
      g_set_error_literal (error,
                           G_IO_ERROR,
                           G_IO_ERROR_FAILED, /* TODO: new error code */
                           "The object is already exported");
      goto out;
    }

  g_assert (stub->priv->connection == NULL);
  g_assert (stub->priv->object_path == NULL);
  g_assert (stub->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
   */
  stub->priv->hooked_vtable = g_memdup (g_dbus_interface_stub_get_vtable (stub), sizeof (GDBusInterfaceVTable));
  stub->priv->hooked_vtable->method_call = stub_intercept_handle_method_call;

  stub->priv->connection = g_object_ref (connection);
  stub->priv->object_path = g_strdup (object_path);
  stub->priv->registration_id = g_dbus_connection_register_object (connection,
                                                                   object_path,
                                                                   g_dbus_interface_stub_get_info (stub),
                                                                   stub->priv->hooked_vtable,
                                                                   stub,
                                                                   NULL, /* user_data_free_func */
                                                                   error);
  if (stub->priv->registration_id == 0)
    goto out;

  ret = TRUE;

 out:
  return ret;
}

/**
 * g_dbus_interface_stub_unexport:
 * @stub: A #GDBusInterfaceStub.
 *
 * Stops exporting an interface previously exported with
 * g_dbus_interface_stub_export().
 */
void
g_dbus_interface_stub_unexport (GDBusInterfaceStub *stub)
{
  g_return_if_fail (G_IS_DBUS_INTERFACE_STUB (stub));
  g_return_if_fail (stub->priv->registration_id > 0);

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

  g_warn_if_fail (g_dbus_connection_unregister_object (stub->priv->connection,
                                                       stub->priv->registration_id));

  g_object_unref (stub->priv->connection);
  g_free (stub->priv->object_path);
  stub->priv->connection = NULL;
  stub->priv->object_path = NULL;
  stub->priv->hooked_vtable = NULL;
  stub->priv->registration_id = 0;
}

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