72
|
1 |
/* |
|
2 |
* roster.c -- Local roster implementation |
|
3 |
* |
|
4 |
* Copyright (C) 2005 Mikael Berthe <bmikael@lists.lilotux.net> |
|
5 |
* |
|
6 |
* This program is free software; you can redistribute it and/or modify |
|
7 |
* it under the terms of the GNU General Public License as published by |
|
8 |
* the Free Software Foundation; either version 2 of the License, or (at |
|
9 |
* your option) any later version. |
|
10 |
* |
|
11 |
* This program is distributed in the hope that it will be useful, but |
|
12 |
* 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 License |
|
17 |
* along with this program; if not, write to the Free Software |
|
18 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 |
|
19 |
* USA |
|
20 |
*/ |
|
21 |
|
|
22 |
#include <string.h> |
|
23 |
|
|
24 |
#include "roster.h" |
|
25 |
|
|
26 |
|
|
27 |
/* This is a private structure type for the roster */ |
|
28 |
|
|
29 |
typedef struct { |
78
|
30 |
const char *name; |
|
31 |
const char *jid; |
72
|
32 |
guint type; |
|
33 |
enum imstatus status; |
|
34 |
guint flags; |
|
35 |
// list: user -> points to his group; group -> points to its users list |
|
36 |
GSList *list; |
|
37 |
} roster; |
|
38 |
|
|
39 |
|
|
40 |
/* ### Variables ### */ |
|
41 |
|
|
42 |
static int hide_offline_buddies; |
|
43 |
static GSList *groups; |
|
44 |
GList *buddylist; |
78
|
45 |
GList *current_buddy; |
72
|
46 |
|
|
47 |
#ifdef MCABBER_TESTUNIT |
|
48 |
// Export groups for testing routines |
|
49 |
GSList **pgroups = &groups; |
|
50 |
#endif |
|
51 |
|
|
52 |
|
|
53 |
/* ### Roster functions ### */ |
|
54 |
|
|
55 |
// Comparison function used to search in the roster (compares jids and types) |
|
56 |
gint roster_compare_jid_type(roster *a, roster *b) { |
|
57 |
if (a->type != b->type) |
|
58 |
return -1; // arbitrary (but should be != , of course) |
|
59 |
return strcasecmp(a->jid, b->jid); |
|
60 |
} |
|
61 |
|
|
62 |
// Comparison function used to sort the roster (by name) |
|
63 |
gint roster_compare_name(roster *a, roster *b) { |
|
64 |
return strcasecmp(a->name, b->name); |
|
65 |
} |
|
66 |
|
|
67 |
// Finds a roster element (user, group, agent...), by jid or name |
|
68 |
// Returns the roster GSList element, or NULL if jid/name not found |
78
|
69 |
GSList *roster_find(const char *jidname, enum findwhat type, guint roster_type) |
72
|
70 |
{ |
|
71 |
GSList *sl_roster_elt = groups; |
|
72 |
GSList *res; |
|
73 |
roster sample; |
|
74 |
GCompareFunc comp; |
|
75 |
|
|
76 |
if (!jidname) |
|
77 |
return NULL; // should not happen |
|
78 |
|
|
79 |
sample.type = roster_type; |
|
80 |
if (type == jidsearch) { |
|
81 |
sample.jid = jidname; |
|
82 |
comp = (GCompareFunc)&roster_compare_jid_type; |
|
83 |
} else if (type == namesearch) { |
|
84 |
sample.name = jidname; |
|
85 |
comp = (GCompareFunc)&roster_compare_name; |
|
86 |
} else |
|
87 |
return NULL; // should not happen |
|
88 |
|
|
89 |
while (sl_roster_elt) { |
|
90 |
roster *roster_elt = (roster*)sl_roster_elt->data; |
|
91 |
if (roster_type & ROSTER_TYPE_GROUP) { |
|
92 |
if ((type == namesearch) && !strcasecmp(jidname, roster_elt->name)) |
|
93 |
return sl_roster_elt; |
|
94 |
} else { |
|
95 |
res = g_slist_find_custom(roster_elt->list, &sample, comp); |
|
96 |
if (res) |
|
97 |
return res; |
|
98 |
} |
|
99 |
sl_roster_elt = g_slist_next(sl_roster_elt); |
|
100 |
} |
|
101 |
return NULL; |
|
102 |
} |
|
103 |
|
|
104 |
// Returns pointer to new group, or existing group with that name |
78
|
105 |
GSList *roster_add_group(const char *name) |
72
|
106 |
{ |
|
107 |
roster *roster_grp; |
|
108 |
// #1 Check name doesn't already exist |
|
109 |
if (!roster_find(name, namesearch, ROSTER_TYPE_GROUP)) { |
|
110 |
// #2 Create the group node |
|
111 |
roster_grp = g_new0(roster, 1); |
|
112 |
roster_grp->name = g_strdup(name); |
|
113 |
roster_grp->type = ROSTER_TYPE_GROUP; |
|
114 |
// #3 Insert (sorted) |
|
115 |
groups = g_slist_insert_sorted(groups, roster_grp, |
|
116 |
(GCompareFunc)&roster_compare_name); |
|
117 |
} |
|
118 |
return roster_find(name, namesearch, ROSTER_TYPE_GROUP); |
|
119 |
} |
|
120 |
|
|
121 |
// Returns a pointer to the new user, or existing user with that name |
78
|
122 |
GSList *roster_add_user(const char *jid, const char *name, const char *group, |
|
123 |
guint type) |
72
|
124 |
{ |
|
125 |
roster *roster_usr; |
|
126 |
roster *my_group; |
|
127 |
GSList *slist; |
|
128 |
|
|
129 |
if ((type != ROSTER_TYPE_USER) && (type != ROSTER_TYPE_AGENT)) { |
|
130 |
// XXX Error message? |
|
131 |
return NULL; |
|
132 |
} |
|
133 |
|
78
|
134 |
// Let's be arbitrary: default group has an empty name (""). |
|
135 |
if (!group) group = ""; |
|
136 |
|
72
|
137 |
// #1 Check this user doesn't already exist |
|
138 |
if ((slist = roster_find(jid, jidsearch, type)) != NULL) |
|
139 |
return slist; |
|
140 |
// #2 add group if necessary |
|
141 |
slist = roster_add_group(group); |
|
142 |
if (!slist) return NULL; |
|
143 |
my_group = (roster*)slist->data; |
|
144 |
// #3 Create user node |
|
145 |
roster_usr = g_new0(roster, 1); |
|
146 |
roster_usr->jid = g_strdup(jid); |
78
|
147 |
if (name) { |
|
148 |
roster_usr->name = g_strdup(name); |
|
149 |
} else { |
|
150 |
gchar *p, *str = g_strdup(jid); |
80
|
151 |
p = strstr(str, "/"); |
78
|
152 |
if (p) *p = '\0'; |
|
153 |
roster_usr->name = g_strdup(str); |
|
154 |
g_free(str); |
|
155 |
} |
72
|
156 |
roster_usr->type = type; //ROSTER_TYPE_USER; |
|
157 |
roster_usr->list = slist; // (my_group SList element) |
|
158 |
// #4 Insert node (sorted) |
|
159 |
my_group->list = g_slist_insert_sorted(my_group->list, roster_usr, |
|
160 |
(GCompareFunc)&roster_compare_name); |
|
161 |
return roster_find(jid, jidsearch, type); |
|
162 |
} |
|
163 |
|
|
164 |
// Removes user (jid) from roster, frees allocated memory |
78
|
165 |
void roster_del_user(const char *jid) |
72
|
166 |
{ |
|
167 |
GSList *sl_user, *sl_group; |
|
168 |
GSList **sl_group_listptr; |
|
169 |
roster *roster_usr; |
|
170 |
|
|
171 |
if ((sl_user = roster_find(jid, jidsearch, ROSTER_TYPE_USER)) == NULL) |
|
172 |
return; |
|
173 |
// Let's free memory (jid, name) |
|
174 |
roster_usr = (roster*)sl_user->data; |
|
175 |
if (roster_usr->jid) |
78
|
176 |
g_free((gchar*)roster_usr->jid); |
72
|
177 |
if (roster_usr->name) |
78
|
178 |
g_free((gchar*)roster_usr->name); |
72
|
179 |
|
|
180 |
// That's a little complex, we need to dereference twice |
|
181 |
sl_group = ((roster*)sl_user->data)->list; |
|
182 |
sl_group_listptr = &((roster*)(sl_group->data))->list; |
|
183 |
*sl_group_listptr = g_slist_delete_link(*sl_group_listptr, sl_user); |
78
|
184 |
|
|
185 |
// We need to rebuild the list |
|
186 |
if (current_buddy) |
|
187 |
buddylist_build(); |
|
188 |
// TODO What we should do, too, is to check if the deleted node is |
|
189 |
// current_buddy, in which case we could move current_buddy to the |
|
190 |
// previous (or next) node. |
72
|
191 |
} |
|
192 |
|
78
|
193 |
void roster_setstatus(const char *jid, enum imstatus bstat) |
72
|
194 |
{ |
|
195 |
GSList *sl_user; |
|
196 |
roster *roster_usr; |
|
197 |
|
|
198 |
if ((sl_user = roster_find(jid, jidsearch, ROSTER_TYPE_USER)) == NULL) |
|
199 |
return; |
|
200 |
|
|
201 |
roster_usr = (roster*)sl_user->data; |
|
202 |
roster_usr->status = bstat; |
|
203 |
} |
|
204 |
|
78
|
205 |
// roster_setflags() |
|
206 |
// Set one or several flags to value (TRUE/FALSE) |
80
|
207 |
void roster_setflags(const char *jid, guint flags, guint value) |
78
|
208 |
{ |
|
209 |
GSList *sl_user; |
|
210 |
roster *roster_usr; |
|
211 |
|
|
212 |
if ((sl_user = roster_find(jid, jidsearch, ROSTER_TYPE_USER)) == NULL) |
|
213 |
return; |
|
214 |
|
|
215 |
roster_usr = (roster*)sl_user->data; |
|
216 |
if (value) |
|
217 |
roster_usr->flags |= flags; |
|
218 |
else |
|
219 |
roster_usr->flags &= ~flags; |
|
220 |
} |
|
221 |
|
72
|
222 |
// char *roster_getgroup(...) / Or *GSList? Which use?? |
|
223 |
// ... setgroup(char*) ?? |
|
224 |
// guint roster_gettype(...) / settype |
78
|
225 |
// guchar roster_getflags(...) |
72
|
226 |
// guchar roster_getname(...) / setname ?? |
|
227 |
// roster_del_group? |
|
228 |
|
|
229 |
|
|
230 |
/* ### BuddyList functions ### */ |
|
231 |
|
|
232 |
// buddylist_hide_offline_buddies(hide) |
|
233 |
// "hide" values: 1=hide 0=show_all -1=invert |
|
234 |
void buddylist_hide_offline_buddies(int hide) |
|
235 |
{ |
|
236 |
if (hide < 0) // NEG (invert) |
|
237 |
hide_offline_buddies = !hide_offline_buddies; |
|
238 |
else if (hide == 0) // FALSE (don't hide) |
|
239 |
hide_offline_buddies = 0; |
|
240 |
else // TRUE (hide) |
|
241 |
hide_offline_buddies = 1; |
|
242 |
} |
|
243 |
|
|
244 |
// buddylist_build() |
|
245 |
// Creates the buddylist from the roster entries. |
|
246 |
void buddylist_build(void) |
|
247 |
{ |
|
248 |
GSList *sl_roster_elt = groups; |
|
249 |
roster *roster_elt; |
|
250 |
int pending_group; |
|
251 |
|
|
252 |
// Destroy old buddylist |
|
253 |
if (buddylist) { |
|
254 |
g_list_free(buddylist); |
|
255 |
buddylist = NULL; |
|
256 |
} |
|
257 |
|
|
258 |
// Create the new list |
|
259 |
while (sl_roster_elt) { |
|
260 |
GSList *sl_roster_usrelt; |
|
261 |
roster *roster_usrelt; |
|
262 |
roster_elt = (roster*) sl_roster_elt->data; |
|
263 |
|
|
264 |
// Add the group now unless hide_offline_buddies is set, |
|
265 |
// in which case we'll add it only if an online buddy belongs to it. |
|
266 |
if (!hide_offline_buddies) |
|
267 |
buddylist = g_list_append(buddylist, roster_elt); |
|
268 |
else |
|
269 |
pending_group = TRUE; |
|
270 |
|
|
271 |
sl_roster_usrelt = roster_elt->list; |
|
272 |
while (sl_roster_usrelt) { |
|
273 |
roster_usrelt = (roster*) sl_roster_usrelt->data; |
|
274 |
|
|
275 |
// Buddy will be added if either: |
|
276 |
// - hide_offline_buddies is FALSE |
|
277 |
// - buddy is not offline |
|
278 |
// - buddy has a lock (for example the buddy window is currently open) |
|
279 |
// - buddy has a pending (non-read) message |
|
280 |
if (!hide_offline_buddies || |
|
281 |
(buddy_getstatus((gpointer)roster_usrelt) != offline) || |
|
282 |
(buddy_getflags((gpointer)roster_usrelt) & |
|
283 |
(ROSTER_FLAG_LOCK | ROSTER_FLAG_MSG))) { |
|
284 |
// This user should be added. Maybe the group hasn't been added yet? |
|
285 |
if (hide_offline_buddies && pending_group) { |
|
286 |
// It hasn't been done yet |
|
287 |
buddylist = g_list_append(buddylist, roster_elt); |
|
288 |
pending_group = FALSE; |
|
289 |
} |
|
290 |
// Add user |
|
291 |
buddylist = g_list_append(buddylist, roster_usrelt); |
|
292 |
} |
|
293 |
|
|
294 |
sl_roster_usrelt = g_slist_next(sl_roster_usrelt); |
|
295 |
} |
|
296 |
sl_roster_elt = g_slist_next(sl_roster_elt); |
|
297 |
} |
78
|
298 |
|
|
299 |
// current_buddy initialization |
|
300 |
if (!current_buddy || (g_list_position(buddylist, current_buddy) == -1)) |
|
301 |
current_buddy = buddylist; |
72
|
302 |
} |
|
303 |
|
|
304 |
// buddy_hide_group(roster, hide) |
|
305 |
// "hide" values: 1=hide 0=show_all -1=invert |
|
306 |
void buddy_hide_group(gpointer rosterdata, int hide) |
|
307 |
{ |
|
308 |
roster *roster = rosterdata; |
|
309 |
if (hide > 0) // TRUE (hide) |
|
310 |
roster->flags |= ROSTER_FLAG_HIDE; |
|
311 |
else if (hide < 0) // NEG (invert) |
|
312 |
roster->flags ^= ROSTER_FLAG_HIDE; |
|
313 |
else // FALSE (don't hide) |
|
314 |
roster->flags &= ~ROSTER_FLAG_HIDE; |
|
315 |
} |
|
316 |
|
|
317 |
const char *buddy_getjid(gpointer rosterdata) |
|
318 |
{ |
|
319 |
roster *roster = rosterdata; |
|
320 |
return roster->jid; |
|
321 |
} |
|
322 |
|
|
323 |
const char *buddy_getname(gpointer rosterdata) |
|
324 |
{ |
|
325 |
roster *roster = rosterdata; |
|
326 |
return roster->name; |
|
327 |
} |
|
328 |
|
|
329 |
guint buddy_gettype(gpointer rosterdata) |
|
330 |
{ |
|
331 |
roster *roster = rosterdata; |
|
332 |
return roster->type; |
|
333 |
} |
|
334 |
|
|
335 |
enum imstatus buddy_getstatus(gpointer rosterdata) |
|
336 |
{ |
|
337 |
roster *roster = rosterdata; |
|
338 |
return roster->status; |
|
339 |
} |
|
340 |
|
|
341 |
guint buddy_getflags(gpointer rosterdata) |
|
342 |
{ |
|
343 |
roster *roster = rosterdata; |
|
344 |
return roster->flags; |
|
345 |
} |
|
346 |
|