path: root/libempathy-gtk/empathy-contact-list-view.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2005-2007 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., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  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-lib.h>
#include <gdk/gdkkeysyms.h>
#include <gtk/gtk.h>

#include <telepathy-glib/account-manager.h>
#include <telepathy-glib/util.h>

#include <libempathy/empathy-tp-contact-factory.h>
#include <libempathy/empathy-contact-list.h>
#include <libempathy/empathy-contact-groups.h>
#include <libempathy/empathy-dispatcher.h>
#include <libempathy/empathy-utils.h>

#include "empathy-contact-list-view.h"
#include "empathy-contact-list-store.h"
#include "empathy-images.h"
#include "empathy-cell-renderer-expander.h"
#include "empathy-cell-renderer-text.h"
#include "empathy-cell-renderer-activatable.h"
#include "empathy-ui-utils.h"
#include "empathy-gtk-enum-types.h"
#include "empathy-gtk-marshal.h"

#define DEBUG_FLAG EMPATHY_DEBUG_CONTACT
#include <libempathy/empathy-debug.h>

/* Active users are those which have recently changed state
 * (e.g. online, offline or from normal to a busy state).
 */

#define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyContactListView)
typedef struct {
    EmpathyContactListStore        *store;
    GtkTreeRowReference            *drag_row;
    EmpathyContactListFeatureFlags  list_features;
    EmpathyContactFeatureFlags      contact_features;
    GtkWidget                      *tooltip_widget;
    GtkTargetList                  *file_targets;

    GtkTreeModelFilter             *filter;
    GtkWidget                      *search_widget;
} EmpathyContactListViewPriv;

typedef struct {
    EmpathyContactListView *view;
    GtkTreePath           *path;
    guint                  timeout_id;
} DragMotionData;

typedef struct {
    EmpathyContactListView *view;
    EmpathyContact         *contact;
    gboolean               remove;
} ShowActiveData;

enum {
    PROP_0,
    PROP_STORE,
    PROP_LIST_FEATURES,
    PROP_CONTACT_FEATURES,
};

enum DndDragType {
    DND_DRAG_TYPE_CONTACT_ID,
    DND_DRAG_TYPE_URI_LIST,
    DND_DRAG_TYPE_STRING,
};

static const GtkTargetEntry drag_types_dest[] = {
    { "text/path-list",  0, DND_DRAG_TYPE_URI_LIST },
    { "text/uri-list",   0, DND_DRAG_TYPE_URI_LIST },
    { "text/contact-id", 0, DND_DRAG_TYPE_CONTACT_ID },
    { "text/plain",      0, DND_DRAG_TYPE_STRING },
    { "STRING",          0, DND_DRAG_TYPE_STRING },
};

static const GtkTargetEntry drag_types_dest_file[] = {
    { "text/path-list",  0, DND_DRAG_TYPE_URI_LIST },
    { "text/uri-list",   0, DND_DRAG_TYPE_URI_LIST },
};

static const GtkTargetEntry drag_types_source[] = {
    { "text/contact-id", 0, DND_DRAG_TYPE_CONTACT_ID },
};

static GdkAtom drag_atoms_dest[G_N_ELEMENTS (drag_types_dest)];
static GdkAtom drag_atoms_source[G_N_ELEMENTS (drag_types_source)];

enum {
    DRAG_CONTACT_RECEIVED,
    LAST_SIGNAL
};

static guint signals[LAST_SIGNAL];

G_DEFINE_TYPE (EmpathyContactListView, empathy_contact_list_view, GTK_TYPE_TREE_VIEW);

static void
contact_list_view_tooltip_destroy_cb (GtkWidget              *widget,
                      EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);

    if (priv->tooltip_widget) {
        DEBUG ("Tooltip destroyed");
        g_object_unref (priv->tooltip_widget);
        priv->tooltip_widget = NULL;
    }
}

static gboolean
contact_list_view_is_visible_contact (EmpathyContactListView *self,
                      EmpathyContact *contact)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (self);
    EmpathyLiveSearch *live = EMPATHY_LIVE_SEARCH (priv->search_widget);
    const gchar *str;
    const gchar *p;
    gchar *dup_str = NULL;
    gboolean visible;

    g_assert (live != NULL);

    /* check alias name */
    str = empathy_contact_get_alias (contact);
    if (empathy_live_search_match (live, str))
        return TRUE;

    /* check contact id, remove the @server.com part */
    str = empathy_contact_get_id (contact);
    p = strstr (str, "@");
    if (p != NULL)
        str = dup_str = g_strndup (str, p - str);

    visible = empathy_live_search_match (live, str);
    g_free (dup_str);
    if (visible)
        return TRUE;

    /* FIXME: Add more rules here, we could check phone numbers in
     * contact's vCard for example. */

    return FALSE;
}

static gboolean
contact_list_view_filter_visible_func (GtkTreeModel *model,
                       GtkTreeIter  *iter,
                       gpointer      user_data)
{
    EmpathyContactListView     *self = EMPATHY_CONTACT_LIST_VIEW (user_data);
    EmpathyContactListViewPriv *priv = GET_PRIV (self);
    EmpathyContact             *contact = NULL;
    gboolean                    is_group, is_separator, valid;
    GtkTreeIter                 child_iter;
    gboolean                    visible;

    if (priv->search_widget == NULL ||
        !gtk_widget_get_visible (priv->search_widget))
        return TRUE;

    gtk_tree_model_get (model, iter,
        EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
        EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator,
        EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
        -1);

    if (contact != NULL) {
        visible = contact_list_view_is_visible_contact (self, contact);
        g_object_unref (contact);
        return visible;
    }

    if (is_separator) {
        return TRUE;
    }

    /* Not a contact, not a separator, must be a group */
    g_return_val_if_fail (is_group, FALSE);

    /* only show groups which are not empty */
    for (valid = gtk_tree_model_iter_children (model, &child_iter, iter);
         valid; valid = gtk_tree_model_iter_next (model, &child_iter)) {
        gtk_tree_model_get (model, &child_iter,
            EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
            -1);

        if (contact == NULL)
            continue;

        visible = contact_list_view_is_visible_contact (self, contact);
        g_object_unref (contact);

        /* show group if it has at least one visible contact in it */
        if (visible)
            return TRUE;
    }

    return FALSE;
}

static gboolean
contact_list_view_query_tooltip_cb (EmpathyContactListView *view,
                    gint                    x,
                    gint                    y,
                    gboolean                keyboard_mode,
                    GtkTooltip             *tooltip,
                    gpointer                user_data)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    EmpathyContact             *contact;
    GtkTreeModel               *model;
    GtkTreeIter                 iter;
    GtkTreePath                *path;
    static gint                 running = 0;
    gboolean                    ret = FALSE;

    /* Avoid an infinite loop. See GNOME bug #574377 */
    if (running > 0) {
        return FALSE;
    }
    running++;

    /* Don't show the tooltip if there's already a popup menu */
    if (gtk_menu_get_for_attach_widget (GTK_WIDGET (view)) != NULL) {
        goto OUT;
    }

    if (!gtk_tree_view_get_tooltip_context (GTK_TREE_VIEW (view), &x, &y,
                        keyboard_mode,
                        &model, &path, &iter)) {
        goto OUT;
    }

    gtk_tree_view_set_tooltip_row (GTK_TREE_VIEW (view), tooltip, path);
    gtk_tree_path_free (path);

    gtk_tree_model_get (model, &iter,
                EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
                -1);
    if (!contact) {
        goto OUT;
    }

    if (!priv->tooltip_widget) {
        priv->tooltip_widget = empathy_contact_widget_new (contact,
            EMPATHY_CONTACT_WIDGET_FOR_TOOLTIP |
            EMPATHY_CONTACT_WIDGET_SHOW_LOCATION);
        gtk_container_set_border_width (
            GTK_CONTAINER (priv->tooltip_widget), 8);
        g_object_ref (priv->tooltip_widget);
        g_signal_connect (priv->tooltip_widget, "destroy",
                  G_CALLBACK (contact_list_view_tooltip_destroy_cb),
                  view);
        gtk_widget_show (priv->tooltip_widget);
    } else {
        empathy_contact_widget_set_contact (priv->tooltip_widget,
                            contact);
    }

    gtk_tooltip_set_custom (tooltip, priv->tooltip_widget);
    ret = TRUE;

    g_object_unref (contact);
OUT:
    running--;

    return ret;
}

typedef struct {
    gchar *new_group;
    gchar *old_group;
    GdkDragAction action;
} DndGetContactData;

static void
contact_list_view_dnd_get_contact_free (DndGetContactData *data)
{
    g_free (data->new_group);
    g_free (data->old_group);
    g_slice_free (DndGetContactData, data);
}

static void
contact_list_view_drag_got_contact (TpConnection            *connection,
                    EmpathyContact          *contact,
                    const GError            *error,
                    gpointer                 user_data,
                    GObject                 *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    DndGetContactData          *data = user_data;
    EmpathyContactList         *list;

    if (error != NULL) {
        DEBUG ("Error: %s", error->message);
        return;
    }

    DEBUG ("contact %s (%d) dragged from '%s' to '%s'",
        empathy_contact_get_id (contact),
        empathy_contact_get_handle (contact),
        data->old_group, data->new_group);

    list = empathy_contact_list_store_get_list_iface (priv->store);

    if (!tp_strdiff (data->new_group, EMPATHY_CONTACT_LIST_STORE_FAVORITE)) {
        /* Mark contact as favourite */
        empathy_contact_list_add_to_favourites (list, contact);
        return;
    }

    if (!tp_strdiff (data->old_group, EMPATHY_CONTACT_LIST_STORE_FAVORITE)) {
        /* Remove contact as favourite */
        empathy_contact_list_remove_from_favourites (list, contact);
        /* Don't try to remove it */
        g_free (data->old_group);
        data->old_group = NULL;
    }

    if (data->new_group) {
        empathy_contact_list_add_to_group (list, contact, data->new_group);
    }
    if (data->old_group && data->action == GDK_ACTION_MOVE) {
        empathy_contact_list_remove_from_group (list, contact, data->old_group);
    }
}

static gboolean
group_can_be_modified (const gchar *name,
               gboolean     is_fake_group,
               gboolean     adding)
{
    /* Real groups can always be modified */
    if (!is_fake_group)
        return TRUE;

    /* The favorite fake group can be modified so users can
     * add/remove favorites using DnD */
    if (!tp_strdiff (name, EMPATHY_CONTACT_LIST_STORE_FAVORITE))
        return TRUE;

    /* We can remove contacts from the 'ungrouped' fake group */
    if (!adding && !tp_strdiff (name, EMPATHY_CONTACT_LIST_STORE_UNGROUPED))
        return TRUE;

    return FALSE;
}

static gboolean
contact_list_view_contact_drag_received (GtkWidget         *view,
                     GdkDragContext    *context,
                     GtkTreeModel      *model,
                     GtkTreePath       *path,
                     GtkSelectionData  *selection)
{
    EmpathyContactListViewPriv *priv;
    TpAccountManager           *account_manager;
    TpConnection               *connection = NULL;
    TpAccount                  *account = NULL;
    DndGetContactData          *data;
    GtkTreePath                *source_path;
    const gchar   *sel_data;
    gchar        **strv = NULL;
    const gchar   *account_id = NULL;
    const gchar   *contact_id = NULL;
    gchar         *new_group = NULL;
    gchar         *old_group = NULL;
    gboolean       success = TRUE;
    gboolean       new_group_is_fake, old_group_is_fake = TRUE;

    priv = GET_PRIV (view);

    sel_data = (const gchar *) gtk_selection_data_get_data (selection);
    new_group = empathy_contact_list_store_get_parent_group (model,
                                 path, NULL, &new_group_is_fake);

    if (!group_can_be_modified (new_group, new_group_is_fake, TRUE))
        return FALSE;

    /* Get source group information. */
    if (priv->drag_row) {
        source_path = gtk_tree_row_reference_get_path (priv->drag_row);
        if (source_path) {
            old_group = empathy_contact_list_store_get_parent_group (
                                         model, source_path, NULL, &old_group_is_fake);
            gtk_tree_path_free (source_path);
        }
    }

    if (!group_can_be_modified (old_group, old_group_is_fake, FALSE))
        return FALSE;

    if (!tp_strdiff (old_group, new_group)) {
        g_free (new_group);
        g_free (old_group);
        return FALSE;
    }

    account_manager = tp_account_manager_dup ();
    strv = g_strsplit (sel_data, ":", 2);
    if (g_strv_length (strv) == 2) {
        account_id = strv[0];
        contact_id = strv[1];
        account = tp_account_manager_ensure_account (account_manager, account_id);
    }
    if (account) {
        connection = tp_account_get_connection (account);
    }

    if (!connection) {
        DEBUG ("Failed to get connection for account '%s'", account_id);
        success = FALSE;
        g_free (new_group);
        g_free (old_group);
        g_object_unref (account_manager);
        return FALSE;
    }

    data = g_slice_new0 (DndGetContactData);
    data->new_group = new_group;
    data->old_group = old_group;
    data->action = gdk_drag_context_get_selected_action (context);

    /* FIXME: We should probably wait for the cb before calling
     * gtk_drag_finish */
    empathy_tp_contact_factory_get_from_id (connection, contact_id,
                        contact_list_view_drag_got_contact,
                        data, (GDestroyNotify) contact_list_view_dnd_get_contact_free,
                        G_OBJECT (view));
    g_strfreev (strv);
    g_object_unref (account_manager);

    return TRUE;
}

static gboolean
contact_list_view_file_drag_received (GtkWidget         *view,
                      GdkDragContext    *context,
                      GtkTreeModel      *model,
                      GtkTreePath       *path,
                      GtkSelectionData  *selection)
{
    GtkTreeIter     iter;
    const gchar    *sel_data;
    EmpathyContact *contact;

    sel_data = (const gchar *) gtk_selection_data_get_data (selection);

    gtk_tree_model_get_iter (model, &iter, path);
    gtk_tree_model_get (model, &iter,
                EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
                -1);
    if (!contact) {
        return FALSE;
    }

    empathy_send_file_from_uri_list (contact, sel_data);

    g_object_unref (contact);

    return TRUE;
}

static void
contact_list_view_drag_data_received (GtkWidget         *view,
                      GdkDragContext    *context,
                      gint               x,
                      gint               y,
                      GtkSelectionData  *selection,
                      guint              info,
                      guint              time_)
{
    GtkTreeModel               *model;
    gboolean                    is_row;
    GtkTreeViewDropPosition     position;
    GtkTreePath                *path;
    gboolean                    success = TRUE;

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (view));

    /* Get destination group information. */
    is_row = gtk_tree_view_get_dest_row_at_pos (GTK_TREE_VIEW (view),
                            x,
                            y,
                            &path,
                            &position);
    if (!is_row) {
        success = FALSE;
    }
    else if (info == DND_DRAG_TYPE_CONTACT_ID || info == DND_DRAG_TYPE_STRING) {
        success = contact_list_view_contact_drag_received (view,
                                   context,
                                   model,
                                   path,
                                   selection);
    }
    else if (info == DND_DRAG_TYPE_URI_LIST) {
        success = contact_list_view_file_drag_received (view,
                                context,
                                model,
                                path,
                                selection);
    }

    gtk_tree_path_free (path);
    gtk_drag_finish (context, success, FALSE, GDK_CURRENT_TIME);
}

static gboolean
contact_list_view_drag_motion_cb (DragMotionData *data)
{
    gtk_tree_view_expand_row (GTK_TREE_VIEW (data->view),
                  data->path,
                  FALSE);

    data->timeout_id = 0;

    return FALSE;
}

static gboolean
contact_list_view_drag_motion (GtkWidget      *widget,
                   GdkDragContext *context,
                   gint            x,
                   gint            y,
                   guint           time_)
{
    EmpathyContactListViewPriv *priv;
    GtkTreeModel               *model;
    GdkAtom                target;
    GtkTreeIter            iter;
    static DragMotionData *dm = NULL;
    GtkTreePath           *path;
    gboolean               is_row;
    gboolean               is_different = FALSE;
    gboolean               cleanup = TRUE;
    gboolean               retval = TRUE;

    priv = GET_PRIV (EMPATHY_CONTACT_LIST_VIEW (widget));
    model = gtk_tree_view_get_model (GTK_TREE_VIEW (widget));

    is_row = gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (widget),
                        x,
                        y,
                        &path,
                        NULL,
                        NULL,
                        NULL);

    cleanup &= (!dm);

    if (is_row) {
        cleanup &= (dm && gtk_tree_path_compare (dm->path, path) != 0);
        is_different = (!dm || (dm && gtk_tree_path_compare (dm->path, path) != 0));
    } else {
        cleanup &= FALSE;
    }

    if (path == NULL) {
        /* Coordinates don't point to an actual row, so make sure the pointer
           and highlighting don't indicate that a drag is possible.
         */
        gdk_drag_status (context, GDK_ACTION_DEFAULT, time_);
        gtk_tree_view_set_drag_dest_row (GTK_TREE_VIEW (widget), NULL, 0);
        return FALSE;
    }
    target = gtk_drag_dest_find_target (widget, context, priv->file_targets);
    gtk_tree_model_get_iter (model, &iter, path);

    if (target == GDK_NONE) {
        /* If target == GDK_NONE, then we don't have a target that can be
           dropped on a contact.  This means a contact drag.  If we're
           pointing to a group, highlight it.  Otherwise, if the contact
           we're pointing to is in a group, highlight that.  Otherwise,
           set the drag position to before the first row for a drag into
           the "non-group" at the top.
         */
        GtkTreeIter  group_iter;
        gboolean     is_group;
        GtkTreePath *group_path;
        gtk_tree_model_get (model, &iter,
                    EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                    -1);
        if (is_group) {
            group_iter = iter;
        }
        else {
            if (gtk_tree_model_iter_parent (model, &group_iter, &iter))
                gtk_tree_model_get (model, &group_iter,
                            EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                            -1);
        }
        if (is_group) {
            gdk_drag_status (context, GDK_ACTION_MOVE, time_);
            group_path = gtk_tree_model_get_path (model, &group_iter);
            gtk_tree_view_set_drag_dest_row (GTK_TREE_VIEW (widget),
                             group_path,
                             GTK_TREE_VIEW_DROP_INTO_OR_BEFORE);
            gtk_tree_path_free (group_path);
        }
        else {
            group_path = gtk_tree_path_new_first ();
            gdk_drag_status (context, GDK_ACTION_MOVE, time_);
            gtk_tree_view_set_drag_dest_row (GTK_TREE_VIEW (widget),
                             group_path,
                             GTK_TREE_VIEW_DROP_BEFORE);
        }
    }
    else {
        /* This is a file drag, and it can only be dropped on contacts,
           not groups.
         */
        EmpathyContact *contact;
        gtk_tree_model_get (model, &iter,
                    EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
                    -1);
        if (contact != NULL &&
            empathy_contact_is_online (contact) &&
            (empathy_contact_get_capabilities (contact) & EMPATHY_CAPABILITIES_FT)) {
            gdk_drag_status (context, GDK_ACTION_COPY, time_);
            gtk_tree_view_set_drag_dest_row (GTK_TREE_VIEW (widget),
                             path,
                             GTK_TREE_VIEW_DROP_INTO_OR_BEFORE);
            g_object_unref (contact);
        }
        else {
            gdk_drag_status (context, 0, time_);
            gtk_tree_view_set_drag_dest_row (GTK_TREE_VIEW (widget), NULL, 0);
            retval = FALSE;
        }
    }

    if (!is_different && !cleanup) {
        return retval;
    }

    if (dm) {
        gtk_tree_path_free (dm->path);
        if (dm->timeout_id) {
            g_source_remove (dm->timeout_id);
        }

        g_free (dm);

        dm = NULL;
    }

    if (!gtk_tree_view_row_expanded (GTK_TREE_VIEW (widget), path)) {
        dm = g_new0 (DragMotionData, 1);

        dm->view = EMPATHY_CONTACT_LIST_VIEW (widget);
        dm->path = gtk_tree_path_copy (path);

        dm->timeout_id = g_timeout_add_seconds (1,
            (GSourceFunc) contact_list_view_drag_motion_cb,
            dm);
    }

    return retval;
}

static void
contact_list_view_drag_begin (GtkWidget      *widget,
                  GdkDragContext *context)
{
    EmpathyContactListViewPriv *priv;
    GtkTreeSelection          *selection;
    GtkTreeModel              *model;
    GtkTreePath               *path;
    GtkTreeIter                iter;

    priv = GET_PRIV (widget);

    GTK_WIDGET_CLASS (empathy_contact_list_view_parent_class)->drag_begin (widget,
                                          context);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (widget));
    if (!gtk_tree_selection_get_selected (selection, &model, &iter)) {
        return;
    }

    path = gtk_tree_model_get_path (model, &iter);
    priv->drag_row = gtk_tree_row_reference_new (model, path);
    gtk_tree_path_free (path);
}

static void
contact_list_view_drag_data_get (GtkWidget        *widget,
                 GdkDragContext   *context,
                 GtkSelectionData *selection,
                 guint             info,
                 guint             time_)
{
    EmpathyContactListViewPriv *priv;
    GtkTreePath                *src_path;
    GtkTreeIter                 iter;
    GtkTreeModel               *model;
    EmpathyContact             *contact;
    TpAccount                  *account;
    const gchar                *contact_id;
    const gchar                *account_id;
    gchar                      *str;

    priv = GET_PRIV (widget);

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (widget));
    if (!priv->drag_row) {
        return;
    }

    src_path = gtk_tree_row_reference_get_path (priv->drag_row);
    if (!src_path) {
        return;
    }

    if (!gtk_tree_model_get_iter (model, &iter, src_path)) {
        gtk_tree_path_free (src_path);
        return;
    }

    gtk_tree_path_free (src_path);

    contact = empathy_contact_list_view_dup_selected (EMPATHY_CONTACT_LIST_VIEW (widget));
    if (!contact) {
        return;
    }

    account = empathy_contact_get_account (contact);
    account_id = tp_proxy_get_object_path (account);
    contact_id = empathy_contact_get_id (contact);
    g_object_unref (contact);
    str = g_strconcat (account_id, ":", contact_id, NULL);

    if (info == DND_DRAG_TYPE_CONTACT_ID) {
        gtk_selection_data_set (selection, drag_atoms_source[info], 8,
                    (guchar *) str, strlen (str) + 1);
    }

    g_free (str);
}

static void
contact_list_view_drag_end (GtkWidget      *widget,
                GdkDragContext *context)
{
    EmpathyContactListViewPriv *priv;

    priv = GET_PRIV (widget);

    GTK_WIDGET_CLASS (empathy_contact_list_view_parent_class)->drag_end (widget,
                                        context);

    if (priv->drag_row) {
        gtk_tree_row_reference_free (priv->drag_row);
        priv->drag_row = NULL;
    }
}

static gboolean
contact_list_view_drag_drop (GtkWidget      *widget,
                 GdkDragContext *drag_context,
                 gint            x,
                 gint            y,
                 guint           time_)
{
    return FALSE;
}

typedef struct {
    EmpathyContactListView *view;
    guint                   button;
    guint32                 time;
} MenuPopupData;

static void
menu_deactivate_cb (GtkMenuShell *menushell,
            gpointer user_data)
{
    /* FIXME: we shouldn't have to disconnec the signal (bgo #641327) */
    g_signal_handlers_disconnect_by_func (menushell,
        menu_deactivate_cb, user_data);

    gtk_menu_detach (GTK_MENU (menushell));
}

static gboolean
contact_list_view_popup_menu_idle_cb (gpointer user_data)
{
    MenuPopupData *data = user_data;
    GtkWidget     *menu;

    menu = empathy_contact_list_view_get_contact_menu (data->view);
    if (!menu) {
        menu = empathy_contact_list_view_get_group_menu (data->view);
    }

    if (menu) {
        gtk_menu_attach_to_widget (GTK_MENU (menu),
                       GTK_WIDGET (data->view), NULL);
        gtk_widget_show (menu);
        gtk_menu_popup (GTK_MENU (menu),
                NULL, NULL, NULL, NULL,
                data->button, data->time);

        /* menu is initially unowned but gtk_menu_attach_to_widget () taked its
         * floating ref. We can either wait that the treeview releases its ref
         * when it will be destroyed (when leaving Empathy) or explicitely
         * detach the menu when it's not displayed any more.
         * We go for the latter as we don't want to keep useless menus in memory
         * during the whole lifetime of Empathy. */
        g_signal_connect (menu, "deactivate", G_CALLBACK (menu_deactivate_cb),
            NULL);
    }

    g_slice_free (MenuPopupData, data);

    return FALSE;
}

static gboolean
contact_list_view_button_press_event_cb (EmpathyContactListView *view,
                     GdkEventButton         *event,
                     gpointer                user_data)
{
    if (event->button == 3) {
        MenuPopupData *data;

        data = g_slice_new (MenuPopupData);
        data->view = view;
        data->button = event->button;
        data->time = event->time;
        g_idle_add (contact_list_view_popup_menu_idle_cb, data);
    }

    return FALSE;
}

static gboolean
contact_list_view_key_press_event_cb (EmpathyContactListView *view,
                      GdkEventKey        *event,
                      gpointer            user_data)
{
    if (event->keyval == GDK_KEY_Menu) {
        MenuPopupData *data;

        data = g_slice_new (MenuPopupData);
        data->view = view;
        data->button = 0;
        data->time = event->time;
        g_idle_add (contact_list_view_popup_menu_idle_cb, data);
    }

    return FALSE;
}

static void
contact_list_view_row_activated (GtkTreeView       *view,
                 GtkTreePath       *path,
                 GtkTreeViewColumn *column)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    EmpathyContact             *contact;
    GtkTreeModel               *model;
    GtkTreeIter                 iter;

    if (!(priv->contact_features & EMPATHY_CONTACT_FEATURE_CHAT)) {
        return;
    }

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (view));
    gtk_tree_model_get_iter (model, &iter, path);
    gtk_tree_model_get (model, &iter,
                EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
                -1);

    if (contact) {
        DEBUG ("Starting a chat");
        empathy_dispatcher_chat_with_contact (contact,
            gtk_get_current_event_time ());
        g_object_unref (contact);
    }
}

static void
contact_list_view_call_activated_cb (
    EmpathyCellRendererActivatable *cell,
    const gchar                    *path_string,
    EmpathyContactListView         *view)
{
    GtkWidget *menu;
    GtkTreeModel *model;
    GtkTreeIter iter;
    EmpathyContact *contact;
    GdkEventButton *event;
    GtkMenuShell *shell;
    GtkWidget *item;

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (view));
    if (!gtk_tree_model_get_iter_from_string (model, &iter, path_string))
        return;

    gtk_tree_model_get (model, &iter,
                EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
                -1);
    if (contact == NULL)
        return;

    event = (GdkEventButton *) gtk_get_current_event ();

    menu = empathy_context_menu_new (GTK_WIDGET (view));
    shell = GTK_MENU_SHELL (menu);

    /* audio */
    item = empathy_contact_audio_call_menu_item_new (contact);
    gtk_menu_shell_append (shell, item);
    gtk_widget_show (item);

    /* video */
    item = empathy_contact_video_call_menu_item_new (contact);
    gtk_menu_shell_append (shell, item);
    gtk_widget_show (item);

    gtk_widget_show (menu);
    gtk_menu_popup (GTK_MENU (menu), NULL, NULL, NULL, NULL,
            event->button, event->time);

    g_object_unref (contact);
}

static void
contact_list_view_cell_set_background (EmpathyContactListView *view,
                       GtkCellRenderer        *cell,
                       gboolean                is_group,
                       gboolean                is_active)
{
    if (!is_group && is_active) {
        GdkRGBA color;
        GtkStyleContext *style;

        style = gtk_widget_get_style_context (GTK_WIDGET (view));

        gtk_style_context_get_background_color (style, GTK_STATE_FLAG_SELECTED,
        &color);

        /* Here we take the current theme colour and add it to
         * the colour for white and average the two. This
         * gives a colour which is inline with the theme but
         * slightly whiter.
         */
        empathy_make_color_whiter (&color);

        g_object_set (cell,
                  "cell-background-rgba", &color,
                  NULL);
    } else {
        g_object_set (cell,
                  "cell-background-rgba", NULL,
                  NULL);
    }
}

static void
contact_list_view_pixbuf_cell_data_func (GtkTreeViewColumn      *tree_column,
                     GtkCellRenderer        *cell,
                     GtkTreeModel           *model,
                     GtkTreeIter            *iter,
                     EmpathyContactListView *view)
{
    GdkPixbuf *pixbuf;
    gboolean   is_group;
    gboolean   is_active;

    gtk_tree_model_get (model, iter,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, &is_active,
                EMPATHY_CONTACT_LIST_STORE_COL_ICON_STATUS, &pixbuf,
                -1);

    g_object_set (cell,
              "visible", !is_group,
              "pixbuf", pixbuf,
              NULL);

    if (pixbuf != NULL) {
        g_object_unref (pixbuf);
    }

    contact_list_view_cell_set_background (view, cell, is_group, is_active);
}

static void
contact_list_view_group_icon_cell_data_func (GtkTreeViewColumn     *tree_column,
                         GtkCellRenderer       *cell,
                         GtkTreeModel          *model,
                         GtkTreeIter           *iter,
                         EmpathyContactListView *view)
{
    GdkPixbuf *pixbuf = NULL;
    gboolean is_group;
    gchar *name;

    gtk_tree_model_get (model, iter,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name,
                -1);

    if (!is_group)
        goto out;

    if (!tp_strdiff (name, EMPATHY_CONTACT_LIST_STORE_FAVORITE)) {
        pixbuf = empathy_pixbuf_from_icon_name ("emblem-favorite",
            GTK_ICON_SIZE_MENU);
    }
    else if (!tp_strdiff (name, EMPATHY_CONTACT_LIST_STORE_PEOPLE_NEARBY)) {
        pixbuf = empathy_pixbuf_from_icon_name ("im-local-xmpp",
            GTK_ICON_SIZE_MENU);
    }

out:
    g_object_set (cell,
              "visible", pixbuf != NULL,
              "pixbuf", pixbuf,
              NULL);

    if (pixbuf != NULL)
        g_object_unref (pixbuf);

    g_free (name);
}

static void
contact_list_view_audio_call_cell_data_func (
                       GtkTreeViewColumn      *tree_column,
                       GtkCellRenderer        *cell,
                       GtkTreeModel           *model,
                       GtkTreeIter            *iter,
                       EmpathyContactListView *view)
{
    gboolean is_group;
    gboolean is_active;
    gboolean can_audio, can_video;

    gtk_tree_model_get (model, iter,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, &is_active,
                EMPATHY_CONTACT_LIST_STORE_COL_CAN_AUDIO_CALL, &can_audio,
                EMPATHY_CONTACT_LIST_STORE_COL_CAN_VIDEO_CALL, &can_video,
                -1);

    g_object_set (cell,
              "visible", !is_group && (can_audio || can_video),
              "icon-name", can_video? EMPATHY_IMAGE_VIDEO_CALL : EMPATHY_IMAGE_VOIP,
              NULL);

    contact_list_view_cell_set_background (view, cell, is_group, is_active);
}

static void
contact_list_view_avatar_cell_data_func (GtkTreeViewColumn      *tree_column,
                     GtkCellRenderer        *cell,
                     GtkTreeModel           *model,
                     GtkTreeIter            *iter,
                     EmpathyContactListView *view)
{
    GdkPixbuf *pixbuf;
    gboolean   show_avatar;
    gboolean   is_group;
    gboolean   is_active;

    gtk_tree_model_get (model, iter,
                EMPATHY_CONTACT_LIST_STORE_COL_PIXBUF_AVATAR, &pixbuf,
                EMPATHY_CONTACT_LIST_STORE_COL_PIXBUF_AVATAR_VISIBLE, &show_avatar,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, &is_active,
                -1);

    g_object_set (cell,
              "visible", !is_group && show_avatar,
              "pixbuf", pixbuf,
              NULL);

    if (pixbuf) {
        g_object_unref (pixbuf);
    }

    contact_list_view_cell_set_background (view, cell, is_group, is_active);
}

static void
contact_list_view_text_cell_data_func (GtkTreeViewColumn      *tree_column,
                       GtkCellRenderer        *cell,
                       GtkTreeModel           *model,
                       GtkTreeIter            *iter,
                       EmpathyContactListView *view)
{
    gboolean is_group;
    gboolean is_active;

    gtk_tree_model_get (model, iter,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, &is_active,
                -1);

    contact_list_view_cell_set_background (view, cell, is_group, is_active);
}

static void
contact_list_view_expander_cell_data_func (GtkTreeViewColumn      *column,
                       GtkCellRenderer        *cell,
                       GtkTreeModel           *model,
                       GtkTreeIter            *iter,
                       EmpathyContactListView *view)
{
    gboolean is_group;
    gboolean is_active;

    gtk_tree_model_get (model, iter,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, &is_active,
                -1);

    if (gtk_tree_model_iter_has_child (model, iter)) {
        GtkTreePath *path;
        gboolean     row_expanded;

        path = gtk_tree_model_get_path (model, iter);
        row_expanded = gtk_tree_view_row_expanded (GTK_TREE_VIEW (gtk_tree_view_column_get_tree_view (column)), path);
        gtk_tree_path_free (path);

        g_object_set (cell,
                  "visible", TRUE,
                  "expander-style", row_expanded ? GTK_EXPANDER_EXPANDED : GTK_EXPANDER_COLLAPSED,
                  NULL);
    } else {
        g_object_set (cell, "visible", FALSE, NULL);
    }

    contact_list_view_cell_set_background (view, cell, is_group, is_active);
}

static void
contact_list_view_row_expand_or_collapse_cb (EmpathyContactListView *view,
                         GtkTreeIter            *iter,
                         GtkTreePath            *path,
                         gpointer                user_data)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    GtkTreeModel               *model;
    gchar                      *name;
    gboolean                    expanded;

    if (!(priv->list_features & EMPATHY_CONTACT_LIST_FEATURE_GROUPS_SAVE)) {
        return;
    }

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (view));

    gtk_tree_model_get (model, iter,
                EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name,
                -1);

    expanded = GPOINTER_TO_INT (user_data);
    empathy_contact_group_set_expanded (name, expanded);

    g_free (name);
}

static gboolean
contact_list_view_start_search_cb (EmpathyContactListView *view,
                   gpointer                data)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);

    if (priv->search_widget == NULL)
        return FALSE;

    if (gtk_widget_get_visible (GTK_WIDGET (priv->search_widget)))
        gtk_widget_grab_focus (GTK_WIDGET (priv->search_widget));
    else
        gtk_widget_show (GTK_WIDGET (priv->search_widget));

    return TRUE;
}

static void
contact_list_view_search_text_notify_cb (EmpathyLiveSearch      *search,
                     GParamSpec             *pspec,
                     EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    GtkTreePath *path;
    GtkTreeViewColumn *focus_column;
    GtkTreeModel *model;
    GtkTreeIter iter;
    gboolean set_cursor = FALSE;

    gtk_tree_model_filter_refilter (priv->filter);

    /* Set cursor on the first contact. If it is already set on a group,
     * set it on its first child contact. Note that first child of a group
     * is its separator, that's why we actually set to the 2nd
     */

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (view));
    gtk_tree_view_get_cursor (GTK_TREE_VIEW (view), &path, &focus_column);

    if (path == NULL) {
        path = gtk_tree_path_new_from_string ("0:1");
        set_cursor = TRUE;
    } else if (gtk_tree_path_get_depth (path) < 2) {
        gboolean is_group;

        gtk_tree_model_get_iter (model, &iter, path);
        gtk_tree_model_get (model, &iter,
            EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
            -1);

        if (is_group) {
            gtk_tree_path_down (path);
            gtk_tree_path_next (path);
            set_cursor = TRUE;
        }
    }

    if (set_cursor) {
        /* FIXME: Workaround for GTK bug #621651, we have to make sure
         * the path is valid. */
        if (gtk_tree_model_get_iter (model, &iter, path)) {
            gtk_tree_view_set_cursor (GTK_TREE_VIEW (view), path,
                focus_column, FALSE);
        }
    }

    gtk_tree_path_free (path);
}

static void
contact_list_view_search_activate_cb (GtkWidget *search,
                      EmpathyContactListView *view)
{
    GtkTreePath *path;
    GtkTreeViewColumn *focus_column;

    gtk_tree_view_get_cursor (GTK_TREE_VIEW (view), &path, &focus_column);
    if (path != NULL) {
        gtk_tree_view_row_activated (GTK_TREE_VIEW (view), path,
            focus_column);
        gtk_tree_path_free (path);

        gtk_widget_hide (search);
    }
}

static gboolean
contact_list_view_search_key_navigation_cb (GtkWidget *search,
                        GdkEvent *event,
                        EmpathyContactListView *view)
{
    GdkEventKey *eventkey = ((GdkEventKey *) event);
    gboolean ret = FALSE;

    if (eventkey->keyval == GDK_KEY_Up || eventkey->keyval == GDK_KEY_Down) {
        GdkEvent *new_event;

        new_event = gdk_event_copy (event);
        gtk_widget_grab_focus (GTK_WIDGET (view));
        ret = gtk_widget_event (GTK_WIDGET (view), new_event);
        gtk_widget_grab_focus (search);

        gdk_event_free (new_event);
    }

    return ret;
}

static void
contact_list_view_search_hide_cb (EmpathyLiveSearch      *search,
                  EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    GtkTreeModel               *model;
    GtkTreeIter                 iter;
    gboolean                    valid = FALSE;

    /* block expand or collapse handlers, they would write the
     * expand or collapsed setting to file otherwise */
    g_signal_handlers_block_by_func (view,
        contact_list_view_row_expand_or_collapse_cb,
        GINT_TO_POINTER (TRUE));
    g_signal_handlers_block_by_func (view,
        contact_list_view_row_expand_or_collapse_cb,
        GINT_TO_POINTER (FALSE));

    /* restore which groups are expanded and which are not */
    model = gtk_tree_view_get_model (GTK_TREE_VIEW (view));
    for (valid = gtk_tree_model_get_iter_first (model, &iter);
         valid; valid = gtk_tree_model_iter_next (model, &iter)) {
        gboolean      is_group;
        gchar        *name = NULL;
        GtkTreePath  *path;

        gtk_tree_model_get (model, &iter,
            EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name,
            EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
            -1);

        if (!is_group) {
            g_free (name);
            continue;
        }

        path = gtk_tree_model_get_path (model, &iter);
        if ((priv->list_features & EMPATHY_CONTACT_LIST_FEATURE_GROUPS_SAVE) == 0 ||
            empathy_contact_group_get_expanded (name)) {
            gtk_tree_view_expand_row (GTK_TREE_VIEW (view), path,
                TRUE);
        } else {
            gtk_tree_view_collapse_row (GTK_TREE_VIEW (view), path);
        }

        gtk_tree_path_free (path);
        g_free (name);
    }

    /* unblock expand or collapse handlers */
    g_signal_handlers_unblock_by_func (view,
        contact_list_view_row_expand_or_collapse_cb,
        GINT_TO_POINTER (TRUE));
    g_signal_handlers_unblock_by_func (view,
        contact_list_view_row_expand_or_collapse_cb,
        GINT_TO_POINTER (FALSE));
}

static void
contact_list_view_search_show_cb (EmpathyLiveSearch      *search,
                  EmpathyContactListView *view)
{
    /* block expand or collapse handlers during expand all, they would
     * write the expand or collapsed setting to file otherwise */
    g_signal_handlers_block_by_func (view,
        contact_list_view_row_expand_or_collapse_cb,
        GINT_TO_POINTER (TRUE));

    gtk_tree_view_expand_all (GTK_TREE_VIEW (view));

    g_signal_handlers_unblock_by_func (view,
        contact_list_view_row_expand_or_collapse_cb,
        GINT_TO_POINTER (TRUE));
}

typedef struct {
    EmpathyContactListView *view;
    GtkTreeRowReference *row_ref;
    gboolean expand;
} ExpandData;

static gboolean
contact_list_view_expand_idle_cb (gpointer user_data)
{
    ExpandData *data = user_data;
    GtkTreePath *path;

    path = gtk_tree_row_reference_get_path (data->row_ref);
    if (path == NULL)
        goto done;

    g_signal_handlers_block_by_func (data->view,
        contact_list_view_row_expand_or_collapse_cb,
        GINT_TO_POINTER (data->expand));

    if (data->expand) {
        gtk_tree_view_expand_row (GTK_TREE_VIEW (data->view), path,
            TRUE);
    } else {
        gtk_tree_view_collapse_row (GTK_TREE_VIEW (data->view), path);
    }
    gtk_tree_path_free (path);

    g_signal_handlers_unblock_by_func (data->view,
        contact_list_view_row_expand_or_collapse_cb,
        GINT_TO_POINTER (data->expand));

done:
    g_object_unref (data->view);
    gtk_tree_row_reference_free (data->row_ref);
    g_slice_free (ExpandData, data);

    return FALSE;
}

static void
contact_list_view_row_has_child_toggled_cb (GtkTreeModel           *model,
                        GtkTreePath            *path,
                        GtkTreeIter            *iter,
                        EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    gboolean  is_group = FALSE;
    gchar    *name = NULL;
    ExpandData *data;

    gtk_tree_model_get (model, iter,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name,
                -1);

    if (!is_group || EMP_STR_EMPTY (name)) {
        g_free (name);
        return;
    }

    data = g_slice_new0 (ExpandData);
    data->view = g_object_ref (view);
    data->row_ref = gtk_tree_row_reference_new (model, path);
    data->expand =
        (priv->list_features & EMPATHY_CONTACT_LIST_FEATURE_GROUPS_SAVE) == 0 ||
        (priv->search_widget != NULL && gtk_widget_get_visible (priv->search_widget)) ||
        empathy_contact_group_get_expanded (name);

    /* FIXME: It doesn't work to call gtk_tree_view_expand_row () from within
     * gtk_tree_model_filter_refilter () */
    g_idle_add (contact_list_view_expand_idle_cb, data);

    g_free (name);
}

static void
contact_list_view_verify_group_visibility (EmpathyContactListView *view,
                       GtkTreePath            *path)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    GtkTreeModel *model;
    GtkTreePath *parent_path;
    GtkTreeIter parent_iter;

    if (gtk_tree_path_get_depth (path) < 2)
        return;

    /* A group row is visible if and only if at least one if its child is
     * visible. So when a row is inserted/deleted/changed in the base model,
     * that could modify the visibility of its parent in the filter model.
     */

    model = GTK_TREE_MODEL (priv->store);
    parent_path = gtk_tree_path_copy (path);
    gtk_tree_path_up (parent_path);
    if (gtk_tree_model_get_iter (model, &parent_iter, parent_path)) {
        /* This tells the filter to verify the visibility of that row,
         * and show/hide it if necessary */
        gtk_tree_model_row_changed (GTK_TREE_MODEL (priv->store),
            parent_path, &parent_iter);
    }
    gtk_tree_path_free (parent_path);
}

static void
contact_list_view_store_row_changed_cb (GtkTreeModel           *model,
                    GtkTreePath            *path,
                    GtkTreeIter            *iter,
                    EmpathyContactListView *view)
{
    contact_list_view_verify_group_visibility (view, path);
}

static void
contact_list_view_store_row_deleted_cb (GtkTreeModel           *model,
                    GtkTreePath            *path,
                    EmpathyContactListView *view)
{
    contact_list_view_verify_group_visibility (view, path);
}

static void
contact_list_view_constructed (GObject *object)
{
    EmpathyContactListView     *view = EMPATHY_CONTACT_LIST_VIEW (object);
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    GtkCellRenderer            *cell;
    GtkTreeViewColumn          *col;
    guint                       i;

    priv->filter = GTK_TREE_MODEL_FILTER (gtk_tree_model_filter_new (
            GTK_TREE_MODEL (priv->store), NULL));
    gtk_tree_model_filter_set_visible_func (priv->filter,
            contact_list_view_filter_visible_func,
            view, NULL);

    g_signal_connect (priv->filter, "row-has-child-toggled",
              G_CALLBACK (contact_list_view_row_has_child_toggled_cb),
              view);

    gtk_tree_view_set_model (GTK_TREE_VIEW (view),
                 GTK_TREE_MODEL (priv->filter));

    tp_g_signal_connect_object (priv->store, "row-changed",
        G_CALLBACK (contact_list_view_store_row_changed_cb),
        view, 0);
    tp_g_signal_connect_object (priv->store, "row-inserted",
        G_CALLBACK (contact_list_view_store_row_changed_cb),
        view, 0);
    tp_g_signal_connect_object (priv->store, "row-deleted",
        G_CALLBACK (contact_list_view_store_row_deleted_cb),
        view, 0);

    /* Setup view */
    /* Setting reorderable is a hack that gets us row previews as drag icons
       for free.  We override all the drag handlers.  It's tricky to get the
       position of the drag icon right in drag_begin.  GtkTreeView has special
       voodoo for it, so we let it do the voodoo that he do.
     */
    g_object_set (view,
              "headers-visible", FALSE,
              "reorderable", TRUE,
              "show-expanders", FALSE,
              NULL);

    col = gtk_tree_view_column_new ();

    /* State */
    cell = gtk_cell_renderer_pixbuf_new ();
    gtk_tree_view_column_pack_start (col, cell, FALSE);
    gtk_tree_view_column_set_cell_data_func (
        col, cell,
        (GtkTreeCellDataFunc) contact_list_view_pixbuf_cell_data_func,
        view, NULL);

    g_object_set (cell,
              "xpad", 5,
              "ypad", 1,
              "visible", FALSE,
              NULL);

    /* Group icon */
    cell = gtk_cell_renderer_pixbuf_new ();
    gtk_tree_view_column_pack_start (col, cell, FALSE);
    gtk_tree_view_column_set_cell_data_func (
        col, cell,
        (GtkTreeCellDataFunc) contact_list_view_group_icon_cell_data_func,
        view, NULL);

    g_object_set (cell,
              "xpad", 0,
              "ypad", 0,
              "visible", FALSE,
              "width", 16,
              "height", 16,
              NULL);

    /* Name */
    cell = empathy_cell_renderer_text_new ();
    gtk_tree_view_column_pack_start (col, cell, TRUE);
    gtk_tree_view_column_set_cell_data_func (
        col, cell,
        (GtkTreeCellDataFunc) contact_list_view_text_cell_data_func,
        view, NULL);

    gtk_tree_view_column_add_attribute (col, cell,
                        "name", EMPATHY_CONTACT_LIST_STORE_COL_NAME);
    gtk_tree_view_column_add_attribute (col, cell,
                        "text", EMPATHY_CONTACT_LIST_STORE_COL_NAME);
    gtk_tree_view_column_add_attribute (col, cell,
                        "presence-type", EMPATHY_CONTACT_LIST_STORE_COL_PRESENCE_TYPE);
    gtk_tree_view_column_add_attribute (col, cell,
                        "status", EMPATHY_CONTACT_LIST_STORE_COL_STATUS);
    gtk_tree_view_column_add_attribute (col, cell,
                        "is_group", EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP);
    gtk_tree_view_column_add_attribute (col, cell,
                        "compact", EMPATHY_CONTACT_LIST_STORE_COL_COMPACT);

    /* Audio Call Icon */
    cell = empathy_cell_renderer_activatable_new ();
    gtk_tree_view_column_pack_start (col, cell, FALSE);
    gtk_tree_view_column_set_cell_data_func (
        col, cell,
        (GtkTreeCellDataFunc) contact_list_view_audio_call_cell_data_func,
        view, NULL);

    g_object_set (cell,
              "visible", FALSE,
              NULL);

    g_signal_connect (cell, "path-activated",
              G_CALLBACK (contact_list_view_call_activated_cb),
              view);

    /* Avatar */
    cell = gtk_cell_renderer_pixbuf_new ();
    gtk_tree_view_column_pack_start (col, cell, FALSE);
    gtk_tree_view_column_set_cell_data_func (
        col, cell,
        (GtkTreeCellDataFunc) contact_list_view_avatar_cell_data_func,
        view, NULL);

    g_object_set (cell,
              "xpad", 0,
              "ypad", 0,
              "visible", FALSE,
              "width", 32,
              "height", 32,
              NULL);

    /* Expander */
    cell = empathy_cell_renderer_expander_new ();
    gtk_tree_view_column_pack_end (col, cell, FALSE);
    gtk_tree_view_column_set_cell_data_func (
        col, cell,
        (GtkTreeCellDataFunc) contact_list_view_expander_cell_data_func,
        view, NULL);

    /* Actually add the column now we have added all cell renderers */
    gtk_tree_view_append_column (GTK_TREE_VIEW (view), col);

    /* Drag & Drop. */
    for (i = 0; i < G_N_ELEMENTS (drag_types_dest); ++i) {
        drag_atoms_dest[i] = gdk_atom_intern (drag_types_dest[i].target,
                              FALSE);
    }

    for (i = 0; i < G_N_ELEMENTS (drag_types_source); ++i) {
        drag_atoms_source[i] = gdk_atom_intern (drag_types_source[i].target,
                            FALSE);
    }
}

static void
contact_list_view_set_list_features (EmpathyContactListView         *view,
                     EmpathyContactListFeatureFlags  features)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    gboolean                    has_tooltip;

    g_return_if_fail (EMPATHY_IS_CONTACT_LIST_VIEW (view));

    priv->list_features = features;

    /* Update DnD source/dest */
    if (features & EMPATHY_CONTACT_LIST_FEATURE_CONTACT_DRAG) {
        gtk_drag_source_set (GTK_WIDGET (view),
                     GDK_BUTTON1_MASK,
                     drag_types_source,
                     G_N_ELEMENTS (drag_types_source),
                     GDK_ACTION_MOVE | GDK_ACTION_COPY);
    } else {
        gtk_drag_source_unset (GTK_WIDGET (view));

    }

    if (features & EMPATHY_CONTACT_LIST_FEATURE_CONTACT_DROP) {
        gtk_drag_dest_set (GTK_WIDGET (view),
                   GTK_DEST_DEFAULT_ALL,
                   drag_types_dest,
                   G_N_ELEMENTS (drag_types_dest),
                   GDK_ACTION_MOVE | GDK_ACTION_COPY);
    } else {
        /* FIXME: URI could still be droped depending on FT feature */
        gtk_drag_dest_unset (GTK_WIDGET (view));
    }

    /* Update has-tooltip */
    has_tooltip = (features & EMPATHY_CONTACT_LIST_FEATURE_CONTACT_TOOLTIP) != 0;
    gtk_widget_set_has_tooltip (GTK_WIDGET (view), has_tooltip);
}

static void
contact_list_view_dispose (GObject *object)
{
    EmpathyContactListView *view = EMPATHY_CONTACT_LIST_VIEW (object);
    EmpathyContactListViewPriv *priv = GET_PRIV (view);

    if (priv->store) {
        g_object_unref (priv->store);
        priv->store = NULL;
    }
    if (priv->filter) {
        g_object_unref (priv->filter);
        priv->filter = NULL;
    }
    if (priv->tooltip_widget) {
        gtk_widget_destroy (priv->tooltip_widget);
        priv->tooltip_widget = NULL;
    }
    if (priv->file_targets) {
        gtk_target_list_unref (priv->file_targets);
        priv->file_targets = NULL;
    }

    empathy_contact_list_view_set_live_search (view, NULL);

    G_OBJECT_CLASS (empathy_contact_list_view_parent_class)->dispose (object);
}

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

    priv = GET_PRIV (object);

    switch (param_id) {
    case PROP_STORE:
        g_value_set_object (value, priv->store);
        break;
    case PROP_LIST_FEATURES:
        g_value_set_flags (value, priv->list_features);
        break;
    case PROP_CONTACT_FEATURES:
        g_value_set_flags (value, priv->contact_features);
        break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
        break;
    };
}

static void
contact_list_view_set_property (GObject      *object,
                guint         param_id,
                const GValue *value,
                GParamSpec   *pspec)
{
    EmpathyContactListView     *view = EMPATHY_CONTACT_LIST_VIEW (object);
    EmpathyContactListViewPriv *priv = GET_PRIV (object);

    switch (param_id) {
    case PROP_STORE:
        priv->store = g_value_dup_object (value);
        break;
    case PROP_LIST_FEATURES:
        contact_list_view_set_list_features (view, g_value_get_flags (value));
        break;
    case PROP_CONTACT_FEATURES:
        priv->contact_features = g_value_get_flags (value);
        break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
        break;
    };
}

static void
empathy_contact_list_view_class_init (EmpathyContactListViewClass *klass)
{
    GObjectClass     *object_class = G_OBJECT_CLASS (klass);
    GtkWidgetClass   *widget_class = GTK_WIDGET_CLASS (klass);
    GtkTreeViewClass *tree_view_class = GTK_TREE_VIEW_CLASS (klass);

    object_class->constructed        = contact_list_view_constructed;
    object_class->dispose            = contact_list_view_dispose;
    object_class->get_property       = contact_list_view_get_property;
    object_class->set_property       = contact_list_view_set_property;

    widget_class->drag_data_received = contact_list_view_drag_data_received;
    widget_class->drag_drop          = contact_list_view_drag_drop;
    widget_class->drag_begin         = contact_list_view_drag_begin;
    widget_class->drag_data_get      = contact_list_view_drag_data_get;
    widget_class->drag_end           = contact_list_view_drag_end;
    widget_class->drag_motion        = contact_list_view_drag_motion;

    /* We use the class method to let user of this widget to connect to
     * the signal and stop emission of the signal so the default handler
     * won't be called. */
    tree_view_class->row_activated = contact_list_view_row_activated;

    signals[DRAG_CONTACT_RECEIVED] =
        g_signal_new ("drag-contact-received",
                  G_OBJECT_CLASS_TYPE (klass),
                  G_SIGNAL_RUN_LAST,
                  0,
                  NULL, NULL,
                  _empathy_gtk_marshal_VOID__OBJECT_STRING_STRING,
                  G_TYPE_NONE,
                  3, EMPATHY_TYPE_CONTACT, G_TYPE_STRING, G_TYPE_STRING);

    g_object_class_install_property (object_class,
                     PROP_STORE,
                     g_param_spec_object ("store",
                                 "The store of the view",
                                 "The store of the view",
                                  EMPATHY_TYPE_CONTACT_LIST_STORE,
                                  G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE));
    g_object_class_install_property (object_class,
                     PROP_LIST_FEATURES,
                     g_param_spec_flags ("list-features",
                                 "Features of the view",
                                 "Flags for all enabled features",
                                  EMPATHY_TYPE_CONTACT_LIST_FEATURE_FLAGS,
                                  EMPATHY_CONTACT_LIST_FEATURE_NONE,
                                  G_PARAM_READWRITE));
    g_object_class_install_property (object_class,
                     PROP_CONTACT_FEATURES,
                     g_param_spec_flags ("contact-features",
                                 "Features of the contact menu",
                                 "Flags for all enabled features for the menu",
                                  EMPATHY_TYPE_CONTACT_FEATURE_FLAGS,
                                  EMPATHY_CONTACT_FEATURE_NONE,
                                  G_PARAM_READWRITE));

    g_type_class_add_private (object_class, sizeof (EmpathyContactListViewPriv));
}

static void
empathy_contact_list_view_init (EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (view,
        EMPATHY_TYPE_CONTACT_LIST_VIEW, EmpathyContactListViewPriv);

    view->priv = priv;

    /* Get saved group states. */
    empathy_contact_groups_get_all ();

    gtk_tree_view_set_row_separator_func (GTK_TREE_VIEW (view),
                          empathy_contact_list_store_row_separator_func,
                          NULL, NULL);

    /* Set up drag target lists. */
    priv->file_targets = gtk_target_list_new (drag_types_dest_file,
                          G_N_ELEMENTS (drag_types_dest_file));

    /* Connect to tree view signals rather than override. */
    g_signal_connect (view, "button-press-event",
              G_CALLBACK (contact_list_view_button_press_event_cb),
              NULL);
    g_signal_connect (view, "key-press-event",
              G_CALLBACK (contact_list_view_key_press_event_cb),
              NULL);
    g_signal_connect (view, "row-expanded",
              G_CALLBACK (contact_list_view_row_expand_or_collapse_cb),
              GINT_TO_POINTER (TRUE));
    g_signal_connect (view, "row-collapsed",
              G_CALLBACK (contact_list_view_row_expand_or_collapse_cb),
              GINT_TO_POINTER (FALSE));
    g_signal_connect (view, "query-tooltip",
              G_CALLBACK (contact_list_view_query_tooltip_cb),
              NULL);
}

EmpathyContactListView *
empathy_contact_list_view_new (EmpathyContactListStore        *store,
                   EmpathyContactListFeatureFlags  list_features,
                   EmpathyContactFeatureFlags      contact_features)
{
    g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store), NULL);

    return g_object_new (EMPATHY_TYPE_CONTACT_LIST_VIEW,
                 "store", store,
                 "contact-features", contact_features,
                 "list-features", list_features,
                 NULL);
}

EmpathyContact *
empathy_contact_list_view_dup_selected (EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv;
    GtkTreeSelection          *selection;
    GtkTreeIter                iter;
    GtkTreeModel              *model;
    EmpathyContact             *contact;

    g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_VIEW (view), NULL);

    priv = GET_PRIV (view);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (view));
    if (!gtk_tree_selection_get_selected (selection, &model, &iter)) {
        return NULL;
    }

    gtk_tree_model_get (model, &iter,
                EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
                -1);

    return contact;
}

EmpathyContactListFlags
empathy_contact_list_view_get_flags (EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv;
    GtkTreeSelection          *selection;
    GtkTreeIter                iter;
    GtkTreeModel              *model;
    EmpathyContactListFlags    flags;

    g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_VIEW (view), 0);

    priv = GET_PRIV (view);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (view));
    if (!gtk_tree_selection_get_selected (selection, &model, &iter)) {
        return 0;
    }

    gtk_tree_model_get (model, &iter,
                EMPATHY_CONTACT_LIST_STORE_COL_FLAGS, &flags,
                -1);

    return flags;
}

gchar *
empathy_contact_list_view_get_selected_group (EmpathyContactListView *view,
                          gboolean *is_fake_group)
{
    EmpathyContactListViewPriv *priv;
    GtkTreeSelection          *selection;
    GtkTreeIter                iter;
    GtkTreeModel              *model;
    gboolean                   is_group;
    gchar                     *name;
    gboolean                   fake;

    g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_VIEW (view), NULL);

    priv = GET_PRIV (view);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (view));
    if (!gtk_tree_selection_get_selected (selection, &model, &iter)) {
        return NULL;
    }

    gtk_tree_model_get (model, &iter,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
                EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name,
                EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake,
                -1);

    if (!is_group) {
        g_free (name);
        return NULL;
    }

    if (is_fake_group != NULL)
        *is_fake_group = fake;

    return name;
}

static gboolean
contact_list_view_remove_dialog_show (GtkWindow   *parent,
                      const gchar *message,
                      const gchar *secondary_text)
{
    GtkWidget *dialog;
    gboolean res;

    dialog = gtk_message_dialog_new (parent, GTK_DIALOG_MODAL,
                     GTK_MESSAGE_QUESTION, GTK_BUTTONS_NONE,
                     "%s", message);
    gtk_dialog_add_buttons (GTK_DIALOG (dialog),
                GTK_STOCK_CANCEL, GTK_RESPONSE_NO,
                GTK_STOCK_DELETE, GTK_RESPONSE_YES,
                NULL);
    gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (dialog),
                          "%s", secondary_text);

    gtk_widget_show (dialog);

    res = gtk_dialog_run (GTK_DIALOG (dialog));
    gtk_widget_destroy (dialog);

    return (res == GTK_RESPONSE_YES);
}

static void
contact_list_view_group_remove_activate_cb (GtkMenuItem            *menuitem,
                        EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    gchar                      *group;

    group = empathy_contact_list_view_get_selected_group (view, NULL);
    if (group) {
        gchar     *text;
        GtkWindow *parent;

        text = g_strdup_printf (_("Do you really want to remove the group '%s'?"), group);
        parent = empathy_get_toplevel_window (GTK_WIDGET (view));
        if (contact_list_view_remove_dialog_show (parent, _("Removing group"), text)) {
            EmpathyContactList *list;

            list = empathy_contact_list_store_get_list_iface (priv->store);
            empathy_contact_list_remove_group (list, group);
        }

        g_free (text);
    }

    g_free (group);
}

GtkWidget *
empathy_contact_list_view_get_group_menu (EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    gchar                      *group;
    GtkWidget                  *menu;
    GtkWidget                  *item;
    GtkWidget                  *image;
    gboolean                   is_fake_group;

    g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_VIEW (view), NULL);

    if (!(priv->list_features & (EMPATHY_CONTACT_LIST_FEATURE_GROUPS_RENAME |
                     EMPATHY_CONTACT_LIST_FEATURE_GROUPS_REMOVE))) {
        return NULL;
    }

    group = empathy_contact_list_view_get_selected_group (view, &is_fake_group);
    if (!group || is_fake_group) {
        /* We can't alter fake groups */
        return NULL;
    }

    menu = gtk_menu_new ();

    /* FIXME: Not implemented yet
    if (priv->features & EMPATHY_CONTACT_LIST_FEATURE_GROUPS_RENAME) {
        item = gtk_menu_item_new_with_mnemonic (_("Re_name"));
        gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
        gtk_widget_show (item);
        g_signal_connect (item, "activate",
                  G_CALLBACK (contact_list_view_group_rename_activate_cb),
                  view);
    }*/

    if (priv->list_features & EMPATHY_CONTACT_LIST_FEATURE_GROUPS_REMOVE) {
        item = gtk_image_menu_item_new_with_mnemonic (_("_Remove"));
        image = gtk_image_new_from_icon_name (GTK_STOCK_REMOVE,
                              GTK_ICON_SIZE_MENU);
        gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
        gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
        gtk_widget_show (item);
        g_signal_connect (item, "activate",
                  G_CALLBACK (contact_list_view_group_remove_activate_cb),
                  view);
    }

    g_free (group);

    return menu;
}

static void
contact_list_view_remove_activate_cb (GtkMenuItem            *menuitem,
                      EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    EmpathyContact             *contact;

    contact = empathy_contact_list_view_dup_selected (view);

    if (contact) {
        gchar     *text;
        GtkWindow *parent;

        parent = empathy_get_toplevel_window (GTK_WIDGET (view));
        text = g_strdup_printf (_("Do you really want to remove the contact '%s'?"),
                    empathy_contact_get_alias (contact));
        if (contact_list_view_remove_dialog_show (parent, _("Removing contact"), text)) {
            EmpathyContactList *list;

            list = empathy_contact_list_store_get_list_iface (priv->store);
            empathy_contact_list_remove (list, contact, "");
        }

        g_free (text);
        g_object_unref (contact);
    }
}

GtkWidget *
empathy_contact_list_view_get_contact_menu (EmpathyContactListView *view)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);
    EmpathyContact             *contact;
    GtkWidget                  *menu;
    GtkWidget                  *item;
    GtkWidget                  *image;
    EmpathyContactListFlags     flags;

    g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_VIEW (view), NULL);

    contact = empathy_contact_list_view_dup_selected (view);
    if (!contact) {
        return NULL;
    }
    flags = empathy_contact_list_view_get_flags (view);

    menu = empathy_contact_menu_new (contact, priv->contact_features);

    /* Remove contact */
    if (priv->list_features & EMPATHY_CONTACT_LIST_FEATURE_CONTACT_REMOVE &&
        flags & EMPATHY_CONTACT_LIST_CAN_REMOVE) {
        /* create the menu if required, or just add a separator */
        if (!menu) {
            menu = gtk_menu_new ();
        } else {
            item = gtk_separator_menu_item_new ();
            gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
            gtk_widget_show (item);
        }

        /* Remove */
        item = gtk_image_menu_item_new_with_mnemonic (_("_Remove"));
        image = gtk_image_new_from_icon_name (GTK_STOCK_REMOVE,
                              GTK_ICON_SIZE_MENU);
        gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
        gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
        gtk_widget_show (item);
        g_signal_connect (item, "activate",
                  G_CALLBACK (contact_list_view_remove_activate_cb),
                  view);
    }

    g_object_unref (contact);

    return menu;
}

void
empathy_contact_list_view_set_live_search (EmpathyContactListView *view,
                       EmpathyLiveSearch      *search)
{
    EmpathyContactListViewPriv *priv = GET_PRIV (view);

    /* remove old handlers if old search was not null */
    if (priv->search_widget != NULL) {
        g_signal_handlers_disconnect_by_func (view,
            contact_list_view_start_search_cb,
            NULL);

        g_signal_handlers_disconnect_by_func (priv->search_widget,
            contact_list_view_search_text_notify_cb,
            view);
        g_signal_handlers_disconnect_by_func (priv->search_widget,
            contact_list_view_search_activate_cb,
            view);
        g_signal_handlers_disconnect_by_func (priv->search_widget,
            contact_list_view_search_key_navigation_cb,
            view);
        g_signal_handlers_disconnect_by_func (priv->search_widget,
            contact_list_view_search_hide_cb,
            view);
        g_signal_handlers_disconnect_by_func (priv->search_widget,
            contact_list_view_search_show_cb,
            view);
        g_object_unref (priv->search_widget);
        priv->search_widget = NULL;
    }

    /* connect handlers if new search is not null */
    if (search != NULL) {
        priv->search_widget = g_object_ref (search);

        g_signal_connect (view, "start-interactive-search",
                  G_CALLBACK (contact_list_view_start_search_cb),
                  NULL);

        g_signal_connect (priv->search_widget, "notify::text",
            G_CALLBACK (contact_list_view_search_text_notify_cb),
            view);
        g_signal_connect (priv->search_widget, "activate",
            G_CALLBACK (contact_list_view_search_activate_cb),
            view);
        g_signal_connect (priv->search_widget, "key-navigation",
            G_CALLBACK (contact_list_view_search_key_navigation_cb),
            view);
        g_signal_connect (priv->search_widget, "hide",
            G_CALLBACK (contact_list_view_search_hide_cb),
            view);
        g_signal_connect (priv->search_widget, "show",
            G_CALLBACK (contact_list_view_search_show_cb),
            view);
    }
}