Merge branch 'people-nearby-fake-group-613558'
[empathy.git] / libempathy-gtk / empathy-contact-list-store.c
1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
2 /*
3  * Copyright (C) 2005-2007 Imendio AB
4  * Copyright (C) 2007-2008 Collabora Ltd.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License as
8  * published by the Free Software Foundation; either version 2 of the
9  * License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public
17  * License along with this program; if not, write to the
18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19  * Boston, MA  02110-1301  USA
20  *
21  * Authors: Mikael Hallendal <micke@imendio.com>
22  *          Martyn Russell <martyn@imendio.com>
23  *          Xavier Claessens <xclaesse@gmail.com>
24  */
25
26 #include "config.h"
27
28 #include <string.h>
29
30 #include <glib.h>
31 #include <glib/gi18n-lib.h>
32 #include <gtk/gtk.h>
33
34 #include <telepathy-glib/util.h>
35
36 #include <libempathy/empathy-utils.h>
37 #include <libempathy/empathy-enum-types.h>
38 #include <libempathy/empathy-contact-manager.h>
39
40 #include "empathy-contact-list-store.h"
41 #include "empathy-ui-utils.h"
42 #include "empathy-gtk-enum-types.h"
43
44 #define DEBUG_FLAG EMPATHY_DEBUG_CONTACT
45 #include <libempathy/empathy-debug.h>
46
47 /* Active users are those which have recently changed state
48  * (e.g. online, offline or from normal to a busy state).
49  */
50
51 /* Time in seconds user is shown as active */
52 #define ACTIVE_USER_SHOW_TIME 7
53
54 /* Time in seconds after connecting which we wait before active users are enabled */
55 #define ACTIVE_USER_WAIT_TO_ENABLE_TIME 5
56
57 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyContactListStore)
58 typedef struct {
59         EmpathyContactList         *list;
60         gboolean                    show_offline;
61         gboolean                    show_avatars;
62         gboolean                    show_groups;
63         gboolean                    is_compact;
64         gboolean                    show_protocols;
65         gboolean                    show_active;
66         EmpathyContactListStoreSort sort_criterium;
67         guint                       inhibit_active;
68         guint                       setup_idle_id;
69         gboolean                    dispose_has_run;
70         GHashTable                  *status_icons;
71 } EmpathyContactListStorePriv;
72
73 typedef struct {
74         GtkTreeIter  iter;
75         const gchar *name;
76         gboolean     found;
77 } FindGroup;
78
79 typedef struct {
80         EmpathyContact *contact;
81         gboolean       found;
82         GList         *iters;
83 } FindContact;
84
85 typedef struct {
86         EmpathyContactListStore *store;
87         EmpathyContact          *contact;
88         gboolean                remove;
89 } ShowActiveData;
90
91 static void             contact_list_store_dispose                  (GObject                       *object);
92 static void             contact_list_store_get_property              (GObject                       *object,
93                                                                       guint                          param_id,
94                                                                       GValue                        *value,
95                                                                       GParamSpec                    *pspec);
96 static void             contact_list_store_set_property              (GObject                       *object,
97                                                                       guint                          param_id,
98                                                                       const GValue                  *value,
99                                                                       GParamSpec                    *pspec);
100 static void             contact_list_store_setup                     (EmpathyContactListStore       *store);
101 static gboolean         contact_list_store_inibit_active_cb          (EmpathyContactListStore       *store);
102 static void             contact_list_store_members_changed_cb        (EmpathyContactList            *list_iface,
103                                                                       EmpathyContact                *contact,
104                                                                       EmpathyContact                *actor,
105                                                                       guint                          reason,
106                                                                       gchar                         *message,
107                                                                       gboolean                       is_member,
108                                                                       EmpathyContactListStore       *store);
109 static void             contact_list_store_favourites_changed_cb     (EmpathyContactList            *list_iface,
110                                                                       EmpathyContact                *contact,
111                                                                       gboolean                       is_favourite,
112                                                                       EmpathyContactListStore       *store);
113 static void             contact_list_store_member_renamed_cb         (EmpathyContactList            *list_iface,
114                                                                       EmpathyContact                *old_contact,
115                                                                       EmpathyContact                *new_contact,
116                                                                       guint                          reason,
117                                                                       gchar                         *message,
118                                                                       EmpathyContactListStore       *store);
119 static void             contact_list_store_groups_changed_cb         (EmpathyContactList            *list_iface,
120                                                                       EmpathyContact                *contact,
121                                                                       gchar                         *group,
122                                                                       gboolean                       is_member,
123                                                                       EmpathyContactListStore       *store);
124 static void             contact_list_store_add_contact               (EmpathyContactListStore       *store,
125                                                                       EmpathyContact                *contact);
126 static void             contact_list_store_remove_contact            (EmpathyContactListStore       *store,
127                                                                       EmpathyContact                *contact);
128 static void             contact_list_store_contact_update            (EmpathyContactListStore       *store,
129                                                                       EmpathyContact                *contact);
130 static void             contact_list_store_contact_updated_cb        (EmpathyContact                *contact,
131                                                                       GParamSpec                    *param,
132                                                                       EmpathyContactListStore       *store);
133 static void             contact_list_store_contact_set_active        (EmpathyContactListStore       *store,
134                                                                       EmpathyContact                *contact,
135                                                                       gboolean                       active,
136                                                                       gboolean                       set_changed);
137 static ShowActiveData * contact_list_store_contact_active_new        (EmpathyContactListStore       *store,
138                                                                       EmpathyContact                *contact,
139                                                                       gboolean                       remove);
140 static void             contact_list_store_contact_active_free       (ShowActiveData                *data);
141 static gboolean         contact_list_store_contact_active_cb         (ShowActiveData                *data);
142 static gboolean         contact_list_store_get_group_foreach         (GtkTreeModel                  *model,
143                                                                       GtkTreePath                   *path,
144                                                                       GtkTreeIter                   *iter,
145                                                                       FindGroup                     *fg);
146 static void             contact_list_store_get_group                 (EmpathyContactListStore       *store,
147                                                                       const gchar                   *name,
148                                                                       GtkTreeIter                   *iter_group_to_set,
149                                                                       GtkTreeIter                   *iter_separator_to_set,
150                                                                       gboolean                      *created,
151                                                                       gboolean                      is_fake_group);
152 static gint             contact_list_store_state_sort_func           (GtkTreeModel                  *model,
153                                                                       GtkTreeIter                   *iter_a,
154                                                                       GtkTreeIter                   *iter_b,
155                                                                       gpointer                       user_data);
156 static gint             contact_list_store_name_sort_func            (GtkTreeModel                  *model,
157                                                                       GtkTreeIter                   *iter_a,
158                                                                       GtkTreeIter                   *iter_b,
159                                                                       gpointer                       user_data);
160 static gboolean         contact_list_store_find_contact_foreach      (GtkTreeModel                  *model,
161                                                                       GtkTreePath                   *path,
162                                                                       GtkTreeIter                   *iter,
163                                                                       FindContact                   *fc);
164 static GList *          contact_list_store_find_contact              (EmpathyContactListStore       *store,
165                                                                       EmpathyContact                *contact);
166 static gboolean         contact_list_store_update_list_mode_foreach  (GtkTreeModel                  *model,
167                                                                       GtkTreePath                   *path,
168                                                                       GtkTreeIter                   *iter,
169                                                                       EmpathyContactListStore       *store);
170
171 enum {
172         PROP_0,
173         PROP_CONTACT_LIST,
174         PROP_SHOW_OFFLINE,
175         PROP_SHOW_AVATARS,
176         PROP_SHOW_PROTOCOLS,
177         PROP_SHOW_GROUPS,
178         PROP_IS_COMPACT,
179         PROP_SORT_CRITERIUM
180 };
181
182 G_DEFINE_TYPE (EmpathyContactListStore, empathy_contact_list_store, GTK_TYPE_TREE_STORE);
183
184 static gboolean
185 contact_list_store_iface_setup (gpointer user_data)
186 {
187         EmpathyContactListStore     *store = user_data;
188         EmpathyContactListStorePriv *priv = GET_PRIV (store);
189         GList                       *contacts, *l;
190
191         /* Signal connection. */
192         g_signal_connect (priv->list,
193                           "member-renamed",
194                           G_CALLBACK (contact_list_store_member_renamed_cb),
195                           store);
196         g_signal_connect (priv->list,
197                           "members-changed",
198                           G_CALLBACK (contact_list_store_members_changed_cb),
199                           store);
200         g_signal_connect (priv->list,
201                           "favourites-changed",
202                           G_CALLBACK (contact_list_store_favourites_changed_cb),
203                           store);
204         g_signal_connect (priv->list,
205                           "groups-changed",
206                           G_CALLBACK (contact_list_store_groups_changed_cb),
207                           store);
208
209         /* Add contacts already created. */
210         contacts = empathy_contact_list_get_members (priv->list);
211         for (l = contacts; l; l = l->next) {
212                 contact_list_store_members_changed_cb (priv->list, l->data,
213                                                        NULL, 0, NULL,
214                                                        TRUE,
215                                                        store);
216
217                 g_object_unref (l->data);
218         }
219         g_list_free (contacts);
220
221         priv->setup_idle_id = 0;
222         return FALSE;
223 }
224
225
226 static void
227 contact_list_store_set_contact_list (EmpathyContactListStore *store,
228                                      EmpathyContactList      *list_iface)
229 {
230         EmpathyContactListStorePriv *priv = GET_PRIV (store);
231
232         priv->list = g_object_ref (list_iface);
233
234         /* Let a chance to have all properties set before populating */
235         priv->setup_idle_id = g_idle_add (contact_list_store_iface_setup, store);
236 }
237
238 static void
239 empathy_contact_list_store_class_init (EmpathyContactListStoreClass *klass)
240 {
241         GObjectClass *object_class = G_OBJECT_CLASS (klass);
242
243         object_class->dispose = contact_list_store_dispose;
244         object_class->get_property = contact_list_store_get_property;
245         object_class->set_property = contact_list_store_set_property;
246
247         g_object_class_install_property (object_class,
248                                          PROP_CONTACT_LIST,
249                                          g_param_spec_object ("contact-list",
250                                                               "The contact list iface",
251                                                               "The contact list iface",
252                                                               EMPATHY_TYPE_CONTACT_LIST,
253                                                               G_PARAM_CONSTRUCT_ONLY |
254                                                               G_PARAM_READWRITE));
255         g_object_class_install_property (object_class,
256                                          PROP_SHOW_OFFLINE,
257                                          g_param_spec_boolean ("show-offline",
258                                                                "Show Offline",
259                                                                "Whether contact list should display "
260                                                                "offline contacts",
261                                                                FALSE,
262                                                                G_PARAM_READWRITE));
263          g_object_class_install_property (object_class,
264                                           PROP_SHOW_AVATARS,
265                                           g_param_spec_boolean ("show-avatars",
266                                                                 "Show Avatars",
267                                                                 "Whether contact list should display "
268                                                                 "avatars for contacts",
269                                                                 TRUE,
270                                                                 G_PARAM_READWRITE));
271          g_object_class_install_property (object_class,
272                                           PROP_SHOW_PROTOCOLS,
273                                           g_param_spec_boolean ("show-protocols",
274                                                                 "Show Protocols",
275                                                                 "Whether contact list should display "
276                                                                 "protocols for contacts",
277                                                                 FALSE,
278                                                                 G_PARAM_READWRITE));
279          g_object_class_install_property (object_class,
280                                           PROP_SHOW_GROUPS,
281                                           g_param_spec_boolean ("show-groups",
282                                                                 "Show Groups",
283                                                                 "Whether contact list should display "
284                                                                 "contact groups",
285                                                                 TRUE,
286                                                                 G_PARAM_READWRITE));
287         g_object_class_install_property (object_class,
288                                          PROP_IS_COMPACT,
289                                          g_param_spec_boolean ("is-compact",
290                                                                "Is Compact",
291                                                                "Whether the contact list is in compact mode or not",
292                                                                FALSE,
293                                                                G_PARAM_READWRITE));
294
295         g_object_class_install_property (object_class,
296                                          PROP_SORT_CRITERIUM,
297                                          g_param_spec_enum ("sort-criterium",
298                                                             "Sort citerium",
299                                                             "The sort criterium to use for sorting the contact list",
300                                                             EMPATHY_TYPE_CONTACT_LIST_STORE_SORT,
301                                                             EMPATHY_CONTACT_LIST_STORE_SORT_NAME,
302                                                             G_PARAM_READWRITE));
303
304         g_type_class_add_private (object_class, sizeof (EmpathyContactListStorePriv));
305 }
306
307 static void
308 empathy_contact_list_store_init (EmpathyContactListStore *store)
309 {
310         EmpathyContactListStorePriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (store,
311                 EMPATHY_TYPE_CONTACT_LIST_STORE, EmpathyContactListStorePriv);
312
313         store->priv = priv;
314         priv->show_avatars = TRUE;
315         priv->show_groups = TRUE;
316         priv->show_protocols = FALSE;
317         priv->inhibit_active = g_timeout_add_seconds (ACTIVE_USER_WAIT_TO_ENABLE_TIME,
318                                                       (GSourceFunc) contact_list_store_inibit_active_cb,
319                                                       store);
320         priv->status_icons = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
321         contact_list_store_setup (store);
322 }
323
324 static void
325 contact_list_store_dispose (GObject *object)
326 {
327         EmpathyContactListStorePriv *priv = GET_PRIV (object);
328         GList                       *contacts, *l;
329
330         if (priv->dispose_has_run)
331                 return;
332         priv->dispose_has_run = TRUE;
333
334         contacts = empathy_contact_list_get_members (priv->list);
335         for (l = contacts; l; l = l->next) {
336                 g_signal_handlers_disconnect_by_func (l->data,
337                                                       G_CALLBACK (contact_list_store_contact_updated_cb),
338                                                       object);
339
340                 g_object_unref (l->data);
341         }
342         g_list_free (contacts);
343
344         g_signal_handlers_disconnect_by_func (priv->list,
345                                               G_CALLBACK (contact_list_store_member_renamed_cb),
346                                               object);
347         g_signal_handlers_disconnect_by_func (priv->list,
348                                               G_CALLBACK (contact_list_store_members_changed_cb),
349                                               object);
350         g_signal_handlers_disconnect_by_func (priv->list,
351                                               G_CALLBACK (contact_list_store_favourites_changed_cb),
352                                               object);
353         g_signal_handlers_disconnect_by_func (priv->list,
354                                               G_CALLBACK (contact_list_store_groups_changed_cb),
355                                               object);
356         g_object_unref (priv->list);
357
358         if (priv->inhibit_active) {
359                 g_source_remove (priv->inhibit_active);
360         }
361
362         if (priv->setup_idle_id != 0) {
363                 g_source_remove (priv->setup_idle_id);
364         }
365
366         g_hash_table_destroy (priv->status_icons);
367         G_OBJECT_CLASS (empathy_contact_list_store_parent_class)->dispose (object);
368 }
369
370 static void
371 contact_list_store_get_property (GObject    *object,
372                                  guint       param_id,
373                                  GValue     *value,
374                                  GParamSpec *pspec)
375 {
376         EmpathyContactListStorePriv *priv;
377
378         priv = GET_PRIV (object);
379
380         switch (param_id) {
381         case PROP_CONTACT_LIST:
382                 g_value_set_object (value, priv->list);
383                 break;
384         case PROP_SHOW_OFFLINE:
385                 g_value_set_boolean (value, priv->show_offline);
386                 break;
387         case PROP_SHOW_AVATARS:
388                 g_value_set_boolean (value, priv->show_avatars);
389                 break;
390         case PROP_SHOW_PROTOCOLS:
391                 g_value_set_boolean (value, priv->show_protocols);
392                 break;
393         case PROP_SHOW_GROUPS:
394                 g_value_set_boolean (value, priv->show_groups);
395                 break;
396         case PROP_IS_COMPACT:
397                 g_value_set_boolean (value, priv->is_compact);
398                 break;
399         case PROP_SORT_CRITERIUM:
400                 g_value_set_enum (value, priv->sort_criterium);
401                 break;
402         default:
403                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
404                 break;
405         };
406 }
407
408 static void
409 contact_list_store_set_property (GObject      *object,
410                                  guint         param_id,
411                                  const GValue *value,
412                                  GParamSpec   *pspec)
413 {
414         EmpathyContactListStorePriv *priv;
415
416         priv = GET_PRIV (object);
417
418         switch (param_id) {
419         case PROP_CONTACT_LIST:
420                 contact_list_store_set_contact_list (EMPATHY_CONTACT_LIST_STORE (object),
421                                                      g_value_get_object (value));
422                 break;
423         case PROP_SHOW_OFFLINE:
424                 empathy_contact_list_store_set_show_offline (EMPATHY_CONTACT_LIST_STORE (object),
425                                                             g_value_get_boolean (value));
426                 break;
427         case PROP_SHOW_AVATARS:
428                 empathy_contact_list_store_set_show_avatars (EMPATHY_CONTACT_LIST_STORE (object),
429                                                             g_value_get_boolean (value));
430                 break;
431         case PROP_SHOW_PROTOCOLS:
432                 empathy_contact_list_store_set_show_protocols (EMPATHY_CONTACT_LIST_STORE (object),
433                                                             g_value_get_boolean (value));
434                 break;
435         case PROP_SHOW_GROUPS:
436                 empathy_contact_list_store_set_show_groups (EMPATHY_CONTACT_LIST_STORE (object),
437                                                             g_value_get_boolean (value));
438                 break;
439         case PROP_IS_COMPACT:
440                 empathy_contact_list_store_set_is_compact (EMPATHY_CONTACT_LIST_STORE (object),
441                                                           g_value_get_boolean (value));
442                 break;
443         case PROP_SORT_CRITERIUM:
444                 empathy_contact_list_store_set_sort_criterium (EMPATHY_CONTACT_LIST_STORE (object),
445                                                               g_value_get_enum (value));
446                 break;
447         default:
448                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
449                 break;
450         };
451 }
452
453 EmpathyContactListStore *
454 empathy_contact_list_store_new (EmpathyContactList *list_iface)
455 {
456         g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST (list_iface), NULL);
457
458         return g_object_new (EMPATHY_TYPE_CONTACT_LIST_STORE,
459                              "contact-list", list_iface,
460                              NULL);
461 }
462
463 EmpathyContactList *
464 empathy_contact_list_store_get_list_iface (EmpathyContactListStore *store)
465 {
466         EmpathyContactListStorePriv *priv;
467
468         g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store), FALSE);
469
470         priv = GET_PRIV (store);
471
472         return priv->list;
473 }
474
475 gboolean
476 empathy_contact_list_store_get_show_offline (EmpathyContactListStore *store)
477 {
478         EmpathyContactListStorePriv *priv;
479
480         g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store), FALSE);
481
482         priv = GET_PRIV (store);
483
484         return priv->show_offline;
485 }
486
487 void
488 empathy_contact_list_store_set_show_offline (EmpathyContactListStore *store,
489                                             gboolean                show_offline)
490 {
491         EmpathyContactListStorePriv *priv;
492         GList                      *contacts, *l;
493         gboolean                    show_active;
494
495         g_return_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store));
496
497         priv = GET_PRIV (store);
498
499         priv->show_offline = show_offline;
500         show_active = priv->show_active;
501
502         /* Disable temporarily. */
503         priv->show_active = FALSE;
504
505         contacts = empathy_contact_list_get_members (priv->list);
506         for (l = contacts; l; l = l->next) {
507                 contact_list_store_contact_update (store, l->data);
508
509                 g_object_unref (l->data);
510         }
511         g_list_free (contacts);
512
513         /* Restore to original setting. */
514         priv->show_active = show_active;
515
516         g_object_notify (G_OBJECT (store), "show-offline");
517 }
518
519 gboolean
520 empathy_contact_list_store_get_show_avatars (EmpathyContactListStore *store)
521 {
522         EmpathyContactListStorePriv *priv;
523
524         g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store), TRUE);
525
526         priv = GET_PRIV (store);
527
528         return priv->show_avatars;
529 }
530
531 void
532 empathy_contact_list_store_set_show_avatars (EmpathyContactListStore *store,
533                                             gboolean                show_avatars)
534 {
535         EmpathyContactListStorePriv *priv;
536         GtkTreeModel               *model;
537
538         g_return_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store));
539
540         priv = GET_PRIV (store);
541
542         priv->show_avatars = show_avatars;
543
544         model = GTK_TREE_MODEL (store);
545
546         gtk_tree_model_foreach (model,
547                                 (GtkTreeModelForeachFunc)
548                                 contact_list_store_update_list_mode_foreach,
549                                 store);
550
551         g_object_notify (G_OBJECT (store), "show-avatars");
552 }
553
554
555 gboolean
556 empathy_contact_list_store_get_show_protocols (EmpathyContactListStore *store)
557 {
558         EmpathyContactListStorePriv *priv;
559
560         g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store), TRUE);
561
562         priv = GET_PRIV (store);
563
564         return priv->show_protocols;
565 }
566
567 void
568 empathy_contact_list_store_set_show_protocols (EmpathyContactListStore *store,
569                                             gboolean                show_protocols)
570 {
571         EmpathyContactListStorePriv *priv;
572         GtkTreeModel               *model;
573
574         g_return_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store));
575
576         priv = GET_PRIV (store);
577
578         priv->show_protocols = show_protocols;
579
580         model = GTK_TREE_MODEL (store);
581
582         gtk_tree_model_foreach (model,
583                                 (GtkTreeModelForeachFunc)
584                                 contact_list_store_update_list_mode_foreach,
585                                 store);
586
587         g_object_notify (G_OBJECT (store), "show-protocols");
588 }
589
590 gboolean
591 empathy_contact_list_store_get_show_groups (EmpathyContactListStore *store)
592 {
593         EmpathyContactListStorePriv *priv;
594
595         g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store), TRUE);
596
597         priv = GET_PRIV (store);
598
599         return priv->show_groups;
600 }
601
602 void
603 empathy_contact_list_store_set_show_groups (EmpathyContactListStore *store,
604                                             gboolean                 show_groups)
605 {
606         EmpathyContactListStorePriv *priv;
607         GList                       *contacts, *l;
608
609         g_return_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store));
610
611         priv = GET_PRIV (store);
612
613         if (priv->show_groups == show_groups) {
614                 return;
615         }
616
617         priv->show_groups = show_groups;
618
619         /* Remove all contacts and add them back, not optimized but that's the
620          * easy way :) */
621         gtk_tree_store_clear (GTK_TREE_STORE (store));
622         contacts = empathy_contact_list_get_members (priv->list);
623         for (l = contacts; l; l = l->next) {
624                 contact_list_store_members_changed_cb (priv->list, l->data,
625                                                        NULL, 0, NULL,
626                                                        TRUE,
627                                                        store);
628
629                 g_object_unref (l->data);
630         }
631         g_list_free (contacts);
632
633         g_object_notify (G_OBJECT (store), "show-groups");
634 }
635
636 gboolean
637 empathy_contact_list_store_get_is_compact (EmpathyContactListStore *store)
638 {
639         EmpathyContactListStorePriv *priv;
640
641         g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store), TRUE);
642
643         priv = GET_PRIV (store);
644
645         return priv->is_compact;
646 }
647
648 void
649 empathy_contact_list_store_set_is_compact (EmpathyContactListStore *store,
650                                           gboolean                is_compact)
651 {
652         EmpathyContactListStorePriv *priv;
653         GtkTreeModel               *model;
654
655         g_return_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store));
656
657         priv = GET_PRIV (store);
658
659         priv->is_compact = is_compact;
660
661         model = GTK_TREE_MODEL (store);
662
663         gtk_tree_model_foreach (model,
664                                 (GtkTreeModelForeachFunc)
665                                 contact_list_store_update_list_mode_foreach,
666                                 store);
667
668         g_object_notify (G_OBJECT (store), "is-compact");
669 }
670
671 EmpathyContactListStoreSort
672 empathy_contact_list_store_get_sort_criterium (EmpathyContactListStore *store)
673 {
674         EmpathyContactListStorePriv *priv;
675
676         g_return_val_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store), 0);
677
678         priv = GET_PRIV (store);
679
680         return priv->sort_criterium;
681 }
682
683 void
684 empathy_contact_list_store_set_sort_criterium (EmpathyContactListStore     *store,
685                                               EmpathyContactListStoreSort  sort_criterium)
686 {
687         EmpathyContactListStorePriv *priv;
688
689         g_return_if_fail (EMPATHY_IS_CONTACT_LIST_STORE (store));
690
691         priv = GET_PRIV (store);
692
693         priv->sort_criterium = sort_criterium;
694
695         switch (sort_criterium) {
696         case EMPATHY_CONTACT_LIST_STORE_SORT_STATE:
697                 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (store),
698                                                       EMPATHY_CONTACT_LIST_STORE_COL_STATUS,
699                                                       GTK_SORT_ASCENDING);
700                 break;
701
702         case EMPATHY_CONTACT_LIST_STORE_SORT_NAME:
703                 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (store),
704                                                       EMPATHY_CONTACT_LIST_STORE_COL_NAME,
705                                                       GTK_SORT_ASCENDING);
706                 break;
707         }
708
709         g_object_notify (G_OBJECT (store), "sort-criterium");
710 }
711
712 gboolean
713 empathy_contact_list_store_row_separator_func (GtkTreeModel *model,
714                                               GtkTreeIter  *iter,
715                                               gpointer      data)
716 {
717         gboolean is_separator = FALSE;
718
719         g_return_val_if_fail (GTK_IS_TREE_MODEL (model), FALSE);
720
721         gtk_tree_model_get (model, iter,
722                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator,
723                             -1);
724
725         return is_separator;
726 }
727
728 gchar *
729 empathy_contact_list_store_get_parent_group (GtkTreeModel *model,
730                                             GtkTreePath  *path,
731                                             gboolean     *path_is_group,
732                                             gboolean     *is_fake_group)
733 {
734         GtkTreeIter  parent_iter, iter;
735         gchar       *name = NULL;
736         gboolean     is_group;
737         gboolean     fake;
738
739         g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
740
741         if (path_is_group) {
742                 *path_is_group = FALSE;
743         }
744
745         if (!gtk_tree_model_get_iter (model, &iter, path)) {
746                 return NULL;
747         }
748
749         gtk_tree_model_get (model, &iter,
750                             EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
751                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name,
752                             -1);
753
754         if (!is_group) {
755                 g_free (name);
756                 name = NULL;
757
758                 if (!gtk_tree_model_iter_parent (model, &parent_iter, &iter)) {
759                         return NULL;
760                 }
761
762                 iter = parent_iter;
763
764                 gtk_tree_model_get (model, &iter,
765                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
766                                     EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name,
767                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake,
768                                     -1);
769                 if (!is_group) {
770                         g_free (name);
771                         return NULL;
772                 }
773         }
774
775         if (path_is_group) {
776                 *path_is_group = TRUE;
777         }
778
779         if (is_fake_group != NULL)
780                 *is_fake_group = fake;
781
782         return name;
783 }
784
785 gboolean
786 empathy_contact_list_store_search_equal_func (GtkTreeModel *model,
787                                               gint          column,
788                                               const gchar  *key,
789                                               GtkTreeIter  *iter,
790                                               gpointer      search_data)
791 {
792         gchar    *name, *name_folded;
793         gchar    *key_folded;
794         gboolean  ret;
795
796         g_return_val_if_fail (GTK_IS_TREE_MODEL (model), FALSE);
797
798         if (!key) {
799                 return TRUE;
800         }
801
802         gtk_tree_model_get (model, iter,
803                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name,
804                             -1);
805
806         if (!name) {
807                 return TRUE;
808         }
809
810         name_folded = g_utf8_casefold (name, -1);
811         key_folded = g_utf8_casefold (key, -1);
812
813         if (name_folded && key_folded &&
814             strstr (name_folded, key_folded)) {
815                 ret = FALSE;
816         } else {
817                 ret = TRUE;
818         }
819
820         g_free (name);
821         g_free (name_folded);
822         g_free (key_folded);
823
824         return ret;
825 }
826
827 static void
828 contact_list_store_setup (EmpathyContactListStore *store)
829 {
830         EmpathyContactListStorePriv *priv;
831         GType types[] = {
832                 GDK_TYPE_PIXBUF,      /* Status pixbuf */
833                 GDK_TYPE_PIXBUF,      /* Avatar pixbuf */
834                 G_TYPE_BOOLEAN,       /* Avatar pixbuf visible */
835                 G_TYPE_STRING,        /* Name */
836                 G_TYPE_UINT,          /* Presence type */
837                 G_TYPE_STRING,        /* Status string */
838                 G_TYPE_BOOLEAN,       /* Compact view */
839                 EMPATHY_TYPE_CONTACT, /* Contact type */
840                 G_TYPE_BOOLEAN,       /* Is group */
841                 G_TYPE_BOOLEAN,       /* Is active */
842                 G_TYPE_BOOLEAN,       /* Is online */
843                 G_TYPE_BOOLEAN,       /* Is separator */
844                 G_TYPE_BOOLEAN,       /* Can make audio calls */
845                 G_TYPE_BOOLEAN,       /* Can make video calls */
846                 EMPATHY_TYPE_CONTACT_LIST_FLAGS, /* Flags */
847                 G_TYPE_BOOLEAN,       /* Is a fake group */
848         };
849
850         priv = GET_PRIV (store);
851
852         gtk_tree_store_set_column_types (GTK_TREE_STORE (store),
853                                          EMPATHY_CONTACT_LIST_STORE_COL_COUNT,
854                                          types);
855
856         /* Set up sorting */
857         gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (store),
858                                          EMPATHY_CONTACT_LIST_STORE_COL_NAME,
859                                          contact_list_store_name_sort_func,
860                                          store, NULL);
861         gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (store),
862                                          EMPATHY_CONTACT_LIST_STORE_COL_STATUS,
863                                          contact_list_store_state_sort_func,
864                                          store, NULL);
865
866         priv->sort_criterium = EMPATHY_CONTACT_LIST_STORE_SORT_NAME;
867         empathy_contact_list_store_set_sort_criterium (store, priv->sort_criterium);
868 }
869
870 static gboolean
871 contact_list_store_inibit_active_cb (EmpathyContactListStore *store)
872 {
873         EmpathyContactListStorePriv *priv;
874
875         priv = GET_PRIV (store);
876
877         priv->show_active = TRUE;
878         priv->inhibit_active = 0;
879
880         return FALSE;
881 }
882
883 static void
884 contact_list_store_add_contact_and_connect (EmpathyContactListStore *store, EmpathyContact *contact)
885 {
886         g_signal_connect (contact, "notify::presence",
887                           G_CALLBACK (contact_list_store_contact_updated_cb),
888                           store);
889         g_signal_connect (contact, "notify::presence-message",
890                           G_CALLBACK (contact_list_store_contact_updated_cb),
891                           store);
892         g_signal_connect (contact, "notify::name",
893                           G_CALLBACK (contact_list_store_contact_updated_cb),
894                           store);
895         g_signal_connect (contact, "notify::avatar",
896                           G_CALLBACK (contact_list_store_contact_updated_cb),
897                           store);
898         g_signal_connect (contact, "notify::capabilities",
899                           G_CALLBACK (contact_list_store_contact_updated_cb),
900                           store);
901
902         contact_list_store_add_contact (store, contact);
903 }
904
905 static void
906 contact_list_store_remove_contact_and_disconnect (EmpathyContactListStore *store, EmpathyContact *contact)
907 {
908         g_signal_handlers_disconnect_by_func (contact,
909                                               G_CALLBACK (contact_list_store_contact_updated_cb),
910                                               store);
911
912         contact_list_store_remove_contact (store, contact);
913 }
914
915 static void
916 contact_list_store_members_changed_cb (EmpathyContactList      *list_iface,
917                                        EmpathyContact          *contact,
918                                        EmpathyContact          *actor,
919                                        guint                    reason,
920                                        gchar                   *message,
921                                        gboolean                 is_member,
922                                        EmpathyContactListStore *store)
923 {
924         EmpathyContactListStorePriv *priv;
925
926         priv = GET_PRIV (store);
927
928         DEBUG ("Contact %s (%d) %s",
929                 empathy_contact_get_id (contact),
930                 empathy_contact_get_handle (contact),
931                 is_member ? "added" : "removed");
932
933         if (is_member) {
934                 contact_list_store_add_contact_and_connect (store, contact);
935         } else {
936                 contact_list_store_remove_contact_and_disconnect (store, contact);
937         }
938 }
939
940 static void
941 contact_list_store_favourites_changed_cb (EmpathyContactList      *list_iface,
942                                           EmpathyContact          *contact,
943                                           gboolean                 is_favourite,
944                                           EmpathyContactListStore *store)
945 {
946         EmpathyContactListStorePriv *priv;
947
948         priv = GET_PRIV (store);
949
950         DEBUG ("Contact %s (%d) is %s a favourite",
951                 empathy_contact_get_id (contact),
952                 empathy_contact_get_handle (contact),
953                 is_favourite ? "now" : "no longer");
954
955         contact_list_store_remove_contact (store, contact);
956         contact_list_store_add_contact (store, contact);
957 }
958
959 static void
960 contact_list_store_member_renamed_cb (EmpathyContactList      *list_iface,
961                                       EmpathyContact          *old_contact,
962                                       EmpathyContact          *new_contact,
963                                       guint                    reason,
964                                       gchar                   *message,
965                                       EmpathyContactListStore *store)
966 {
967         EmpathyContactListStorePriv *priv;
968
969         priv = GET_PRIV (store);
970
971         DEBUG ("Contact %s (%d) renamed to %s (%d)",
972                 empathy_contact_get_id (old_contact),
973                 empathy_contact_get_handle (old_contact),
974                 empathy_contact_get_id (new_contact),
975                 empathy_contact_get_handle (new_contact));
976
977         /* add the new contact */
978         contact_list_store_add_contact_and_connect (store, new_contact);
979
980         /* remove old contact */
981         contact_list_store_remove_contact_and_disconnect (store, old_contact);
982 }
983
984 static void
985 contact_list_store_groups_changed_cb (EmpathyContactList      *list_iface,
986                                       EmpathyContact          *contact,
987                                       gchar                   *group,
988                                       gboolean                 is_member,
989                                       EmpathyContactListStore *store)
990 {
991         EmpathyContactListStorePriv *priv;
992         gboolean                     show_active;
993
994         priv = GET_PRIV (store);
995
996         DEBUG ("Updating groups for contact %s (%d)",
997                 empathy_contact_get_id (contact),
998                 empathy_contact_get_handle (contact));
999
1000         /* We do this to make sure the groups are correct, if not, we
1001          * would have to check the groups already set up for each
1002          * contact and then see what has been updated.
1003          */
1004         show_active = priv->show_active;
1005         priv->show_active = FALSE;
1006         contact_list_store_remove_contact (store, contact);
1007         contact_list_store_add_contact (store, contact);
1008         priv->show_active = show_active;
1009 }
1010
1011 static void
1012 add_contact_to_store (GtkTreeStore *store,
1013                       GtkTreeIter *iter,
1014                       EmpathyContact *contact,
1015                       EmpathyContactListFlags flags)
1016 {
1017         gtk_tree_store_set (store, iter,
1018                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, empathy_contact_get_name (contact),
1019                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, contact,
1020                             EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, FALSE,
1021                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, FALSE,
1022                             EMPATHY_CONTACT_LIST_STORE_COL_CAN_AUDIO_CALL,
1023                               empathy_contact_get_capabilities (contact) &
1024                                 EMPATHY_CAPABILITIES_AUDIO,
1025                             EMPATHY_CONTACT_LIST_STORE_COL_CAN_VIDEO_CALL,
1026                               empathy_contact_get_capabilities (contact) &
1027                                 EMPATHY_CAPABILITIES_VIDEO,
1028                             EMPATHY_CONTACT_LIST_STORE_COL_FLAGS, flags,
1029                             -1);
1030 }
1031
1032 static void
1033 contact_list_store_add_contact (EmpathyContactListStore *store,
1034                                 EmpathyContact          *contact)
1035 {
1036         EmpathyContactListStorePriv *priv;
1037         GtkTreeIter                 iter;
1038         GList                      *groups = NULL, *l;
1039         TpConnection               *connection;
1040         EmpathyContactListFlags     flags = 0;
1041         char                       *protocol_name;
1042
1043         priv = GET_PRIV (store);
1044
1045         if (EMP_STR_EMPTY (empathy_contact_get_name (contact)) ||
1046             (!priv->show_offline && !empathy_contact_is_online (contact))) {
1047                 return;
1048         }
1049
1050         if (priv->show_groups) {
1051                 groups = empathy_contact_list_get_groups (priv->list, contact);
1052         }
1053
1054         connection = empathy_contact_get_connection (contact);
1055         if (EMPATHY_IS_CONTACT_MANAGER (priv->list)) {
1056                 flags = empathy_contact_manager_get_flags_for_connection (
1057                         EMPATHY_CONTACT_MANAGER (priv->list), connection);
1058         }
1059
1060         tp_connection_parse_object_path (connection, &protocol_name, NULL);
1061
1062         if (!groups) {
1063 #if HAVE_FAVOURITE_CONTACTS
1064                 GtkTreeIter iter_group;
1065
1066                 if (!tp_strdiff (protocol_name, "local-xmpp")) {
1067                         /* these are People Nearby */
1068                         contact_list_store_get_group (store,
1069                                 EMPATHY_CONTACT_LIST_STORE_PEOPLE_NEARBY,
1070                                 &iter_group, NULL, NULL, TRUE);
1071                 } else {
1072                         contact_list_store_get_group (store,
1073                                 EMPATHY_CONTACT_LIST_STORE_UNGROUPED,
1074                                 &iter_group, NULL, NULL, TRUE);
1075                 }
1076
1077                 gtk_tree_store_insert_after (GTK_TREE_STORE (store), &iter,
1078                                              &iter_group, NULL);
1079 #else
1080                 /* FIXME: remove this in 2.31.x */
1081                 /* If no groups just add it at the top level. */
1082                 GtkTreeModel *model = GTK_TREE_MODEL (store);
1083
1084                 if (gtk_tree_model_get_iter_first (model, &iter)) do {
1085                         EmpathyContact *c;
1086
1087                         gtk_tree_model_get (model, &iter,
1088                                 EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &c,
1089                                 -1);
1090
1091                         if (c == contact) {
1092                                 g_object_unref (c);
1093                                 return;
1094                         }
1095                         if (c != NULL)
1096                                 g_object_unref (c);
1097                 } while (gtk_tree_model_iter_next (model, &iter));
1098
1099                 gtk_tree_store_append (GTK_TREE_STORE (store), &iter, NULL);
1100 #endif
1101
1102                 add_contact_to_store (GTK_TREE_STORE (store), &iter, contact, flags);
1103         }
1104
1105         g_free (protocol_name);
1106
1107         /* Else add to each group. */
1108         for (l = groups; l; l = l->next) {
1109                 GtkTreeIter iter_group;
1110
1111                 contact_list_store_get_group (store, l->data, &iter_group, NULL, NULL, FALSE);
1112
1113                 gtk_tree_store_insert_after (GTK_TREE_STORE (store), &iter,
1114                                              &iter_group, NULL);
1115
1116                 add_contact_to_store (GTK_TREE_STORE (store), &iter, contact, flags);
1117                 g_free (l->data);
1118         }
1119         g_list_free (groups);
1120
1121 #ifdef HAVE_FAVOURITE_CONTACTS
1122         if (empathy_contact_list_is_favourite (priv->list, contact)) {
1123         /* Add contact to the fake 'Favorites' group */
1124                 GtkTreeIter iter_group;
1125
1126                 contact_list_store_get_group (store, EMPATHY_CONTACT_LIST_STORE_FAVORITE,
1127                         &iter_group, NULL, NULL, TRUE);
1128
1129                 gtk_tree_store_insert_after (GTK_TREE_STORE (store), &iter,
1130                                              &iter_group, NULL);
1131
1132                 add_contact_to_store (GTK_TREE_STORE (store), &iter, contact, flags);
1133         }
1134 #endif
1135
1136         contact_list_store_contact_update (store, contact);
1137 }
1138
1139 static void
1140 contact_list_store_remove_contact (EmpathyContactListStore *store,
1141                                    EmpathyContact          *contact)
1142 {
1143         EmpathyContactListStorePriv *priv;
1144         GtkTreeModel               *model;
1145         GList                      *iters, *l;
1146
1147         priv = GET_PRIV (store);
1148
1149         iters = contact_list_store_find_contact (store, contact);
1150         if (!iters) {
1151                 return;
1152         }
1153
1154         /* Clean up model */
1155         model = GTK_TREE_MODEL (store);
1156
1157         for (l = iters; l; l = l->next) {
1158                 GtkTreeIter parent;
1159
1160                 /* NOTE: it is only <= 2 here because we have
1161                  * separators after the group name, otherwise it
1162                  * should be 1.
1163                  */
1164                 if (gtk_tree_model_iter_parent (model, &parent, l->data) &&
1165                     gtk_tree_model_iter_n_children (model, &parent) <= 2) {
1166                         gtk_tree_store_remove (GTK_TREE_STORE (store), &parent);
1167                 } else {
1168                         gtk_tree_store_remove (GTK_TREE_STORE (store), l->data);
1169                 }
1170         }
1171
1172         g_list_foreach (iters, (GFunc) gtk_tree_iter_free, NULL);
1173         g_list_free (iters);
1174 }
1175
1176 static void
1177 contact_list_store_contact_update (EmpathyContactListStore *store,
1178                                    EmpathyContact          *contact)
1179 {
1180         EmpathyContactListStorePriv *priv;
1181         ShowActiveData             *data;
1182         GtkTreeModel               *model;
1183         GList                      *iters, *l;
1184         gboolean                    in_list;
1185         gboolean                    should_be_in_list;
1186         gboolean                    was_online = TRUE;
1187         gboolean                    now_online = FALSE;
1188         gboolean                    set_model = FALSE;
1189         gboolean                    do_remove = FALSE;
1190         gboolean                    do_set_active = FALSE;
1191         gboolean                    do_set_refresh = FALSE;
1192         gboolean                    show_avatar = FALSE;
1193         GdkPixbuf                  *pixbuf_avatar;
1194         GdkPixbuf                  *pixbuf_status;
1195
1196         priv = GET_PRIV (store);
1197
1198         model = GTK_TREE_MODEL (store);
1199
1200         iters = contact_list_store_find_contact (store, contact);
1201         if (!iters) {
1202                 in_list = FALSE;
1203         } else {
1204                 in_list = TRUE;
1205         }
1206
1207         /* Get online state now. */
1208         now_online = empathy_contact_is_online (contact);
1209
1210         if (priv->show_offline || now_online) {
1211                 should_be_in_list = TRUE;
1212         } else {
1213                 should_be_in_list = FALSE;
1214         }
1215
1216         if (!in_list && !should_be_in_list) {
1217                 /* Nothing to do. */
1218                 DEBUG ("Contact:'%s' in list:NO, should be:NO",
1219                         empathy_contact_get_name (contact));
1220
1221                 g_list_foreach (iters, (GFunc) gtk_tree_iter_free, NULL);
1222                 g_list_free (iters);
1223                 return;
1224         }
1225         else if (in_list && !should_be_in_list) {
1226                 DEBUG ("Contact:'%s' in list:YES, should be:NO",
1227                         empathy_contact_get_name (contact));
1228
1229                 if (priv->show_active) {
1230                         do_remove = TRUE;
1231                         do_set_active = TRUE;
1232                         do_set_refresh = TRUE;
1233
1234                         set_model = TRUE;
1235                         DEBUG ("Remove item (after timeout)");
1236                 } else {
1237                         DEBUG ("Remove item (now)!");
1238                         contact_list_store_remove_contact (store, contact);
1239                 }
1240         }
1241         else if (!in_list && should_be_in_list) {
1242                 DEBUG ("Contact:'%s' in list:NO, should be:YES",
1243                         empathy_contact_get_name (contact));
1244
1245                 contact_list_store_add_contact (store, contact);
1246
1247                 if (priv->show_active) {
1248                         do_set_active = TRUE;
1249
1250                         DEBUG ("Set active (contact added)");
1251                 }
1252         } else {
1253                 DEBUG ("Contact:'%s' in list:YES, should be:YES",
1254                         empathy_contact_get_name (contact));
1255
1256                 /* Get online state before. */
1257                 if (iters && g_list_length (iters) > 0) {
1258                         gtk_tree_model_get (model, iters->data,
1259                                             EMPATHY_CONTACT_LIST_STORE_COL_IS_ONLINE, &was_online,
1260                                             -1);
1261                 }
1262
1263                 /* Is this really an update or an online/offline. */
1264                 if (priv->show_active) {
1265                         if (was_online != now_online) {
1266                                 do_set_active = TRUE;
1267                                 do_set_refresh = TRUE;
1268
1269                                 DEBUG ("Set active (contact updated %s)",
1270                                         was_online ? "online  -> offline" :
1271                                         "offline -> online");
1272                         } else {
1273                                 /* Was TRUE for presence updates. */
1274                                 /* do_set_active = FALSE;  */
1275                                 do_set_refresh = TRUE;
1276
1277                                 DEBUG ("Set active (contact updated)");
1278                         }
1279                 }
1280
1281                 set_model = TRUE;
1282         }
1283
1284         if (priv->show_avatars && !priv->is_compact) {
1285                 show_avatar = TRUE;
1286         }
1287         pixbuf_avatar = empathy_pixbuf_avatar_from_contact_scaled (contact, 32, 32);
1288         pixbuf_status = contact_list_store_get_contact_status_icon (store, contact);
1289         for (l = iters; l && set_model; l = l->next) {
1290                 gtk_tree_store_set (GTK_TREE_STORE (store), l->data,
1291                                     EMPATHY_CONTACT_LIST_STORE_COL_ICON_STATUS, pixbuf_status,
1292                                     EMPATHY_CONTACT_LIST_STORE_COL_PIXBUF_AVATAR, pixbuf_avatar,
1293                                     EMPATHY_CONTACT_LIST_STORE_COL_PIXBUF_AVATAR_VISIBLE, show_avatar,
1294                                     EMPATHY_CONTACT_LIST_STORE_COL_NAME, empathy_contact_get_name (contact),
1295                                     EMPATHY_CONTACT_LIST_STORE_COL_PRESENCE_TYPE,
1296                                       empathy_contact_get_presence (contact),
1297                                     EMPATHY_CONTACT_LIST_STORE_COL_STATUS,
1298                                       empathy_contact_get_presence_message (contact),
1299                                     EMPATHY_CONTACT_LIST_STORE_COL_COMPACT, priv->is_compact,
1300                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, FALSE,
1301                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_ONLINE, now_online,
1302                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, FALSE,
1303                                     EMPATHY_CONTACT_LIST_STORE_COL_CAN_AUDIO_CALL,
1304                                       empathy_contact_get_capabilities (contact) &
1305                                         EMPATHY_CAPABILITIES_AUDIO,
1306                                     EMPATHY_CONTACT_LIST_STORE_COL_CAN_VIDEO_CALL,
1307                                       empathy_contact_get_capabilities (contact) &
1308                                         EMPATHY_CAPABILITIES_VIDEO,
1309                                     -1);
1310         }
1311
1312         if (pixbuf_avatar) {
1313                 g_object_unref (pixbuf_avatar);
1314         }
1315
1316         if (priv->show_active && do_set_active) {
1317                 contact_list_store_contact_set_active (store, contact, do_set_active, do_set_refresh);
1318
1319                 if (do_set_active) {
1320                         data = contact_list_store_contact_active_new (store, contact, do_remove);
1321                         g_timeout_add_seconds (ACTIVE_USER_SHOW_TIME,
1322                                                (GSourceFunc) contact_list_store_contact_active_cb,
1323                                                data);
1324                 }
1325         }
1326
1327         /* FIXME: when someone goes online then offline quickly, the
1328          * first timeout sets the user to be inactive and the second
1329          * timeout removes the user from the contact list, really we
1330          * should remove the first timeout.
1331          */
1332         g_list_foreach (iters, (GFunc) gtk_tree_iter_free, NULL);
1333         g_list_free (iters);
1334 }
1335
1336 static void
1337 contact_list_store_contact_updated_cb (EmpathyContact          *contact,
1338                                        GParamSpec              *param,
1339                                        EmpathyContactListStore *store)
1340 {
1341         DEBUG ("Contact:'%s' updated, checking roster is in sync...",
1342                 empathy_contact_get_name (contact));
1343
1344         contact_list_store_contact_update (store, contact);
1345 }
1346
1347 static void
1348 contact_list_store_contact_set_active (EmpathyContactListStore *store,
1349                                        EmpathyContact          *contact,
1350                                        gboolean                active,
1351                                        gboolean                set_changed)
1352 {
1353         EmpathyContactListStorePriv *priv;
1354         GtkTreeModel               *model;
1355         GList                      *iters, *l;
1356
1357         priv = GET_PRIV (store);
1358         model = GTK_TREE_MODEL (store);
1359
1360         iters = contact_list_store_find_contact (store, contact);
1361         for (l = iters; l; l = l->next) {
1362                 GtkTreePath *path;
1363
1364                 gtk_tree_store_set (GTK_TREE_STORE (store), l->data,
1365                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, active,
1366                                     -1);
1367
1368                 DEBUG ("Set item %s", active ? "active" : "inactive");
1369
1370                 if (set_changed) {
1371                         path = gtk_tree_model_get_path (model, l->data);
1372                         gtk_tree_model_row_changed (model, path, l->data);
1373                         gtk_tree_path_free (path);
1374                 }
1375         }
1376
1377         g_list_foreach (iters, (GFunc) gtk_tree_iter_free, NULL);
1378         g_list_free (iters);
1379
1380 }
1381
1382 static ShowActiveData *
1383 contact_list_store_contact_active_new (EmpathyContactListStore *store,
1384                                        EmpathyContact          *contact,
1385                                        gboolean                remove_)
1386 {
1387         ShowActiveData *data;
1388
1389         DEBUG ("Contact:'%s' now active, and %s be removed",
1390                 empathy_contact_get_name (contact),
1391                 remove_ ? "WILL" : "WILL NOT");
1392
1393         data = g_slice_new0 (ShowActiveData);
1394
1395         data->store = g_object_ref (store);
1396         data->contact = g_object_ref (contact);
1397         data->remove = remove_;
1398
1399         return data;
1400 }
1401
1402 static void
1403 contact_list_store_contact_active_free (ShowActiveData *data)
1404 {
1405         g_object_unref (data->contact);
1406         g_object_unref (data->store);
1407
1408         g_slice_free (ShowActiveData, data);
1409 }
1410
1411 static gboolean
1412 contact_list_store_contact_active_cb (ShowActiveData *data)
1413 {
1414         EmpathyContactListStorePriv *priv;
1415
1416         priv = GET_PRIV (data->store);
1417
1418         if (data->remove &&
1419             !priv->show_offline &&
1420             !empathy_contact_is_online (data->contact)) {
1421                 DEBUG ("Contact:'%s' active timeout, removing item",
1422                         empathy_contact_get_name (data->contact));
1423                 contact_list_store_remove_contact (data->store, data->contact);
1424         }
1425
1426         DEBUG ("Contact:'%s' no longer active",
1427                 empathy_contact_get_name (data->contact));
1428
1429         contact_list_store_contact_set_active (data->store,
1430                                                data->contact,
1431                                                FALSE,
1432                                                TRUE);
1433
1434         contact_list_store_contact_active_free (data);
1435
1436         return FALSE;
1437 }
1438
1439 static gboolean
1440 contact_list_store_get_group_foreach (GtkTreeModel *model,
1441                                       GtkTreePath  *path,
1442                                       GtkTreeIter  *iter,
1443                                       FindGroup    *fg)
1444 {
1445         gchar    *str;
1446         gboolean  is_group;
1447
1448         /* Groups are only at the top level. */
1449         if (gtk_tree_path_get_depth (path) != 1) {
1450                 return FALSE;
1451         }
1452
1453         gtk_tree_model_get (model, iter,
1454                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &str,
1455                             EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
1456                             -1);
1457
1458         if (is_group && !tp_strdiff (str, fg->name)) {
1459                 fg->found = TRUE;
1460                 fg->iter = *iter;
1461         }
1462
1463         g_free (str);
1464
1465         return fg->found;
1466 }
1467
1468 static void
1469 contact_list_store_get_group (EmpathyContactListStore *store,
1470                               const gchar            *name,
1471                               GtkTreeIter            *iter_group_to_set,
1472                               GtkTreeIter            *iter_separator_to_set,
1473                               gboolean               *created,
1474                               gboolean               is_fake_group)
1475 {
1476         EmpathyContactListStorePriv *priv;
1477         GtkTreeModel                *model;
1478         GtkTreeIter                  iter_group;
1479         GtkTreeIter                  iter_separator;
1480         FindGroup                    fg;
1481
1482         priv = GET_PRIV (store);
1483
1484         memset (&fg, 0, sizeof (fg));
1485
1486         fg.name = name;
1487
1488         model = GTK_TREE_MODEL (store);
1489         gtk_tree_model_foreach (model,
1490                                 (GtkTreeModelForeachFunc) contact_list_store_get_group_foreach,
1491                                 &fg);
1492
1493         if (!fg.found) {
1494                 if (created) {
1495                         *created = TRUE;
1496                 }
1497
1498                 gtk_tree_store_append (GTK_TREE_STORE (store), &iter_group, NULL);
1499                 gtk_tree_store_set (GTK_TREE_STORE (store), &iter_group,
1500                                     EMPATHY_CONTACT_LIST_STORE_COL_ICON_STATUS, NULL,
1501                                     EMPATHY_CONTACT_LIST_STORE_COL_NAME, name,
1502                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, TRUE,
1503                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, FALSE,
1504                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, FALSE,
1505                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, is_fake_group,
1506                                     -1);
1507
1508                 if (iter_group_to_set) {
1509                         *iter_group_to_set = iter_group;
1510                 }
1511
1512                 gtk_tree_store_append (GTK_TREE_STORE (store),
1513                                        &iter_separator,
1514                                        &iter_group);
1515                 gtk_tree_store_set (GTK_TREE_STORE (store), &iter_separator,
1516                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, TRUE,
1517                                     -1);
1518
1519                 if (iter_separator_to_set) {
1520                         *iter_separator_to_set = iter_separator;
1521                 }
1522         } else {
1523                 if (created) {
1524                         *created = FALSE;
1525                 }
1526
1527                 if (iter_group_to_set) {
1528                         *iter_group_to_set = fg.iter;
1529                 }
1530
1531                 iter_separator = fg.iter;
1532
1533                 if (gtk_tree_model_iter_next (model, &iter_separator)) {
1534                         gboolean is_separator;
1535
1536                         gtk_tree_model_get (model, &iter_separator,
1537                                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator,
1538                                             -1);
1539
1540                         if (is_separator && iter_separator_to_set) {
1541                                 *iter_separator_to_set = iter_separator;
1542                         }
1543                 }
1544         }
1545 }
1546
1547 static gint
1548 get_position (const char **strv,
1549               const char *str)
1550 {
1551         int i;
1552
1553         for (i = 0; strv[i] != NULL; i++) {
1554                 if (!tp_strdiff (strv[i], str))
1555                         return i;
1556         }
1557
1558         return -1;
1559 }
1560
1561 static gint
1562 compare_separator_and_groups (gboolean is_separator_a,
1563                               gboolean is_separator_b,
1564                               const gchar *name_a,
1565                               const gchar *name_b,
1566                               EmpathyContact *contact_a,
1567                               EmpathyContact *contact_b,
1568                               gboolean fake_group_a,
1569                               gboolean fake_group_b)
1570 {
1571         /* these two lists are the sorted list of fake groups to include at the
1572          * top and bottom of the roster */
1573         const char *top_groups[] = {
1574                 EMPATHY_CONTACT_LIST_STORE_FAVORITE,
1575                 NULL
1576         };
1577
1578         const char *bottom_groups[] = {
1579                 EMPATHY_CONTACT_LIST_STORE_UNGROUPED,
1580                 NULL
1581         };
1582
1583         if (is_separator_a || is_separator_b) {
1584                 /* We have at least one separator */
1585                 if (is_separator_a) {
1586                         return -1;
1587                 } else if (is_separator_b) {
1588                         return 1;
1589                 }
1590         }
1591
1592         /* One group and one contact */
1593         if (!contact_a && contact_b) {
1594                 return 1;
1595         } else if (contact_a && !contact_b) {
1596                 return -1;
1597         } else if (!contact_a && !contact_b) {
1598                 gboolean a_in_top, b_in_top, a_in_bottom, b_in_bottom;
1599
1600                 a_in_top = fake_group_a &&
1601                         tp_strv_contains (top_groups, name_a);
1602                 b_in_top = fake_group_b &&
1603                         tp_strv_contains (top_groups, name_b);
1604                 a_in_bottom = fake_group_b &&
1605                         tp_strv_contains (bottom_groups, name_a);
1606                 b_in_bottom = fake_group_b &&
1607                         tp_strv_contains (bottom_groups, name_b);
1608
1609                 if (a_in_top && b_in_top) {
1610                         /* compare positions */
1611                         return CLAMP (get_position (top_groups, name_a) -
1612                                       get_position (top_groups, name_b),
1613                                       -1, 1);
1614                 } else if (a_in_bottom && b_in_bottom) {
1615                         /* compare positions */
1616                         return CLAMP (get_position (bottom_groups, name_a) -
1617                                       get_position (bottom_groups, name_b),
1618                                       -1, 1);
1619                 } else if (a_in_top || b_in_bottom) {
1620                         return -1;
1621                 } else if (b_in_top || a_in_bottom) {
1622                         return 1;
1623                 } else {
1624                         return g_utf8_collate (name_a, name_b);
1625                 }
1626         }
1627
1628         /* Two contacts, ordering depends of the sorting policy */
1629         return 0;
1630 }
1631
1632 static gint
1633 contact_list_store_state_sort_func (GtkTreeModel *model,
1634                                     GtkTreeIter  *iter_a,
1635                                     GtkTreeIter  *iter_b,
1636                                     gpointer      user_data)
1637 {
1638         gint            ret_val;
1639         gchar          *name_a, *name_b;
1640         gboolean        is_separator_a, is_separator_b;
1641         EmpathyContact *contact_a, *contact_b;
1642         gboolean       fake_group_a, fake_group_b;
1643
1644         gtk_tree_model_get (model, iter_a,
1645                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name_a,
1646                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact_a,
1647                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator_a,
1648                             EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake_group_a,
1649                             -1);
1650         gtk_tree_model_get (model, iter_b,
1651                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name_b,
1652                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact_b,
1653                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator_b,
1654                             EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake_group_b,
1655                             -1);
1656
1657         ret_val = compare_separator_and_groups (is_separator_a, is_separator_b,
1658                 name_a, name_b, contact_a, contact_b, fake_group_a, fake_group_b);
1659
1660         if (ret_val != 0) {
1661                 goto free_and_out;
1662         }
1663
1664         /* If we managed to get this far, we can start looking at
1665          * the presences.
1666          */
1667         ret_val = -tp_connection_presence_type_cmp_availability (
1668                 empathy_contact_get_presence (EMPATHY_CONTACT (contact_a)),
1669                 empathy_contact_get_presence (EMPATHY_CONTACT (contact_b)));
1670
1671         if (ret_val == 0) {
1672                 /* Fallback: compare by name */
1673                 ret_val = g_utf8_collate (name_a, name_b);
1674         }
1675
1676 free_and_out:
1677         g_free (name_a);
1678         g_free (name_b);
1679
1680         if (contact_a) {
1681                 g_object_unref (contact_a);
1682         }
1683
1684         if (contact_b) {
1685                 g_object_unref (contact_b);
1686         }
1687
1688         return ret_val;
1689 }
1690
1691 static gint
1692 contact_list_store_name_sort_func (GtkTreeModel *model,
1693                                    GtkTreeIter  *iter_a,
1694                                    GtkTreeIter  *iter_b,
1695                                    gpointer      user_data)
1696 {
1697         gchar         *name_a, *name_b;
1698         EmpathyContact *contact_a, *contact_b;
1699         gboolean       is_separator_a = FALSE, is_separator_b = FALSE;
1700         gint           ret_val;
1701         gboolean       fake_group_a, fake_group_b;
1702
1703         gtk_tree_model_get (model, iter_a,
1704                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name_a,
1705                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact_a,
1706                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator_a,
1707                             EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake_group_a,
1708                             -1);
1709         gtk_tree_model_get (model, iter_b,
1710                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name_b,
1711                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact_b,
1712                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator_b,
1713                             EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake_group_b,
1714                             -1);
1715
1716         ret_val = compare_separator_and_groups (is_separator_a, is_separator_b,
1717                 name_a, name_b, contact_a, contact_b, fake_group_a, fake_group_b);
1718
1719         if (ret_val == 0)
1720                 ret_val = g_utf8_collate (name_a, name_b);
1721
1722         if (contact_a) {
1723                 g_object_unref (contact_a);
1724         }
1725
1726         if (contact_b) {
1727                 g_object_unref (contact_b);
1728         }
1729
1730         return ret_val;
1731 }
1732
1733 static gboolean
1734 contact_list_store_find_contact_foreach (GtkTreeModel *model,
1735                                          GtkTreePath  *path,
1736                                          GtkTreeIter  *iter,
1737                                          FindContact  *fc)
1738 {
1739         EmpathyContact *contact;
1740
1741         gtk_tree_model_get (model, iter,
1742                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
1743                             -1);
1744
1745         if (contact == fc->contact) {
1746                 fc->found = TRUE;
1747                 fc->iters = g_list_append (fc->iters, gtk_tree_iter_copy (iter));
1748         }
1749
1750         if (contact) {
1751                 g_object_unref (contact);
1752         }
1753
1754         return FALSE;
1755 }
1756
1757 static GList *
1758 contact_list_store_find_contact (EmpathyContactListStore *store,
1759                                  EmpathyContact          *contact)
1760 {
1761         EmpathyContactListStorePriv *priv;
1762         GtkTreeModel              *model;
1763         GList                     *l = NULL;
1764         FindContact                fc;
1765
1766         priv = GET_PRIV (store);
1767
1768         memset (&fc, 0, sizeof (fc));
1769
1770         fc.contact = contact;
1771
1772         model = GTK_TREE_MODEL (store);
1773         gtk_tree_model_foreach (model,
1774                                 (GtkTreeModelForeachFunc) contact_list_store_find_contact_foreach,
1775                                 &fc);
1776
1777         if (fc.found) {
1778                 l = fc.iters;
1779         }
1780
1781         return l;
1782 }
1783
1784 static gboolean
1785 contact_list_store_update_list_mode_foreach (GtkTreeModel           *model,
1786                                              GtkTreePath            *path,
1787                                              GtkTreeIter            *iter,
1788                                              EmpathyContactListStore *store)
1789 {
1790         EmpathyContactListStorePriv *priv;
1791         gboolean                     show_avatar = FALSE;
1792         EmpathyContact              *contact;
1793         GdkPixbuf                   *pixbuf_status;
1794
1795         priv = GET_PRIV (store);
1796
1797         if (priv->show_avatars && !priv->is_compact) {
1798                 show_avatar = TRUE;
1799         }
1800
1801         gtk_tree_model_get (model, iter,
1802                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
1803                             -1);
1804
1805         if (contact == NULL){
1806                 return FALSE;
1807         }
1808         /* get icon from hash_table */
1809         pixbuf_status = contact_list_store_get_contact_status_icon (store, contact);
1810
1811         gtk_tree_store_set (GTK_TREE_STORE (store), iter,
1812                             EMPATHY_CONTACT_LIST_STORE_COL_ICON_STATUS, pixbuf_status,
1813                             EMPATHY_CONTACT_LIST_STORE_COL_PIXBUF_AVATAR_VISIBLE, show_avatar,
1814                             EMPATHY_CONTACT_LIST_STORE_COL_COMPACT, priv->is_compact,
1815                             -1);
1816
1817         return FALSE;
1818 }
1819
1820 static GdkPixbuf *
1821 contact_list_store_get_contact_status_icon_with_icon_name (
1822                                         EmpathyContactListStore *store,
1823                                         EmpathyContact *contact,
1824                                         const gchar *status_icon_name)
1825 {
1826         GdkPixbuf                   *pixbuf_status = NULL;
1827         EmpathyContactListStorePriv *priv;
1828         const gchar                 *protocol_name = NULL;
1829         gchar                       *icon_name = NULL;
1830
1831         priv = GET_PRIV (store);
1832
1833         if (priv->show_protocols) {
1834                 protocol_name = empathy_protocol_name_for_contact (contact);
1835                 icon_name = g_strdup_printf ("%s-%s", status_icon_name, protocol_name);
1836         } else {
1837                 icon_name = g_strdup_printf ("%s", status_icon_name);
1838         }
1839         pixbuf_status = g_hash_table_lookup (priv->status_icons, icon_name);
1840         if (pixbuf_status == NULL) {
1841                 pixbuf_status = empathy_pixbuf_contact_status_icon_with_icon_name (contact,
1842                                     status_icon_name,
1843                                     priv->show_protocols);
1844                 if (pixbuf_status != NULL) {
1845                         g_hash_table_insert (priv->status_icons,
1846                             g_strdup (icon_name),
1847                             pixbuf_status);
1848                 }
1849         }
1850
1851         g_free (icon_name);
1852         return pixbuf_status;
1853 }
1854
1855 GdkPixbuf *
1856 contact_list_store_get_contact_status_icon (EmpathyContactListStore *store,
1857                                             EmpathyContact *contact)
1858 {
1859         GdkPixbuf                   *pixbuf_status = NULL;
1860         const gchar                 *status_icon_name = NULL;
1861
1862         status_icon_name = empathy_icon_name_for_contact (contact);
1863         if (status_icon_name == NULL)
1864                 return NULL;
1865
1866         pixbuf_status = contact_list_store_get_contact_status_icon_with_icon_name (
1867                             store,
1868                             contact,
1869                             status_icon_name);
1870
1871         return pixbuf_status;
1872 }