citadel/modules/xmpp/xmpp_presence.c

   1 /*
   2  * $Id$
   3  *
   4  * Handle XMPP presence exchanges
   5  *
   6  * Copyright (c) 2007-2010 by Art Cancro
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  *
  22  */
  23
  24 #include "sysdep.h"
  25 #include <stdlib.h>
  26 #include <unistd.h>
  27 #include <stdio.h>
  28 #include <fcntl.h>
  29 #include <signal.h>
  30 #include <pwd.h>
  31 #include <errno.h>
  32 #include <sys/types.h>
  33
  34 #if TIME_WITH_SYS_TIME
  35 # include <sys/time.h>
  36 # include <time.h>
  37 #else
  38 # if HAVE_SYS_TIME_H
  39 #  include <sys/time.h>
  40 # else
  41 #  include <time.h>
  42 # endif
  43 #endif
  44
  45 #include <sys/wait.h>
  46 #include <string.h>
  47 #include <limits.h>
  48 #include <ctype.h>
  49 #include <expat.h>
  50 #include <libcitadel.h>
  51 #include "citadel.h"
  52 #include "server.h"
  53 #include "citserver.h"
  54 #include "support.h"
  55 #include "config.h"
  56 #include "internet_addressing.h"
  57 #include "md5.h"
  58 #include "ctdl_module.h"
  59 #include "serv_xmpp.h"
  60
  61
  62
  63 /*
  64  * Indicate the presence of another user to the client
  65  * (used in several places)
  66  */
  67 void xmpp_indicate_presence(char *presence_jid)
  68 {
  69         cprintf("<presence from=\"%s\" to=\"%s\"></presence>",
  70                 presence_jid,
  71                 XMPP->client_jid
  72         );
  73 }
  74
  75
  76
  77 /*
  78  * Convenience function to determine whether a particular session is visible to this user
  79  */
  80 int xmpp_is_visible(struct CitContext *cptr) {
  81         int aide = (CC->user.axlevel >= AxAideU);
  82
  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 */
  87         ) {
  88                 return(1);
  89         }
  90         else {
  91                 return(0);
  92         }
  93 }
  94
  95
  96 /*
  97  * Initial dump of the entire wholist
  98  */
  99 void xmpp_wholist_presence_dump(void)
 100 {
 101         struct CitContext *cptr = NULL;
 102         int nContexts, i;
 103
 104         cptr = CtdlGetContextArray(&nContexts);
 105         if (!cptr) {
 106                 return;
 107         }
 108
 109         for (i=0; i<nContexts; i++) {
 110                 if (xmpp_is_visible(&cptr[i])) {
 111                         xmpp_indicate_presence(cptr[i].cs_inet_email);
 112                 }
 113         }
 114         free(cptr);
 115 }
 116
 117
 118 /*
 119  * Function to remove a buddy subscription and delete from the roster
 120  * (used in several places)
 121  */
 122 void xmpp_destroy_buddy(char *presence_jid) {
 123         static int unsolicited_id = 1;
 124
 125         if (!presence_jid) return;
 126         if (!XMPP) return;
 127         if (!XMPP->client_jid) return;
 128
 129         /* Transmit non-presence information */
 130         cprintf("<presence type=\"unavailable\" from=\"%s\" to=\"%s\"></presence>",
 131                 presence_jid, XMPP->client_jid
 132         );
 133         cprintf("<presence type=\"unsubscribed\" from=\"%s\" to=\"%s\"></presence>",
 134                 presence_jid, XMPP->client_jid
 135         );
 136         // FIXME ... we should implement xmpp_indicate_nonpresence so we can use it elsewhere
 137
 138         /* Do an unsolicited roster update that deletes the contact. */
 139         cprintf("<iq from=\"%s\" to=\"%s\" id=\"unbuddy_%x\" type=\"result\">",
 140                 CC->cs_inet_email,
 141                 XMPP->client_jid,
 142                 ++unsolicited_id
 143         );
 144         cprintf("<query xmlns=\"jabber:iq:roster\">");
 145         cprintf("<item jid=\"%s\" subscription=\"remove\">", presence_jid);
 146         cprintf("<group>%s</group>", config.c_humannode);
 147         cprintf("</item>");
 148         cprintf("</query>"
 149                 "</iq>"
 150         );
 151 }
 152
 153
 154 /*
 155  * When a user logs in or out of the local Citadel system, notify all XMPP sessions about it.
 156  */
 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;
 161         int nContexts, i;
 162
 163         if (IsEmptyStr(presence_jid)) return;
 164         if (CC->kill_me) return;
 165
 166         cptr = CtdlGetContextArray(&nContexts);
 167         if (!cptr) {
 168                 return;
 169         }
 170
 171         /* Count the visible sessions for this user */
 172         for (i=0; i<nContexts; i++) {
 173                 if (xmpp_is_visible(&cptr[i])) {
 174                         ++visible_sessions;
 175                 }
 176         }
 177
 178         CtdlLogPrintf(CTDL_DEBUG, "%d sessions for <%s> are now visible to session %d\n",
 179                 visible_sessions, presence_jid, CC->cs_pid);
 180
 181         if ( (event_type == XMPP_EVT_LOGIN) && (visible_sessions == 1) ) {
 182
 183                 CtdlLogPrintf(CTDL_DEBUG, "Telling session %d that <%s> logged in\n", CC->cs_pid, presence_jid);
 184
 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\">",
 190                                                 ++unsolicited_id);
 191                                         cprintf("<query xmlns=\"jabber:iq:roster\">");
 192                                         xmpp_roster_item(&cptr[i]);
 193                                         cprintf("</query>"
 194                                                 "</iq>");
 195                                 }
 196                         }
 197                 }
 198
 199                 /* Transmit presence information */
 200                 xmpp_indicate_presence(presence_jid);
 201         }
 202
 203         if (visible_sessions == 0) {
 204                 CtdlLogPrintf(CTDL_DEBUG, "Telling session %d that <%s> logged out\n", CC->cs_pid, presence_jid);
 205
 206                 xmpp_destroy_buddy(presence_jid);
 207         }
 208         free(cptr);
 209 }
 210
 211
 212
 213 void xmpp_fetch_mortuary_backend(long msgnum, void *userdata) {
 214         HashList *mortuary = (HashList *) userdata;
 215         struct CtdlMessage *msg;
 216         char *ptr = NULL;
 217         char *lasts = NULL;
 218
 219         msg = CtdlFetchMessage(msgnum, 1);
 220         if (msg == NULL) {
 221                 return;
 222         }
 223
 224         /* now add anyone we find into the hashlist */
 225
 226         /* skip past the headers */
 227         ptr = strstr(msg->cm_fields['M'], "\n\n");
 228         if (ptr != NULL) {
 229                 ptr += 2;
 230         }
 231         else {
 232                 ptr = strstr(msg->cm_fields['M'], "\n\r\n");
 233                 if (ptr != NULL) {
 234                         ptr += 3;
 235                 }
 236         }
 237
 238         /* the remaining lines are addresses */
 239         if (ptr != NULL) {
 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);
 245                 }
 246         }
 247
 248         CtdlFreeMessage(msg);
 249 }
 250
 251
 252
 253 /*
 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
 256  */
 257 HashList *xmpp_fetch_mortuary(void) {
 258         HashList *mortuary = NewHash(1, NULL);
 259         if (!mortuary) {
 260                 CtdlLogPrintf(CTDL_ALERT, "NewHash() failed!\n");
 261                 return(NULL);
 262         }
 263
 264         if (CtdlGetRoom(&CC->room, USERCONFIGROOM) != 0) {
 265                 /* no config room exists - no further processing is required. */
 266                 return(mortuary);
 267         }
 268         CtdlForEachMessage(MSGS_LAST, 1, NULL, XMPPMORTUARY, NULL,
 269                 xmpp_fetch_mortuary_backend, (void *)mortuary );
 270
 271         return(mortuary);
 272 }
 273
 274
 275
 276 /*
 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
 279  */
 280 void xmpp_store_mortuary(HashList *mortuary) {
 281         HashPos *HashPos;
 282         long len;
 283         void *Value;
 284         const char *Key;
 285         StrBuf *themsg;
 286
 287         themsg = NewStrBuf();
 288         StrBufPrintf(themsg,    "Content-type: " XMPPMORTUARY "\n"
 289                                 "Content-transfer-encoding: 7bit\n"
 290                                 "\n"
 291         );
 292
 293         HashPos = GetNewHashPos(mortuary, 0);
 294         while (GetNextHashPos(mortuary, HashPos, &len, &Key, &Value) != 0)
 295         {
 296                 StrBufAppendPrintf(themsg, "%s\n", (char *)Value);
 297         }
 298         DeleteHashPos(&HashPos);
 299
 300         /* Delete the old mortuary */
 301         CtdlDeleteMessages(USERCONFIGROOM, NULL, 0, XMPPMORTUARY);
 302
 303         /* And save the new one to disk */
 304         quickie_message("Citadel", NULL, NULL, USERCONFIGROOM, ChrPtr(themsg), 4, "XMPP Mortuary");
 305         FreeStrBuf(&themsg);
 306 }
 307
 308
 309
 310 /*
 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.
 313  *
 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.
 316  */
 317 void xmpp_massacre_roster(void)
 318 {
 319         struct CitContext *cptr;
 320         int nContexts, i;
 321         HashList *mortuary = xmpp_fetch_mortuary();
 322
 323         cptr = CtdlGetContextArray(&nContexts);
 324         if (cptr) {
 325                 for (i=0; i<nContexts; i++) {
 326                         if (xmpp_is_visible(&cptr[i])) {
 327                                 if (mortuary) {
 328                                         char *buddy = strdup(cptr[i].cs_inet_email);
 329                                         Put(mortuary, buddy, strlen(buddy), buddy, NULL);
 330                                 }
 331                         }
 332                 }
 333                 free (cptr);
 334         }
 335
 336         if (mortuary) {
 337                 xmpp_store_mortuary(mortuary);
 338                 DeleteHash(&mortuary);
 339         }
 340 }
 341
 342
 343
 344 /*
 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.
 348  *
 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.
 353  */
 354 void xmpp_delete_old_buddies_who_no_longer_exist_from_the_client_roster(void)
 355 {
 356         long len;
 357         void *Value;
 358         const char *Key;
 359         struct CitContext *cptr;
 360         int nContexts, i;
 361         int online_now = 0;
 362         HashList *mortuary = xmpp_fetch_mortuary();
 363         HashPos *HashPos = GetNewHashPos(mortuary, 0);
 364
 365         /* we need to omit anyone who is currently online */
 366         cptr = CtdlGetContextArray(&nContexts);
 367
 368         /* go through the list of users in the mortuary... */
 369         while (GetNextHashPos(mortuary, HashPos, &len, &Key, &Value) != 0)
 370         {
 371
 372                 online_now = 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)) {
 376                                         online_now = 1;
 377                                 }
 378                         }
 379                 }
 380
 381                 if (!online_now) {
 382                         xmpp_destroy_buddy((char *)Value);
 383                 }
 384
 385         }
 386         DeleteHashPos(&HashPos);
 387         DeleteHash(&mortuary);
 388         free(cptr);
 389 }
 390