Blame gio/gdbusobjectproxy.c

Packit ae235b
/* GDBus - GLib D-Bus Library
Packit ae235b
 *
Packit ae235b
 * Copyright (C) 2008-2010 Red Hat, Inc.
Packit ae235b
 *
Packit ae235b
 * This library is free software; you can redistribute it and/or
Packit ae235b
 * modify it under the terms of the GNU Lesser General Public
Packit ae235b
 * License as published by the Free Software Foundation; either
Packit ae235b
 * version 2.1 of the License, or (at your option) any later version.
Packit ae235b
 *
Packit ae235b
 * This library is distributed in the hope that it will be useful,
Packit ae235b
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit ae235b
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit ae235b
 * Lesser General Public License for more details.
Packit ae235b
 *
Packit ae235b
 * You should have received a copy of the GNU Lesser General
Packit ae235b
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
Packit ae235b
 *
Packit ae235b
 * Author: David Zeuthen <davidz@redhat.com>
Packit ae235b
 */
Packit ae235b
Packit ae235b
#include "config.h"
Packit ae235b
Packit ae235b
#include "gdbusobject.h"
Packit ae235b
#include "gdbusobjectproxy.h"
Packit ae235b
#include "gdbusconnection.h"
Packit ae235b
#include "gdbusprivate.h"
Packit ae235b
#include "gdbusutils.h"
Packit ae235b
#include "gdbusproxy.h"
Packit ae235b
Packit ae235b
#include "glibintl.h"
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * SECTION:gdbusobjectproxy
Packit ae235b
 * @short_description: Client-side D-Bus object
Packit ae235b
 * @include: gio/gio.h
Packit ae235b
 *
Packit ae235b
 * A #GDBusObjectProxy is an object used to represent a remote object
Packit ae235b
 * with one or more D-Bus interfaces. Normally, you don't instantiate
Packit ae235b
 * a #GDBusObjectProxy yourself - typically #GDBusObjectManagerClient
Packit ae235b
 * is used to obtain it.
Packit ae235b
 *
Packit ae235b
 * Since: 2.30
Packit ae235b
 */
Packit ae235b
Packit ae235b
struct _GDBusObjectProxyPrivate
Packit ae235b
{
Packit ae235b
  GMutex lock;
Packit ae235b
  GHashTable *map_name_to_iface;
Packit ae235b
  gchar *object_path;
Packit ae235b
  GDBusConnection *connection;
Packit ae235b
};
Packit ae235b
Packit ae235b
enum
Packit ae235b
{
Packit ae235b
  PROP_0,
Packit ae235b
  PROP_G_OBJECT_PATH,
Packit ae235b
  PROP_G_CONNECTION
Packit ae235b
};
Packit ae235b
Packit ae235b
static void dbus_object_interface_init (GDBusObjectIface *iface);
Packit ae235b
Packit ae235b
G_DEFINE_TYPE_WITH_CODE (GDBusObjectProxy, g_dbus_object_proxy, G_TYPE_OBJECT,
Packit ae235b
                         G_ADD_PRIVATE (GDBusObjectProxy)
Packit ae235b
                         G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_OBJECT, dbus_object_interface_init))
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_dbus_object_proxy_finalize (GObject *object)
Packit ae235b
{
Packit ae235b
  GDBusObjectProxy *proxy = G_DBUS_OBJECT_PROXY (object);
Packit ae235b
Packit ae235b
  g_hash_table_unref (proxy->priv->map_name_to_iface);
Packit ae235b
Packit ae235b
  g_clear_object (&proxy->priv->connection);
Packit ae235b
Packit ae235b
  g_free (proxy->priv->object_path);
Packit ae235b
Packit ae235b
  g_mutex_clear (&proxy->priv->lock);
Packit ae235b
Packit ae235b
  if (G_OBJECT_CLASS (g_dbus_object_proxy_parent_class)->finalize != NULL)
Packit ae235b
    G_OBJECT_CLASS (g_dbus_object_proxy_parent_class)->finalize (object);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_dbus_object_proxy_get_property (GObject    *object,
Packit ae235b
                                  guint       prop_id,
Packit ae235b
                                  GValue     *value,
Packit ae235b
                                  GParamSpec *pspec)
Packit ae235b
{
Packit ae235b
  GDBusObjectProxy *proxy = G_DBUS_OBJECT_PROXY (object);
Packit ae235b
Packit ae235b
  switch (prop_id)
Packit ae235b
    {
Packit ae235b
    case PROP_G_OBJECT_PATH:
Packit ae235b
      g_mutex_lock (&proxy->priv->lock);
Packit ae235b
      g_value_set_string (value, proxy->priv->object_path);
Packit ae235b
      g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
      break;
Packit ae235b
Packit ae235b
    case PROP_G_CONNECTION:
Packit ae235b
      g_value_set_object (value, g_dbus_object_proxy_get_connection (proxy));
Packit ae235b
      break;
Packit ae235b
Packit ae235b
    default:
Packit ae235b
      G_OBJECT_WARN_INVALID_PROPERTY_ID (proxy, prop_id, pspec);
Packit ae235b
      break;
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_dbus_object_proxy_set_property (GObject       *object,
Packit ae235b
                                  guint          prop_id,
Packit ae235b
                                  const GValue  *value,
Packit ae235b
                                  GParamSpec    *pspec)
Packit ae235b
{
Packit ae235b
  GDBusObjectProxy *proxy = G_DBUS_OBJECT_PROXY (object);
Packit ae235b
Packit ae235b
  switch (prop_id)
Packit ae235b
    {
Packit ae235b
    case PROP_G_OBJECT_PATH:
Packit ae235b
      g_mutex_lock (&proxy->priv->lock);
Packit ae235b
      proxy->priv->object_path = g_value_dup_string (value);
Packit ae235b
      g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
      break;
Packit ae235b
Packit ae235b
    case PROP_G_CONNECTION:
Packit ae235b
      g_mutex_lock (&proxy->priv->lock);
Packit ae235b
      proxy->priv->connection = g_value_dup_object (value);
Packit ae235b
      g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
      break;
Packit ae235b
Packit ae235b
    default:
Packit ae235b
      G_OBJECT_WARN_INVALID_PROPERTY_ID (proxy, prop_id, pspec);
Packit ae235b
      break;
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_dbus_object_proxy_class_init (GDBusObjectProxyClass *klass)
Packit ae235b
{
Packit ae235b
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit ae235b
Packit ae235b
  gobject_class->finalize     = g_dbus_object_proxy_finalize;
Packit ae235b
  gobject_class->set_property = g_dbus_object_proxy_set_property;
Packit ae235b
  gobject_class->get_property = g_dbus_object_proxy_get_property;
Packit ae235b
Packit ae235b
  /**
Packit ae235b
   * GDBusObjectProxy:g-object-path:
Packit ae235b
   *
Packit ae235b
   * The object path of the proxy.
Packit ae235b
   *
Packit ae235b
   * Since: 2.30
Packit ae235b
   */
Packit ae235b
  g_object_class_install_property (gobject_class,
Packit ae235b
                                   PROP_G_OBJECT_PATH,
Packit ae235b
                                   g_param_spec_string ("g-object-path",
Packit ae235b
                                                        "Object Path",
Packit ae235b
                                                        "The object path of the proxy",
Packit ae235b
                                                        NULL,
Packit ae235b
                                                        G_PARAM_READWRITE |
Packit ae235b
                                                        G_PARAM_CONSTRUCT_ONLY |
Packit ae235b
                                                        G_PARAM_STATIC_STRINGS));
Packit ae235b
Packit ae235b
  /**
Packit ae235b
   * GDBusObjectProxy:g-connection:
Packit ae235b
   *
Packit ae235b
   * The connection of the proxy.
Packit ae235b
   *
Packit ae235b
   * Since: 2.30
Packit ae235b
   */
Packit ae235b
  g_object_class_install_property (gobject_class,
Packit ae235b
                                   PROP_G_CONNECTION,
Packit ae235b
                                   g_param_spec_object ("g-connection",
Packit ae235b
                                                        "Connection",
Packit ae235b
                                                        "The connection of the proxy",
Packit ae235b
                                                        G_TYPE_DBUS_CONNECTION,
Packit ae235b
                                                        G_PARAM_READWRITE |
Packit ae235b
                                                        G_PARAM_CONSTRUCT_ONLY |
Packit ae235b
                                                        G_PARAM_STATIC_STRINGS));
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_dbus_object_proxy_init (GDBusObjectProxy *proxy)
Packit ae235b
{
Packit ae235b
  proxy->priv = g_dbus_object_proxy_get_instance_private (proxy);
Packit ae235b
  g_mutex_init (&proxy->priv->lock);
Packit ae235b
  proxy->priv->map_name_to_iface = g_hash_table_new_full (g_str_hash,
Packit ae235b
                                                          g_str_equal,
Packit ae235b
                                                          g_free,
Packit ae235b
                                                          (GDestroyNotify) g_object_unref);
Packit ae235b
}
Packit ae235b
Packit ae235b
static const gchar *
Packit ae235b
g_dbus_object_proxy_get_object_path (GDBusObject *object)
Packit ae235b
{
Packit ae235b
  GDBusObjectProxy *proxy = G_DBUS_OBJECT_PROXY (object);
Packit ae235b
  const gchar *ret;
Packit ae235b
  g_mutex_lock (&proxy->priv->lock);
Packit ae235b
  ret = proxy->priv->object_path;
Packit ae235b
  g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
  return ret;
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_dbus_object_proxy_get_connection:
Packit ae235b
 * @proxy: a #GDBusObjectProxy
Packit ae235b
 *
Packit ae235b
 * Gets the connection that @proxy is for.
Packit ae235b
 *
Packit ae235b
 * Returns: (transfer none): A #GDBusConnection. Do not free, the
Packit ae235b
 *   object is owned by @proxy.
Packit ae235b
 *
Packit ae235b
 * Since: 2.30
Packit ae235b
 */
Packit ae235b
GDBusConnection *
Packit ae235b
g_dbus_object_proxy_get_connection (GDBusObjectProxy *proxy)
Packit ae235b
{
Packit ae235b
  GDBusConnection *ret;
Packit ae235b
  g_return_val_if_fail (G_IS_DBUS_OBJECT_PROXY (proxy), NULL);
Packit ae235b
  g_mutex_lock (&proxy->priv->lock);
Packit ae235b
  ret = proxy->priv->connection;
Packit ae235b
  g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
  return ret;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GDBusInterface *
Packit ae235b
g_dbus_object_proxy_get_interface (GDBusObject *object,
Packit ae235b
                                   const gchar *interface_name)
Packit ae235b
{
Packit ae235b
  GDBusObjectProxy *proxy = G_DBUS_OBJECT_PROXY (object);
Packit ae235b
  GDBusProxy *ret;
Packit ae235b
Packit ae235b
  g_return_val_if_fail (G_IS_DBUS_OBJECT_PROXY (proxy), NULL);
Packit ae235b
  g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
Packit ae235b
Packit ae235b
  g_mutex_lock (&proxy->priv->lock);
Packit ae235b
  ret = g_hash_table_lookup (proxy->priv->map_name_to_iface, interface_name);
Packit ae235b
  if (ret != NULL)
Packit ae235b
    g_object_ref (ret);
Packit ae235b
  g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
Packit ae235b
  return (GDBusInterface *) ret; /* TODO: proper cast */
Packit ae235b
}
Packit ae235b
Packit ae235b
static GList *
Packit ae235b
g_dbus_object_proxy_get_interfaces (GDBusObject *object)
Packit ae235b
{
Packit ae235b
  GDBusObjectProxy *proxy = G_DBUS_OBJECT_PROXY (object);
Packit ae235b
  GList *ret;
Packit ae235b
Packit ae235b
  g_return_val_if_fail (G_IS_DBUS_OBJECT_PROXY (proxy), NULL);
Packit ae235b
Packit ae235b
  ret = NULL;
Packit ae235b
Packit ae235b
  g_mutex_lock (&proxy->priv->lock);
Packit ae235b
  ret = g_hash_table_get_values (proxy->priv->map_name_to_iface);
Packit ae235b
  g_list_foreach (ret, (GFunc) g_object_ref, NULL);
Packit ae235b
  g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
Packit ae235b
  return ret;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_dbus_object_proxy_new:
Packit ae235b
 * @connection: a #GDBusConnection
Packit ae235b
 * @object_path: the object path
Packit ae235b
 *
Packit ae235b
 * Creates a new #GDBusObjectProxy for the given connection and
Packit ae235b
 * object path.
Packit ae235b
 *
Packit ae235b
 * Returns: a new #GDBusObjectProxy
Packit ae235b
 *
Packit ae235b
 * Since: 2.30
Packit ae235b
 */
Packit ae235b
GDBusObjectProxy *
Packit ae235b
g_dbus_object_proxy_new (GDBusConnection *connection,
Packit ae235b
                         const gchar     *object_path)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
Packit ae235b
  g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
Packit ae235b
  return G_DBUS_OBJECT_PROXY (g_object_new (G_TYPE_DBUS_OBJECT_PROXY,
Packit ae235b
                                            "g-object-path", object_path,
Packit ae235b
                                            "g-connection", connection,
Packit ae235b
                                            NULL));
Packit ae235b
}
Packit ae235b
Packit ae235b
void
Packit ae235b
_g_dbus_object_proxy_add_interface (GDBusObjectProxy *proxy,
Packit ae235b
                                    GDBusProxy       *interface_proxy)
Packit ae235b
{
Packit ae235b
  const gchar *interface_name;
Packit ae235b
  GDBusProxy *interface_proxy_to_remove;
Packit ae235b
Packit ae235b
  g_return_if_fail (G_IS_DBUS_OBJECT_PROXY (proxy));
Packit ae235b
  g_return_if_fail (G_IS_DBUS_PROXY (interface_proxy));
Packit ae235b
Packit ae235b
  g_mutex_lock (&proxy->priv->lock);
Packit ae235b
Packit ae235b
  interface_name = g_dbus_proxy_get_interface_name (interface_proxy);
Packit ae235b
  interface_proxy_to_remove = g_hash_table_lookup (proxy->priv->map_name_to_iface, interface_name);
Packit ae235b
  if (interface_proxy_to_remove != NULL)
Packit ae235b
    {
Packit ae235b
      g_object_ref (interface_proxy_to_remove);
Packit ae235b
      g_warn_if_fail (g_hash_table_remove (proxy->priv->map_name_to_iface, interface_name));
Packit ae235b
    }
Packit ae235b
  g_hash_table_insert (proxy->priv->map_name_to_iface,
Packit ae235b
                       g_strdup (interface_name),
Packit ae235b
                       g_object_ref (interface_proxy));
Packit ae235b
  g_object_ref (interface_proxy);
Packit ae235b
Packit ae235b
  g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
Packit ae235b
  if (interface_proxy_to_remove != NULL)
Packit ae235b
    {
Packit ae235b
      g_signal_emit_by_name (proxy, "interface-removed", interface_proxy_to_remove);
Packit ae235b
      g_object_unref (interface_proxy_to_remove);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  g_signal_emit_by_name (proxy, "interface-added", interface_proxy);
Packit ae235b
  g_object_unref (interface_proxy);
Packit ae235b
}
Packit ae235b
Packit ae235b
void
Packit ae235b
_g_dbus_object_proxy_remove_interface (GDBusObjectProxy *proxy,
Packit ae235b
                                       const gchar      *interface_name)
Packit ae235b
{
Packit ae235b
  GDBusProxy *interface_proxy;
Packit ae235b
Packit ae235b
  g_return_if_fail (G_IS_DBUS_OBJECT_PROXY (proxy));
Packit ae235b
  g_return_if_fail (g_dbus_is_interface_name (interface_name));
Packit ae235b
Packit ae235b
  g_mutex_lock (&proxy->priv->lock);
Packit ae235b
Packit ae235b
  interface_proxy = g_hash_table_lookup (proxy->priv->map_name_to_iface, interface_name);
Packit ae235b
  if (interface_proxy != NULL)
Packit ae235b
    {
Packit ae235b
      g_object_ref (interface_proxy);
Packit ae235b
      g_warn_if_fail (g_hash_table_remove (proxy->priv->map_name_to_iface, interface_name));
Packit ae235b
      g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
      g_signal_emit_by_name (proxy, "interface-removed", interface_proxy);
Packit ae235b
      g_object_unref (interface_proxy);
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      g_mutex_unlock (&proxy->priv->lock);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
dbus_object_interface_init (GDBusObjectIface *iface)
Packit ae235b
{
Packit ae235b
  iface->get_object_path       = g_dbus_object_proxy_get_object_path;
Packit ae235b
  iface->get_interfaces        = g_dbus_object_proxy_get_interfaces;
Packit ae235b
  iface->get_interface         = g_dbus_object_proxy_get_interface;
Packit ae235b
}