/* -*- 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: Martyn Russell <martyn@imendio.com>
* Xavier Claessens <xclaesse@gmail.com>
*/
#include "config.h"
#include <string.h>
#include <glib/gi18n-lib.h>
#include <gtk/gtk.h>
#include <telepathy-glib/account-manager.h>
#include <libempathy/empathy-utils.h>
#include "empathy-ui-utils.h"
#include "empathy-account-chooser.h"
/**
* SECTION:empathy-account-chooser
* @title:EmpathyAccountChooser
* @short_description: A widget used to choose from a list of accounts
* @include: libempathy-gtk/empathy-account-chooser.h
*
* #EmpathyAccountChooser is a widget which extends #GtkComboBox to provide
* a chooser of available accounts.
*/
/**
* EmpathyAccountChooser:
* @parent: parent object
*
* Widget which extends #GtkComboBox to provide a chooser of available accounts.
*/
#define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyAccountChooser)
typedef struct {
TpAccountManager *manager;
gboolean set_active_item;
gboolean account_manually_set;
gboolean has_all_option;
EmpathyAccountChooserFilterFunc filter;
gpointer filter_data;
} EmpathyAccountChooserPriv;
typedef struct {
EmpathyAccountChooser *chooser;
TpAccount *account;
gboolean set;
} SetAccountData;
enum {
COL_ACCOUNT_IMAGE,
COL_ACCOUNT_TEXT,
COL_ACCOUNT_ENABLED, /* Usually tied to connected state */
COL_ACCOUNT_POINTER,
COL_ACCOUNT_COUNT
};
static void account_chooser_finalize (GObject *object);
static void account_chooser_get_property (GObject *object,
guint param_id,
GValue *value,
GParamSpec *pspec);
static void account_chooser_set_property (GObject *object,
guint param_id,
const GValue *value,
GParamSpec *pspec);
static void account_chooser_setup (EmpathyAccountChooser *chooser);
static void account_chooser_account_validity_changed_cb (TpAccountManager *manager,
TpAccount *account,
gboolean valid,
EmpathyAccountChooser *chooser);
static void account_chooser_account_add_foreach (TpAccount *account,
EmpathyAccountChooser *chooser);
static void account_chooser_account_removed_cb (TpAccountManager *manager,
TpAccount *account,
EmpathyAccountChooser *chooser);
static void account_chooser_account_remove_foreach (TpAccount *account,
EmpathyAccountChooser *chooser);
static void account_chooser_update_iter (EmpathyAccountChooser *chooser,
GtkTreeIter *iter);
static void account_chooser_status_changed_cb (TpAccount *account,
guint old_status,
guint new_status,
guint reason,
gchar *dbus_error_name,
GHashTable *details,
gpointer user_data);
static gboolean account_chooser_separator_func (GtkTreeModel *model,
GtkTreeIter *iter,
EmpathyAccountChooser *chooser);
static gboolean account_chooser_set_account_foreach (GtkTreeModel *model,
GtkTreePath *path,
GtkTreeIter *iter,
SetAccountData *data);
enum {
PROP_0,
PROP_HAS_ALL_OPTION,
};
G_DEFINE_TYPE (EmpathyAccountChooser, empathy_account_chooser, GTK_TYPE_COMBO_BOX);
static void
empathy_account_chooser_class_init (EmpathyAccountChooserClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->finalize = account_chooser_finalize;
object_class->get_property = account_chooser_get_property;
object_class->set_property = account_chooser_set_property;
/**
* EmpathyAccountChooser:has-all-option:
*
* Have an additional option in the list to mean all accounts.
*/
g_object_class_install_property (object_class,
PROP_HAS_ALL_OPTION,
g_param_spec_boolean ("has-all-option",
"Has All Option",
"Have a separate option in the list to mean ALL accounts",
FALSE,
G_PARAM_READWRITE));
g_type_class_add_private (object_class, sizeof (EmpathyAccountChooserPriv));
}
static void
empathy_account_chooser_init (EmpathyAccountChooser *chooser)
{
EmpathyAccountChooserPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (chooser,
EMPATHY_TYPE_ACCOUNT_CHOOSER, EmpathyAccountChooserPriv);
chooser->priv = priv;
priv->set_active_item = FALSE;
priv->account_manually_set = FALSE;
priv->filter = NULL;
priv->filter_data = NULL;
priv->manager = tp_account_manager_dup ();
g_signal_connect (priv->manager, "account-validity-changed",
G_CALLBACK (account_chooser_account_validity_changed_cb),
chooser);
g_signal_connect (priv->manager, "account-removed",
G_CALLBACK (account_chooser_account_removed_cb),
chooser);
account_chooser_setup (EMPATHY_ACCOUNT_CHOOSER (chooser));
}
static void
account_chooser_finalize (GObject *object)
{
EmpathyAccountChooserPriv *priv = GET_PRIV (object);
g_signal_handlers_disconnect_by_func (priv->manager,
account_chooser_account_validity_changed_cb,
object);
g_signal_handlers_disconnect_by_func (priv->manager,
account_chooser_account_removed_cb,
object);
g_object_unref (priv->manager);
G_OBJECT_CLASS (empathy_account_chooser_parent_class)->finalize (object);
}
static void
account_chooser_get_property (GObject *object,
guint param_id,
GValue *value,
GParamSpec *pspec)
{
EmpathyAccountChooserPriv *priv;
priv = GET_PRIV (object);
switch (param_id) {
case PROP_HAS_ALL_OPTION:
g_value_set_boolean (value, priv->has_all_option);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
break;
};
}
static void
account_chooser_set_property (GObject *object,
guint param_id,
const GValue *value,
GParamSpec *pspec)
{
EmpathyAccountChooserPriv *priv;
priv = GET_PRIV (object);
switch (param_id) {
case PROP_HAS_ALL_OPTION:
empathy_account_chooser_set_has_all_option (EMPATHY_ACCOUNT_CHOOSER (object),
g_value_get_boolean (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
break;
};
}
/**
* empathy_account_chooser_new:
*
* Creates a new #EmpathyAccountChooser.
*
* Return value: A new #EmpathyAccountChooser
*/
GtkWidget *
empathy_account_chooser_new (void)
{
GtkWidget *chooser;
chooser = g_object_new (EMPATHY_TYPE_ACCOUNT_CHOOSER, NULL);
return chooser;
}
/**
* empathy_account_chooser_dup_account:
* @chooser: an #EmpathyAccountChooser
*
* Returns the account which is currently selected in the chooser or %NULL
* if there is no account selected. The #TpAccount returned should be
* unrefed with g_object_unref() when finished with.
*
* Return value: a new ref to the #TpAccount currently selected, or %NULL.
*/
TpAccount *
empathy_account_chooser_dup_account (EmpathyAccountChooser *chooser)
{
EmpathyAccountChooserPriv *priv;
TpAccount *account;
GtkTreeModel *model;
GtkTreeIter iter;
g_return_val_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser), NULL);
priv = GET_PRIV (chooser);
model = gtk_combo_box_get_model (GTK_COMBO_BOX (chooser));
if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (chooser), &iter)) {
return NULL;
}
gtk_tree_model_get (model, &iter, COL_ACCOUNT_POINTER, &account, -1);
return account;
}
/**
* empathy_account_chooser_get_connection:
* @chooser: an #EmpathyAccountChooser
*
* Returns a borrowed reference to the #TpConnection associated with the
* account currently selected. The caller must reference the returned object with
* g_object_ref() if it will be kept
*
* Return value: a borrowed reference to the #TpConnection associated with the
* account curently selected.
*/
TpConnection *
empathy_account_chooser_get_connection (EmpathyAccountChooser *chooser)
{
EmpathyAccountChooserPriv *priv;
TpAccount *account;
TpConnection *connection;
g_return_val_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser), NULL);
priv = GET_PRIV (chooser);
account = empathy_account_chooser_dup_account (chooser);
connection = tp_account_get_connection (account);
g_object_unref (account);
return connection;
}
/**
* empathy_account_chooser_set_account:
* @chooser: an #EmpathyAccountChooser
* @account: a #TpAccount
*
* Sets the currently selected account to @account, if it exists in the list.
*
* Return value: whether the chooser was set to @account.
*/
gboolean
empathy_account_chooser_set_account (EmpathyAccountChooser *chooser,
TpAccount *account)
{
EmpathyAccountChooserPriv *priv;
GtkComboBox *combobox;
GtkTreeModel *model;
GtkTreeIter iter;
SetAccountData data;
g_return_val_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser), FALSE);
priv = GET_PRIV (chooser);
combobox = GTK_COMBO_BOX (chooser);
model = gtk_combo_box_get_model (combobox);
gtk_combo_box_get_active_iter (combobox, &iter);
data.chooser = chooser;
data.account = account;
gtk_tree_model_foreach (model,
(GtkTreeModelForeachFunc) account_chooser_set_account_foreach,
&data);
priv->account_manually_set = data.set;
return data.set;
}
/**
* empathy_account_chooser_get_has_all_option:
* @chooser: an #EmpathyAccountChooser
*
* Returns whether @chooser has the #EmpathyAccountChooser:has-all-option property
* set to true.
*
* Return value: whether @chooser has the #EmpathyAccountChooser:has-all-option property
* enabled.
*/
gboolean
empathy_account_chooser_get_has_all_option (EmpathyAccountChooser *chooser)
{
EmpathyAccountChooserPriv *priv;
g_return_val_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser), FALSE);
priv = GET_PRIV (chooser);
return priv->has_all_option;
}
/**
* empathy_account_chooser_set_has_all_option:
* @chooser: an #EmpathyAccountChooser
* @has_all_option: a new value for the #EmpathyAccountChooser:has-all-option property
*
* Sets the #EmpathyAccountChooser:has-all-option property.
*/
void
empathy_account_chooser_set_has_all_option (EmpathyAccountChooser *chooser,
gboolean has_all_option)
{
EmpathyAccountChooserPriv *priv;
GtkComboBox *combobox;
GtkListStore *store;
GtkTreeModel *model;
GtkTreeIter iter;
g_return_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser));
priv = GET_PRIV (chooser);
if (priv->has_all_option == has_all_option) {
return;
}
combobox = GTK_COMBO_BOX (chooser);
model = gtk_combo_box_get_model (combobox);
store = GTK_LIST_STORE (model);
priv->has_all_option = has_all_option;
/*
* The first 2 options are the ALL and separator
*/
if (has_all_option) {
gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (chooser),
(GtkTreeViewRowSeparatorFunc)
account_chooser_separator_func,
chooser,
NULL);
gtk_list_store_prepend (store, &iter);
gtk_list_store_set (store, &iter,
COL_ACCOUNT_TEXT, NULL,
COL_ACCOUNT_ENABLED, TRUE,
COL_ACCOUNT_POINTER, NULL,
-1);
gtk_list_store_prepend (store, &iter);
gtk_list_store_set (store, &iter,
COL_ACCOUNT_TEXT, _("All"),
COL_ACCOUNT_ENABLED, TRUE,
COL_ACCOUNT_POINTER, NULL,
-1);
} else {
if (gtk_tree_model_get_iter_first (model, &iter)) {
if (gtk_list_store_remove (GTK_LIST_STORE (model), &iter)) {
gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
}
}
gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (chooser),
(GtkTreeViewRowSeparatorFunc)
NULL,
NULL,
NULL);
}
g_object_notify (G_OBJECT (chooser), "has-all-option");
}
static void
account_manager_prepared_cb (GObject *source_object,
GAsyncResult *result,
gpointer user_data)
{
GList *accounts, *l;
TpAccountManager *manager = TP_ACCOUNT_MANAGER (source_object);
EmpathyAccountChooser *chooser = user_data;
if (!tp_account_manager_prepare_finish (manager, result, NULL)) {
return;
}
accounts = tp_account_manager_get_valid_accounts (manager);
for (l = accounts; l != NULL; l = l->next) {
TpAccount *account = l->data;
account_chooser_account_add_foreach (account, chooser);
empathy_signal_connect_weak (account, "status-changed",
G_CALLBACK (account_chooser_status_changed_cb),
G_OBJECT (chooser));
}
g_list_free (accounts);
}
static void
account_chooser_setup (EmpathyAccountChooser *chooser)
{
EmpathyAccountChooserPriv *priv;
GtkListStore *store;
GtkCellRenderer *renderer;
GtkComboBox *combobox;
priv = GET_PRIV (chooser);
/* Set up combo box with new store */
combobox = GTK_COMBO_BOX (chooser);
gtk_cell_layout_clear (GTK_CELL_LAYOUT (combobox));
store = gtk_list_store_new (COL_ACCOUNT_COUNT,
G_TYPE_STRING, /* Image */
G_TYPE_STRING, /* Name */
G_TYPE_BOOLEAN, /* Enabled */
TP_TYPE_ACCOUNT);
gtk_combo_box_set_model (combobox, GTK_TREE_MODEL (store));
renderer = gtk_cell_renderer_pixbuf_new ();
gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combobox), renderer, FALSE);
gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (combobox), renderer,
"icon-name", COL_ACCOUNT_IMAGE,
"sensitive", COL_ACCOUNT_ENABLED,
NULL);
g_object_set (renderer, "stock-size", GTK_ICON_SIZE_BUTTON, NULL);
renderer = gtk_cell_renderer_text_new ();
gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combobox), renderer, TRUE);
gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (combobox), renderer,
"text", COL_ACCOUNT_TEXT,
"sensitive", COL_ACCOUNT_ENABLED,
NULL);
/* Populate accounts */
tp_account_manager_prepare_async (priv->manager, NULL,
account_manager_prepared_cb, chooser);
g_object_unref (store);
}
static void
account_chooser_account_validity_changed_cb (TpAccountManager *manager,
TpAccount *account,
gboolean valid,
EmpathyAccountChooser *chooser)
{
if (valid) {
account_chooser_account_add_foreach (account, chooser);
} else {
account_chooser_account_remove_foreach (account, chooser);
}
}
static void
account_chooser_account_add_foreach (TpAccount *account,
EmpathyAccountChooser *chooser)
{
GtkListStore *store;
GtkComboBox *combobox;
GtkTreeIter iter;
gint position;
combobox = GTK_COMBO_BOX (chooser);
store = GTK_LIST_STORE (gtk_combo_box_get_model (combobox));
position = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (store), NULL);
gtk_list_store_insert_with_values (store, &iter, position,
COL_ACCOUNT_POINTER, account,
-1);
account_chooser_update_iter (chooser, &iter);
}
static void
account_chooser_account_removed_cb (TpAccountManager *manager,
TpAccount *account,
EmpathyAccountChooser *chooser)
{
account_chooser_account_remove_foreach (account, chooser);
}
typedef struct {
TpAccount *account;
GtkTreeIter *iter;
gboolean found;
} FindAccountData;
static gboolean
account_chooser_find_account_foreach (GtkTreeModel *model,
GtkTreePath *path,
GtkTreeIter *iter,
gpointer user_data)
{
FindAccountData *data = user_data;
TpAccount *account;
gtk_tree_model_get (model, iter, COL_ACCOUNT_POINTER, &account, -1);
if (account == data->account) {
data->found = TRUE;
*(data->iter) = *iter;
g_object_unref (account);
return TRUE;
}
g_object_unref (account);
return FALSE;
}
static gboolean
account_chooser_find_account (EmpathyAccountChooser *chooser,
TpAccount *account,
GtkTreeIter *iter)
{
GtkListStore *store;
GtkComboBox *combobox;
FindAccountData data;
combobox = GTK_COMBO_BOX (chooser);
store = GTK_LIST_STORE (gtk_combo_box_get_model (combobox));
data.account = account;
data.iter = iter;
gtk_tree_model_foreach (GTK_TREE_MODEL (store),
account_chooser_find_account_foreach,
&data);
return data.found;
}
static void
account_chooser_account_remove_foreach (TpAccount *account,
EmpathyAccountChooser *chooser)
{
GtkListStore *store;
GtkComboBox *combobox;
GtkTreeIter iter;
combobox = GTK_COMBO_BOX (chooser);
store = GTK_LIST_STORE (gtk_combo_box_get_model (combobox));
if (account_chooser_find_account (chooser, account, &iter)) {
gtk_list_store_remove (store, &iter);
}
}
static void
account_chooser_update_iter (EmpathyAccountChooser *chooser,
GtkTreeIter *iter)
{
EmpathyAccountChooserPriv *priv;
GtkListStore *store;
GtkComboBox *combobox;
TpAccount *account;
const gchar *icon_name;
gboolean is_enabled = TRUE;
priv = GET_PRIV (chooser);
combobox = GTK_COMBO_BOX (chooser);
store = GTK_LIST_STORE (gtk_combo_box_get_model (combobox));
gtk_tree_model_get (GTK_TREE_MODEL (store), iter,
COL_ACCOUNT_POINTER, &account,
-1);
icon_name = tp_account_get_icon_name (account);
if (priv->filter) {
is_enabled = priv->filter (account, priv->filter_data);
}
gtk_list_store_set (store, iter,
COL_ACCOUNT_IMAGE, icon_name,
COL_ACCOUNT_TEXT, tp_account_get_display_name (account),
COL_ACCOUNT_ENABLED, is_enabled,
-1);
/* set first connected account as active account */
if (priv->account_manually_set == FALSE &&
priv->set_active_item == FALSE && is_enabled) {
priv->set_active_item = TRUE;
gtk_combo_box_set_active_iter (combobox, iter);
}
g_object_unref (account);
}
static void
account_chooser_status_changed_cb (TpAccount *account,
guint old_status,
guint new_status,
guint reason,
gchar *dbus_error_name,
GHashTable *details,
gpointer user_data)
{
EmpathyAccountChooser *chooser = user_data;
GtkTreeIter iter;
if (account_chooser_find_account (chooser, account, &iter)) {
account_chooser_update_iter (chooser, &iter);
}
}
static gboolean
account_chooser_separator_func (GtkTreeModel *model,
GtkTreeIter *iter,
EmpathyAccountChooser *chooser)
{
EmpathyAccountChooserPriv *priv;
gchar *text;
gboolean is_separator;
priv = GET_PRIV (chooser);
if (!priv->has_all_option) {
return FALSE;
}
gtk_tree_model_get (model, iter, COL_ACCOUNT_TEXT, &text, -1);
is_separator = text == NULL;
g_free (text);
return is_separator;
}
static gboolean
account_chooser_set_account_foreach (GtkTreeModel *model,
GtkTreePath *path,
GtkTreeIter *iter,
SetAccountData *data)
{
TpAccount *account;
gboolean equal;
gtk_tree_model_get (model, iter, COL_ACCOUNT_POINTER, &account, -1);
/* Special case so we can make it possible to select the All option */
if ((data->account == NULL) != (account == NULL)) {
equal = FALSE;
}
else {
equal = (data->account == account);
}
if (account) {
g_object_unref (account);
}
if (equal) {
GtkComboBox *combobox;
combobox = GTK_COMBO_BOX (data->chooser);
gtk_combo_box_set_active_iter (combobox, iter);
data->set = TRUE;
}
return equal;
}
static gboolean
account_chooser_filter_foreach (GtkTreeModel *model,
GtkTreePath *path,
GtkTreeIter *iter,
gpointer chooser)
{
account_chooser_update_iter (chooser, iter);
return FALSE;
}
/**
* empathy_account_chooser_set_filter:
* @chooser: an #EmpathyAccountChooser
* @filter: a filter
* @user_data: data to pass to @filter, or %NULL
*
* Sets a filter on the @chooser so only accounts that are %TRUE in the eyes
* of the filter are visible in the @chooser.
*/
void
empathy_account_chooser_set_filter (EmpathyAccountChooser *chooser,
EmpathyAccountChooserFilterFunc filter,
gpointer user_data)
{
EmpathyAccountChooserPriv *priv;
GtkTreeModel *model;
g_return_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser));
priv = GET_PRIV (chooser);
priv->filter = filter;
priv->filter_data = user_data;
/* Refilter existing data */
priv->set_active_item = FALSE;
model = gtk_combo_box_get_model (GTK_COMBO_BOX (chooser));
gtk_tree_model_foreach (model, account_chooser_filter_foreach, chooser);
}
/**
* EmpathyAccountChooserFilterFunc:
* @account: a #TpAccount
* @user_data: user data, or %NULL
*
* A function which decides whether the account indicated by @account
* is visible.
*
* Return value: whether the account indicated by @account is visible.
*/
/**
* empathy_account_chooser_filter_is_connected:
* @account: a #TpAccount
* @user_data: user data or %NULL
*
* A useful #EmpathyAccountChooserFilterFunc that one could pass into
* empathy_account_chooser_set_filter() and only show connected accounts.
*
* Return value: Whether @account is connected
*/
gboolean
empathy_account_chooser_filter_is_connected (TpAccount *account,
gpointer user_data)
{
return (tp_account_get_connection_status (account, NULL)
== TP_CONNECTION_STATUS_CONNECTED);
}
