]> git.0d.be Git - empathy.git/blob - libempathy-gtk/empathy-contact-list-store.c
Clean up sorting function to take top/bottom lists of fake groups
[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_STRING,        /* Status string */
837                 G_TYPE_BOOLEAN,       /* Show status */
838                 EMPATHY_TYPE_CONTACT, /* Contact type */
839                 G_TYPE_BOOLEAN,       /* Is group */
840                 G_TYPE_BOOLEAN,       /* Is active */
841                 G_TYPE_BOOLEAN,       /* Is online */
842                 G_TYPE_BOOLEAN,       /* Is separator */
843                 G_TYPE_BOOLEAN,       /* Can make audio calls */
844                 G_TYPE_BOOLEAN,       /* Can make video calls */
845                 EMPATHY_TYPE_CONTACT_LIST_FLAGS, /* Flags */
846                 G_TYPE_BOOLEAN,       /* Is a fake group */
847         };
848
849         priv = GET_PRIV (store);
850
851         gtk_tree_store_set_column_types (GTK_TREE_STORE (store),
852                                          EMPATHY_CONTACT_LIST_STORE_COL_COUNT,
853                                          types);
854
855         /* Set up sorting */
856         gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (store),
857                                          EMPATHY_CONTACT_LIST_STORE_COL_NAME,
858                                          contact_list_store_name_sort_func,
859                                          store, NULL);
860         gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (store),
861                                          EMPATHY_CONTACT_LIST_STORE_COL_STATUS,
862                                          contact_list_store_state_sort_func,
863                                          store, NULL);
864
865         priv->sort_criterium = EMPATHY_CONTACT_LIST_STORE_SORT_NAME;
866         empathy_contact_list_store_set_sort_criterium (store, priv->sort_criterium);
867 }
868
869 static gboolean
870 contact_list_store_inibit_active_cb (EmpathyContactListStore *store)
871 {
872         EmpathyContactListStorePriv *priv;
873
874         priv = GET_PRIV (store);
875
876         priv->show_active = TRUE;
877         priv->inhibit_active = 0;
878
879         return FALSE;
880 }
881
882 static void
883 contact_list_store_add_contact_and_connect (EmpathyContactListStore *store, EmpathyContact *contact)
884 {
885         g_signal_connect (contact, "notify::presence",
886                           G_CALLBACK (contact_list_store_contact_updated_cb),
887                           store);
888         g_signal_connect (contact, "notify::presence-message",
889                           G_CALLBACK (contact_list_store_contact_updated_cb),
890                           store);
891         g_signal_connect (contact, "notify::name",
892                           G_CALLBACK (contact_list_store_contact_updated_cb),
893                           store);
894         g_signal_connect (contact, "notify::avatar",
895                           G_CALLBACK (contact_list_store_contact_updated_cb),
896                           store);
897         g_signal_connect (contact, "notify::capabilities",
898                           G_CALLBACK (contact_list_store_contact_updated_cb),
899                           store);
900
901         contact_list_store_add_contact (store, contact);
902 }
903
904 static void
905 contact_list_store_remove_contact_and_disconnect (EmpathyContactListStore *store, EmpathyContact *contact)
906 {
907         g_signal_handlers_disconnect_by_func (contact,
908                                               G_CALLBACK (contact_list_store_contact_updated_cb),
909                                               store);
910
911         contact_list_store_remove_contact (store, contact);
912 }
913
914 static void
915 contact_list_store_members_changed_cb (EmpathyContactList      *list_iface,
916                                        EmpathyContact          *contact,
917                                        EmpathyContact          *actor,
918                                        guint                    reason,
919                                        gchar                   *message,
920                                        gboolean                 is_member,
921                                        EmpathyContactListStore *store)
922 {
923         EmpathyContactListStorePriv *priv;
924
925         priv = GET_PRIV (store);
926
927         DEBUG ("Contact %s (%d) %s",
928                 empathy_contact_get_id (contact),
929                 empathy_contact_get_handle (contact),
930                 is_member ? "added" : "removed");
931
932         if (is_member) {
933                 contact_list_store_add_contact_and_connect (store, contact);
934         } else {
935                 contact_list_store_remove_contact_and_disconnect (store, contact);
936         }
937 }
938
939 static void
940 contact_list_store_favourites_changed_cb (EmpathyContactList      *list_iface,
941                                           EmpathyContact          *contact,
942                                           gboolean                 is_favourite,
943                                           EmpathyContactListStore *store)
944 {
945         EmpathyContactListStorePriv *priv;
946
947         priv = GET_PRIV (store);
948
949         DEBUG ("Contact %s (%d) is %s a favourite",
950                 empathy_contact_get_id (contact),
951                 empathy_contact_get_handle (contact),
952                 is_favourite ? "now" : "no longer");
953
954         contact_list_store_remove_contact (store, contact);
955         contact_list_store_add_contact (store, contact);
956 }
957
958 static void
959 contact_list_store_member_renamed_cb (EmpathyContactList      *list_iface,
960                                       EmpathyContact          *old_contact,
961                                       EmpathyContact          *new_contact,
962                                       guint                    reason,
963                                       gchar                   *message,
964                                       EmpathyContactListStore *store)
965 {
966         EmpathyContactListStorePriv *priv;
967
968         priv = GET_PRIV (store);
969
970         DEBUG ("Contact %s (%d) renamed to %s (%d)",
971                 empathy_contact_get_id (old_contact),
972                 empathy_contact_get_handle (old_contact),
973                 empathy_contact_get_id (new_contact),
974                 empathy_contact_get_handle (new_contact));
975
976         /* add the new contact */
977         contact_list_store_add_contact_and_connect (store, new_contact);
978
979         /* remove old contact */
980         contact_list_store_remove_contact_and_disconnect (store, old_contact);
981 }
982
983 static void
984 contact_list_store_groups_changed_cb (EmpathyContactList      *list_iface,
985                                       EmpathyContact          *contact,
986                                       gchar                   *group,
987                                       gboolean                 is_member,
988                                       EmpathyContactListStore *store)
989 {
990         EmpathyContactListStorePriv *priv;
991         gboolean                     show_active;
992
993         priv = GET_PRIV (store);
994
995         DEBUG ("Updating groups for contact %s (%d)",
996                 empathy_contact_get_id (contact),
997                 empathy_contact_get_handle (contact));
998
999         /* We do this to make sure the groups are correct, if not, we
1000          * would have to check the groups already set up for each
1001          * contact and then see what has been updated.
1002          */
1003         show_active = priv->show_active;
1004         priv->show_active = FALSE;
1005         contact_list_store_remove_contact (store, contact);
1006         contact_list_store_add_contact (store, contact);
1007         priv->show_active = show_active;
1008 }
1009
1010 static void
1011 add_contact_to_store (GtkTreeStore *store,
1012                       GtkTreeIter *iter,
1013                       EmpathyContact *contact,
1014                       EmpathyContactListFlags flags)
1015 {
1016         gtk_tree_store_set (store, iter,
1017                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, empathy_contact_get_name (contact),
1018                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, contact,
1019                             EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, FALSE,
1020                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, FALSE,
1021                             EMPATHY_CONTACT_LIST_STORE_COL_CAN_AUDIO_CALL,
1022                               empathy_contact_get_capabilities (contact) &
1023                                 EMPATHY_CAPABILITIES_AUDIO,
1024                             EMPATHY_CONTACT_LIST_STORE_COL_CAN_VIDEO_CALL,
1025                               empathy_contact_get_capabilities (contact) &
1026                                 EMPATHY_CAPABILITIES_VIDEO,
1027                             EMPATHY_CONTACT_LIST_STORE_COL_FLAGS, flags,
1028                             -1);
1029 }
1030
1031 static void
1032 contact_list_store_add_contact (EmpathyContactListStore *store,
1033                                 EmpathyContact          *contact)
1034 {
1035         EmpathyContactListStorePriv *priv;
1036         GtkTreeIter                 iter;
1037         GList                      *groups = NULL, *l;
1038         TpConnection               *connection;
1039         EmpathyContactListFlags     flags = 0;
1040         char                       *protocol_name;
1041
1042         priv = GET_PRIV (store);
1043
1044         if (EMP_STR_EMPTY (empathy_contact_get_name (contact)) ||
1045             (!priv->show_offline && !empathy_contact_is_online (contact))) {
1046                 return;
1047         }
1048
1049         if (priv->show_groups) {
1050                 groups = empathy_contact_list_get_groups (priv->list, contact);
1051         }
1052
1053         connection = empathy_contact_get_connection (contact);
1054         if (EMPATHY_IS_CONTACT_MANAGER (priv->list)) {
1055                 flags = empathy_contact_manager_get_flags_for_connection (
1056                         EMPATHY_CONTACT_MANAGER (priv->list), connection);
1057         }
1058
1059         tp_connection_parse_object_path (connection, &protocol_name, NULL);
1060
1061         if (!groups) {
1062 #if HAVE_FAVOURITE_CONTACTS
1063                 GtkTreeIter iter_group;
1064
1065                 if (!tp_strdiff (protocol_name, "local-xmpp")) {
1066                         /* these are People Nearby */
1067                         contact_list_store_get_group (store,
1068                                 EMPATHY_CONTACT_LIST_STORE_PEOPLE_NEARBY,
1069                                 &iter_group, NULL, NULL, TRUE);
1070                 } else {
1071                         contact_list_store_get_group (store,
1072                                 EMPATHY_CONTACT_LIST_STORE_UNGROUPED,
1073                                 &iter_group, NULL, NULL, TRUE);
1074                 }
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         g_free (protocol_name);
1105
1106         /* Else add to each group. */
1107         for (l = groups; l; l = l->next) {
1108                 GtkTreeIter iter_group;
1109
1110                 contact_list_store_get_group (store, l->data, &iter_group, NULL, NULL, FALSE);
1111
1112                 gtk_tree_store_insert_after (GTK_TREE_STORE (store), &iter,
1113                                              &iter_group, NULL);
1114
1115                 add_contact_to_store (GTK_TREE_STORE (store), &iter, contact, flags);
1116                 g_free (l->data);
1117         }
1118         g_list_free (groups);
1119
1120 #ifdef HAVE_FAVOURITE_CONTACTS
1121         if (empathy_contact_list_is_favourite (priv->list, contact)) {
1122         /* Add contact to the fake 'Favorites' group */
1123                 GtkTreeIter iter_group;
1124
1125                 contact_list_store_get_group (store, EMPATHY_CONTACT_LIST_STORE_FAVORITE,
1126                         &iter_group, NULL, NULL, TRUE);
1127
1128                 gtk_tree_store_insert_after (GTK_TREE_STORE (store), &iter,
1129                                              &iter_group, NULL);
1130
1131                 add_contact_to_store (GTK_TREE_STORE (store), &iter, contact, flags);
1132         }
1133 #endif
1134
1135         contact_list_store_contact_update (store, contact);
1136 }
1137
1138 static void
1139 contact_list_store_remove_contact (EmpathyContactListStore *store,
1140                                    EmpathyContact          *contact)
1141 {
1142         EmpathyContactListStorePriv *priv;
1143         GtkTreeModel               *model;
1144         GList                      *iters, *l;
1145
1146         priv = GET_PRIV (store);
1147
1148         iters = contact_list_store_find_contact (store, contact);
1149         if (!iters) {
1150                 return;
1151         }
1152
1153         /* Clean up model */
1154         model = GTK_TREE_MODEL (store);
1155
1156         for (l = iters; l; l = l->next) {
1157                 GtkTreeIter parent;
1158
1159                 /* NOTE: it is only <= 2 here because we have
1160                  * separators after the group name, otherwise it
1161                  * should be 1.
1162                  */
1163                 if (gtk_tree_model_iter_parent (model, &parent, l->data) &&
1164                     gtk_tree_model_iter_n_children (model, &parent) <= 2) {
1165                         gtk_tree_store_remove (GTK_TREE_STORE (store), &parent);
1166                 } else {
1167                         gtk_tree_store_remove (GTK_TREE_STORE (store), l->data);
1168                 }
1169         }
1170
1171         g_list_foreach (iters, (GFunc) gtk_tree_iter_free, NULL);
1172         g_list_free (iters);
1173 }
1174
1175 static void
1176 contact_list_store_contact_update (EmpathyContactListStore *store,
1177                                    EmpathyContact          *contact)
1178 {
1179         EmpathyContactListStorePriv *priv;
1180         ShowActiveData             *data;
1181         GtkTreeModel               *model;
1182         GList                      *iters, *l;
1183         gboolean                    in_list;
1184         gboolean                    should_be_in_list;
1185         gboolean                    was_online = TRUE;
1186         gboolean                    now_online = FALSE;
1187         gboolean                    set_model = FALSE;
1188         gboolean                    do_remove = FALSE;
1189         gboolean                    do_set_active = FALSE;
1190         gboolean                    do_set_refresh = FALSE;
1191         gboolean                    show_avatar = FALSE;
1192         GdkPixbuf                  *pixbuf_avatar;
1193         GdkPixbuf                  *pixbuf_status;
1194
1195         priv = GET_PRIV (store);
1196
1197         model = GTK_TREE_MODEL (store);
1198
1199         iters = contact_list_store_find_contact (store, contact);
1200         if (!iters) {
1201                 in_list = FALSE;
1202         } else {
1203                 in_list = TRUE;
1204         }
1205
1206         /* Get online state now. */
1207         now_online = empathy_contact_is_online (contact);
1208
1209         if (priv->show_offline || now_online) {
1210                 should_be_in_list = TRUE;
1211         } else {
1212                 should_be_in_list = FALSE;
1213         }
1214
1215         if (!in_list && !should_be_in_list) {
1216                 /* Nothing to do. */
1217                 DEBUG ("Contact:'%s' in list:NO, should be:NO",
1218                         empathy_contact_get_name (contact));
1219
1220                 g_list_foreach (iters, (GFunc) gtk_tree_iter_free, NULL);
1221                 g_list_free (iters);
1222                 return;
1223         }
1224         else if (in_list && !should_be_in_list) {
1225                 DEBUG ("Contact:'%s' in list:YES, should be:NO",
1226                         empathy_contact_get_name (contact));
1227
1228                 if (priv->show_active) {
1229                         do_remove = TRUE;
1230                         do_set_active = TRUE;
1231                         do_set_refresh = TRUE;
1232
1233                         set_model = TRUE;
1234                         DEBUG ("Remove item (after timeout)");
1235                 } else {
1236                         DEBUG ("Remove item (now)!");
1237                         contact_list_store_remove_contact (store, contact);
1238                 }
1239         }
1240         else if (!in_list && should_be_in_list) {
1241                 DEBUG ("Contact:'%s' in list:NO, should be:YES",
1242                         empathy_contact_get_name (contact));
1243
1244                 contact_list_store_add_contact (store, contact);
1245
1246                 if (priv->show_active) {
1247                         do_set_active = TRUE;
1248
1249                         DEBUG ("Set active (contact added)");
1250                 }
1251         } else {
1252                 DEBUG ("Contact:'%s' in list:YES, should be:YES",
1253                         empathy_contact_get_name (contact));
1254
1255                 /* Get online state before. */
1256                 if (iters && g_list_length (iters) > 0) {
1257                         gtk_tree_model_get (model, iters->data,
1258                                             EMPATHY_CONTACT_LIST_STORE_COL_IS_ONLINE, &was_online,
1259                                             -1);
1260                 }
1261
1262                 /* Is this really an update or an online/offline. */
1263                 if (priv->show_active) {
1264                         if (was_online != now_online) {
1265                                 do_set_active = TRUE;
1266                                 do_set_refresh = TRUE;
1267
1268                                 DEBUG ("Set active (contact updated %s)",
1269                                         was_online ? "online  -> offline" :
1270                                         "offline -> online");
1271                         } else {
1272                                 /* Was TRUE for presence updates. */
1273                                 /* do_set_active = FALSE;  */
1274                                 do_set_refresh = TRUE;
1275
1276                                 DEBUG ("Set active (contact updated)");
1277                         }
1278                 }
1279
1280                 set_model = TRUE;
1281         }
1282
1283         if (priv->show_avatars && !priv->is_compact) {
1284                 show_avatar = TRUE;
1285         }
1286         pixbuf_avatar = empathy_pixbuf_avatar_from_contact_scaled (contact, 32, 32);
1287         pixbuf_status = contact_list_store_get_contact_status_icon (store, contact);
1288         for (l = iters; l && set_model; l = l->next) {
1289                 gtk_tree_store_set (GTK_TREE_STORE (store), l->data,
1290                                     EMPATHY_CONTACT_LIST_STORE_COL_ICON_STATUS, pixbuf_status,
1291                                     EMPATHY_CONTACT_LIST_STORE_COL_PIXBUF_AVATAR, pixbuf_avatar,
1292                                     EMPATHY_CONTACT_LIST_STORE_COL_PIXBUF_AVATAR_VISIBLE, show_avatar,
1293                                     EMPATHY_CONTACT_LIST_STORE_COL_NAME, empathy_contact_get_name (contact),
1294                                     EMPATHY_CONTACT_LIST_STORE_COL_STATUS, empathy_contact_get_status (contact),
1295                                     EMPATHY_CONTACT_LIST_STORE_COL_STATUS_VISIBLE, !priv->is_compact,
1296                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, FALSE,
1297                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_ONLINE, now_online,
1298                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, FALSE,
1299                                     EMPATHY_CONTACT_LIST_STORE_COL_CAN_AUDIO_CALL,
1300                                       empathy_contact_get_capabilities (contact) &
1301                                         EMPATHY_CAPABILITIES_AUDIO,
1302                                     EMPATHY_CONTACT_LIST_STORE_COL_CAN_VIDEO_CALL,
1303                                       empathy_contact_get_capabilities (contact) &
1304                                         EMPATHY_CAPABILITIES_VIDEO,
1305                                     -1);
1306         }
1307
1308         if (pixbuf_avatar) {
1309                 g_object_unref (pixbuf_avatar);
1310         }
1311
1312         if (priv->show_active && do_set_active) {
1313                 contact_list_store_contact_set_active (store, contact, do_set_active, do_set_refresh);
1314
1315                 if (do_set_active) {
1316                         data = contact_list_store_contact_active_new (store, contact, do_remove);
1317                         g_timeout_add_seconds (ACTIVE_USER_SHOW_TIME,
1318                                                (GSourceFunc) contact_list_store_contact_active_cb,
1319                                                data);
1320                 }
1321         }
1322
1323         /* FIXME: when someone goes online then offline quickly, the
1324          * first timeout sets the user to be inactive and the second
1325          * timeout removes the user from the contact list, really we
1326          * should remove the first timeout.
1327          */
1328         g_list_foreach (iters, (GFunc) gtk_tree_iter_free, NULL);
1329         g_list_free (iters);
1330 }
1331
1332 static void
1333 contact_list_store_contact_updated_cb (EmpathyContact          *contact,
1334                                        GParamSpec              *param,
1335                                        EmpathyContactListStore *store)
1336 {
1337         DEBUG ("Contact:'%s' updated, checking roster is in sync...",
1338                 empathy_contact_get_name (contact));
1339
1340         contact_list_store_contact_update (store, contact);
1341 }
1342
1343 static void
1344 contact_list_store_contact_set_active (EmpathyContactListStore *store,
1345                                        EmpathyContact          *contact,
1346                                        gboolean                active,
1347                                        gboolean                set_changed)
1348 {
1349         EmpathyContactListStorePriv *priv;
1350         GtkTreeModel               *model;
1351         GList                      *iters, *l;
1352
1353         priv = GET_PRIV (store);
1354         model = GTK_TREE_MODEL (store);
1355
1356         iters = contact_list_store_find_contact (store, contact);
1357         for (l = iters; l; l = l->next) {
1358                 GtkTreePath *path;
1359
1360                 gtk_tree_store_set (GTK_TREE_STORE (store), l->data,
1361                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, active,
1362                                     -1);
1363
1364                 DEBUG ("Set item %s", active ? "active" : "inactive");
1365
1366                 if (set_changed) {
1367                         path = gtk_tree_model_get_path (model, l->data);
1368                         gtk_tree_model_row_changed (model, path, l->data);
1369                         gtk_tree_path_free (path);
1370                 }
1371         }
1372
1373         g_list_foreach (iters, (GFunc) gtk_tree_iter_free, NULL);
1374         g_list_free (iters);
1375
1376 }
1377
1378 static ShowActiveData *
1379 contact_list_store_contact_active_new (EmpathyContactListStore *store,
1380                                        EmpathyContact          *contact,
1381                                        gboolean                remove_)
1382 {
1383         ShowActiveData *data;
1384
1385         DEBUG ("Contact:'%s' now active, and %s be removed",
1386                 empathy_contact_get_name (contact),
1387                 remove_ ? "WILL" : "WILL NOT");
1388
1389         data = g_slice_new0 (ShowActiveData);
1390
1391         data->store = g_object_ref (store);
1392         data->contact = g_object_ref (contact);
1393         data->remove = remove_;
1394
1395         return data;
1396 }
1397
1398 static void
1399 contact_list_store_contact_active_free (ShowActiveData *data)
1400 {
1401         g_object_unref (data->contact);
1402         g_object_unref (data->store);
1403
1404         g_slice_free (ShowActiveData, data);
1405 }
1406
1407 static gboolean
1408 contact_list_store_contact_active_cb (ShowActiveData *data)
1409 {
1410         EmpathyContactListStorePriv *priv;
1411
1412         priv = GET_PRIV (data->store);
1413
1414         if (data->remove &&
1415             !priv->show_offline &&
1416             !empathy_contact_is_online (data->contact)) {
1417                 DEBUG ("Contact:'%s' active timeout, removing item",
1418                         empathy_contact_get_name (data->contact));
1419                 contact_list_store_remove_contact (data->store, data->contact);
1420         }
1421
1422         DEBUG ("Contact:'%s' no longer active",
1423                 empathy_contact_get_name (data->contact));
1424
1425         contact_list_store_contact_set_active (data->store,
1426                                                data->contact,
1427                                                FALSE,
1428                                                TRUE);
1429
1430         contact_list_store_contact_active_free (data);
1431
1432         return FALSE;
1433 }
1434
1435 static gboolean
1436 contact_list_store_get_group_foreach (GtkTreeModel *model,
1437                                       GtkTreePath  *path,
1438                                       GtkTreeIter  *iter,
1439                                       FindGroup    *fg)
1440 {
1441         gchar    *str;
1442         gboolean  is_group;
1443
1444         /* Groups are only at the top level. */
1445         if (gtk_tree_path_get_depth (path) != 1) {
1446                 return FALSE;
1447         }
1448
1449         gtk_tree_model_get (model, iter,
1450                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &str,
1451                             EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, &is_group,
1452                             -1);
1453
1454         if (is_group && !tp_strdiff (str, fg->name)) {
1455                 fg->found = TRUE;
1456                 fg->iter = *iter;
1457         }
1458
1459         g_free (str);
1460
1461         return fg->found;
1462 }
1463
1464 static void
1465 contact_list_store_get_group (EmpathyContactListStore *store,
1466                               const gchar            *name,
1467                               GtkTreeIter            *iter_group_to_set,
1468                               GtkTreeIter            *iter_separator_to_set,
1469                               gboolean               *created,
1470                               gboolean               is_fake_group)
1471 {
1472         EmpathyContactListStorePriv *priv;
1473         GtkTreeModel                *model;
1474         GtkTreeIter                  iter_group;
1475         GtkTreeIter                  iter_separator;
1476         FindGroup                    fg;
1477
1478         priv = GET_PRIV (store);
1479
1480         memset (&fg, 0, sizeof (fg));
1481
1482         fg.name = name;
1483
1484         model = GTK_TREE_MODEL (store);
1485         gtk_tree_model_foreach (model,
1486                                 (GtkTreeModelForeachFunc) contact_list_store_get_group_foreach,
1487                                 &fg);
1488
1489         if (!fg.found) {
1490                 if (created) {
1491                         *created = TRUE;
1492                 }
1493
1494                 gtk_tree_store_append (GTK_TREE_STORE (store), &iter_group, NULL);
1495                 gtk_tree_store_set (GTK_TREE_STORE (store), &iter_group,
1496                                     EMPATHY_CONTACT_LIST_STORE_COL_ICON_STATUS, NULL,
1497                                     EMPATHY_CONTACT_LIST_STORE_COL_NAME, name,
1498                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_GROUP, TRUE,
1499                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_ACTIVE, FALSE,
1500                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, FALSE,
1501                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, is_fake_group,
1502                                     -1);
1503
1504                 if (iter_group_to_set) {
1505                         *iter_group_to_set = iter_group;
1506                 }
1507
1508                 gtk_tree_store_append (GTK_TREE_STORE (store),
1509                                        &iter_separator,
1510                                        &iter_group);
1511                 gtk_tree_store_set (GTK_TREE_STORE (store), &iter_separator,
1512                                     EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, TRUE,
1513                                     -1);
1514
1515                 if (iter_separator_to_set) {
1516                         *iter_separator_to_set = iter_separator;
1517                 }
1518         } else {
1519                 if (created) {
1520                         *created = FALSE;
1521                 }
1522
1523                 if (iter_group_to_set) {
1524                         *iter_group_to_set = fg.iter;
1525                 }
1526
1527                 iter_separator = fg.iter;
1528
1529                 if (gtk_tree_model_iter_next (model, &iter_separator)) {
1530                         gboolean is_separator;
1531
1532                         gtk_tree_model_get (model, &iter_separator,
1533                                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator,
1534                                             -1);
1535
1536                         if (is_separator && iter_separator_to_set) {
1537                                 *iter_separator_to_set = iter_separator;
1538                         }
1539                 }
1540         }
1541 }
1542
1543 static gint
1544 get_position (const char **strv,
1545               const char *str)
1546 {
1547         int i;
1548
1549         for (i = 0; strv[i] != NULL; i++) {
1550                 if (!tp_strdiff (strv[i], str))
1551                         return i;
1552         }
1553
1554         return -1;
1555 }
1556
1557 static gint
1558 compare_separator_and_groups (gboolean is_separator_a,
1559                               gboolean is_separator_b,
1560                               const gchar *name_a,
1561                               const gchar *name_b,
1562                               EmpathyContact *contact_a,
1563                               EmpathyContact *contact_b,
1564                               gboolean fake_group_a,
1565                               gboolean fake_group_b)
1566 {
1567         /* these two lists are the sorted list of fake groups to include at the
1568          * top and bottom of the roster */
1569         const char *top_groups[] = {
1570                 EMPATHY_CONTACT_LIST_STORE_FAVORITE,
1571                 EMPATHY_CONTACT_LIST_STORE_PEOPLE_NEARBY,
1572                 NULL
1573         };
1574
1575         const char *bottom_groups[] = {
1576                 EMPATHY_CONTACT_LIST_STORE_UNGROUPED,
1577                 NULL
1578         };
1579
1580         if (is_separator_a || is_separator_b) {
1581                 /* We have at least one separator */
1582                 if (is_separator_a) {
1583                         return -1;
1584                 } else if (is_separator_b) {
1585                         return 1;
1586                 }
1587         }
1588
1589         /* One group and one contact */
1590         if (!contact_a && contact_b) {
1591                 return 1;
1592         } else if (contact_a && !contact_b) {
1593                 return -1;
1594         } else if (!contact_a && !contact_b) {
1595                 gboolean a_in_top, b_in_top, a_in_bottom, b_in_bottom;
1596
1597                 a_in_top = fake_group_a &&
1598                         tp_strv_contains (top_groups, name_a);
1599                 b_in_top = fake_group_b &&
1600                         tp_strv_contains (top_groups, name_b);
1601                 a_in_bottom = fake_group_b &&
1602                         tp_strv_contains (bottom_groups, name_a);
1603                 b_in_bottom = fake_group_b &&
1604                         tp_strv_contains (bottom_groups, name_b);
1605
1606                 if (a_in_top && b_in_top) {
1607                         /* compare positions */
1608                         return CLAMP (get_position (top_groups, name_a) -
1609                                       get_position (top_groups, name_b),
1610                                       -1, 1);
1611                 } else if (a_in_bottom && b_in_bottom) {
1612                         /* compare positions */
1613                         return CLAMP (get_position (bottom_groups, name_a) -
1614                                       get_position (bottom_groups, name_b),
1615                                       -1, 1);
1616                 } else if (a_in_top || b_in_bottom) {
1617                         return -1;
1618                 } else if (b_in_top || a_in_bottom) {
1619                         return 1;
1620                 } else {
1621                         return g_utf8_collate (name_a, name_b);
1622                 }
1623         }
1624
1625         /* Two contacts, ordering depends of the sorting policy */
1626         return 0;
1627 }
1628
1629 static gint
1630 contact_list_store_state_sort_func (GtkTreeModel *model,
1631                                     GtkTreeIter  *iter_a,
1632                                     GtkTreeIter  *iter_b,
1633                                     gpointer      user_data)
1634 {
1635         gint            ret_val;
1636         gchar          *name_a, *name_b;
1637         gboolean        is_separator_a, is_separator_b;
1638         EmpathyContact *contact_a, *contact_b;
1639         gboolean       fake_group_a, fake_group_b;
1640
1641         gtk_tree_model_get (model, iter_a,
1642                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name_a,
1643                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact_a,
1644                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator_a,
1645                             EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake_group_a,
1646                             -1);
1647         gtk_tree_model_get (model, iter_b,
1648                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name_b,
1649                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact_b,
1650                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator_b,
1651                             EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake_group_b,
1652                             -1);
1653
1654         ret_val = compare_separator_and_groups (is_separator_a, is_separator_b,
1655                 name_a, name_b, contact_a, contact_b, fake_group_a, fake_group_b);
1656
1657         if (ret_val != 0) {
1658                 goto free_and_out;
1659         }
1660
1661         /* If we managed to get this far, we can start looking at
1662          * the presences.
1663          */
1664         ret_val = -tp_connection_presence_type_cmp_availability (
1665                 empathy_contact_get_presence (EMPATHY_CONTACT (contact_a)),
1666                 empathy_contact_get_presence (EMPATHY_CONTACT (contact_b)));
1667
1668         if (ret_val == 0) {
1669                 /* Fallback: compare by name */
1670                 ret_val = g_utf8_collate (name_a, name_b);
1671         }
1672
1673 free_and_out:
1674         g_free (name_a);
1675         g_free (name_b);
1676
1677         if (contact_a) {
1678                 g_object_unref (contact_a);
1679         }
1680
1681         if (contact_b) {
1682                 g_object_unref (contact_b);
1683         }
1684
1685         return ret_val;
1686 }
1687
1688 static gint
1689 contact_list_store_name_sort_func (GtkTreeModel *model,
1690                                    GtkTreeIter  *iter_a,
1691                                    GtkTreeIter  *iter_b,
1692                                    gpointer      user_data)
1693 {
1694         gchar         *name_a, *name_b;
1695         EmpathyContact *contact_a, *contact_b;
1696         gboolean       is_separator_a = FALSE, is_separator_b = FALSE;
1697         gint           ret_val;
1698         gboolean       fake_group_a, fake_group_b;
1699
1700         gtk_tree_model_get (model, iter_a,
1701                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name_a,
1702                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact_a,
1703                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator_a,
1704                             EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake_group_a,
1705                             -1);
1706         gtk_tree_model_get (model, iter_b,
1707                             EMPATHY_CONTACT_LIST_STORE_COL_NAME, &name_b,
1708                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact_b,
1709                             EMPATHY_CONTACT_LIST_STORE_COL_IS_SEPARATOR, &is_separator_b,
1710                             EMPATHY_CONTACT_LIST_STORE_COL_IS_FAKE_GROUP, &fake_group_b,
1711                             -1);
1712
1713         ret_val = compare_separator_and_groups (is_separator_a, is_separator_b,
1714                 name_a, name_b, contact_a, contact_b, fake_group_a, fake_group_b);
1715
1716         if (ret_val == 0)
1717                 ret_val = g_utf8_collate (name_a, name_b);
1718
1719         if (contact_a) {
1720                 g_object_unref (contact_a);
1721         }
1722
1723         if (contact_b) {
1724                 g_object_unref (contact_b);
1725         }
1726
1727         return ret_val;
1728 }
1729
1730 static gboolean
1731 contact_list_store_find_contact_foreach (GtkTreeModel *model,
1732                                          GtkTreePath  *path,
1733                                          GtkTreeIter  *iter,
1734                                          FindContact  *fc)
1735 {
1736         EmpathyContact *contact;
1737
1738         gtk_tree_model_get (model, iter,
1739                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
1740                             -1);
1741
1742         if (contact == fc->contact) {
1743                 fc->found = TRUE;
1744                 fc->iters = g_list_append (fc->iters, gtk_tree_iter_copy (iter));
1745         }
1746
1747         if (contact) {
1748                 g_object_unref (contact);
1749         }
1750
1751         return FALSE;
1752 }
1753
1754 static GList *
1755 contact_list_store_find_contact (EmpathyContactListStore *store,
1756                                  EmpathyContact          *contact)
1757 {
1758         EmpathyContactListStorePriv *priv;
1759         GtkTreeModel              *model;
1760         GList                     *l = NULL;
1761         FindContact                fc;
1762
1763         priv = GET_PRIV (store);
1764
1765         memset (&fc, 0, sizeof (fc));
1766
1767         fc.contact = contact;
1768
1769         model = GTK_TREE_MODEL (store);
1770         gtk_tree_model_foreach (model,
1771                                 (GtkTreeModelForeachFunc) contact_list_store_find_contact_foreach,
1772                                 &fc);
1773
1774         if (fc.found) {
1775                 l = fc.iters;
1776         }
1777
1778         return l;
1779 }
1780
1781 static gboolean
1782 contact_list_store_update_list_mode_foreach (GtkTreeModel           *model,
1783                                              GtkTreePath            *path,
1784                                              GtkTreeIter            *iter,
1785                                              EmpathyContactListStore *store)
1786 {
1787         EmpathyContactListStorePriv *priv;
1788         gboolean                     show_avatar = FALSE;
1789         EmpathyContact              *contact;
1790         GdkPixbuf                   *pixbuf_status;
1791
1792         priv = GET_PRIV (store);
1793
1794         if (priv->show_avatars && !priv->is_compact) {
1795                 show_avatar = TRUE;
1796         }
1797
1798         gtk_tree_model_get (model, iter,
1799                             EMPATHY_CONTACT_LIST_STORE_COL_CONTACT, &contact,
1800                             -1);
1801
1802         if (contact == NULL){
1803                 return FALSE;
1804         }
1805         /* get icon from hash_table */
1806         pixbuf_status = contact_list_store_get_contact_status_icon (store, contact);
1807
1808         gtk_tree_store_set (GTK_TREE_STORE (store), iter,
1809                             EMPATHY_CONTACT_LIST_STORE_COL_ICON_STATUS, pixbuf_status,
1810                             EMPATHY_CONTACT_LIST_STORE_COL_PIXBUF_AVATAR_VISIBLE, show_avatar,
1811                             EMPATHY_CONTACT_LIST_STORE_COL_STATUS_VISIBLE, !priv->is_compact,
1812                             -1);
1813
1814         return FALSE;
1815 }
1816
1817 static GdkPixbuf *
1818 contact_list_store_get_contact_status_icon_with_icon_name (
1819                                         EmpathyContactListStore *store,
1820                                         EmpathyContact *contact,
1821                                         const gchar *status_icon_name)
1822 {
1823         GdkPixbuf                   *pixbuf_status = NULL;
1824         EmpathyContactListStorePriv *priv;
1825         const gchar                 *protocol_name = NULL;
1826         gchar                       *icon_name = NULL;
1827
1828         priv = GET_PRIV (store);
1829
1830         if (priv->show_protocols) {
1831                 protocol_name = empathy_protocol_name_for_contact (contact);
1832                 icon_name = g_strdup_printf ("%s-%s", status_icon_name, protocol_name);
1833         } else {
1834                 icon_name = g_strdup_printf ("%s", status_icon_name);
1835         }
1836         pixbuf_status = g_hash_table_lookup (priv->status_icons, icon_name);
1837         if (pixbuf_status == NULL) {
1838                 pixbuf_status = empathy_pixbuf_contact_status_icon_with_icon_name (contact,
1839                                     status_icon_name,
1840                                     priv->show_protocols);
1841                 if (pixbuf_status != NULL) {
1842                         g_hash_table_insert (priv->status_icons,
1843                             g_strdup (icon_name),
1844                             pixbuf_status);
1845                 }
1846         }
1847
1848         g_free (icon_name);
1849         return pixbuf_status;
1850 }
1851
1852 GdkPixbuf *
1853 contact_list_store_get_contact_status_icon (EmpathyContactListStore *store,
1854                                             EmpathyContact *contact)
1855 {
1856         GdkPixbuf                   *pixbuf_status = NULL;
1857         const gchar                 *status_icon_name = NULL;
1858
1859         status_icon_name = empathy_icon_name_for_contact (contact);
1860         if (status_icon_name == NULL)
1861                 return NULL;
1862
1863         pixbuf_status = contact_list_store_get_contact_status_icon_with_icon_name (
1864                             store,
1865                             contact,
1866                             status_icon_name);
1867
1868         return pixbuf_status;
1869 }