1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
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.
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.
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.
20 * Author: David Zeuthen <davidz@redhat.com>
25 #include "gdbusinterface.h"
26 #include "gdbusinterfaceskeleton.h"
27 #include "gdbusobjectskeleton.h"
28 #include "gio-marshal.h"
29 #include "gioenumtypes.h"
30 #include "gdbusprivate.h"
31 #include "gdbusmethodinvocation.h"
32 #include "gdbusconnection.h"
33 #include "gioscheduler.h"
39 * SECTION:gdbusinterfaceskeleton
40 * @short_description: Service-side D-Bus interface
43 * Abstract base class for D-Bus interfaces on the service side.
46 struct _GDBusInterfaceSkeletonPrivate
49 GDBusInterfaceSkeletonFlags flags;
50 guint registration_id;
52 GDBusConnection *connection;
54 GDBusInterfaceVTable *hooked_vtable;
59 G_AUTHORIZE_METHOD_SIGNAL,
69 static guint signals[LAST_SIGNAL] = {0};
71 static void dbus_interface_interface_init (GDBusInterfaceIface *iface);
73 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GDBusInterfaceSkeleton, g_dbus_interface_skeleton, G_TYPE_OBJECT,
74 G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_INTERFACE, dbus_interface_interface_init));
77 g_dbus_interface_skeleton_finalize (GObject *object)
79 GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object);
80 /* unexport if already exported */
81 if (interface->priv->registration_id > 0)
82 g_dbus_interface_skeleton_unexport (interface);
84 g_assert (interface->priv->connection == NULL);
85 g_assert (interface->priv->object_path == NULL);
86 g_assert (interface->priv->hooked_vtable == NULL);
88 if (interface->priv->object != NULL)
89 g_object_remove_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object);
90 G_OBJECT_CLASS (g_dbus_interface_skeleton_parent_class)->finalize (object);
94 g_dbus_interface_skeleton_get_property (GObject *object,
99 GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object);
104 g_value_set_flags (value, g_dbus_interface_skeleton_get_flags (interface));
108 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
114 g_dbus_interface_skeleton_set_property (GObject *object,
119 GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object);
124 g_dbus_interface_skeleton_set_flags (interface, g_value_get_flags (value));
128 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
134 g_dbus_interface_skeleton_g_authorize_method_default (GDBusInterfaceSkeleton *interface,
135 GDBusMethodInvocation *invocation)
141 g_dbus_interface_skeleton_class_init (GDBusInterfaceSkeletonClass *klass)
143 GObjectClass *gobject_class;
145 gobject_class = G_OBJECT_CLASS (klass);
146 gobject_class->finalize = g_dbus_interface_skeleton_finalize;
147 gobject_class->set_property = g_dbus_interface_skeleton_set_property;
148 gobject_class->get_property = g_dbus_interface_skeleton_get_property;
150 klass->g_authorize_method = g_dbus_interface_skeleton_g_authorize_method_default;
153 * GDBusInterfaceSkeleton:g-flags:
155 * Flags from the #GDBusInterfaceSkeletonFlags enumeration.
159 g_object_class_install_property (gobject_class,
161 g_param_spec_flags ("g-flags",
163 "Flags for the interface skeleton",
164 G_TYPE_DBUS_INTERFACE_SKELETON_FLAGS,
165 G_DBUS_INTERFACE_SKELETON_FLAGS_NONE,
168 G_PARAM_STATIC_STRINGS));
171 * GDBusInterfaceSkeleton::g-authorize-method:
172 * @interface: The #GDBusInterfaceSkeleton emitting the signal.
173 * @invocation: A #GDBusMethodInvocation.
175 * Emitted when a method is invoked by a remote caller and used to
176 * determine if the method call is authorized.
178 * Note that this signal is emitted in a thread dedicated to
179 * handling the method call so handlers are allowed to perform
180 * blocking IO. This means that it is appropriate to call
182 * url="http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#polkit-authority-check-authorization-sync">polkit_authority_check_authorization_sync()</ulink>
184 * 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.
186 * If %FALSE is returned then no further handlers are run and the
187 * signal handler must take a reference to @invocation and finish
188 * handling the call (e.g. return an error via
189 * g_dbus_method_invocation_return_error()).
191 * Otherwise, if %TRUE is returned, signal emission continues. If no
192 * handlers return %FALSE, then the method is dispatched. If
193 * @interface has an enclosing #GDBusObjectSkeleton, then the
194 * #GDBusObjectSkeleton::authorize-method signal handlers run before
195 * the handlers for this signal.
197 * The default class handler just returns %TRUE.
199 * Please note that the common case is optimized: if no signals
200 * handlers are connected and the default class handler isn't
201 * overridden (for both @interface and the enclosing
202 * #GDBusObjectSkeleton, if any) and #GDBusInterfaceSkeleton:g-flags does
204 * %G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD
205 * flags set, no dedicated thread is ever used and the call will be
206 * handled in the same thread as the object that @interface belongs
207 * to was exported in.
209 * Returns: %TRUE if the call is authorized, %FALSE otherwise.
213 signals[G_AUTHORIZE_METHOD_SIGNAL] =
214 g_signal_new ("g-authorize-method",
215 G_TYPE_DBUS_INTERFACE_SKELETON,
217 G_STRUCT_OFFSET (GDBusInterfaceSkeletonClass, g_authorize_method),
218 _g_signal_accumulator_false_handled,
220 _gio_marshal_BOOLEAN__OBJECT,
223 G_TYPE_DBUS_METHOD_INVOCATION);
225 g_type_class_add_private (klass, sizeof (GDBusInterfaceSkeletonPrivate));
229 g_dbus_interface_skeleton_init (GDBusInterfaceSkeleton *interface)
231 interface->priv = G_TYPE_INSTANCE_GET_PRIVATE (interface, G_TYPE_DBUS_INTERFACE_SKELETON, GDBusInterfaceSkeletonPrivate);
234 /* ---------------------------------------------------------------------------------------------------- */
237 * g_dbus_interface_skeleton_get_flags:
238 * @interface_: A #GDBusInterfaceSkeleton.
240 * Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior
243 * Returns: One or more flags from the #GDBusInterfaceSkeletonFlags enumeration.
247 GDBusInterfaceSkeletonFlags
248 g_dbus_interface_skeleton_get_flags (GDBusInterfaceSkeleton *interface_)
250 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), G_DBUS_INTERFACE_SKELETON_FLAGS_NONE);
251 return interface_->priv->flags;
255 * g_dbus_interface_skeleton_set_flags:
256 * @interface_: A #GDBusInterfaceSkeleton.
257 * @flags: Flags from the #GDBusInterfaceSkeletonFlags enumeration.
259 * Sets flags describing what the behavior of @skeleton should be.
264 g_dbus_interface_skeleton_set_flags (GDBusInterfaceSkeleton *interface_,
265 GDBusInterfaceSkeletonFlags flags)
267 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_));
268 if (interface_->priv->flags != flags)
270 interface_->priv->flags = flags;
271 g_object_notify (G_OBJECT (interface_), "g-flags");
276 * g_dbus_interface_skeleton_get_info:
277 * @interface_: A #GDBusInterfaceSkeleton.
279 * Gets D-Bus introspection information for the D-Bus interface
280 * implemented by @interface_.
282 * Returns: (transfer none): A #GDBusInterfaceInfo (never %NULL). Do not free.
287 g_dbus_interface_skeleton_get_info (GDBusInterfaceSkeleton *interface_)
289 GDBusInterfaceInfo *ret;
290 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
291 ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_info (interface_);
292 g_warn_if_fail (ret != NULL);
297 * g_dbus_interface_skeleton_get_vtable: (skip)
298 * @interface_: A #GDBusInterfaceSkeleton.
300 * Gets the interface vtable for the D-Bus interface implemented by
301 * @interface_. The returned function pointers should expect @interface_
302 * itself to be passed as @user_data.
304 * Returns: A #GDBusInterfaceVTable (never %NULL).
308 GDBusInterfaceVTable *
309 g_dbus_interface_skeleton_get_vtable (GDBusInterfaceSkeleton *interface_)
311 GDBusInterfaceVTable *ret;
312 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
313 ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_vtable (interface_);
314 g_warn_if_fail (ret != NULL);
319 * g_dbus_interface_skeleton_get_properties:
320 * @interface_: A #GDBusInterfaceSkeleton.
322 * Gets all D-Bus properties for @interface_.
324 * Returns: A new, floating, #GVariant of type <link linkend="G-VARIANT-TYPE-VARDICT:CAPS">'a{sv}'</link>. Free with g_variant_unref().
329 g_dbus_interface_skeleton_get_properties (GDBusInterfaceSkeleton *interface_)
332 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
333 ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_properties (interface_);
334 g_warn_if_fail (g_variant_is_floating (ret));
339 * g_dbus_interface_skeleton_flush:
340 * @interface_: A #GDBusInterfaceSkeleton.
342 * If @interface_ has outstanding changes, request for these changes to be
343 * emitted immediately.
345 * For example, an exported D-Bus interface may queue up property
346 * changes and emit the
347 * <literal>org.freedesktop.DBus.Properties::PropertiesChanged</literal>
348 * signal later (e.g. in an idle handler). This technique is useful
349 * for collapsing multiple property changes into one.
354 g_dbus_interface_skeleton_flush (GDBusInterfaceSkeleton *interface_)
356 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_));
357 G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->flush (interface_);
360 /* ---------------------------------------------------------------------------------------------------- */
362 static GDBusInterfaceInfo *
363 _g_dbus_interface_skeleton_get_info (GDBusInterface *interface_)
365 GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_);
366 return g_dbus_interface_skeleton_get_info (interface);
370 g_dbus_interface_skeleton_get_object (GDBusInterface *interface_)
372 GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_);
373 return interface->priv->object;
377 g_dbus_interface_skeleton_set_object (GDBusInterface *interface_,
380 GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_);
381 if (interface->priv->object != NULL)
382 g_object_remove_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object);
383 interface->priv->object = object;
385 g_object_add_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object);
389 dbus_interface_interface_init (GDBusInterfaceIface *iface)
391 iface->get_info = _g_dbus_interface_skeleton_get_info;
392 iface->get_object = g_dbus_interface_skeleton_get_object;
393 iface->set_object = g_dbus_interface_skeleton_set_object;
396 /* ---------------------------------------------------------------------------------------------------- */
400 volatile gint ref_count;
401 GDBusInterfaceSkeleton *interface;
402 GDBusInterfaceMethodCallFunc method_call_func;
403 GDBusMethodInvocation *invocation;
404 GMainContext *context;
408 dispatch_data_unref (DispatchData *data)
410 if (g_atomic_int_dec_and_test (&data->ref_count))
412 if (data->context != NULL)
413 g_main_context_unref (data->context);
418 static DispatchData *
419 dispatch_data_ref (DispatchData *data)
421 g_atomic_int_inc (&data->ref_count);
426 dispatch_invoke_in_context_func (gpointer user_data)
428 DispatchData *data = user_data;
429 data->method_call_func (g_dbus_method_invocation_get_connection (data->invocation),
430 g_dbus_method_invocation_get_sender (data->invocation),
431 g_dbus_method_invocation_get_object_path (data->invocation),
432 g_dbus_method_invocation_get_interface_name (data->invocation),
433 g_dbus_method_invocation_get_method_name (data->invocation),
434 g_dbus_method_invocation_get_parameters (data->invocation),
436 g_dbus_method_invocation_get_user_data (data->invocation));
441 dispatch_in_thread_func (GIOSchedulerJob *job,
442 GCancellable *cancellable,
445 DispatchData *data = user_data;
448 /* first check on the enclosing object (if any), then the interface */
450 if (data->interface->priv->object != NULL)
452 g_signal_emit_by_name (data->interface->priv->object,
460 g_signal_emit (data->interface,
461 signals[G_AUTHORIZE_METHOD_SIGNAL],
469 gboolean run_in_thread;
470 run_in_thread = (data->interface->priv->flags & G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD);
473 /* might as well just re-use the existing thread */
474 data->method_call_func (g_dbus_method_invocation_get_connection (data->invocation),
475 g_dbus_method_invocation_get_sender (data->invocation),
476 g_dbus_method_invocation_get_object_path (data->invocation),
477 g_dbus_method_invocation_get_interface_name (data->invocation),
478 g_dbus_method_invocation_get_method_name (data->invocation),
479 g_dbus_method_invocation_get_parameters (data->invocation),
481 g_dbus_method_invocation_get_user_data (data->invocation));
485 /* bah, back to original context */
486 g_main_context_invoke_full (data->context,
488 dispatch_invoke_in_context_func,
489 dispatch_data_ref (data),
490 (GDestroyNotify) dispatch_data_unref);
502 g_dbus_interface_method_dispatch_helper (GDBusInterfaceSkeleton *interface,
503 GDBusInterfaceMethodCallFunc method_call_func,
504 GDBusMethodInvocation *invocation)
506 gboolean has_handlers;
507 gboolean has_default_class_handler;
508 gboolean emit_authorized_signal;
509 gboolean run_in_thread;
511 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface));
512 g_return_if_fail (method_call_func != NULL);
513 g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));
515 /* optimization for the common case where
517 * a) no handler is connected and class handler is not overridden (both interface and object); and
518 * b) method calls are not dispatched in a thread
520 has_handlers = g_signal_has_handler_pending (interface,
521 signals[G_AUTHORIZE_METHOD_SIGNAL],
524 has_default_class_handler = (G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface)->g_authorize_method ==
525 g_dbus_interface_skeleton_g_authorize_method_default);
527 emit_authorized_signal = (has_handlers || !has_default_class_handler);
528 if (!emit_authorized_signal)
530 if (interface->priv->object != NULL)
531 emit_authorized_signal = _g_dbus_object_skeleton_has_authorize_method_handlers (G_DBUS_OBJECT_SKELETON (interface->priv->object));
534 run_in_thread = (interface->priv->flags & G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD);
535 if (!emit_authorized_signal && !run_in_thread)
537 method_call_func (g_dbus_method_invocation_get_connection (invocation),
538 g_dbus_method_invocation_get_sender (invocation),
539 g_dbus_method_invocation_get_object_path (invocation),
540 g_dbus_method_invocation_get_interface_name (invocation),
541 g_dbus_method_invocation_get_method_name (invocation),
542 g_dbus_method_invocation_get_parameters (invocation),
544 g_dbus_method_invocation_get_user_data (invocation));
549 data = g_new0 (DispatchData, 1);
550 data->interface = interface;
551 data->method_call_func = method_call_func;
552 data->invocation = invocation;
553 data->context = g_main_context_get_thread_default ();
555 if (data->context != NULL)
556 g_main_context_ref (data->context);
557 g_io_scheduler_push_job (dispatch_in_thread_func,
559 (GDestroyNotify) dispatch_data_unref,
561 NULL); /* GCancellable* */
566 skeleton_intercept_handle_method_call (GDBusConnection *connection,
568 const gchar *object_path,
569 const gchar *interface_name,
570 const gchar *method_name,
571 GVariant *parameters,
572 GDBusMethodInvocation *invocation,
575 GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (user_data);
576 g_dbus_interface_method_dispatch_helper (interface,
577 g_dbus_interface_skeleton_get_vtable (interface)->method_call,
581 /* ---------------------------------------------------------------------------------------------------- */
584 * g_dbus_interface_skeleton_get_connection:
585 * @interface_: A #GDBusInterfaceSkeleton.
587 * Gets the connection that @interface_ is exported on, if any.
589 * Returns: (transfer none): A #GDBusConnection or %NULL if @interface_ is
590 * not exported anywhere. Do not free, the object belongs to @interface_.
595 g_dbus_interface_skeleton_get_connection (GDBusInterfaceSkeleton *interface_)
597 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
598 return interface_->priv->connection;
602 * g_dbus_interface_skeleton_get_object_path:
603 * @interface_: A #GDBusInterfaceSkeleton.
605 * Gets the object path that @interface_ is exported on, if any.
607 * Returns: A string owned by @interface_ or %NULL if @interface_ is not exported
608 * anywhere. Do not free, the string belongs to @interface_.
613 g_dbus_interface_skeleton_get_object_path (GDBusInterfaceSkeleton *interface_)
615 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL);
616 return interface_->priv->object_path;
620 * g_dbus_interface_skeleton_export:
621 * @interface_: The D-Bus interface to export.
622 * @connection: A #GDBusConnection to export @interface_ on.
623 * @object_path: The path to export the interface at.
624 * @error: Return location for error or %NULL.
626 * Exports @interface_ at @object_path on @connection.
628 * Use g_dbus_interface_skeleton_unexport() to unexport the object.
630 * Returns: %TRUE if the interface was exported, other %FALSE with
636 g_dbus_interface_skeleton_export (GDBusInterfaceSkeleton *interface_,
637 GDBusConnection *connection,
638 const gchar *object_path,
643 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), 0);
644 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
645 g_return_val_if_fail (g_variant_is_object_path (object_path), 0);
646 g_return_val_if_fail (error == NULL || *error == NULL, 0);
649 if (interface_->priv->registration_id > 0)
651 g_set_error_literal (error,
653 G_IO_ERROR_FAILED, /* TODO: new error code */
654 "The object is already exported");
658 g_assert (interface_->priv->connection == NULL);
659 g_assert (interface_->priv->object_path == NULL);
660 g_assert (interface_->priv->hooked_vtable == NULL);
662 /* Hook the vtable since we need to intercept method calls for
663 * ::g-authorize-method and for dispatching in thread vs
666 interface_->priv->hooked_vtable = g_memdup (g_dbus_interface_skeleton_get_vtable (interface_), sizeof (GDBusInterfaceVTable));
667 interface_->priv->hooked_vtable->method_call = skeleton_intercept_handle_method_call;
669 interface_->priv->connection = g_object_ref (connection);
670 interface_->priv->object_path = g_strdup (object_path);
671 interface_->priv->registration_id = g_dbus_connection_register_object (connection,
673 g_dbus_interface_skeleton_get_info (interface_),
674 interface_->priv->hooked_vtable,
676 NULL, /* user_data_free_func */
678 if (interface_->priv->registration_id == 0)
688 * g_dbus_interface_skeleton_unexport:
689 * @interface_: A #GDBusInterfaceSkeleton.
691 * Stops exporting an interface previously exported with
692 * g_dbus_interface_skeleton_export().
697 g_dbus_interface_skeleton_unexport (GDBusInterfaceSkeleton *interface_)
699 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_));
700 g_return_if_fail (interface_->priv->registration_id > 0);
702 g_assert (interface_->priv->connection != NULL);
703 g_assert (interface_->priv->object_path != NULL);
704 g_assert (interface_->priv->hooked_vtable != NULL);
706 g_warn_if_fail (g_dbus_connection_unregister_object (interface_->priv->connection,
707 interface_->priv->registration_id));
709 g_object_unref (interface_->priv->connection);
710 g_free (interface_->priv->object_path);
711 interface_->priv->connection = NULL;
712 interface_->priv->object_path = NULL;
713 interface_->priv->hooked_vtable = NULL;
714 interface_->priv->registration_id = 0;
717 /* ---------------------------------------------------------------------------------------------------- */