libempathy-gtk/empathy-persona-store.c

   1 /*
   2  * Copyright (C) 2005-2007 Imendio AB
   3  * Copyright (C) 2007-2008, 2010 Collabora Ltd.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public
  16  * License along with this program; if not, write to the
  17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  18  * Boston, MA  02110-1301  USA
  19  *
  20  * Authors: Mikael Hallendal <micke@imendio.com>
  21  *          Martyn Russell <martyn@imendio.com>
  22  *          Xavier Claessens <xclaesse@gmail.com>
  23  *          Philip Withnall <philip.withnall@collabora.co.uk>
  24  *
  25  * Based off EmpathyContactListStore.
  26  */
  27
  28 #include "config.h"
  29
  30 #include <string.h>
  31
  32 #include <glib.h>
  33 #include <glib/gi18n-lib.h>
  34 #include <gtk/gtk.h>
  35
  36 #include <telepathy-glib/util.h>
  37
  38 #include <folks/folks.h>
  39 #include <folks/folks-telepathy.h>
  40
  41 #include <libempathy/empathy-utils.h>
  42
  43 #include "empathy-persona-store.h"
  44 #include "empathy-gtk-enum-types.h"
  45 #include "empathy-ui-utils.h"
  46
  47 #define DEBUG_FLAG EMPATHY_DEBUG_CONTACT
  48 #include <libempathy/empathy-debug.h>
  49
  50 /* Active users are those which have recently changed state
  51  * (e.g. online, offline or from normal to a busy state). */
  52
  53 /* Time in seconds user is shown as active */
  54 #define ACTIVE_USER_SHOW_TIME 7
  55
  56 /* Time in seconds after connecting which we wait before active users are
  57  * enabled */
  58 #define ACTIVE_USER_WAIT_TO_ENABLE_TIME 5
  59
  60 static void add_persona (EmpathyPersonaStore *self,
  61     FolksPersona *persona);
  62 static GtkTreePath * find_persona (EmpathyPersonaStore *self,
  63     FolksPersona *persona);
  64 static void update_persona (EmpathyPersonaStore *self,
  65     FolksPersona *persona);
  66 static void remove_persona (EmpathyPersonaStore *self,
  67     FolksPersona *persona);
  68
  69 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyPersonaStore)
  70
  71 typedef struct
  72 {
  73   FolksIndividual *individual; /* owned */
  74   GHashTable *personas; /* owned Persona -> owned GtkTreeRowReference */
  75
  76   gboolean show_avatars;
  77   gboolean show_protocols;
  78   gboolean show_active;
  79   EmpathyPersonaStoreSort sort_criterion;
  80
  81   guint inhibit_active;
  82   guint setup_idle_id;
  83
  84   GHashTable *status_icons; /* owned icon name -> owned GdkPixbuf */
  85 } EmpathyPersonaStorePriv;
  86
  87 enum {
  88   PROP_0,
  89   PROP_INDIVIDUAL,
  90   PROP_SHOW_AVATARS,
  91   PROP_SHOW_PROTOCOLS,
  92   PROP_SORT_CRITERION
  93 };
  94
  95 G_DEFINE_TYPE (EmpathyPersonaStore, empathy_persona_store, GTK_TYPE_LIST_STORE);
  96
  97 static gboolean
  98 inhibit_active_cb (EmpathyPersonaStore *store)
  99 {
 100   EmpathyPersonaStorePriv *priv;
 101
 102   priv = GET_PRIV (store);
 103
 104   priv->show_active = TRUE;
 105   priv->inhibit_active = 0;
 106
 107   return FALSE;
 108 }
 109
 110 typedef struct {
 111   EmpathyPersonaStore *store;
 112   FolksPersona *persona;
 113   gboolean remove;
 114   guint timeout;
 115 } ShowActiveData;
 116
 117 static void persona_active_free (ShowActiveData *data);
 118
 119 static void
 120 persona_active_invalidated (ShowActiveData *data,
 121     GObject *old_object)
 122 {
 123   /* Remove the timeout and free the struct, since the persona or persona
 124    * store has disappeared. */
 125   g_source_remove (data->timeout);
 126
 127   if (old_object == (GObject *) data->store)
 128     data->store = NULL;
 129   else if (old_object == (GObject *) data->persona)
 130     data->persona = NULL;
 131   else
 132     g_assert_not_reached ();
 133
 134   persona_active_free (data);
 135 }
 136
 137 static ShowActiveData *
 138 persona_active_new (EmpathyPersonaStore *self,
 139     FolksPersona *persona,
 140     gboolean remove_)
 141 {
 142   ShowActiveData *data;
 143
 144   DEBUG ("Contact:'%s' now active, and %s be removed",
 145       folks_aliasable_get_alias (FOLKS_ALIASABLE (persona)),
 146       remove_ ? "WILL" : "WILL NOT");
 147
 148   data = g_slice_new0 (ShowActiveData);
 149
 150   /* We don't actually want to force either the PersonaStore or the
 151    * Persona to stay alive, since the user could quit Empathy or disable
 152    * the account before the persona_active timeout is fired. */
 153   g_object_weak_ref (G_OBJECT (self),
 154       (GWeakNotify) persona_active_invalidated, data);
 155   g_object_weak_ref (G_OBJECT (persona),
 156       (GWeakNotify) persona_active_invalidated, data);
 157
 158   data->store = self;
 159   data->persona = persona;
 160   data->remove = remove_;
 161
 162   return data;
 163 }
 164
 165 static void
 166 persona_active_free (ShowActiveData *data)
 167 {
 168   if (data->store != NULL)
 169     {
 170       g_object_weak_unref (G_OBJECT (data->store),
 171           (GWeakNotify) persona_active_invalidated, data);
 172     }
 173
 174   if (data->persona != NULL)
 175     {
 176       g_object_weak_unref (G_OBJECT (data->persona),
 177           (GWeakNotify) persona_active_invalidated, data);
 178     }
 179
 180   g_slice_free (ShowActiveData, data);
 181 }
 182
 183 static void
 184 persona_set_active (EmpathyPersonaStore *self,
 185     FolksPersona *persona,
 186     gboolean active,
 187     gboolean set_changed)
 188 {
 189   EmpathyPersonaStorePriv *priv;
 190   GtkTreePath *path;
 191   GtkTreeIter iter;
 192
 193   priv = GET_PRIV (self);
 194
 195   path = find_persona (self, persona);
 196   if (path == NULL)
 197     return;
 198
 199   gtk_tree_model_get_iter (GTK_TREE_MODEL (self), &iter, path);
 200   gtk_list_store_set (GTK_LIST_STORE (self), &iter,
 201       EMPATHY_PERSONA_STORE_COL_IS_ACTIVE, active,
 202       -1);
 203
 204   DEBUG ("Set item %s", active ? "active" : "inactive");
 205
 206   if (set_changed)
 207     gtk_tree_model_row_changed (GTK_TREE_MODEL (self), path, &iter);
 208
 209   gtk_tree_path_free (path);
 210 }
 211
 212 static gboolean
 213 persona_active_cb (ShowActiveData *data)
 214 {
 215   const gchar *alias =
 216       folks_aliasable_get_alias (FOLKS_ALIASABLE (data->persona));
 217
 218   if (data->remove)
 219     {
 220       DEBUG ("Contact:'%s' active timeout, removing item", alias);
 221       remove_persona (data->store, data->persona);
 222     }
 223
 224   DEBUG ("Contact:'%s' no longer active", alias);
 225   persona_set_active (data->store, data->persona, FALSE, TRUE);
 226
 227   persona_active_free (data);
 228
 229   return FALSE;
 230 }
 231
 232 static void
 233 persona_updated_cb (FolksPersona *persona,
 234     GParamSpec *pspec,
 235     EmpathyPersonaStore *self)
 236 {
 237   DEBUG ("Contact:'%s' updated, checking roster is in sync...",
 238       folks_aliasable_get_alias (FOLKS_ALIASABLE (persona)));
 239
 240   update_persona (self, persona);
 241 }
 242
 243 static void
 244 add_persona_and_connect (EmpathyPersonaStore *self,
 245     FolksPersona *persona)
 246 {
 247   /* We don't want any non-Telepathy personas */
 248   if (!TPF_IS_PERSONA (persona))
 249     return;
 250
 251   g_signal_connect (persona, "notify::presence",
 252       (GCallback) persona_updated_cb, self);
 253   g_signal_connect (persona, "notify::presence-message",
 254       (GCallback) persona_updated_cb, self);
 255   g_signal_connect (persona, "notify::alias",
 256       (GCallback) persona_updated_cb, self);
 257   g_signal_connect (persona, "notify::avatar",
 258       (GCallback) persona_updated_cb, self);
 259
 260   add_persona (self, persona);
 261 }
 262
 263 static void
 264 remove_persona_and_disconnect (EmpathyPersonaStore *self,
 265     FolksPersona *persona)
 266 {
 267   if (!TPF_IS_PERSONA (persona))
 268     return;
 269
 270   g_signal_handlers_disconnect_by_func (persona,
 271       (GCallback) persona_updated_cb, self);
 272
 273   remove_persona (self, persona);
 274 }
 275
 276 static void
 277 add_persona (EmpathyPersonaStore *self,
 278     FolksPersona *persona)
 279 {
 280   EmpathyPersonaStorePriv *priv;
 281   GtkTreeIter iter;
 282   GtkTreePath *path;
 283   FolksPersonaStore *store;
 284   EmpathyContact *contact;
 285   const gchar *alias;
 286
 287   if (!TPF_IS_PERSONA (persona))
 288     return;
 289
 290   priv = GET_PRIV (self);
 291
 292   alias = folks_aliasable_get_alias (FOLKS_ALIASABLE (persona));
 293   if (EMP_STR_EMPTY (alias))
 294     return;
 295
 296   contact = empathy_contact_dup_from_tp_contact (tpf_persona_get_contact (
 297       TPF_PERSONA (persona)));
 298   store = folks_persona_get_store (persona);
 299
 300   gtk_list_store_insert_with_values (GTK_LIST_STORE (self), &iter, 0,
 301       EMPATHY_PERSONA_STORE_COL_NAME, alias,
 302       EMPATHY_PERSONA_STORE_COL_ACCOUNT_NAME,
 303           folks_persona_store_get_display_name (store),
 304       EMPATHY_PERSONA_STORE_COL_DISPLAY_ID,
 305           folks_persona_get_display_id (persona),
 306       EMPATHY_PERSONA_STORE_COL_PERSONA, persona,
 307       EMPATHY_PERSONA_STORE_COL_CAN_AUDIO_CALL,
 308           empathy_contact_get_capabilities (contact) &
 309               EMPATHY_CAPABILITIES_AUDIO,
 310       EMPATHY_PERSONA_STORE_COL_CAN_VIDEO_CALL,
 311           empathy_contact_get_capabilities (contact) &
 312               EMPATHY_CAPABILITIES_VIDEO,
 313       -1);
 314
 315   g_object_unref (contact);
 316
 317   path = gtk_tree_model_get_path (GTK_TREE_MODEL (self), &iter);
 318   g_hash_table_replace (priv->personas, g_object_ref (persona),
 319       gtk_tree_row_reference_new (GTK_TREE_MODEL (self), path));
 320   gtk_tree_path_free (path);
 321
 322   update_persona (self, persona);
 323 }
 324
 325 static void
 326 remove_persona (EmpathyPersonaStore *self,
 327     FolksPersona *persona)
 328 {
 329   EmpathyPersonaStorePriv *priv;
 330   GtkTreePath *path;
 331   GtkTreeIter iter;
 332
 333   if (!TPF_IS_PERSONA (persona))
 334     return;
 335
 336   priv = GET_PRIV (self);
 337
 338   path = find_persona (self, persona);
 339   if (path == NULL)
 340     return;
 341
 342   g_hash_table_remove (priv->personas, persona);
 343
 344   gtk_tree_model_get_iter (GTK_TREE_MODEL (self), &iter, path);
 345   gtk_list_store_remove (GTK_LIST_STORE (self), &iter);
 346   gtk_tree_path_free (path);
 347 }
 348
 349 static GdkPixbuf *
 350 get_persona_status_icon (EmpathyPersonaStore *self,
 351     FolksPersona *persona)
 352 {
 353   EmpathyPersonaStorePriv *priv = GET_PRIV (self);
 354   EmpathyContact *contact;
 355   const gchar *protocol_name = NULL;
 356   gchar *icon_name = NULL;
 357   GdkPixbuf *pixbuf_status = NULL;
 358   const gchar *status_icon_name = NULL;
 359
 360   contact = empathy_contact_dup_from_tp_contact (tpf_persona_get_contact (
 361       TPF_PERSONA (persona)));
 362
 363   status_icon_name = empathy_icon_name_for_contact (contact);
 364   if (status_icon_name == NULL)
 365     {
 366       g_object_unref (contact);
 367       return NULL;
 368     }
 369
 370   if (priv->show_protocols)
 371     {
 372       protocol_name = empathy_protocol_name_for_contact (contact);
 373       icon_name = g_strdup_printf ("%s-%s", status_icon_name, protocol_name);
 374     }
 375   else
 376     {
 377       icon_name = g_strdup_printf ("%s", status_icon_name);
 378     }
 379
 380   pixbuf_status = g_hash_table_lookup (priv->status_icons, icon_name);
 381
 382   if (pixbuf_status == NULL)
 383     {
 384       pixbuf_status = empathy_pixbuf_contact_status_icon_with_icon_name (
 385           contact, status_icon_name, priv->show_protocols);
 386
 387       if (pixbuf_status != NULL)
 388         {
 389           g_hash_table_insert (priv->status_icons, g_strdup (icon_name),
 390               pixbuf_status);
 391         }
 392     }
 393
 394   g_object_unref (contact);
 395   g_free (icon_name);
 396
 397   return pixbuf_status;
 398 }
 399
 400 static void
 401 update_persona (EmpathyPersonaStore *self,
 402     FolksPersona *persona)
 403 {
 404   EmpathyPersonaStorePriv *priv = GET_PRIV (self);
 405   GtkTreePath *path;
 406   gboolean do_set_active = FALSE;
 407   gboolean do_set_refresh = FALSE;
 408   const gchar *alias;
 409
 410   path = find_persona (self, persona);
 411   alias = folks_aliasable_get_alias (FOLKS_ALIASABLE (persona));
 412
 413   if (path == NULL)
 414     {
 415       DEBUG ("Contact:'%s' in list:NO, should be:YES", alias);
 416
 417       add_persona (self, persona);
 418
 419       if (priv->show_active)
 420         {
 421           do_set_active = TRUE;
 422           DEBUG ("Set active (contact added)");
 423         }
 424     }
 425   else
 426     {
 427       FolksPersonaStore *store;
 428       EmpathyContact *contact;
 429       GtkTreeIter iter;
 430       GdkPixbuf *pixbuf_avatar;
 431       GdkPixbuf *pixbuf_status;
 432       gboolean now_online = FALSE;
 433       gboolean was_online = TRUE;
 434
 435       DEBUG ("Contact:'%s' in list:YES, should be:YES", alias);
 436
 437       gtk_tree_model_get_iter (GTK_TREE_MODEL (self), &iter, path);
 438       gtk_tree_path_free (path);
 439
 440       /* Get online state now. */
 441       now_online = folks_presence_is_online (FOLKS_PRESENCE (persona));
 442
 443       /* Get online state before. */
 444       gtk_tree_model_get (GTK_TREE_MODEL (self), &iter,
 445           EMPATHY_PERSONA_STORE_COL_IS_ONLINE, &was_online,
 446           -1);
 447
 448       /* Is this really an update or an online/offline. */
 449       if (priv->show_active)
 450         {
 451           if (was_online != now_online)
 452             {
 453               do_set_active = TRUE;
 454               do_set_refresh = TRUE;
 455
 456               DEBUG ("Set active (contact updated %s)",
 457                   was_online ? "online  -> offline" : "offline -> online");
 458             }
 459           else
 460             {
 461               /* Was TRUE for presence updates. */
 462               /* do_set_active = FALSE;  */
 463               do_set_refresh = TRUE;
 464               DEBUG ("Set active (contact updated)");
 465             }
 466         }
 467
 468       /* We still need to use EmpathyContact for the capabilities stuff */
 469       contact = empathy_contact_dup_from_tp_contact (tpf_persona_get_contact (
 470           TPF_PERSONA (persona)));
 471       store = folks_persona_get_store (persona);
 472
 473       pixbuf_avatar = empathy_pixbuf_avatar_from_contact_scaled (contact,
 474           32, 32);
 475       pixbuf_status = get_persona_status_icon (self, persona);
 476
 477       gtk_list_store_set (GTK_LIST_STORE (self), &iter,
 478           EMPATHY_PERSONA_STORE_COL_ICON_STATUS, pixbuf_status,
 479           EMPATHY_PERSONA_STORE_COL_PIXBUF_AVATAR, pixbuf_avatar,
 480           EMPATHY_PERSONA_STORE_COL_PIXBUF_AVATAR_VISIBLE, priv->show_avatars,
 481           EMPATHY_PERSONA_STORE_COL_NAME, alias,
 482           EMPATHY_PERSONA_STORE_COL_ACCOUNT_NAME,
 483               folks_persona_store_get_display_name (store),
 484           EMPATHY_PERSONA_STORE_COL_DISPLAY_ID,
 485               folks_persona_get_display_id (persona),
 486           EMPATHY_PERSONA_STORE_COL_PRESENCE_TYPE,
 487               folks_presence_get_presence_type (FOLKS_PRESENCE (persona)),
 488           EMPATHY_PERSONA_STORE_COL_STATUS,
 489               folks_presence_get_presence_message (FOLKS_PRESENCE (persona)),
 490           EMPATHY_PERSONA_STORE_COL_IS_ONLINE, now_online,
 491           EMPATHY_PERSONA_STORE_COL_CAN_AUDIO_CALL,
 492               empathy_contact_get_capabilities (contact) &
 493                 EMPATHY_CAPABILITIES_AUDIO,
 494           EMPATHY_PERSONA_STORE_COL_CAN_VIDEO_CALL,
 495               empathy_contact_get_capabilities (contact) &
 496                 EMPATHY_CAPABILITIES_VIDEO,
 497           -1);
 498
 499       g_object_unref (contact);
 500
 501       if (pixbuf_avatar)
 502         g_object_unref (pixbuf_avatar);
 503     }
 504
 505   if (priv->show_active && do_set_active)
 506     {
 507       persona_set_active (self, persona, do_set_active, do_set_refresh);
 508
 509       if (do_set_active)
 510         {
 511           ShowActiveData *data;
 512
 513           data = persona_active_new (self, persona, FALSE);
 514           data->timeout = g_timeout_add_seconds (ACTIVE_USER_SHOW_TIME,
 515               (GSourceFunc) persona_active_cb,
 516               data);
 517         }
 518     }
 519
 520   /* FIXME: when someone goes online then offline quickly, the
 521    * first timeout sets the user to be inactive and the second
 522    * timeout removes the user from the contact list, really we
 523    * should remove the first timeout.
 524    */
 525 }
 526
 527 static void
 528 individual_personas_changed_cb (GObject *object,
 529     GList *added,
 530     GList *removed,
 531     EmpathyPersonaStore *self)
 532 {
 533   GList *l;
 534
 535   /* Remove the old personas. */
 536   for (l = removed; l != NULL; l = l->next)
 537     remove_persona_and_disconnect (self, FOLKS_PERSONA (l->data));
 538
 539   /* Add each of the new personas to the tree model */
 540   for (l = added; l != NULL; l = l->next)
 541     add_persona_and_connect (self, FOLKS_PERSONA (l->data));
 542 }
 543
 544 static gint
 545 sort_personas (FolksPersona *persona_a,
 546     FolksPersona *persona_b)
 547 {
 548   EmpathyContact *contact;
 549   TpAccount *account_a, *account_b;
 550   gint ret_val;
 551
 552   g_return_val_if_fail (persona_a != NULL || persona_b != NULL, 0);
 553
 554   /* alias */
 555   ret_val = g_utf8_collate (
 556       folks_aliasable_get_alias (FOLKS_ALIASABLE (persona_a)),
 557       folks_aliasable_get_alias (FOLKS_ALIASABLE (persona_b)));
 558
 559   if (ret_val != 0)
 560     goto out;
 561
 562   /* identifier */
 563   ret_val = g_utf8_collate (folks_persona_get_display_id (persona_a),
 564           folks_persona_get_display_id (persona_b));
 565
 566   if (ret_val != 0)
 567     goto out;
 568
 569   contact = empathy_contact_dup_from_tp_contact (tpf_persona_get_contact (
 570       TPF_PERSONA (persona_a)));
 571   account_a = empathy_contact_get_account (contact);
 572   g_object_unref (contact);
 573
 574   contact = empathy_contact_dup_from_tp_contact (tpf_persona_get_contact (
 575       TPF_PERSONA (persona_b)));
 576   account_b = empathy_contact_get_account (contact);
 577   g_object_unref (contact);
 578
 579   /* protocol */
 580   ret_val = strcmp (tp_account_get_protocol (account_a),
 581         tp_account_get_protocol (account_a));
 582
 583   if (ret_val != 0)
 584     goto out;
 585
 586   /* account ID */
 587   ret_val = strcmp (tp_proxy_get_object_path (account_a),
 588         tp_proxy_get_object_path (account_a));
 589
 590 out:
 591   return ret_val;
 592 }
 593
 594 static gint
 595 state_sort_func (GtkTreeModel *model,
 596     GtkTreeIter *iter_a,
 597     GtkTreeIter *iter_b,
 598     gpointer user_data)
 599 {
 600   gint ret_val;
 601   gchar *name_a, *name_b;
 602   FolksPersona *persona_a, *persona_b;
 603
 604   gtk_tree_model_get (model, iter_a,
 605           EMPATHY_PERSONA_STORE_COL_NAME, &name_a,
 606           EMPATHY_PERSONA_STORE_COL_PERSONA, &persona_a,
 607           -1);
 608   gtk_tree_model_get (model, iter_b,
 609           EMPATHY_PERSONA_STORE_COL_NAME, &name_b,
 610           EMPATHY_PERSONA_STORE_COL_PERSONA, &persona_b,
 611           -1);
 612
 613   if (persona_a == NULL || persona_b == NULL) {
 614     ret_val = 0;
 615     goto free_and_out;
 616   }
 617
 618   /* If we managed to get this far, we can start looking at
 619    * the presences.
 620    */
 621   ret_val = -tp_connection_presence_type_cmp_availability (
 622       folks_presence_get_presence_type (FOLKS_PRESENCE (persona_a)),
 623       folks_presence_get_presence_type (FOLKS_PRESENCE (persona_b)));
 624
 625   if (ret_val == 0) {
 626     /* Fallback: compare by name et al. */
 627     ret_val = sort_personas (persona_a, persona_b);
 628   }
 629
 630 free_and_out:
 631   g_free (name_a);
 632   g_free (name_b);
 633
 634   tp_clear_object (&persona_a);
 635   tp_clear_object (&persona_b);
 636
 637   return ret_val;
 638 }
 639
 640 static gint
 641 name_sort_func (GtkTreeModel *model,
 642     GtkTreeIter *iter_a,
 643     GtkTreeIter *iter_b,
 644     gpointer user_data)
 645 {
 646   gchar *name_a, *name_b;
 647   FolksPersona *persona_a, *persona_b;
 648   gint ret_val;
 649
 650   gtk_tree_model_get (model, iter_a,
 651           EMPATHY_PERSONA_STORE_COL_NAME, &name_a,
 652           EMPATHY_PERSONA_STORE_COL_PERSONA, &persona_a,
 653           -1);
 654   gtk_tree_model_get (model, iter_b,
 655           EMPATHY_PERSONA_STORE_COL_NAME, &name_b,
 656           EMPATHY_PERSONA_STORE_COL_PERSONA, &persona_b,
 657           -1);
 658
 659   if (persona_a == NULL || persona_b == NULL)
 660     ret_val = 0;
 661   else
 662     ret_val = sort_personas (persona_a, persona_b);
 663
 664   tp_clear_object (&persona_a);
 665   tp_clear_object (&persona_b);
 666
 667   return ret_val;
 668 }
 669
 670 static GtkTreePath *
 671 find_persona (EmpathyPersonaStore *self,
 672     FolksPersona *persona)
 673 {
 674   EmpathyPersonaStorePriv *priv = GET_PRIV (self);
 675   GtkTreeRowReference *row;
 676
 677   row = g_hash_table_lookup (priv->personas, persona);
 678   if (row == NULL)
 679     return NULL;
 680
 681   return gtk_tree_row_reference_get_path (row);
 682 }
 683
 684 static gboolean
 685 update_list_mode_foreach (GtkTreeModel *model,
 686     GtkTreePath *path,
 687     GtkTreeIter *iter,
 688     EmpathyPersonaStore *self)
 689 {
 690   EmpathyPersonaStorePriv *priv;
 691   FolksPersona *persona;
 692   GdkPixbuf *pixbuf_status;
 693
 694   priv = GET_PRIV (self);
 695
 696   gtk_tree_model_get (model, iter,
 697       EMPATHY_PERSONA_STORE_COL_PERSONA, &persona,
 698       -1);
 699
 700   if (persona == NULL)
 701     return FALSE;
 702
 703   /* get icon from hash_table */
 704   pixbuf_status = get_persona_status_icon (self, persona);
 705
 706   gtk_list_store_set (GTK_LIST_STORE (self), iter,
 707       EMPATHY_PERSONA_STORE_COL_ICON_STATUS, pixbuf_status,
 708       EMPATHY_PERSONA_STORE_COL_PIXBUF_AVATAR_VISIBLE, priv->show_avatars,
 709       -1);
 710
 711   tp_clear_object (&persona);
 712
 713   return FALSE;
 714 }
 715
 716 static void
 717 set_up (EmpathyPersonaStore *self)
 718 {
 719   EmpathyPersonaStorePriv *priv;
 720   GType types[] = {
 721     GDK_TYPE_PIXBUF,      /* Status pixbuf */
 722     GDK_TYPE_PIXBUF,      /* Avatar pixbuf */
 723     G_TYPE_BOOLEAN,       /* Avatar pixbuf visible */
 724     G_TYPE_STRING,        /* Name */
 725     G_TYPE_STRING,        /* Account name */
 726     G_TYPE_STRING,        /* Display ID */
 727     G_TYPE_UINT,          /* Presence type */
 728     G_TYPE_STRING,        /* Status string */
 729     FOLKS_TYPE_PERSONA,   /* Persona */
 730     G_TYPE_BOOLEAN,       /* Is active */
 731     G_TYPE_BOOLEAN,       /* Is online */
 732     G_TYPE_BOOLEAN,       /* Can make audio calls */
 733     G_TYPE_BOOLEAN,       /* Can make video calls */
 734   };
 735
 736   priv = GET_PRIV (self);
 737
 738   gtk_list_store_set_column_types (GTK_LIST_STORE (self),
 739       EMPATHY_PERSONA_STORE_COL_COUNT, types);
 740
 741   /* Set up sorting */
 742   gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (self),
 743       EMPATHY_PERSONA_STORE_COL_NAME, name_sort_func, self, NULL);
 744   gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (self),
 745       EMPATHY_PERSONA_STORE_COL_STATUS, state_sort_func, self, NULL);
 746
 747   priv->sort_criterion = EMPATHY_PERSONA_STORE_SORT_NAME;
 748   empathy_persona_store_set_sort_criterion (self, priv->sort_criterion);
 749 }
 750
 751 static void
 752 empathy_persona_store_init (EmpathyPersonaStore *self)
 753 {
 754   EmpathyPersonaStorePriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
 755       EMPATHY_TYPE_PERSONA_STORE, EmpathyPersonaStorePriv);
 756
 757   self->priv = priv;
 758
 759   priv->show_avatars = TRUE;
 760   priv->show_protocols = FALSE;
 761   priv->inhibit_active = g_timeout_add_seconds (ACTIVE_USER_WAIT_TO_ENABLE_TIME,
 762       (GSourceFunc) inhibit_active_cb, self);
 763
 764   priv->status_icons = g_hash_table_new_full (g_str_hash, g_str_equal, g_free,
 765       g_object_unref);
 766   priv->personas = g_hash_table_new_full (g_direct_hash, g_direct_equal,
 767       g_object_unref, (GDestroyNotify) gtk_tree_row_reference_free);
 768
 769   set_up (self);
 770 }
 771
 772 static void
 773 get_property (GObject *object,
 774     guint param_id,
 775     GValue *value,
 776     GParamSpec *pspec)
 777 {
 778   EmpathyPersonaStorePriv *priv = GET_PRIV (object);
 779
 780   switch (param_id)
 781     {
 782       case PROP_INDIVIDUAL:
 783         g_value_set_object (value, priv->individual);
 784         break;
 785       case PROP_SHOW_AVATARS:
 786         g_value_set_boolean (value, priv->show_avatars);
 787         break;
 788       case PROP_SHOW_PROTOCOLS:
 789         g_value_set_boolean (value, priv->show_protocols);
 790         break;
 791       case PROP_SORT_CRITERION:
 792         g_value_set_enum (value, priv->sort_criterion);
 793         break;
 794       default:
 795         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 796         break;
 797     }
 798 }
 799
 800 static void
 801 set_property (GObject *object,
 802     guint param_id,
 803     const GValue *value,
 804     GParamSpec *pspec)
 805 {
 806   EmpathyPersonaStore *self = EMPATHY_PERSONA_STORE (object);
 807
 808   switch (param_id)
 809     {
 810       case PROP_INDIVIDUAL:
 811         empathy_persona_store_set_individual (self, g_value_get_object (value));
 812         break;
 813       case PROP_SHOW_AVATARS:
 814         empathy_persona_store_set_show_avatars (self,
 815             g_value_get_boolean (value));
 816         break;
 817       case PROP_SHOW_PROTOCOLS:
 818         empathy_persona_store_set_show_protocols (self,
 819             g_value_get_boolean (value));
 820         break;
 821       case PROP_SORT_CRITERION:
 822         empathy_persona_store_set_sort_criterion (self,
 823             g_value_get_enum (value));
 824         break;
 825       default:
 826         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 827         break;
 828     }
 829 }
 830
 831 static void
 832 dispose (GObject *object)
 833 {
 834   EmpathyPersonaStorePriv *priv = GET_PRIV (object);
 835
 836   empathy_persona_store_set_individual (EMPATHY_PERSONA_STORE (object), NULL);
 837
 838   if (priv->inhibit_active != 0)
 839     {
 840       g_source_remove (priv->inhibit_active);
 841       priv->inhibit_active = 0;
 842     }
 843
 844   if (priv->setup_idle_id != 0)
 845     {
 846       g_source_remove (priv->setup_idle_id);
 847       priv->setup_idle_id = 0;
 848     }
 849
 850   G_OBJECT_CLASS (empathy_persona_store_parent_class)->dispose (object);
 851 }
 852
 853 static void
 854 finalize (GObject *object)
 855 {
 856   EmpathyPersonaStorePriv *priv = GET_PRIV (object);
 857
 858   g_hash_table_destroy (priv->status_icons);
 859   g_hash_table_destroy (priv->personas);
 860
 861   G_OBJECT_CLASS (empathy_persona_store_parent_class)->finalize (object);
 862 }
 863
 864 static void
 865 empathy_persona_store_class_init (EmpathyPersonaStoreClass *klass)
 866 {
 867   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 868
 869   object_class->get_property = get_property;
 870   object_class->set_property = set_property;
 871   object_class->dispose = dispose;
 872   object_class->finalize = finalize;
 873
 874   /**
 875    * EmpathyPersonaStore:individual:
 876    *
 877    * The #FolksIndividual whose personas should be listed by the store. This
 878    * may be %NULL, which results in an empty store.
 879    */
 880   g_object_class_install_property (object_class, PROP_INDIVIDUAL,
 881       g_param_spec_object ("individual",
 882           "Individual",
 883           "The FolksIndividual whose Personas should be listed by the store.",
 884           FOLKS_TYPE_INDIVIDUAL,
 885           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 886
 887   /**
 888    * EmpathyPersonaStore:show-avatars:
 889    *
 890    * Whether the store should display avatars for personas. This is a property
 891    * of the store rather than of #EmpathyPersonaView for efficiency reasons.
 892    */
 893   g_object_class_install_property (object_class, PROP_SHOW_AVATARS,
 894       g_param_spec_boolean ("show-avatars",
 895           "Show Avatars",
 896           "Whether the store should display avatars for personas.",
 897           TRUE,
 898           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 899
 900   /**
 901    * EmpathyPersonaStore:show-protocols:
 902    *
 903    * Whether the store should display protocol icons for personas. This is a
 904    * property of the store rather than of #EmpathyPersonaView because it is
 905    * closely tied in with #EmpathyPersonaStore:show-avatars.
 906    */
 907   g_object_class_install_property (object_class, PROP_SHOW_PROTOCOLS,
 908       g_param_spec_boolean ("show-protocols",
 909           "Show Protocols",
 910           "Whether the store should display protocol icons for personas.",
 911           FALSE,
 912           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 913
 914   /**
 915    * EmpathyPersonaStore:sort-criterion:
 916    *
 917    * The criterion used to sort the personas in the store.
 918    */
 919   g_object_class_install_property (object_class, PROP_SORT_CRITERION,
 920       g_param_spec_enum ("sort-criterion",
 921           "Sort criterion",
 922           "The sort criterion to use for sorting the persona list",
 923           EMPATHY_TYPE_PERSONA_STORE_SORT,
 924           EMPATHY_PERSONA_STORE_SORT_NAME,
 925           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 926
 927   g_type_class_add_private (object_class, sizeof (EmpathyPersonaStorePriv));
 928 }
 929
 930 /**
 931  * empathy_persona_store_new:
 932  * @individual: the #FolksIndividual whose personas should be used in the store,
 933  * or %NULL
 934  *
 935  * Create a new #EmpathyPersonaStore with the personas from the given
 936  * @individual.
 937  *
 938  * Return value: a new #EmpathyPersonaStore
 939  */
 940 EmpathyPersonaStore *
 941 empathy_persona_store_new (FolksIndividual *individual)
 942 {
 943   g_return_val_if_fail (individual == NULL || FOLKS_IS_INDIVIDUAL (individual),
 944       NULL);
 945
 946   return g_object_new (EMPATHY_TYPE_PERSONA_STORE,
 947       "individual", individual, NULL);
 948 }
 949
 950 /**
 951  * empathy_persona_store_get_individual:
 952  * @self: an #EmpathyPersonaStore
 953  *
 954  * Get the value of #EmpathyPersonaStore:individual.
 955  *
 956  * Return value: the individual being displayed by the store, or %NULL
 957  */
 958 FolksIndividual *
 959 empathy_persona_store_get_individual (EmpathyPersonaStore *self)
 960 {
 961   g_return_val_if_fail (EMPATHY_IS_PERSONA_STORE (self), NULL);
 962
 963   return GET_PRIV (self)->individual;
 964 }
 965
 966 /**
 967  * empathy_persona_store_set_individual:
 968  * @self: an #EmpathyPersonaStore
 969  * @individual: the new individual to display in the store, or %NULL
 970  *
 971  * Set #EmpathyPersonaStore:individual to @individual, replacing the personas
 972  * which were in the store with the personas belonging to @individual, or with
 973  * nothing if @individual is %NULL.
 974  */
 975 void
 976 empathy_persona_store_set_individual (EmpathyPersonaStore *self,
 977     FolksIndividual *individual)
 978 {
 979   EmpathyPersonaStorePriv *priv;
 980
 981   g_return_if_fail (EMPATHY_IS_PERSONA_STORE (self));
 982   g_return_if_fail (individual == NULL || FOLKS_IS_INDIVIDUAL (individual));
 983
 984   priv = GET_PRIV (self);
 985
 986   /* Remove the old individual */
 987   if (priv->individual != NULL)
 988     {
 989       GList *personas, *l;
 990
 991       g_signal_handlers_disconnect_by_func (priv->individual,
 992           (GCallback) individual_personas_changed_cb, self);
 993
 994       /* Disconnect from and remove all personas belonging to this individual */
 995       personas = folks_individual_get_personas (priv->individual);
 996       for (l = personas; l != NULL; l = l->next)
 997         remove_persona_and_disconnect (self, FOLKS_PERSONA (l->data));
 998
 999       g_object_unref (priv->individual);
1000     }
1001
1002   priv->individual = individual;
1003
1004   /* Add the new individual */
1005   if (individual != NULL)
1006     {
1007       GList *personas, *l;
1008
1009       g_object_ref (individual);
1010
1011       g_signal_connect (individual, "personas-changed",
1012           (GCallback) individual_personas_changed_cb, self);
1013
1014       /* Add pre-existing Personas */
1015       personas = folks_individual_get_personas (individual);
1016       for (l = personas; l != NULL; l = l->next)
1017         add_persona_and_connect (self, FOLKS_PERSONA (l->data));
1018     }
1019
1020   g_object_notify (G_OBJECT (self), "individual");
1021 }
1022
1023 /**
1024  * empathy_persona_store_get_show_avatars:
1025  * @self: an #EmpathyPersonaStore
1026  *
1027  * Get the value of #EmpathyPersonaStore:show-avatars.
1028  *
1029  * Return value: %TRUE if avatars are made available by the store, %FALSE
1030  * otherwise
1031  */
1032 gboolean
1033 empathy_persona_store_get_show_avatars (EmpathyPersonaStore *self)
1034 {
1035   g_return_val_if_fail (EMPATHY_IS_PERSONA_STORE (self), TRUE);
1036
1037   return GET_PRIV (self)->show_avatars;
1038 }
1039
1040 /**
1041  * empathy_persona_store_set_show_avatars:
1042  * @self: an #EmpathyPersonaStore
1043  * @show_avatars: %TRUE to make avatars available through the store, %FALSE
1044  * otherwise
1045  *
1046  * Set #EmpathyPersonaStore:show-avatars to @show_avatars.
1047  */
1048 void
1049 empathy_persona_store_set_show_avatars (EmpathyPersonaStore *self,
1050     gboolean show_avatars)
1051 {
1052   EmpathyPersonaStorePriv *priv;
1053
1054   g_return_if_fail (EMPATHY_IS_PERSONA_STORE (self));
1055
1056   priv = GET_PRIV (self);
1057   priv->show_avatars = show_avatars;
1058
1059   gtk_tree_model_foreach (GTK_TREE_MODEL (self),
1060       (GtkTreeModelForeachFunc) update_list_mode_foreach, self);
1061
1062   g_object_notify (G_OBJECT (self), "show-avatars");
1063 }
1064
1065 /**
1066  * empathy_persona_store_get_show_protocols:
1067  * @self: an #EmpathyPersonaStore
1068  *
1069  * Get the value of #EmpathyPersonaStore:show-protocols.
1070  *
1071  * Return value: %TRUE if protocol images are made available by the store,
1072  * %FALSE otherwise
1073  */
1074 gboolean
1075 empathy_persona_store_get_show_protocols (EmpathyPersonaStore *self)
1076 {
1077   g_return_val_if_fail (EMPATHY_IS_PERSONA_STORE (self), TRUE);
1078
1079   return GET_PRIV (self)->show_protocols;
1080 }
1081
1082 /**
1083  * empathy_persona_store_set_show_protocols:
1084  * @self: an #EmpathyPersonaStore
1085  * @show_protocols: %TRUE to make protocol images available through the store,
1086  * %FALSE otherwise
1087  *
1088  * Set #EmpathyPersonaStore:show-protocols to @show_protocols.
1089  */
1090 void
1091 empathy_persona_store_set_show_protocols (EmpathyPersonaStore *self,
1092     gboolean show_protocols)
1093 {
1094   EmpathyPersonaStorePriv *priv;
1095
1096   g_return_if_fail (EMPATHY_IS_PERSONA_STORE (self));
1097
1098   priv = GET_PRIV (self);
1099   priv->show_protocols = show_protocols;
1100
1101   gtk_tree_model_foreach (GTK_TREE_MODEL (self),
1102       (GtkTreeModelForeachFunc) update_list_mode_foreach, self);
1103
1104   g_object_notify (G_OBJECT (self), "show-protocols");
1105 }
1106
1107 /**
1108  * empathy_persona_store_get_sort_criterion:
1109  * @self: an #EmpathyPersonaStore
1110  *
1111  * Get the value of #EmpathyPersonaStore:sort-criterion.
1112  *
1113  * Return value: the criterion used to sort the personas in the store
1114  */
1115 EmpathyPersonaStoreSort
1116 empathy_persona_store_get_sort_criterion (EmpathyPersonaStore *self)
1117 {
1118   g_return_val_if_fail (EMPATHY_IS_PERSONA_STORE (self), 0);
1119
1120   return GET_PRIV (self)->sort_criterion;
1121 }
1122
1123 /**
1124  * empathy_persona_store_set_sort_criterion:
1125  * @self: an #EmpathyPersonaStore
1126  * @show_avatars: a criterion to be used to sort personas in the store
1127  *
1128  * Set #EmpathyPersonaStore:sort-criterion to @sort_criterion.
1129  */
1130 void
1131 empathy_persona_store_set_sort_criterion (EmpathyPersonaStore *self,
1132     EmpathyPersonaStoreSort sort_criterion)
1133 {
1134   EmpathyPersonaStorePriv *priv;
1135
1136   g_return_if_fail (EMPATHY_IS_PERSONA_STORE (self));
1137
1138   priv = GET_PRIV (self);
1139   priv->sort_criterion = sort_criterion;
1140
1141   switch (sort_criterion)
1142     {
1143       case EMPATHY_PERSONA_STORE_SORT_STATE:
1144         gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (self),
1145             EMPATHY_PERSONA_STORE_COL_STATUS, GTK_SORT_ASCENDING);
1146         break;
1147       case EMPATHY_PERSONA_STORE_SORT_NAME:
1148         gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (self),
1149             EMPATHY_PERSONA_STORE_COL_NAME, GTK_SORT_ASCENDING);
1150         break;
1151       default:
1152         g_assert_not_reached ();
1153         break;
1154     }
1155
1156   g_object_notify (G_OBJECT (self), "sort-criterion");
1157 }