2 * Handle XMPP presence exchanges
4 * Copyright (c) 2007-2010 by Art Cancro
6 * This program is open source 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 3 of the License, or
9 * (at your option) any later version.
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
14 * GNU General Public License for more details.
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 USA
30 #include <sys/types.h>
33 #if TIME_WITH_SYS_TIME
34 # include <sys/time.h>
38 # include <sys/time.h>
49 #include <libcitadel.h>
52 #include "citserver.h"
55 #include "internet_addressing.h"
57 #include "ctdl_module.h"
58 #include "serv_xmpp.h"
63 * Indicate the presence of another user to the client
64 * (used in several places)
66 void xmpp_indicate_presence(char *presence_jid)
68 XPrint(HKEY("presence"),
69 XPROPERTY("from", presence_jid, strlen(presence_jid)),
70 XPROPERTY("to", XMPP->client_jid, strlen(XMPP->client_jid)),
77 * Convenience function to determine whether any given session is 'visible' to any other given session,
78 * and is capable of receiving instant messages from that session.
80 int xmpp_is_visible(struct CitContext *cptr, struct CitContext *to_whom) {
81 int aide = (to_whom->user.axlevel >= AxAideU);
83 if ( (cptr->logged_in)
84 && (((cptr->cs_flags&CS_STEALTH)==0) || (aide)) /* aides see everyone */
85 && (cptr->user.usernum != to_whom->user.usernum) /* don't show myself */
86 && (cptr->can_receive_im) /* IM-capable session */
97 * Initial dump of the entire wholist
98 * Respond to a <presence> update by firing back with presence information
99 * on the entire wholist. Check this assumption, it's probably wrong.
101 void xmpp_wholist_presence_dump(void *data, const char *supplied_el, const char **attr)
103 struct CitContext *cptr = NULL;
106 cptr = CtdlGetContextArray(&nContexts);
111 for (i=0; i<nContexts; i++) {
112 if (xmpp_is_visible(&cptr[i], CC)) {
113 xmpp_indicate_presence(cptr[i].cs_inet_email);
121 * Function to remove a buddy subscription and delete from the roster
122 * (used in several places)
124 void xmpp_destroy_buddy(char *presence_jid, int aggressively) {
125 static int unsolicited_id = 1;
126 struct CitContext *CCC = CC;
130 if (!presence_jid) return;
132 if (!XMPP->client_jid) return;
134 /* Transmit non-presence information */
135 XPrint(HKEY("presence"), XCLOSED,
136 XCPROPERTY("type", "unavailable"),
137 XPROPERTY("from", presence_jid, strlen(presence_jid)),
138 XPROPERTY("to", XMPP->client_jid, strlen(XMPP->client_jid)),
142 * Setting the "aggressively" flag also sends an "unsubscribed" presence update.
143 * We only ask for this when flushing the client side roster, because if we do it
144 * in the middle of a session when another user logs off, some clients (Jitsi) interpret
145 * it as a rejection of a subscription request.
148 XPrint(HKEY("presence"), XCLOSED,
149 XCPROPERTY("type", "unsubscribed"),
150 XPROPERTY("from", presence_jid, strlen(presence_jid)),
151 XPROPERTY("to", XMPP->client_jid, strlen(XMPP->client_jid)),
155 // FIXME ... we should implement xmpp_indicate_nonpresence so we can use it elsewhere
157 blen = snprintf(Buf, sizeof(Buf), "unbuddy_%x", ++unsolicited_id);
159 /* Do an unsolicited roster update that deletes the contact. */
160 XPrint(HKEY("iq"), 0,
161 XCPROPERTY("type", "result"),
162 XPROPERTY("from", CCC->cs_inet_email, strlen(CCC->cs_inet_email)),
163 XPROPERTY("to", XMPP->client_jid, strlen(XMPP->client_jid)),
164 XPROPERTY("id", Buf, blen),
167 XPrint(HKEY("query"), 0,
168 XCPROPERTY("xmlns", "jabber:iq:roster"),
171 XPrint(HKEY("item"), 0,
172 XCPROPERTY("subscription", "remove"),
173 XPROPERTY("jid", presence_jid, strlen(presence_jid)),
176 XPrint(HKEY("group"), XCLOSED,
177 XCFGBODY(c_humannode),
187 * When a user logs in or out of the local Citadel system, notify all XMPP sessions about it.
188 * THIS FUNCTION HAS A BUG IN IT THAT ENUMERATES THE SESSIONS WRONG.
190 void xmpp_presence_notify(char *presence_jid, int event_type) {
191 struct CitContext *cptr;
192 static int unsolicited_id;
193 int visible_sessions = 0;
195 int which_cptr_is_relevant = (-1);
197 if (IsEmptyStr(presence_jid)) return;
198 if (CC->kill_me) return;
200 cptr = CtdlGetContextArray(&nContexts);
205 /* Count the visible sessions for this user */
206 for (i=0; i<nContexts; i++) {
207 if ( (!strcasecmp(cptr[i].cs_inet_email, presence_jid))
208 && (xmpp_is_visible(&cptr[i], CC))
211 which_cptr_is_relevant = i;
215 XMPP_syslog(LOG_DEBUG, "%d sessions for <%s> are now visible to session %d\n",
216 visible_sessions, presence_jid, CC->cs_pid);
218 if ( (event_type == XMPP_EVT_LOGIN) && (visible_sessions == 1) ) {
222 XMPP_syslog(LOG_DEBUG, "Telling session %d that <%s> logged in\n",
223 CC->cs_pid, presence_jid);
225 /* Do an unsolicited roster update that adds a new contact. */
226 assert(which_cptr_is_relevant >= 0);
228 blen = snprintf(Buf, sizeof(Buf), "unsolicited_%x", ++unsolicited_id);
230 XPrint(HKEY("iq"), 0,
231 XCPROPERTY("type", "result"),
232 XPROPERTY("id", Buf, blen),
235 XPrint(HKEY("query"), 0,
236 XCPROPERTY("xmlns", "jabber:iq:roster"),
239 xmpp_roster_item(&cptr[which_cptr_is_relevant]);
240 XPUT("</query></iq>");
242 /* Transmit presence information */
243 xmpp_indicate_presence(presence_jid);
246 if (visible_sessions == 0) {
247 XMPP_syslog(LOG_DEBUG, "Telling session %d that <%s> logged out\n",
248 CC->cs_pid, presence_jid);
249 xmpp_destroy_buddy(presence_jid, 0); /* non aggressive presence update */
257 void xmpp_fetch_mortuary_backend(long msgnum, void *userdata) {
258 HashList *mortuary = (HashList *) userdata;
259 struct CtdlMessage *msg;
263 msg = CtdlFetchMessage(msgnum, 1);
268 /* now add anyone we find into the hashlist */
270 /* skip past the headers */
271 ptr = strstr(msg->cm_fields[eMesageText], "\n\n");
276 ptr = strstr(msg->cm_fields[eMesageText], "\n\r\n");
282 /* the remaining lines are addresses */
284 ptr = strtok_r(ptr, "\n", &lasts);
285 while (ptr != NULL) {
286 char *pch = strdup(ptr);
287 Put(mortuary, pch, strlen(pch), pch, NULL);
288 ptr = strtok_r(NULL, "\n", &lasts);
298 * Fetch the "mortuary" - a list of dead buddies which we keep around forever
299 * so we can remove them from any client's roster that still has them listed
301 HashList *xmpp_fetch_mortuary(void) {
302 HashList *mortuary = NewHash(1, NULL);
304 XMPPM_syslog(LOG_ALERT, "NewHash() failed!\n");
308 if (CtdlGetRoom(&CC->room, USERCONFIGROOM) != 0) {
309 /* no config room exists - no further processing is required. */
312 CtdlForEachMessage(MSGS_LAST, 1, NULL, XMPPMORTUARY, NULL,
313 xmpp_fetch_mortuary_backend, (void *)mortuary );
321 * Fetch the "mortuary" - a list of dead buddies which we keep around forever
322 * so we can remove them from any client's roster that still has them listed
324 void xmpp_store_mortuary(HashList *mortuary) {
331 themsg = NewStrBuf();
332 StrBufPrintf(themsg, "Content-type: " XMPPMORTUARY "\n"
333 "Content-transfer-encoding: 7bit\n"
337 HashPos = GetNewHashPos(mortuary, 0);
338 while (GetNextHashPos(mortuary, HashPos, &len, &Key, &Value) != 0)
340 StrBufAppendPrintf(themsg, "%s\n", (char *)Value);
342 DeleteHashPos(&HashPos);
345 StrBufAppendPrintf(themsg, "foo@bar.com\n");
346 StrBufAppendPrintf(themsg, "baz@quux.com\n");
347 StrBufAppendPrintf(themsg, "haha%c\n", 1);
348 StrBufAppendPrintf(themsg, "baaaz@quux.com\n");
349 StrBufAppendPrintf(themsg, "baaaz@quuuuuux.com\n");
352 /* Delete the old mortuary */
353 CtdlDeleteMessages(USERCONFIGROOM, NULL, 0, XMPPMORTUARY);
355 /* And save the new one to disk */
356 quickie_message("Citadel", NULL, NULL, USERCONFIGROOM, ChrPtr(themsg), 4, "XMPP Mortuary");
363 * Upon logout we make an attempt to delete the whole roster, in order to
364 * try to keep "ghost" buddies from remaining in the client-side roster.
366 * Since the client is probably not still alive, also remember the current
367 * roster for next time so we can delete dead buddies then.
369 void xmpp_massacre_roster(void)
371 struct CitContext *cptr;
373 HashList *mortuary = xmpp_fetch_mortuary();
375 cptr = CtdlGetContextArray(&nContexts);
377 for (i=0; i<nContexts; i++) {
378 if (xmpp_is_visible(&cptr[i], CC)) {
380 char *buddy = strdup(cptr[i].cs_inet_email);
381 Put(mortuary, buddy, strlen(buddy), buddy, NULL);
389 xmpp_store_mortuary(mortuary);
390 DeleteHash(&mortuary);
397 * Stupidly, XMPP does not specify a way to tell the client to flush its client-side roster
398 * and prepare to receive a new one. So instead we remember every buddy we've ever told the
399 * client about, and push delete operations out at the beginning of a session.
401 * We omit any users who happen to be online right now, but we still keep them in the mortuary,
402 * which needs to be maintained as a list of every buddy the user has ever seen. We don't know
403 * when they're connecting from the same client and when they're connecting from a different client,
404 * so we have no guarantee of what is in the client side roster at connect time.
406 void xmpp_delete_old_buddies_who_no_longer_exist_from_the_client_roster(void)
411 struct CitContext *cptr;
414 HashList *mortuary = xmpp_fetch_mortuary();
415 HashPos *HashPos = GetNewHashPos(mortuary, 0);
417 /* we need to omit anyone who is currently online */
418 cptr = CtdlGetContextArray(&nContexts);
420 /* go through the list of users in the mortuary... */
421 while (GetNextHashPos(mortuary, HashPos, &len, &Key, &Value) != 0)
425 if (cptr) for (i=0; i<nContexts; i++) {
426 if (xmpp_is_visible(&cptr[i], CC)) {
427 if (!strcasecmp(cptr[i].cs_inet_email, (char *)Value)) {
434 xmpp_destroy_buddy((char *)Value, 1); /* aggressive presence update */
438 DeleteHashPos(&HashPos);
439 DeleteHash(&mortuary);
444 CTDL_MODULE_INIT(xmpp_presence)
447 AddXMPPEndHandler(HKEY("presence"), xmpp_wholist_presence_dump, 0);
449 return "xmpp_presence";