/* 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 */ #include "config.h" #include "gdbusinterface.h" #include "gdbusinterfaceskeleton.h" #include "gdbusobjectskeleton.h" #include "gioenumtypes.h" #include "gdbusprivate.h" #include "gdbusmethodinvocation.h" #include "gdbusconnection.h" #include "gioscheduler.h" #include "gioerror.h" #include "glibintl.h" /** * SECTION:gdbusinterfaceskeleton * @short_description: Service-side D-Bus interface * @include: gio/gio.h * * Abstract base class for D-Bus interfaces on the service side. */ struct _GDBusInterfaceSkeletonPrivate { GDBusObject *object; GDBusInterfaceSkeletonFlags 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 (GDBusInterfaceSkeleton, g_dbus_interface_skeleton, G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_INTERFACE, dbus_interface_interface_init)); static void g_dbus_interface_skeleton_finalize (GObject *object) { GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object); /* unexport if already exported */ if (interface->priv->registration_id > 0) g_dbus_interface_skeleton_unexport (interface); g_assert (interface->priv->connection == NULL); g_assert (interface->priv->object_path == NULL); g_assert (interface->priv->hooked_vtable == NULL); if (interface->priv->object != NULL) g_object_remove_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object); G_OBJECT_CLASS (g_dbus_interface_skeleton_parent_class)->finalize (object); } static void g_dbus_interface_skeleton_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) { GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object); switch (prop_id) { case PROP_G_FLAGS: g_value_set_flags (value, g_dbus_interface_skeleton_get_flags (interface)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void g_dbus_interface_skeleton_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (object); switch (prop_id) { case PROP_G_FLAGS: g_dbus_interface_skeleton_set_flags (interface, g_value_get_flags (value)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static gboolean g_dbus_interface_skeleton_g_authorize_method_default (GDBusInterfaceSkeleton *interface, GDBusMethodInvocation *invocation) { return TRUE; } static void g_dbus_interface_skeleton_class_init (GDBusInterfaceSkeletonClass *klass) { GObjectClass *gobject_class; gobject_class = G_OBJECT_CLASS (klass); 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; klass->g_authorize_method = g_dbus_interface_skeleton_g_authorize_method_default; /** * GDBusInterfaceSkeleton:g-flags: * * Flags from the #GDBusInterfaceSkeletonFlags enumeration. * * Since: 2.30 */ g_object_class_install_property (gobject_class, PROP_G_FLAGS, g_param_spec_flags ("g-flags", "g-flags", "Flags for the interface skeleton", G_TYPE_DBUS_INTERFACE_SKELETON_FLAGS, G_DBUS_INTERFACE_SKELETON_FLAGS_NONE, G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS)); /** * GDBusInterfaceSkeleton::g-authorize-method: * @interface: The #GDBusInterfaceSkeleton 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. polkit_authority_check_authorization_sync() * with the POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION flag set. * * If %FALSE is returned then no further handlers are run and the * signal handler must take a reference to @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 #GDBusObjectSkeleton, then the * #GDBusObjectSkeleton::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 * #GDBusObjectSkeleton, if any) and #GDBusInterfaceSkeleton:g-flags does * not have the * %G_DBUS_INTERFACE_SKELETON_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. * * Since: 2.30 */ signals[G_AUTHORIZE_METHOD_SIGNAL] = g_signal_new ("g-authorize-method", G_TYPE_DBUS_INTERFACE_SKELETON, G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GDBusInterfaceSkeletonClass, g_authorize_method), _g_signal_accumulator_false_handled, NULL, g_cclosure_marshal_generic, G_TYPE_BOOLEAN, 1, G_TYPE_DBUS_METHOD_INVOCATION); g_type_class_add_private (klass, sizeof (GDBusInterfaceSkeletonPrivate)); } static void g_dbus_interface_skeleton_init (GDBusInterfaceSkeleton *interface) { interface->priv = G_TYPE_INSTANCE_GET_PRIVATE (interface, G_TYPE_DBUS_INTERFACE_SKELETON, GDBusInterfaceSkeletonPrivate); } /* ---------------------------------------------------------------------------------------------------- */ /** * g_dbus_interface_skeleton_get_flags: * @interface_: A #GDBusInterfaceSkeleton. * * Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior * of @interface_ * * Returns: One or more flags from the #GDBusInterfaceSkeletonFlags enumeration. * * Since: 2.30 */ GDBusInterfaceSkeletonFlags g_dbus_interface_skeleton_get_flags (GDBusInterfaceSkeleton *interface_) { g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), G_DBUS_INTERFACE_SKELETON_FLAGS_NONE); return interface_->priv->flags; } /** * g_dbus_interface_skeleton_set_flags: * @interface_: A #GDBusInterfaceSkeleton. * @flags: Flags from the #GDBusInterfaceSkeletonFlags enumeration. * * Sets flags describing what the behavior of @skeleton should be. * * Since: 2.30 */ void g_dbus_interface_skeleton_set_flags (GDBusInterfaceSkeleton *interface_, GDBusInterfaceSkeletonFlags flags) { g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_)); if (interface_->priv->flags != flags) { interface_->priv->flags = flags; g_object_notify (G_OBJECT (interface_), "g-flags"); } } /** * g_dbus_interface_skeleton_get_info: * @interface_: A #GDBusInterfaceSkeleton. * * Gets D-Bus introspection information for the D-Bus interface * implemented by @interface_. * * Returns: (transfer none): A #GDBusInterfaceInfo (never %NULL). Do not free. * * Since: 2.30 */ GDBusInterfaceInfo * g_dbus_interface_skeleton_get_info (GDBusInterfaceSkeleton *interface_) { GDBusInterfaceInfo *ret; g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL); ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_info (interface_); g_warn_if_fail (ret != NULL); return ret; } /** * g_dbus_interface_skeleton_get_vtable: (skip) * @interface_: A #GDBusInterfaceSkeleton. * * Gets the interface vtable for the D-Bus interface implemented by * @interface_. The returned function pointers should expect @interface_ * itself to be passed as @user_data. * * Returns: A #GDBusInterfaceVTable (never %NULL). * * Since: 2.30 */ GDBusInterfaceVTable * g_dbus_interface_skeleton_get_vtable (GDBusInterfaceSkeleton *interface_) { GDBusInterfaceVTable *ret; g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL); ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_vtable (interface_); g_warn_if_fail (ret != NULL); return ret; } /** * g_dbus_interface_skeleton_get_properties: * @interface_: A #GDBusInterfaceSkeleton. * * Gets all D-Bus properties for @interface_. * * Returns: (transfer full): A #GVariant of type 'a{sv}'. Free with g_variant_unref(). * * Since: 2.30 */ GVariant * g_dbus_interface_skeleton_get_properties (GDBusInterfaceSkeleton *interface_) { GVariant *ret; g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL); ret = G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->get_properties (interface_); return g_variant_take_ref (ret); } /** * g_dbus_interface_skeleton_flush: * @interface_: A #GDBusInterfaceSkeleton. * * If @interface_ 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 * org.freedesktop.DBus.Properties::PropertiesChanged * signal later (e.g. in an idle handler). This technique is useful * for collapsing multiple property changes into one. * * Since: 2.30 */ void g_dbus_interface_skeleton_flush (GDBusInterfaceSkeleton *interface_) { g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_)); G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_)->flush (interface_); } /* ---------------------------------------------------------------------------------------------------- */ static GDBusInterfaceInfo * _g_dbus_interface_skeleton_get_info (GDBusInterface *interface_) { GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_); return g_dbus_interface_skeleton_get_info (interface); } static GDBusObject * g_dbus_interface_skeleton_get_object (GDBusInterface *interface_) { GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_); return interface->priv->object; } static void g_dbus_interface_skeleton_set_object (GDBusInterface *interface_, GDBusObject *object) { GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (interface_); if (interface->priv->object != NULL) g_object_remove_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object); interface->priv->object = object; if (object != NULL) g_object_add_weak_pointer (G_OBJECT (interface->priv->object), (gpointer *) &interface->priv->object); } static void dbus_interface_interface_init (GDBusInterfaceIface *iface) { iface->get_info = _g_dbus_interface_skeleton_get_info; iface->get_object = g_dbus_interface_skeleton_get_object; iface->set_object = g_dbus_interface_skeleton_set_object; } /* ---------------------------------------------------------------------------------------------------- */ typedef struct { volatile gint ref_count; GDBusInterfaceSkeleton *interface; 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->interface->priv->object != NULL) { g_signal_emit_by_name (data->interface->priv->object, "authorize-method", data->interface, data->invocation, &authorized); } if (authorized) { g_signal_emit (data->interface, signals[G_AUTHORIZE_METHOD_SIGNAL], 0, data->invocation, &authorized); } if (authorized) { gboolean run_in_thread; run_in_thread = (data->interface->priv->flags & G_DBUS_INTERFACE_SKELETON_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 (GDBusInterfaceSkeleton *interface, 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_SKELETON (interface)); 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 (interface, signals[G_AUTHORIZE_METHOD_SIGNAL], 0, TRUE); has_default_class_handler = (G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface)->g_authorize_method == g_dbus_interface_skeleton_g_authorize_method_default); emit_authorized_signal = (has_handlers || !has_default_class_handler); if (!emit_authorized_signal) { if (interface->priv->object != NULL) emit_authorized_signal = _g_dbus_object_skeleton_has_authorize_method_handlers (G_DBUS_OBJECT_SKELETON (interface->priv->object)); } run_in_thread = (interface->priv->flags & G_DBUS_INTERFACE_SKELETON_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->interface = interface; 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 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) { GDBusInterfaceSkeleton *interface = G_DBUS_INTERFACE_SKELETON (user_data); g_dbus_interface_method_dispatch_helper (interface, g_dbus_interface_skeleton_get_vtable (interface)->method_call, invocation); } /* ---------------------------------------------------------------------------------------------------- */ /** * g_dbus_interface_skeleton_get_connection: * @interface_: A #GDBusInterfaceSkeleton. * * Gets the connection that @interface_ is exported on, if any. * * Returns: (transfer none): A #GDBusConnection or %NULL if @interface_ is * not exported anywhere. Do not free, the object belongs to @interface_. * * Since: 2.30 */ GDBusConnection * g_dbus_interface_skeleton_get_connection (GDBusInterfaceSkeleton *interface_) { g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL); return interface_->priv->connection; } /** * g_dbus_interface_skeleton_get_object_path: * @interface_: A #GDBusInterfaceSkeleton. * * Gets the object path that @interface_ is exported on, if any. * * Returns: A string owned by @interface_ or %NULL if @interface_ is not exported * anywhere. Do not free, the string belongs to @interface_. * * Since: 2.30 */ const gchar * g_dbus_interface_skeleton_get_object_path (GDBusInterfaceSkeleton *interface_) { g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), NULL); return interface_->priv->object_path; } /** * g_dbus_interface_skeleton_export: * @interface_: The D-Bus interface to export. * @connection: A #GDBusConnection to export @interface_ on. * @object_path: The path to export the interface at. * @error: Return location for error or %NULL. * * Exports @interface_ at @object_path on @connection. * * Use g_dbus_interface_skeleton_unexport() to unexport the object. * * Returns: %TRUE if the interface was exported, other %FALSE with * @error set. * * Since: 2.30 */ gboolean g_dbus_interface_skeleton_export (GDBusInterfaceSkeleton *interface_, GDBusConnection *connection, const gchar *object_path, GError **error) { gboolean ret; g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_), 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 (interface_->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 (interface_->priv->connection == NULL); g_assert (interface_->priv->object_path == NULL); g_assert (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 */ 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; interface_->priv->connection = g_object_ref (connection); interface_->priv->object_path = g_strdup (object_path); interface_->priv->registration_id = g_dbus_connection_register_object (connection, object_path, g_dbus_interface_skeleton_get_info (interface_), interface_->priv->hooked_vtable, interface_, NULL, /* user_data_free_func */ error); if (interface_->priv->registration_id == 0) goto out; ret = TRUE; out: return ret; } /** * g_dbus_interface_skeleton_unexport: * @interface_: A #GDBusInterfaceSkeleton. * * Stops exporting an interface previously exported with * g_dbus_interface_skeleton_export(). * * Since: 2.30 */ void g_dbus_interface_skeleton_unexport (GDBusInterfaceSkeleton *interface_) { g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_)); g_return_if_fail (interface_->priv->registration_id > 0); g_assert (interface_->priv->connection != NULL); g_assert (interface_->priv->object_path != NULL); g_assert (interface_->priv->hooked_vtable != NULL); g_warn_if_fail (g_dbus_connection_unregister_object (interface_->priv->connection, interface_->priv->registration_id)); g_object_unref (interface_->priv->connection); g_free (interface_->priv->object_path); interface_->priv->connection = NULL; interface_->priv->object_path = NULL; interface_->priv->hooked_vtable = NULL; interface_->priv->registration_id = 0; } /* ---------------------------------------------------------------------------------------------------- */