]> code.citadel.org Git - citadel.git/blobdiff - citadel/serv_vcard.c
* Minor changes for global directory service
[citadel.git] / citadel / serv_vcard.c
index 0150a074864fa9eb02d84bd96494739278907792..36f4b2316cb2ad9a63af636df1b3fa86913bc25e 100644 (file)
@@ -1,15 +1,28 @@
 /*
- * serv_vcard.c
+ * $Id$
  * 
  * A server-side module for Citadel which supports address book information
  * using the standard vCard format.
- *
- * $Id$
- *
+ * 
+ * Copyright (c) 1999-2001 / released under the GNU General Public License
  */
 
+/*
+ * Where we keep messages containing the vCards that source our directory.  It
+ * makes no sense to change this, because you'd have to change it on every
+ * system on the network.  That would be stupid.
+ */
 #define ADDRESS_BOOK_ROOM      "Global Address Book"
 
+/*
+ * Format of the "Extended ID" field of the message containing a user's
+ * vCard.  Doesn't matter what it really looks like as long as it's both
+ * unique and consistent (because we use it for replication checking to
+ * delete the old vCard network-wide when the user enters a new one).
+ */
+#define VCARD_EXT_FORMAT       "Citadel vCard: personal card for %s at %s"
+
+
 #include "sysdep.h"
 #include <stdlib.h>
 #include <unistd.h>
 #include <pwd.h>
 #include <errno.h>
 #include <sys/types.h>
-#include <sys/time.h>
+
+#if TIME_WITH_SYS_TIME
+# include <sys/time.h>
+# include <time.h>
+#else
+# if HAVE_SYS_TIME_H
+#  include <sys/time.h>
+# else
+#  include <time.h>
+# endif
+#endif
+
 #include <sys/wait.h>
 #include <string.h>
 #include <limits.h>
-#ifdef HAVE_PTHREAD_H
-#include <pthread.h>
-#endif
 #include "citadel.h"
 #include "server.h"
-#include <syslog.h>
-#include <time.h>
 #include "sysdep_decls.h"
 #include "citserver.h"
 #include "support.h"
@@ -41,6 +60,7 @@
 #include "policy.h"
 #include "database.h"
 #include "msgbase.h"
+#include "internet_addressing.h"
 #include "tools.h"
 #include "vcard.h"
 
@@ -53,12 +73,85 @@ unsigned long SYM_VCARD;
 #define VC ((struct vcard_internal_info *)CtdlGetUserData(SYM_VCARD))
 
 
+/*
+ * Extract Internet e-mail addresses from a message containing a vCard, and
+ * perform a callback for any found.
+ */
+void vcard_extract_internet_addresses(struct CtdlMessage *msg,
+                               void (*callback)(char *, char *) ) {
+       struct vCard *v;
+       char *s;
+       char *addr;
+       char citadel_address[SIZ];
+
+       if (msg->cm_fields['A'] == NULL) return;
+       if (msg->cm_fields['N'] == NULL) return;
+       sprintf(citadel_address, "%s @ %s",
+               msg->cm_fields['A'], msg->cm_fields['N']);
+
+       v = vcard_load(msg->cm_fields['M']);
+       if (v == NULL) return;
+
+       s = vcard_get_prop(v, "email;internet", 0); /* FIXME handle multiples */
+       if (s != NULL) {
+               addr = strdoop(s);
+               striplt(addr);
+               if (strlen(addr) > 0) {
+                       if (callback != NULL) {
+                               callback(addr, citadel_address);
+                       }
+               }
+               phree(addr);
+       }
+
+       vcard_free(v);
+}
 
 /*
- * back end function used by several functions in this module
+ * Back end function for cmd_igab()
+ * FIXME use a callback that actually writes to the database, dumbass...
  */
-void vcard_gm_backend(long msgnum) {
-       VC->msgnum = msgnum;
+void vcard_add_to_directory(long msgnum, void *data) {
+       struct CtdlMessage *msg;
+
+       msg = CtdlFetchMessage(msgnum);
+       if (msg != NULL) {
+               vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
+       }
+
+       CtdlFreeMessage(msg);
+}
+
+
+/*
+ * Initialize Global Adress Book
+ */
+void cmd_igab(char *argbuf) {
+        char hold_rm[ROOMNAMELEN];
+
+       if (CtdlAccessCheck(ac_aide)) return;
+
+        strcpy(hold_rm, CC->quickroom.QRname); /* save current room */
+
+        if (getroom(&CC->quickroom, ADDRESS_BOOK_ROOM) != 0) {
+                getroom(&CC->quickroom, hold_rm);
+               cprintf("%d cannot get address book room\n", ERROR);
+               return;
+        }
+
+       /* FIXME empty the existing database first.  And don't be a
+        * freakin' momo and dump addresses to the client.  We want to write
+        * the harvested addresses into the database and send an OK to the
+        * client when finished.
+        */
+       
+       cprintf("%d Directory will be rebuilt\n", OK);
+
+        /* We want the last (and probably only) vcard in this room */
+        CtdlForEachMessage(MSGS_ALL, 0, (-127), "text/x-vcard",
+               NULL, vcard_add_to_directory, NULL);
+
+        getroom(&CC->quickroom, hold_rm);      /* return to saved room */
 }
 
 
@@ -66,19 +159,27 @@ void vcard_gm_backend(long msgnum) {
 /*
  * This handler detects whether the user is attempting to save a new
  * vCard as part of his/her personal configuration, and handles the replace
- * function accordingly.
+ * function accordingly (delete the user's existing vCard in the config room
+ * and in the global address book).
  */
-int vcard_personal_upload(struct CtdlMessage *msg) {
+int vcard_upload_beforesave(struct CtdlMessage *msg) {
        char *ptr;
        int linelen;
+        char config_rm[ROOMNAMELEN];
+       char buf[SIZ];
+
+       if (!CC->logged_in) return(0);  /* Only do this if logged in. */
 
        /* If this isn't the configuration room, or if this isn't a MIME
-        * message, don't bother.
+        * message, don't bother.  (Check for NULL room first, otherwise
+        * some messages will cause it to crash!!)
         */
-       if (strcasecmp(msg->cm_fields['O'], CONFIGROOM)) return(0);
+       if (msg->cm_fields['O'] == NULL) return(0);
+       if (strcasecmp(msg->cm_fields['O'], USERCONFIGROOM)) return(0);
        if (msg->cm_format_type != 4) return(0);
 
        ptr = msg->cm_fields['M'];
+       if (ptr == NULL) return(0);
        while (ptr != NULL) {
        
                linelen = strcspn(ptr, "\n");
@@ -88,8 +189,84 @@ int vcard_personal_upload(struct CtdlMessage *msg) {
                        /* Bingo!  The user is uploading a new vCard, so
                         * delete the old one.
                         */
-                       CtdlDeleteMessages(msg->cm_fields['O'],
-                                       0L, "text/x-vcard");
+
+                       /* Delete the user's old vCard.  This would probably
+                        * get taken care of by the replication check, but we
+                        * want to make sure there is absolutely only one
+                        * vCard in the user's config room at all times.
+                        * 
+                        * FIXME ... this needs to be tweaked to allow an admin
+                        * to make changes to another user's vCard instead of
+                        * assuming that it's always the user saving his own.
+                        */
+                       MailboxName(config_rm, &CC->usersupp, USERCONFIGROOM);
+                       CtdlDeleteMessages(config_rm, 0L, "text/x-vcard");
+
+                       /* Set the Extended-ID to a standardized one so the
+                        * replication always works correctly
+                        */
+                        if (msg->cm_fields['E'] != NULL)
+                                phree(msg->cm_fields['E']);
+
+                        sprintf(buf, VCARD_EXT_FORMAT,
+                                msg->cm_fields['A'], NODENAME);
+                        msg->cm_fields['E'] = strdoop(buf);
+
+                       /* Now allow the save to complete. */
+                       return(0);
+               }
+
+               ptr = strchr((char *)ptr, '\n');
+               if (ptr != NULL) ++ptr;
+       }
+
+       return(0);
+}
+
+
+
+/*
+ * This handler detects whether the user is attempting to save a new
+ * vCard as part of his/her personal configuration, and handles the replace
+ * function accordingly (copy the vCard from the config room to the global
+ * address book).
+ */
+int vcard_upload_aftersave(struct CtdlMessage *msg) {
+       char *ptr;
+       int linelen;
+       long I;
+
+       if (!CC->logged_in) return(0);  /* Only do this if logged in. */
+
+       /* If this isn't the configuration room, or if this isn't a MIME
+        * message, don't bother.
+        */
+       if (msg->cm_fields['O'] == NULL) return(0);
+       if (strcasecmp(msg->cm_fields['O'], USERCONFIGROOM)) return(0);
+       if (msg->cm_format_type != 4) return(0);
+
+       ptr = msg->cm_fields['M'];
+       if (ptr == NULL) return(0);
+       while (ptr != NULL) {
+       
+               linelen = strcspn(ptr, "\n");
+               if (linelen == 0) return(0);    /* end of headers */    
+               
+               if (!strncasecmp(ptr, "Content-type: text/x-vcard", 26)) {
+                       /* Bingo!  The user is uploading a new vCard, so
+                        * copy it to the Global Address Book room.
+                        */
+
+                       I = atol(msg->cm_fields['I']);
+                       if (I < 0L) return(0);
+
+                       /* Put it in the Global Address Book room... */
+                       CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I,
+                               (SM_VERIFY_GOODNESS | SM_DO_REPL_CHECK) );
+
+                       /* ...and also in the directory database. */
+                       vcard_add_to_directory(I, NULL);
+
                        return(0);
                }
 
@@ -102,6 +279,14 @@ int vcard_personal_upload(struct CtdlMessage *msg) {
 
 
 
+/*
+ * back end function used for callbacks
+ */
+void vcard_gu_backend(long msgnum, void *userdata) {
+       VC->msgnum = msgnum;
+}
+
+
 /*
  * If this user has a vcard on disk, read it into memory, otherwise allocate
  * and return an empty vCard.
@@ -113,7 +298,7 @@ struct vCard *vcard_get_user(struct usersupp *u) {
        struct vCard *v;
 
         strcpy(hold_rm, CC->quickroom.QRname); /* save current room */
-        MailboxName(config_rm, u, CONFIGROOM);
+        MailboxName(config_rm, u, USERCONFIGROOM);
 
         if (getroom(&CC->quickroom, config_rm) != 0) {
                 getroom(&CC->quickroom, hold_rm);
@@ -122,7 +307,8 @@ struct vCard *vcard_get_user(struct usersupp *u) {
 
         /* We want the last (and probably only) vcard in this room */
        VC->msgnum = (-1);
-        CtdlForEachMessage(MSGS_LAST, 1, "text/x-vcard", vcard_gm_backend);
+        CtdlForEachMessage(MSGS_LAST, 1, (-127), "text/x-vcard",
+               NULL, vcard_gu_backend, NULL);
         getroom(&CC->quickroom, hold_rm);      /* return to saved room */
 
        if (VC->msgnum < 0L) return vcard_new();
@@ -152,7 +338,6 @@ void vcard_write_user(struct usersupp *u, struct vCard *v) {
 
         fp = fopen(temp, "w");
         if (fp == NULL) return;
-       fprintf(fp, "Content-type: text/x-vcard\r\n\r\n");
        if (ser == NULL) {
                fprintf(fp, "begin:vcard\r\nend:vcard\r\n");
        } else {
@@ -164,15 +349,16 @@ void vcard_write_user(struct usersupp *u, struct vCard *v) {
         /* This handy API function does all the work for us.
         * NOTE: normally we would want to set that last argument to 1, to
         * force the system to delete the user's old vCard.  But it doesn't
-        * have to, because the vcard_personal_upload() hook above is going to
-        * notice what we're trying to do, and delete the old vCard.
+        * have to, because the vcard_upload_beforesave() hook above
+        * is going to notice what we're trying to do, and delete the old vCard.
         */
-        CtdlWriteObject(CONFIGROOM,    /* which room */
+        CtdlWriteObject(USERCONFIGROOM,        /* which room */
                        "text/x-vcard", /* MIME type */
                        temp,           /* temp file */
                        u,              /* which user */
                        0,              /* not binary */
-                       0);             /* don't delete others of this type */
+                       0,              /* don't delete others of this type */
+                       0);             /* no flags */
 
         unlink(temp);
 }
@@ -180,63 +366,58 @@ void vcard_write_user(struct usersupp *u, struct vCard *v) {
 
 
 /*
- * old style "enter registration info" command
+ * Old style "enter registration info" command.  This function simply honors
+ * the REGI protocol command, translates the entered parameters into a vCard,
+ * and enters the vCard into the user's configuration.
  */
 void cmd_regi(char *argbuf) {
        int a,b,c;
-       char buf[256];
+       char buf[SIZ];
        struct vCard *my_vcard;
 
-       char tmpaddr[256];
-       char tmpcity[256];
-       char tmpstate[256];
-       char tmpzip[256];
-       char tmpphone[256];
-       char tmpaddress[512];
+       char tmpaddr[SIZ];
+       char tmpcity[SIZ];
+       char tmpstate[SIZ];
+       char tmpzip[SIZ];
+       char tmpaddress[SIZ];
+       char tmpcountry[SIZ];
 
        if (!(CC->logged_in)) {
                cprintf("%d Not logged in.\n",ERROR+NOT_LOGGED_IN);
                return;
-               }
+       }
 
        my_vcard = vcard_get_user(&CC->usersupp);
        strcpy(tmpaddr, "");
        strcpy(tmpcity, "");
        strcpy(tmpstate, "");
        strcpy(tmpzip, "");
+       strcpy(tmpcountry, "USA");
 
        cprintf("%d Send registration...\n", SEND_LISTING);
        a=0;
        while (client_gets(buf), strcmp(buf,"000")) {
                if (a==0) vcard_set_prop(my_vcard, "n", buf);
-               if (a==1) strcpy(tmpaddr,buf);
-               if (a==2) strcpy(tmpcity,buf);
-               if (a==3) strcpy(tmpstate,buf);
+               if (a==1) strcpy(tmpaddr, buf);
+               if (a==2) strcpy(tmpcity, buf);
+               if (a==3) strcpy(tmpstate, buf);
                if (a==4) {
                        for (c=0; c<strlen(buf); ++c) {
-                               if ((buf[c]>='0')&&(buf[c]<='9')) {
-                                       b=strlen(tmpzip);
-                                       tmpzip[b]=buf[c];
-                                       tmpzip[b+1]=0;
-                                       }
+                               if ((buf[c]>='0') && (buf[c]<='9')) {
+                                       b = strlen(tmpzip);
+                                       tmpzip[b] = buf[c];
+                                       tmpzip[b+1] = 0;
                                }
                        }
-               if (a==5) {
-                       strcpy(tmpphone, "");
-                       for (c=0; c<strlen(buf); ++c) {
-                               if ((buf[c]>='0')&&(buf[c]<='9')) {
-                                       b=strlen(tmpphone);
-                                       tmpphone[b]=buf[c];
-                                       tmpphone[b+1]=0;
-                                       }
-                               }
-                       vcard_set_prop(my_vcard, "tel;home", tmpphone);
-                       }
+               }
+               if (a==5) vcard_set_prop(my_vcard, "tel;home", buf);
                if (a==6) vcard_set_prop(my_vcard, "email;internet", buf);
+               if (a==7) strcpy(tmpcountry, buf);
                ++a;
-               }
-       sprintf(tmpaddress, ";;%s;%s;%s;%s;USA",
-               tmpaddr, tmpcity, tmpstate, tmpzip);
+       }
+
+       sprintf(tmpaddress, ";;%s;%s;%s;%s;%s",
+               tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
        vcard_set_prop(my_vcard, "adr", tmpaddress);
        vcard_write_user(&CC->usersupp, my_vcard);
        vcard_free(my_vcard);
@@ -251,21 +432,21 @@ void cmd_regi(char *argbuf) {
        CitControl.MMflags = CitControl.MMflags | MM_VALID ;
        put_control();
        end_critical_section(S_CONTROL);
-       }
+}
 
 
 
 /*
- * get registration info for a user
+ * Protocol command to fetch registration info for a user
  */
 void cmd_greg(char *argbuf)
 {
        struct usersupp usbuf;
        struct vCard *v;
-       char *tel;
-       char who[256];
-       char adr[256];
-       char buf[256];
+       char *s;
+       char who[SIZ];
+       char adr[SIZ];
+       char buf[SIZ];
 
        extract(who, argbuf, 0);
 
@@ -292,9 +473,11 @@ void cmd_greg(char *argbuf)
        cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
        cprintf("%ld\n", usbuf.usernum);
        cprintf("%s\n", usbuf.password);
-       cprintf("%s\n", vcard_get_prop(v, "n", 0));     /* name */
+       s = vcard_get_prop(v, "n", 0);
+       cprintf("%s\n", s ? s : " ");   /* name */
 
-       sprintf(adr, "%s", vcard_get_prop(v, "adr", 0));/* address... */
+       s = vcard_get_prop(v, "adr", 0);
+       sprintf(adr, "%s", s ? s : " ");/* address... */
 
        extract_token(buf, adr, 2, ';');
        cprintf("%s\n", buf);                           /* street */
@@ -305,35 +488,80 @@ void cmd_greg(char *argbuf)
        extract_token(buf, adr, 5, ';');
        cprintf("%s\n", buf);                           /* zip */
 
-       tel = vcard_get_prop(v, "tel;home", 0);
-       if (tel == NULL) tel = vcard_get_prop(v, "tel", 1);
-       if (tel != NULL) {
-               cprintf("%s\n", tel);
-               }
+       s = vcard_get_prop(v, "tel;home", 0);
+       if (s == NULL) s = vcard_get_prop(v, "tel", 1);
+       if (s != NULL) {
+               cprintf("%s\n", s);
+       }
        else {
                cprintf(" \n");
        }
 
        cprintf("%d\n", usbuf.axlevel);
 
-       cprintf("%s\n", vcard_get_prop(v, "email;internet", 0));
+       s = vcard_get_prop(v, "email;internet", 0);
+       cprintf("%s\n", s ? s : " ");
+       s = vcard_get_prop(v, "adr", 0);
+       sprintf(adr, "%s", s ? s : " ");/* address... */
+
+       extract_token(buf, adr, 6, ';');
+       cprintf("%s\n", buf);                           /* country */
        cprintf("000\n");
-       }
+}
+
+
+/*
+ * When a user is being deleted, we have to remove his/her vCard.
+ * This is accomplished by issuing a message with 'CANCEL' in the S (special)
+ * field, and the same Extended ID as the existing card.
+ */
+void vcard_purge(char *username, long usernum) {
+       struct CtdlMessage *msg;
+       char buf[SIZ];
+
+       msg = (struct CtdlMessage *) mallok(sizeof(struct CtdlMessage));
+       if (msg == NULL) return;
+       memset(msg, 0, sizeof(struct CtdlMessage));
+
+        msg->cm_magic = CTDLMESSAGE_MAGIC;
+        msg->cm_anon_type = MES_NORMAL;
+        msg->cm_format_type = 0;
+        msg->cm_fields['A'] = strdoop(username);
+        msg->cm_fields['O'] = strdoop(ADDRESS_BOOK_ROOM);
+        msg->cm_fields['N'] = strdoop(NODENAME);
+        msg->cm_fields['M'] = strdoop("Purge this vCard\n");
 
+        sprintf(buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
+        msg->cm_fields['E'] = strdoop(buf);
 
+       msg->cm_fields['S'] = strdoop("CANCEL");
 
+        CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM);
+        CtdlFreeMessage(msg);
+}
+       
+       
+
+
+/*
+ * Session startup, allocate some per-session data
+ */
 void vcard_session_startup_hook(void) {
        CtdlAllocUserData(SYM_VCARD, sizeof(struct vcard_internal_info));
 }
 
 
-
 char *Dynamic_Module_Init(void)
 {
        SYM_VCARD = CtdlGetDynamicSymbol();
        CtdlRegisterSessionHook(vcard_session_startup_hook, EVT_START);
-       CtdlRegisterMessageHook(vcard_personal_upload, EVT_BEFORESAVE);
+       CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
+       CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
        CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
        CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
+       CtdlRegisterProtoHook(cmd_igab, "IGAB",
+                                       "Initialize Global Address Book");
+       CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
+       create_room(ADDRESS_BOOK_ROOM, 3, "", 0, 1);
        return "$Id$";
 }