4 * Handle XMPP presence exchanges
6 * Copyright (c) 2007-2010 by Art Cancro
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #include <sys/types.h>
34 #if TIME_WITH_SYS_TIME
35 # include <sys/time.h>
39 # include <sys/time.h>
50 #include <libcitadel.h>
53 #include "citserver.h"
56 #include "internet_addressing.h"
58 #include "ctdl_module.h"
59 #include "serv_xmpp.h"
64 * Indicate the presence of another user to the client
65 * (used in several places)
67 void xmpp_indicate_presence(char *presence_jid)
69 cprintf("<presence from=\"%s\" to=\"%s\"></presence>",
78 * Convenience function to determine whether a particular session is visible to this user
80 int xmpp_is_visible(struct CitContext *cptr) {
81 int aide = (CC->user.axlevel >= AxAideU);
83 if ( (cptr->logged_in)
84 && (((cptr->cs_flags&CS_STEALTH)==0) || (aide)) /* aides see everyone */
85 && (cptr->user.usernum != CC->user.usernum) /* don't show myself */
86 && (cptr->can_receive_im) /* IM-capable session */
97 * Initial dump of the entire wholist
99 void xmpp_wholist_presence_dump(void)
101 struct CitContext *cptr = NULL;
104 cptr = CtdlGetContextArray(&nContexts);
109 for (i=0; i<nContexts; i++) {
110 if (xmpp_is_visible(&cptr[i])) {
111 xmpp_indicate_presence(cptr[i].cs_inet_email);
119 * Function to remove a buddy subscription and delete from the roster
120 * (used in several places)
122 void xmpp_destroy_buddy(char *presence_jid) {
123 static int unsolicited_id = 1;
125 if (!presence_jid) return;
127 if (!XMPP->client_jid) return;
129 /* Transmit non-presence information */
130 cprintf("<presence type=\"unavailable\" from=\"%s\" to=\"%s\"></presence>",
131 presence_jid, XMPP->client_jid
133 cprintf("<presence type=\"unsubscribed\" from=\"%s\" to=\"%s\"></presence>",
134 presence_jid, XMPP->client_jid
136 // FIXME ... we should implement xmpp_indicate_nonpresence so we can use it elsewhere
138 /* Do an unsolicited roster update that deletes the contact. */
139 cprintf("<iq from=\"%s\" to=\"%s\" id=\"unbuddy_%x\" type=\"result\">",
144 cprintf("<query xmlns=\"jabber:iq:roster\">");
145 cprintf("<item jid=\"%s\" subscription=\"remove\">", presence_jid);
146 cprintf("<group>%s</group>", config.c_humannode);
155 * When a user logs in or out of the local Citadel system, notify all XMPP sessions about it.
157 void xmpp_presence_notify(char *presence_jid, int event_type) {
158 struct CitContext *cptr;
159 static int unsolicited_id;
160 int visible_sessions = 0;
163 if (IsEmptyStr(presence_jid)) return;
164 if (CC->kill_me) return;
166 cptr = CtdlGetContextArray(&nContexts);
171 /* Count the visible sessions for this user */
172 for (i=0; i<nContexts; i++) {
173 if (xmpp_is_visible(&cptr[i])) {
178 CtdlLogPrintf(CTDL_DEBUG, "%d sessions for <%s> are now visible to session %d\n",
179 visible_sessions, presence_jid, CC->cs_pid);
181 if ( (event_type == XMPP_EVT_LOGIN) && (visible_sessions == 1) ) {
183 CtdlLogPrintf(CTDL_DEBUG, "Telling session %d that <%s> logged in\n", CC->cs_pid, presence_jid);
185 /* Do an unsolicited roster update that adds a new contact. */
186 for (i=0; i<nContexts; i++) {
187 if (xmpp_is_visible(&cptr[i])) {
188 if (!strcasecmp(cptr[i].cs_inet_email, presence_jid)) {
189 cprintf("<iq id=\"unsolicited_%x\" type=\"result\">",
191 cprintf("<query xmlns=\"jabber:iq:roster\">");
192 xmpp_roster_item(&cptr[i]);
199 /* Transmit presence information */
200 xmpp_indicate_presence(presence_jid);
203 if (visible_sessions == 0) {
204 CtdlLogPrintf(CTDL_DEBUG, "Telling session %d that <%s> logged out\n", CC->cs_pid, presence_jid);
206 xmpp_destroy_buddy(presence_jid);
213 void xmpp_fetch_mortuary_backend(long msgnum, void *userdata) {
214 HashList *mortuary = (HashList *) userdata;
215 struct CtdlMessage *msg;
219 msg = CtdlFetchMessage(msgnum, 1);
224 /* now add anyone we find into the hashlist */
226 /* skip past the headers */
227 ptr = strstr(msg->cm_fields['M'], "\n\n");
232 ptr = strstr(msg->cm_fields['M'], "\n\r\n");
238 /* the remaining lines are addresses */
240 ptr = strtok_r(ptr, "\n", &lasts);
241 while (ptr != NULL) {
242 char *pch = strdup(ptr);
243 Put(mortuary, pch, strlen(pch), pch, NULL);
244 ptr = strtok_r(NULL, "\n", &lasts);
248 CtdlFreeMessage(msg);
254 * Fetch the "mortuary" - a list of dead buddies which we keep around forever
255 * so we can remove them from any client's roster that still has them listed
257 HashList *xmpp_fetch_mortuary(void) {
258 HashList *mortuary = NewHash(1, NULL);
260 CtdlLogPrintf(CTDL_ALERT, "NewHash() failed!\n");
264 if (CtdlGetRoom(&CC->room, USERCONFIGROOM) != 0) {
265 /* no config room exists - no further processing is required. */
268 CtdlForEachMessage(MSGS_LAST, 1, NULL, XMPPMORTUARY, NULL,
269 xmpp_fetch_mortuary_backend, (void *)mortuary );
277 * Fetch the "mortuary" - a list of dead buddies which we keep around forever
278 * so we can remove them from any client's roster that still has them listed
280 void xmpp_store_mortuary(HashList *mortuary) {
287 themsg = NewStrBuf();
288 StrBufPrintf(themsg, "Content-type: " XMPPMORTUARY "\n"
289 "Content-transfer-encoding: 7bit\n"
293 HashPos = GetNewHashPos(mortuary, 0);
294 while (GetNextHashPos(mortuary, HashPos, &len, &Key, &Value) != 0)
296 StrBufAppendPrintf(themsg, "%s\n", (char *)Value);
298 DeleteHashPos(&HashPos);
300 /* Delete the old mortuary */
301 CtdlDeleteMessages(USERCONFIGROOM, NULL, 0, XMPPMORTUARY);
303 /* And save the new one to disk */
304 quickie_message("Citadel", NULL, NULL, USERCONFIGROOM, ChrPtr(themsg), 4, "XMPP Mortuary");
311 * Upon logout we make an attempt to delete the whole roster, in order to
312 * try to keep "ghost" buddies from remaining in the client-side roster.
314 * Since the client is probably not still alive, also remember the current
315 * roster for next time so we can delete dead buddies then.
317 void xmpp_massacre_roster(void)
319 struct CitContext *cptr;
321 HashList *mortuary = xmpp_fetch_mortuary();
323 cptr = CtdlGetContextArray(&nContexts);
325 for (i=0; i<nContexts; i++) {
326 if (xmpp_is_visible(&cptr[i])) {
328 char *buddy = strdup(cptr[i].cs_inet_email);
329 Put(mortuary, buddy, strlen(buddy), buddy, NULL);
337 xmpp_store_mortuary(mortuary);
338 DeleteHash(&mortuary);
345 * Stupidly, XMPP does not specify a way to tell the client to flush its client-side roster
346 * and prepare to receive a new one. So instead we remember every buddy we've ever told the
347 * client about, and push delete operations out at the beginning of a session.
349 * We omit any users who happen to be online right now, but we still keep them in the mortuary,
350 * which needs to be maintained as a list of every buddy the user has ever seen. We don't know
351 * when they're connecting from the same client and when they're connecting from a different client,
352 * so we have no guarantee of what is in the client side roster at connect time.
354 void xmpp_delete_old_buddies_who_no_longer_exist_from_the_client_roster(void)
359 struct CitContext *cptr;
362 HashList *mortuary = xmpp_fetch_mortuary();
363 HashPos *HashPos = GetNewHashPos(mortuary, 0);
365 /* we need to omit anyone who is currently online */
366 cptr = CtdlGetContextArray(&nContexts);
368 /* go through the list of users in the mortuary... */
369 while (GetNextHashPos(mortuary, HashPos, &len, &Key, &Value) != 0)
373 if (cptr) for (i=0; i<nContexts; i++) {
374 if (xmpp_is_visible(&cptr[i])) {
375 if (!strcasecmp(cptr[i].cs_inet_email, (char *)Value)) {
382 xmpp_destroy_buddy((char *)Value);
386 DeleteHashPos(&HashPos);
387 DeleteHash(&mortuary);