* New utility function xmpp_is_visible(), used to determine whether any given session...
[citadel.git] / citadel / modules / xmpp / xmpp_presence.c
index 915f1d319ab624cfda906ca371c8c609a7a7c02c..7515dd09280a7b368e7560961d27f809048a5be8 100644 (file)
@@ -5,19 +5,19 @@
  *
  * Copyright (c) 2007-2010 by Art Cancro
  *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 3 of the License, or
- *  (at your option) any later version.
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
  *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
 
@@ -73,6 +73,26 @@ void xmpp_indicate_presence(char *presence_jid)
 }
 
 
+
+/*
+ * Convenience function to determine whether a particular session is visible to this user
+ */
+int xmpp_is_visible(struct CitContext *cptr) {
+       int aide = (CC->user.axlevel >= AxAideU);
+
+       if (    (cptr->logged_in)
+               &&      (((cptr->cs_flags&CS_STEALTH)==0) || (aide))    /* aides see everyone */
+               &&      (cptr->user.usernum != CC->user.usernum)        /* don't show myself */
+               &&      (cptr->can_receive_im)                          /* IM-capable session */
+       ) {
+               return(1);
+       }
+       else {
+               return(0);
+       }
+}
+
+
 /* 
  * Initial dump of the entire wholist
  */
@@ -81,22 +101,14 @@ void xmpp_wholist_presence_dump(void)
        struct CitContext *cptr = NULL;
        int nContexts, i;
        
-       int aide = (CC->user.axlevel >= AxAideU);
-
        cptr = CtdlGetContextArray(&nContexts);
        if (!cptr) {
                return;
        }
 
        for (i=0; i<nContexts; i++) {
-               if (cptr[i].logged_in) {
-                       if (
-                               (((cptr[i].cs_flags&CS_STEALTH)==0) || (aide))  /* aides see everyone */
-                               && (cptr[i].user.usernum != CC->user.usernum)   /* don't show myself */
-                               && (cptr[i].can_receive_im)                     /* IM-capable session */
-                       ) {
-                               xmpp_indicate_presence(cptr[i].cs_inet_email);
-                       }
+               if (xmpp_is_visible(&cptr[i])) {
+                       xmpp_indicate_presence(cptr[i].cs_inet_email);
                }
        }
        free(cptr);
@@ -143,7 +155,6 @@ void xmpp_presence_notify(char *presence_jid, int event_type) {
        static int unsolicited_id;
        int visible_sessions = 0;
        int nContexts, i;
-       int aide = (CC->user.axlevel >= AxAideU);
 
        if (IsEmptyStr(presence_jid)) return;
        if (CC->kill_me) return;
@@ -155,14 +166,8 @@ void xmpp_presence_notify(char *presence_jid, int event_type) {
                
        /* Count the visible sessions for this user */
        for (i=0; i<nContexts; i++) {
-               if (cptr[i].logged_in) {
-                       if (
-                               (!strcasecmp(cptr[i].cs_inet_email, presence_jid)) 
-                               && (((cptr[i].cs_flags&CS_STEALTH)==0) || (aide))
-                               && (cptr[i].can_receive_im)
-                       ) {
-                               ++visible_sessions;
-                       }
+               if (xmpp_is_visible(&cptr[i])) {
+                       ++visible_sessions;
                }
        }
 
@@ -175,7 +180,7 @@ void xmpp_presence_notify(char *presence_jid, int event_type) {
 
                /* Do an unsolicited roster update that adds a new contact. */
                for (i=0; i<nContexts; i++) {
-                       if (cptr[i].logged_in) {
+                       if (xmpp_is_visible(&cptr[i])) {
                                if (!strcasecmp(cptr[i].cs_inet_email, presence_jid)) {
                                        cprintf("<iq id=\"unsolicited_%x\" type=\"result\">",
                                                ++unsolicited_id);
@@ -201,31 +206,181 @@ void xmpp_presence_notify(char *presence_jid, int event_type) {
 
 
 
+void xmpp_fetch_mortuary_backend(long msgnum, void *userdata) {
+       HashList *mortuary = (HashList *) userdata;
+       struct CtdlMessage *msg;
+       char *ptr = NULL;
+       char *lasts = NULL;
+
+       msg = CtdlFetchMessage(msgnum, 1);
+       if (msg == NULL) {
+               return;
+       }
+
+       /* now add anyone we find into the hashlist */
+
+       /* skip past the headers */
+       ptr = strstr(msg->cm_fields['M'], "\n\n");
+       if (ptr != NULL) {
+               ptr += 2;
+       }
+       else {
+               ptr = strstr(msg->cm_fields['M'], "\n\r\n");
+               if (ptr != NULL) {
+                       ptr += 3;
+               }
+       }
+
+       /* the remaining lines are addresses */
+       if (ptr != NULL) {
+               ptr = strtok_r(ptr, "\n", &lasts);
+               while (ptr != NULL) {
+                       char *pch = strdup(ptr);
+                       Put(mortuary, pch, strlen(pch), pch, NULL);
+                       ptr = strtok_r(NULL, "\n", &lasts);
+               }
+       }
+
+       CtdlFreeMessage(msg);
+}
+
+
+
+/*
+ * Fetch the "mortuary" - a list of dead buddies which we keep around forever
+ * so we can remove them from any client's roster that still has them listed
+ */
+HashList *xmpp_fetch_mortuary(void) {
+       HashList *mortuary = NewHash(1, NULL);
+       if (!mortuary) {
+               CtdlLogPrintf(CTDL_ALERT, "NewHash() failed!\n");
+               return(NULL);
+       }
+
+        if (CtdlGetRoom(&CC->room, USERCONFIGROOM) != 0) {
+               /* no config room exists - no further processing is required. */
+                return(mortuary);
+        }
+        CtdlForEachMessage(MSGS_LAST, 1, NULL, XMPPMORTUARY, NULL,
+                xmpp_fetch_mortuary_backend, (void *)mortuary );
+
+       return(mortuary);
+}
+
+
+
+/*
+ * Fetch the "mortuary" - a list of dead buddies which we keep around forever
+ * so we can remove them from any client's roster that still has them listed
+ */
+void xmpp_store_mortuary(HashList *mortuary) {
+       HashPos *HashPos;
+       long len;
+       void *Value;
+       const char *Key;
+       StrBuf *themsg;
+
+       themsg = NewStrBuf();
+       StrBufPrintf(themsg,    "Content-type: " XMPPMORTUARY "\n"
+                               "Content-transfer-encoding: 7bit\n"
+                               "\n"
+       );
+
+       HashPos = GetNewHashPos(mortuary, 0);
+       while (GetNextHashPos(mortuary, HashPos, &len, &Key, &Value) != 0)
+       {
+               StrBufAppendPrintf(themsg, "%s\n", (char *)Value);
+       }
+       DeleteHashPos(&HashPos);
+
+       /* Delete the old mortuary */
+       CtdlDeleteMessages(USERCONFIGROOM, NULL, 0, XMPPMORTUARY);
+
+       /* And save the new one to disk */
+       quickie_message("Citadel", NULL, NULL, USERCONFIGROOM, ChrPtr(themsg), 4, "XMPP Mortuary");
+       FreeStrBuf(&themsg);
+}
+
+
+
 /*
  * Upon logout we make an attempt to delete the whole roster, in order to
  * try to keep "ghost" buddies from remaining in the client-side roster.
+ *
+ * Since the client is probably not still alive, also remember the current
+ * roster for next time so we can delete dead buddies then.
  */
 void xmpp_massacre_roster(void)
 {
        struct CitContext *cptr;
        int nContexts, i;
-       int aide = (CC->user.axlevel >= AxAideU);
+       HashList *mortuary = xmpp_fetch_mortuary();
 
        cptr = CtdlGetContextArray(&nContexts);
        if (cptr) {
                for (i=0; i<nContexts; i++) {
-                       if (cptr[i].logged_in) {
-                               if (
-                                       (((cptr[i].cs_flags&CS_STEALTH)==0) || (aide))
-                                       && (cptr[i].user.usernum != CC->user.usernum)
-                               ) {
-                                       xmpp_destroy_buddy(cptr[i].cs_inet_email);
+                       if (xmpp_is_visible(&cptr[i])) {
+                               if (mortuary) {
+                                       char *buddy = strdup(cptr[i].cs_inet_email);
+                                       Put(mortuary, buddy, strlen(buddy), buddy, NULL);
                                }
                        }
                }
                free (cptr);
        }
+
+       if (mortuary) {
+               xmpp_store_mortuary(mortuary);
+               DeleteHash(&mortuary);
+       }
 }
 
 
 
+/*
+ * Stupidly, XMPP does not specify a way to tell the client to flush its client-side roster
+ * and prepare to receive a new one.  So instead we remember every buddy we've ever told the
+ * client about, and push delete operations out at the beginning of a session.
+ * 
+ * We omit any users who happen to be online right now, but we still keep them in the mortuary,
+ * which needs to be maintained as a list of every buddy the user has ever seen.  We don't know
+ * when they're connecting from the same client and when they're connecting from a different client,
+ * so we have no guarantee of what is in the client side roster at connect time.
+ */
+void xmpp_delete_old_buddies_who_no_longer_exist_from_the_client_roster(void)
+{
+       long len;
+       void *Value;
+       const char *Key;
+       struct CitContext *cptr;
+       int nContexts, i;
+       int online_now = 0;
+       HashList *mortuary = xmpp_fetch_mortuary();
+       HashPos *HashPos = GetNewHashPos(mortuary, 0);
+
+       /* we need to omit anyone who is currently online */
+       cptr = CtdlGetContextArray(&nContexts);
+
+       /* go through the list of users in the mortuary... */
+       while (GetNextHashPos(mortuary, HashPos, &len, &Key, &Value) != 0)
+       {
+
+               online_now = 0;
+               if (cptr) for (i=0; i<nContexts; i++) {
+                       if (xmpp_is_visible(&cptr[i])) {
+                               if (!strcasecmp(cptr[i].cs_inet_email, (char *)Value)) {
+                                       online_now = 1;
+                               }
+                       }
+               }
+
+               if (!online_now) {
+                       xmpp_destroy_buddy((char *)Value);
+               }
+
+       }
+       DeleteHashPos(&HashPos);
+       DeleteHash(&mortuary);
+       free(cptr);
+}
+