]> git.0d.be Git - empathy.git/blob - libempathy/empathy-individual-manager.c
Add a comment about the IndividualManager's general memory management policy.
[empathy.git] / libempathy / empathy-individual-manager.c
1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
2 /*
3  * Copyright (C) 2007-2010 Collabora Ltd.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18  *
19  * Authors: Xavier Claessens <xclaesse@gmail.com>
20  *          Travis Reitter <travis.reitter@collabora.co.uk>
21  */
22
23 #include <config.h>
24
25 #include <string.h>
26
27 #include <telepathy-glib/account-manager.h>
28 #include <telepathy-glib/enums.h>
29 #include <telepathy-glib/proxy-subclass.h>
30 #include <telepathy-glib/util.h>
31
32 #include <folks/folks.h>
33
34 #include <extensions/extensions.h>
35
36 #include "empathy-individual-manager.h"
37 #include "empathy-contact-manager.h"
38 #include "empathy-contact-list.h"
39 #include "empathy-marshal.h"
40 #include "empathy-utils.h"
41
42 #define DEBUG_FLAG EMPATHY_DEBUG_CONTACT
43 #include "empathy-debug.h"
44
45 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyIndividualManager)
46
47 /* This class doesn't store or ref any of the individuals, since they're already
48  * stored and referenced in the aggregator.
49  *
50  * This class merely forwards along signals from the aggregator and individuals
51  * and wraps aggregator functions for other client code. */
52 typedef struct
53 {
54   FolksIndividualAggregator *aggregator;
55   EmpathyContactManager *contact_manager;
56 } EmpathyIndividualManagerPriv;
57
58 enum
59 {
60   FAVOURITES_CHANGED,
61   GROUPS_CHANGED,
62   MEMBERS_CHANGED,
63   LAST_SIGNAL
64 };
65
66 static guint signals[LAST_SIGNAL] = { 0 };
67
68 G_DEFINE_TYPE (EmpathyIndividualManager, empathy_individual_manager,
69     G_TYPE_OBJECT);
70
71 static EmpathyIndividualManager *manager_singleton = NULL;
72
73 static void
74 individual_group_changed_cb (FolksIndividual *individual,
75     gchar *group,
76     gboolean is_member,
77     EmpathyIndividualManager *self)
78 {
79   g_signal_emit (self, signals[GROUPS_CHANGED], 0, individual, group,
80       is_member);
81 }
82
83 static void
84 individual_notify_is_favourite_cb (FolksIndividual *individual,
85     GParamSpec *pspec,
86     EmpathyIndividualManager *self)
87 {
88   gboolean is_favourite = folks_favourite_get_is_favourite (
89       FOLKS_FAVOURITE (individual));
90   g_signal_emit (self, signals[FAVOURITES_CHANGED], 0, individual,
91       is_favourite);
92 }
93
94 static void
95 aggregator_individuals_added_cb (FolksIndividualAggregator *aggregator,
96     GList *individuals,
97     EmpathyIndividualManager *self)
98 {
99   GList *l;
100
101   for (l = individuals; l; l = l->next)
102     {
103       g_signal_connect (l->data, "group-changed",
104           G_CALLBACK (individual_group_changed_cb), self);
105       g_signal_connect (l->data, "notify::is-favourite",
106           G_CALLBACK (individual_notify_is_favourite_cb), self);
107     }
108
109   /* TODO: don't hard-code the reason or message */
110   g_signal_emit (self, signals[MEMBERS_CHANGED], 0, "individual(s) added",
111       individuals, NULL, TP_CHANNEL_GROUP_CHANGE_REASON_NONE, TRUE);
112 }
113
114 static void
115 aggregator_individuals_removed_cb (FolksIndividualAggregator *aggregator,
116     GList *individuals,
117     EmpathyIndividualManager *self)
118 {
119   GList *l;
120
121   for (l = individuals; l; l = l->next)
122     {
123       g_signal_handlers_disconnect_by_func (l->data,
124           individual_group_changed_cb, self);
125       g_signal_handlers_disconnect_by_func (l->data,
126           individual_notify_is_favourite_cb, self);
127     }
128
129   /* TODO: don't hard-code the reason or message */
130   g_signal_emit (self, signals[MEMBERS_CHANGED], 0, "individual(s) removed",
131       NULL, individuals, TP_CHANNEL_GROUP_CHANGE_REASON_NONE, TRUE);
132 }
133
134 static void
135 individual_manager_finalize (GObject *object)
136 {
137   EmpathyIndividualManagerPriv *priv = GET_PRIV (object);
138
139   tp_clear_object (&priv->contact_manager);
140   tp_clear_object (&priv->aggregator);
141 }
142
143 static GObject *
144 individual_manager_constructor (GType type,
145     guint n_props,
146     GObjectConstructParam *props)
147 {
148   GObject *retval;
149
150   if (manager_singleton)
151     {
152       retval = g_object_ref (manager_singleton);
153     }
154   else
155     {
156       retval =
157           G_OBJECT_CLASS (empathy_individual_manager_parent_class)->
158           constructor (type, n_props, props);
159
160       manager_singleton = EMPATHY_INDIVIDUAL_MANAGER (retval);
161       g_object_add_weak_pointer (retval, (gpointer) & manager_singleton);
162     }
163
164   return retval;
165 }
166
167 /**
168  * empathy_individual_manager_initialized:
169  *
170  * Reports whether or not the singleton has already been created.
171  *
172  * There can be instances where you want to access the #EmpathyIndividualManager
173  * only if it has been set up for this process.
174  *
175  * Returns: %TRUE if the #EmpathyIndividualManager singleton has previously
176  * been initialized.
177  */
178 gboolean
179 empathy_individual_manager_initialized (void)
180 {
181   return (manager_singleton != NULL);
182 }
183
184 static void
185 empathy_individual_manager_class_init (EmpathyIndividualManagerClass *klass)
186 {
187   GObjectClass *object_class = G_OBJECT_CLASS (klass);
188
189   object_class->finalize = individual_manager_finalize;
190   object_class->constructor = individual_manager_constructor;
191
192   signals[GROUPS_CHANGED] =
193       g_signal_new ("groups-changed",
194           G_TYPE_FROM_CLASS (klass),
195           G_SIGNAL_RUN_LAST,
196           0,
197           NULL, NULL,
198           _empathy_marshal_VOID__OBJECT_STRING_BOOLEAN,
199           G_TYPE_NONE, 3, FOLKS_TYPE_INDIVIDUAL, G_TYPE_STRING, G_TYPE_BOOLEAN);
200
201   signals[FAVOURITES_CHANGED] =
202       g_signal_new ("favourites-changed",
203           G_TYPE_FROM_CLASS (klass),
204           G_SIGNAL_RUN_LAST,
205           0,
206           NULL, NULL,
207           _empathy_marshal_VOID__OBJECT_BOOLEAN,
208           G_TYPE_NONE, 2, FOLKS_TYPE_INDIVIDUAL, G_TYPE_BOOLEAN);
209
210   signals[MEMBERS_CHANGED] =
211       g_signal_new ("members-changed",
212           G_TYPE_FROM_CLASS (klass),
213           G_SIGNAL_RUN_LAST,
214           0,
215           NULL, NULL,
216           _empathy_marshal_VOID__STRING_OBJECT_OBJECT_UINT,
217           G_TYPE_NONE,
218           4, G_TYPE_STRING, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_UINT);
219
220   g_type_class_add_private (object_class,
221       sizeof (EmpathyIndividualManagerPriv));
222 }
223
224 static void
225 empathy_individual_manager_init (EmpathyIndividualManager *self)
226 {
227   EmpathyIndividualManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
228       EMPATHY_TYPE_INDIVIDUAL_MANAGER, EmpathyIndividualManagerPriv);
229
230   self->priv = priv;
231   priv->contact_manager = empathy_contact_manager_dup_singleton ();
232
233   priv->aggregator = folks_individual_aggregator_new ();
234   g_signal_connect (priv->aggregator, "individuals-added",
235       G_CALLBACK (aggregator_individuals_added_cb), self);
236   g_signal_connect (priv->aggregator, "individuals-removed",
237       G_CALLBACK (aggregator_individuals_removed_cb), self);
238 }
239
240 EmpathyIndividualManager *
241 empathy_individual_manager_dup_singleton (void)
242 {
243   return g_object_new (EMPATHY_TYPE_INDIVIDUAL_MANAGER, NULL);
244 }
245
246 GList *
247 empathy_individual_manager_get_members (EmpathyIndividualManager *self)
248 {
249   EmpathyIndividualManagerPriv *priv = GET_PRIV (self);
250   GHashTable *individuals;
251
252   g_return_val_if_fail (EMPATHY_IS_INDIVIDUAL_MANAGER (self), NULL);
253
254   individuals = folks_individual_aggregator_get_individuals (priv->aggregator);
255   return individuals ? g_hash_table_get_values (individuals) : NULL;
256 }
257
258 FolksIndividual *
259 empathy_individual_manager_lookup_member (EmpathyIndividualManager *self,
260     const gchar *id)
261 {
262   EmpathyIndividualManagerPriv *priv = GET_PRIV (self);
263   GHashTable *individuals;
264
265   g_return_val_if_fail (EMPATHY_IS_INDIVIDUAL_MANAGER (self), NULL);
266
267   individuals = folks_individual_aggregator_get_individuals (priv->aggregator);
268   if (individuals != NULL)
269     return g_hash_table_lookup (individuals, id);
270
271   return NULL;
272 }
273
274 static void
275 aggregator_add_persona_from_details_cb (GObject *source,
276     GAsyncResult *result,
277     gpointer user_data)
278 {
279   FolksIndividualAggregator *aggregator = FOLKS_INDIVIDUAL_AGGREGATOR (source);
280   EmpathyContact *contact = EMPATHY_CONTACT (user_data);
281   FolksPersona *persona;
282   GError *error = NULL;
283
284   persona = folks_individual_aggregator_add_persona_from_details_finish (
285       aggregator, result, &error);
286   if (error != NULL)
287     {
288       g_warning ("failed to add individual from contact: %s", error->message);
289       g_clear_error (&error);
290     }
291
292   /* We can unref the contact now */
293   g_object_unref (contact);
294 }
295
296 void
297 empathy_individual_manager_add_from_contact (EmpathyIndividualManager *self,
298     EmpathyContact *contact)
299 {
300   EmpathyIndividualManagerPriv *priv;
301   GHashTable* details;
302   TpAccount *account;
303   const gchar *store_id;
304
305   g_return_if_fail (EMPATHY_IS_INDIVIDUAL_MANAGER (self));
306   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
307
308   priv = GET_PRIV (self);
309
310   /* We need to ref the contact since otherwise its linked TpHandle will be
311    * destroyed. */
312   g_object_ref (contact);
313
314   DEBUG (G_STRLOC ": adding individual from contact %s (%s)",
315       empathy_contact_get_id (contact), empathy_contact_get_name (contact));
316
317   account = empathy_contact_get_account (contact);
318   store_id = tp_proxy_get_object_path (TP_PROXY (account));
319
320   details = g_hash_table_new (g_str_hash, g_str_equal);
321   g_hash_table_insert (details, "contact",
322       (gchar*) empathy_contact_get_id (contact));
323
324   folks_individual_aggregator_add_persona_from_details (
325       priv->aggregator, NULL, "telepathy", store_id, details,
326       aggregator_add_persona_from_details_cb, contact);
327
328   g_hash_table_destroy (details);
329 }
330
331 /**
332  * Removes the inner contact from the server (and thus the Individual). Not
333  * meant for de-shelling inner personas from an Individual.
334  */
335 void
336 empathy_individual_manager_remove (EmpathyIndividualManager *self,
337     FolksIndividual *individual,
338     const gchar *message)
339 {
340   EmpathyIndividualManagerPriv *priv;
341
342   g_return_if_fail (EMPATHY_IS_INDIVIDUAL_MANAGER (self));
343   g_return_if_fail (FOLKS_IS_INDIVIDUAL (individual));
344
345   priv = GET_PRIV (self);
346
347   DEBUG (G_STRLOC ": removing individual %s (%s)",
348       folks_individual_get_id (individual),
349       folks_individual_get_alias (individual));
350
351   folks_individual_aggregator_remove_individual (priv->aggregator, individual);
352 }
353
354 static void
355 remove_group_cb (const gchar *id, FolksIndividual *individual,
356     const gchar *group)
357 {
358   folks_groups_change_group (FOLKS_GROUPS (individual), group, FALSE);
359 }
360
361 void
362 empathy_individual_manager_remove_group (EmpathyIndividualManager *manager,
363     const gchar *group)
364 {
365   EmpathyIndividualManagerPriv *priv;
366   GHashTable *individuals;
367
368   g_return_if_fail (EMPATHY_IS_INDIVIDUAL_MANAGER (manager));
369   g_return_if_fail (group != NULL);
370
371   priv = GET_PRIV (manager);
372
373   DEBUG (G_STRLOC ": removing group %s", group);
374
375   /* Remove every individual from the group */
376   individuals = folks_individual_aggregator_get_individuals (priv->aggregator);
377   g_hash_table_foreach (individuals, (GHFunc) remove_group_cb,
378       (gpointer) group);
379 }
380
381 EmpathyIndividualManagerFlags
382 empathy_individual_manager_get_flags_for_connection (
383     EmpathyIndividualManager *self,
384     TpConnection *connection)
385 {
386   EmpathyIndividualManagerPriv *priv;
387   EmpathyContactListFlags list_flags;
388   EmpathyIndividualManagerFlags flags;
389
390   g_return_val_if_fail (EMPATHY_IS_INDIVIDUAL_MANAGER (self),
391       EMPATHY_INDIVIDUAL_MANAGER_NO_FLAGS);
392
393   priv = GET_PRIV (self);
394
395   list_flags = empathy_contact_manager_get_flags_for_connection (
396     priv->contact_manager, connection);
397
398   flags = EMPATHY_INDIVIDUAL_MANAGER_NO_FLAGS;
399   if (list_flags & EMPATHY_CONTACT_LIST_CAN_ADD)
400     flags |= EMPATHY_INDIVIDUAL_MANAGER_CAN_ADD;
401   if (list_flags & EMPATHY_CONTACT_LIST_CAN_REMOVE)
402     flags |= EMPATHY_INDIVIDUAL_MANAGER_CAN_REMOVE;
403   if (list_flags & EMPATHY_CONTACT_LIST_CAN_ALIAS)
404     flags |= EMPATHY_INDIVIDUAL_MANAGER_CAN_ALIAS;
405   if (list_flags & EMPATHY_CONTACT_LIST_CAN_GROUP)
406     flags |= EMPATHY_INDIVIDUAL_MANAGER_CAN_GROUP;
407
408   return flags;
409 }