path: root/libempathy/empathy-contact.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2004 Imendio AB
 * Copyright (C) 2007-2008 Collabora Ltd.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Authors: Mikael Hallendal <micke@imendio.com>
 *          Martyn Russell <martyn@imendio.com>
 *          Xavier Claessens <xclaesse@gmail.com>
 */

#include "config.h"

#include <string.h>

#include <glib/gi18n.h>

#include <telepathy-glib/util.h>

#include "empathy-contact.h"
#include "empathy-utils.h"
#include "empathy-debug.h"
#include "empathy-enum-types.h"

#define DEBUG_DOMAIN "Contact"

#define GET_PRIV(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EMPATHY_TYPE_CONTACT, EmpathyContactPriv))

typedef struct _EmpathyContactPriv EmpathyContactPriv;

struct _EmpathyContactPriv {
    gchar              *id;
    gchar              *name;
    EmpathyAvatar      *avatar;
    McAccount          *account;
    McPresence          presence;
    gchar              *presence_message;
    guint               handle;
    EmpathyCapabilities capabilities;
    gboolean            is_user;
    guint               hash;
    EmpathyContactReady ready;
};

static void empathy_contact_class_init (EmpathyContactClass *class);
static void empathy_contact_init       (EmpathyContact      *contact);
static void contact_finalize           (GObject             *object);
static void contact_get_property       (GObject             *object,
                        guint                param_id,
                        GValue              *value,
                        GParamSpec          *pspec);
static void contact_set_property       (GObject             *object,
                        guint                param_id,
                        const GValue        *value,
                        GParamSpec          *pspec);

G_DEFINE_TYPE (EmpathyContact, empathy_contact, G_TYPE_OBJECT);

enum {
    PROP_0,
    PROP_ID,
    PROP_NAME,
    PROP_AVATAR,
    PROP_ACCOUNT,
    PROP_PRESENCE,
    PROP_PRESENCE_MESSAGE,
    PROP_HANDLE,
    PROP_CAPABILITIES,
    PROP_IS_USER,
    PROP_READY
};

static void
empathy_contact_class_init (EmpathyContactClass *class)
{
    GObjectClass *object_class;

    object_class = G_OBJECT_CLASS (class);

    object_class->finalize     = contact_finalize;
    object_class->get_property = contact_get_property;
    object_class->set_property = contact_set_property;

    g_object_class_install_property (object_class,
                     PROP_ID,
                     g_param_spec_string ("id",
                                  "Contact id",
                                  "String identifying contact",
                                  NULL,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_NAME,
                     g_param_spec_string ("name",
                                  "Contact Name",
                                  "The name of the contact",
                                  NULL,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_AVATAR,
                     g_param_spec_boxed ("avatar",
                                 "Avatar image",
                                 "The avatar image",
                                 EMPATHY_TYPE_AVATAR,
                                 G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_ACCOUNT,
                     g_param_spec_object ("account",
                                  "Contact Account",
                                  "The account associated with the contact",
                                  MC_TYPE_ACCOUNT,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_PRESENCE,
                     g_param_spec_uint ("presence",
                                "Contact presence",
                                "Presence of contact",
                                MC_PRESENCE_UNSET,
                                LAST_MC_PRESENCE,
                                MC_PRESENCE_UNSET,
                                G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_PRESENCE_MESSAGE,
                     g_param_spec_string ("presence-message",
                                  "Contact presence message",
                                  "Presence message of contact",
                                  NULL,
                                  G_PARAM_READWRITE));
    g_object_class_install_property (object_class,
                     PROP_HANDLE,
                     g_param_spec_uint ("handle",
                                "Contact Handle",
                                "The handle of the contact",
                                0,
                                G_MAXUINT,
                                0,
                                G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_CAPABILITIES,
                     g_param_spec_flags ("capabilities",
                                 "Contact Capabilities",
                                 "Capabilities of the contact",
                                 EMPATHY_TYPE_CAPABILITIES,
                                 EMPATHY_CAPABILITIES_UNKNOWN,
                                 G_PARAM_CONSTRUCT | G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_IS_USER,
                     g_param_spec_boolean ("is-user",
                                   "Contact is-user",
                                   "Is contact the user",
                                   FALSE,
                                   G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_READY,
                     g_param_spec_flags ("ready",
                                 "Contact ready flags",
                                 "Flags for ready properties",
                                 EMPATHY_TYPE_CONTACT_READY,
                                 EMPATHY_CONTACT_READY_NONE,
                                 G_PARAM_READABLE));

    g_type_class_add_private (object_class, sizeof (EmpathyContactPriv));
}

static void
empathy_contact_init (EmpathyContact *contact)
{
}

static void
contact_finalize (GObject *object)
{
    EmpathyContactPriv *priv;

    priv = GET_PRIV (object);

    empathy_debug (DEBUG_DOMAIN, "finalize: %p", object);

    g_free (priv->name);
    g_free (priv->id);
    g_free (priv->presence_message);

    if (priv->avatar) {
        empathy_avatar_unref (priv->avatar);
    }

    if (priv->account) {
        g_object_unref (priv->account);
    }

    G_OBJECT_CLASS (empathy_contact_parent_class)->finalize (object);
}

static void
contact_get_property (GObject    *object,
              guint       param_id,
              GValue     *value,
              GParamSpec *pspec)
{
    EmpathyContactPriv *priv;

    priv = GET_PRIV (object);

    switch (param_id) {
    case PROP_ID:
        g_value_set_string (value, priv->id);
        break;
    case PROP_NAME:
        g_value_set_string (value,
                    empathy_contact_get_name (EMPATHY_CONTACT (object)));
        break;
    case PROP_AVATAR:
        g_value_set_boxed (value, priv->avatar);
        break;
    case PROP_ACCOUNT:
        g_value_set_object (value, priv->account);
        break;
    case PROP_PRESENCE:
        g_value_set_uint (value, priv->presence);
        break;
    case PROP_PRESENCE_MESSAGE:
        g_value_set_string (value, priv->presence_message);
        break;
    case PROP_HANDLE:
        g_value_set_uint (value, priv->handle);
        break;
    case PROP_CAPABILITIES:
        g_value_set_flags (value, priv->capabilities);
        break;
    case PROP_IS_USER:
        g_value_set_boolean (value, priv->is_user);
        break;
    case PROP_READY:
        g_value_set_flags (value, priv->ready);
        break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
        break;
    };
}

static void
contact_set_property (GObject      *object,
              guint         param_id,
              const GValue *value,
              GParamSpec   *pspec)
{
    EmpathyContactPriv *priv;

    priv = GET_PRIV (object);

    switch (param_id) {
    case PROP_ID:
        empathy_contact_set_id (EMPATHY_CONTACT (object),
                       g_value_get_string (value));
        break;
    case PROP_NAME:
        empathy_contact_set_name (EMPATHY_CONTACT (object),
                     g_value_get_string (value));
        break;
    case PROP_AVATAR:
        empathy_contact_set_avatar (EMPATHY_CONTACT (object),
                       g_value_get_boxed (value));
        break;
    case PROP_ACCOUNT:
        empathy_contact_set_account (EMPATHY_CONTACT (object),
                        MC_ACCOUNT (g_value_get_object (value)));
        break;
    case PROP_PRESENCE:
        empathy_contact_set_presence (EMPATHY_CONTACT (object),
                          g_value_get_uint (value));
        break;
    case PROP_PRESENCE_MESSAGE:
        empathy_contact_set_presence_message (EMPATHY_CONTACT (object),
                              g_value_get_string (value));
        break;
    case PROP_HANDLE:
        empathy_contact_set_handle (EMPATHY_CONTACT (object),
                       g_value_get_uint (value));
        break;
    case PROP_CAPABILITIES:
        empathy_contact_set_capabilities (EMPATHY_CONTACT (object),
                          g_value_get_flags (value));
        break;
    case PROP_IS_USER:
        empathy_contact_set_is_user (EMPATHY_CONTACT (object),
                        g_value_get_boolean (value));
        break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
        break;
    };
}

static void
contact_set_ready_flag (EmpathyContact      *contact,
            EmpathyContactReady  flag,
            gboolean             set)
{
    EmpathyContactPriv *priv = GET_PRIV (contact);
    EmpathyContactReady ready_old = priv->ready;

    if (set) {
        priv->ready |= flag;
    } else {
        priv->ready &= ~flag;
    }

    if (priv->ready != ready_old) {
        g_object_notify (G_OBJECT (contact), "ready");
    }
}

EmpathyContact *
empathy_contact_new (McAccount *account)
{
    return g_object_new (EMPATHY_TYPE_CONTACT,
                 "account", account,
                 NULL);
}

EmpathyContact *
empathy_contact_new_full (McAccount   *account,
              const gchar *id,
              const gchar *name)
{
    return g_object_new (EMPATHY_TYPE_CONTACT,
                 "account", account,
                 "name", name,
                 "id", id,
                 NULL);
}

const gchar *
empathy_contact_get_id (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);

    priv = GET_PRIV (contact);

    return priv->id;
}

void
empathy_contact_set_id (EmpathyContact *contact,
               const gchar   *id)
{
    EmpathyContactPriv *priv;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));
    g_return_if_fail (id != NULL);

    priv = GET_PRIV (contact);

    if (!tp_strdiff (id, priv->id)) {
        return;
    }

    g_free (priv->id);
    priv->id = g_strdup (id);
    contact_set_ready_flag (contact, EMPATHY_CONTACT_READY_ID,
                !G_STR_EMPTY (id));

    g_object_notify (G_OBJECT (contact), "id");
    if (G_STR_EMPTY (priv->name)) {
        g_object_notify (G_OBJECT (contact), "name");
    }
}

const gchar *
empathy_contact_get_name (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);

    priv = GET_PRIV (contact);

    if (G_STR_EMPTY (priv->name)) {
        return empathy_contact_get_id (contact);
    }

    return priv->name;
}

void
empathy_contact_set_name (EmpathyContact *contact,
             const gchar   *name)
{
    EmpathyContactPriv *priv;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));

    priv = GET_PRIV (contact);

    if (!tp_strdiff (name, priv->name)) {
        return;
    }

    g_free (priv->name);
    priv->name = g_strdup (name);
    contact_set_ready_flag (contact, EMPATHY_CONTACT_READY_NAME,
                !G_STR_EMPTY (name));

    g_object_notify (G_OBJECT (contact), "name");
}

EmpathyAvatar *
empathy_contact_get_avatar (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);

    priv = GET_PRIV (contact);

    return priv->avatar;
}

void
empathy_contact_set_avatar (EmpathyContact *contact,
               EmpathyAvatar  *avatar)
{
    EmpathyContactPriv *priv;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));

    priv = GET_PRIV (contact);

    if (priv->avatar == avatar) {
        return;
    }

    if (priv->avatar) {
        empathy_avatar_unref (priv->avatar);
        priv->avatar = NULL;
    }

    if (avatar) {
        priv->avatar = empathy_avatar_ref (avatar);
    }

    g_object_notify (G_OBJECT (contact), "avatar");
}

McAccount *
empathy_contact_get_account (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);

    priv = GET_PRIV (contact);

    return priv->account;
}

void
empathy_contact_set_account (EmpathyContact *contact,
                 McAccount      *account)
{
    EmpathyContactPriv *priv;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));
    g_return_if_fail (MC_IS_ACCOUNT (account));

    priv = GET_PRIV (contact);

    if (account == priv->account) {
        return;
    }

    if (priv->account) {
        g_object_unref (priv->account);
    }
    priv->account = g_object_ref (account);

    g_object_notify (G_OBJECT (contact), "account");
}

McPresence
empathy_contact_get_presence (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), MC_PRESENCE_UNSET);

    priv = GET_PRIV (contact);

    return priv->presence;
}

void
empathy_contact_set_presence (EmpathyContact *contact,
                  McPresence      presence)
{
    EmpathyContactPriv *priv;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));

    priv = GET_PRIV (contact);

    if (presence == priv->presence) {
        return;
    }

    priv->presence = presence;

    g_object_notify (G_OBJECT (contact), "presence");
}

const gchar *
empathy_contact_get_presence_message (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);

    priv = GET_PRIV (contact);

    return priv->presence_message;
}

void
empathy_contact_set_presence_message (EmpathyContact *contact,
                      const gchar    *message)
{
    EmpathyContactPriv *priv = GET_PRIV (contact);

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));

    if (!tp_strdiff (message, priv->presence_message)) {
        return;
    }

    g_free (priv->presence_message);
    priv->presence_message = g_strdup (message);

    g_object_notify (G_OBJECT (contact), "presence-message");
}

guint
empathy_contact_get_handle (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);

    priv = GET_PRIV (contact);

    return priv->handle;
}

void
empathy_contact_set_handle (EmpathyContact *contact,
                guint           handle)
{
    EmpathyContactPriv *priv;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));

    priv = GET_PRIV (contact);

    if (priv->handle == handle) {
        return;
    }

    priv->handle = handle;
    contact_set_ready_flag (contact, EMPATHY_CONTACT_READY_HANDLE,
                handle != 0);

    g_object_notify (G_OBJECT (contact), "handle");
}

EmpathyCapabilities
empathy_contact_get_capabilities (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);

    priv = GET_PRIV (contact);

    return priv->capabilities;
}

void
empathy_contact_set_capabilities (EmpathyContact      *contact,
                  EmpathyCapabilities  capabilities)
{
    EmpathyContactPriv *priv;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));

    priv = GET_PRIV (contact);

    if (priv->capabilities == capabilities) {
        return;
    }

    priv->capabilities = capabilities;

    g_object_notify (G_OBJECT (contact), "capabilities");
}

gboolean
empathy_contact_is_user (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);

    priv = GET_PRIV (contact);

    return priv->is_user;
}

void
empathy_contact_set_is_user (EmpathyContact *contact,
                gboolean       is_user)
{
    EmpathyContactPriv *priv;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));

    priv = GET_PRIV (contact);

    if (priv->is_user == is_user) {
        return;
    }

    priv->is_user = is_user;

    g_object_notify (G_OBJECT (contact), "is-user");
}

gboolean
empathy_contact_is_online (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);

    priv = GET_PRIV (contact);

    return (priv->presence > MC_PRESENCE_OFFLINE);
}

const gchar *
empathy_contact_get_status (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), "");

    priv = GET_PRIV (contact);

    if (priv->presence_message) {
        return priv->presence_message;
    }

    return empathy_presence_get_default_message (priv->presence);
}

gboolean
empathy_contact_can_voip (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);

    priv = GET_PRIV (contact);

    return priv->capabilities & (EMPATHY_CAPABILITIES_AUDIO |
                     EMPATHY_CAPABILITIES_VIDEO);
}

EmpathyContactReady
empathy_contact_get_ready (EmpathyContact *contact)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);

    priv = GET_PRIV (contact);

    return priv->ready;
}

gboolean
empathy_contact_equal (gconstpointer v1,
              gconstpointer v2)
{
    McAccount   *account_a;
    McAccount   *account_b;
    const gchar *id_a;
    const gchar *id_b;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (v1), FALSE);
    g_return_val_if_fail (EMPATHY_IS_CONTACT (v2), FALSE);

    account_a = empathy_contact_get_account (EMPATHY_CONTACT (v1));
    account_b = empathy_contact_get_account (EMPATHY_CONTACT (v2));

    id_a = empathy_contact_get_id (EMPATHY_CONTACT (v1));
    id_b = empathy_contact_get_id (EMPATHY_CONTACT (v2));

    return empathy_account_equal (account_a, account_b) && g_str_equal (id_a, id_b);
}

guint
empathy_contact_hash (gconstpointer key)
{
    EmpathyContactPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CONTACT (key), +1);

    priv = GET_PRIV (EMPATHY_CONTACT (key));

    if (priv->hash == 0) {
        priv->hash = empathy_account_hash (priv->account) + g_str_hash (priv->id);
    }

    return priv->hash;
}

typedef struct {
    EmpathyContactReady  ready;
    GMainLoop           *loop;
} RunUntilReadyData;

static void
contact_ready_notify_cb (EmpathyContact    *contact,
             GParamSpec        *param,
             RunUntilReadyData *data)
{
    EmpathyContactPriv *priv = GET_PRIV (contact);

    if ((priv->ready & data->ready) == data->ready) {
        empathy_debug (DEBUG_DOMAIN, "contact %s (%d) ready %d",
                   priv->id, priv->handle, priv->ready);
        g_main_loop_quit (data->loop);
    }
}

void
empathy_contact_run_until_ready (EmpathyContact      *contact,
                 EmpathyContactReady  ready,
                 GMainLoop          **loop)
{
    EmpathyContactPriv *priv = GET_PRIV (contact);
    RunUntilReadyData   data;
    gulong              signal_id;

    g_return_if_fail (EMPATHY_IS_CONTACT (contact));

    if ((priv->ready & ready) == ready) {
        return;
    }

    empathy_debug (DEBUG_DOMAIN, "Run until ready=%d for contact %s (%d)",
               ready, priv->id, priv->handle);

    data.ready = ready;
    data.loop = g_main_loop_new (NULL, FALSE);

    signal_id = g_signal_connect (contact, "notify::ready",
                      G_CALLBACK (contact_ready_notify_cb),
                      &data);
    if (loop != NULL) {
        *loop = data.loop;
    }

    g_main_loop_run (data.loop);

    if (loop != NULL) {
        *loop = NULL;
    }

    g_signal_handler_disconnect (contact, signal_id);
    g_main_loop_unref (data.loop);
}