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