2 * A server-side module for Citadel which supports address book information
3 * using the standard vCard format.
5 * Copyright (c) 1999-2012 by the citadel.org team
7 * This program is open source software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 3.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 * Format of the "Exclusive ID" field of the message containing a user's
18 * vCard. Doesn't matter what it really looks like as long as it's both
19 * unique and consistent (because we use it for replication checking to
20 * delete the old vCard network-wide when the user enters a new one).
22 #define VCARD_EXT_FORMAT "Citadel vCard: personal card for %s at %s"
25 * Citadel will accept either text/vcard or text/x-vcard as the MIME type
26 * for a vCard. The following definition determines which one it *generates*
29 #define VCARD_MIME_TYPE "text/x-vcard"
40 #include <sys/types.h>
42 #if TIME_WITH_SYS_TIME
43 # include <sys/time.h>
47 # include <sys/time.h>
56 #include <libcitadel.h>
59 #include "citserver.h"
67 #include "internet_addressing.h"
68 #include "serv_vcard.h"
69 #include "citadel_ldap.h"
70 #include "ctdl_module.h"
73 * set global flag calling for an aide to validate new users
75 void set_mm_valid(void) {
76 begin_critical_section(S_CONTROL);
78 CitControl.MMflags = CitControl.MMflags | MM_VALID ;
80 end_critical_section(S_CONTROL);
86 * Extract Internet e-mail addresses from a message containing a vCard, and
87 * perform a callback for any found.
89 void vcard_extract_internet_addresses(struct CtdlMessage *msg, int (*callback)(char *, char *) ) {
94 char citadel_address[SIZ];
96 int found_something = 0;
98 if (CM_IsEmpty(msg, eAuthor)) return;
99 if (CM_IsEmpty(msg, eNodeName)) return;
100 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
101 msg->cm_fields[eAuthor], msg->cm_fields[eNodeName]);
103 v = vcard_load(msg->cm_fields[eMesageText]);
104 if (v == NULL) return;
106 /* Go through the vCard searching for *all* instances of
107 * the "email;internet" key
110 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
111 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
112 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
115 if (!IsEmptyStr(addr)) {
116 if (callback != NULL) {
117 callback(addr, citadel_address);
126 } while(found_something);
133 * Callback for vcard_add_to_directory()
134 * (Lotsa ugly nested callbacks. Oh well.)
136 int vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
137 struct CitContext *CCC = CC;
140 /* We have to validate that we're not stepping on someone else's
141 * email address ... but only if we're logged in. Otherwise it's
142 * probably just the networker or something.
144 if (CCC->logged_in) {
145 syslog(LOG_DEBUG, "Checking for <%s>...", internet_addr);
146 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
147 if (strcasecmp(buf, citadel_addr)) {
148 /* This address belongs to someone else.
149 * Bail out silently without saving.
151 syslog(LOG_DEBUG, "DOOP!");
153 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ALREADY_EXISTS);
154 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
155 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
156 StrBufAppendBufPlain(CCC->StatusMessage, _("Unable to add this email address again."), -1, 0);
157 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("\n"), 0);
162 syslog(LOG_INFO, "Adding %s (%s) to directory", citadel_addr, internet_addr);
163 if (CtdlDirectoryAddUser(internet_addr, citadel_addr))
165 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", CIT_OK);
166 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
167 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
168 StrBufAppendBufPlain(CCC->StatusMessage, _("Successfully added email address."), -1, 0);
173 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
174 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
175 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
176 StrBufAppendBufPlain(CCC->StatusMessage, _("Unable to add this email address. It does not match any local domain."), -1, 0);
183 * Back end function for cmd_igab()
185 void vcard_add_to_directory(long msgnum, void *data) {
186 struct CtdlMessage *msg;
188 msg = CtdlFetchMessage(msgnum, 1, 1);
190 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
198 * Initialize Global Adress Book
200 void cmd_igab(char *argbuf) {
201 char hold_rm[ROOMNAMELEN];
203 if (CtdlAccessCheck(ac_aide)) return;
205 strcpy(hold_rm, CC->room.QRname); /* save current room */
207 if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
208 CtdlGetRoom(&CC->room, hold_rm);
209 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
213 /* Empty the existing database first.
217 /* We want *all* vCards in this room */
218 NewStrBufDupAppendFlush(&CC->StatusMessage, NULL, NULL, 0);
219 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
220 NULL, vcard_add_to_directory, NULL);
222 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
223 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
230 * See if there is a valid Internet address in a vCard to use for outbound
231 * Internet messages. If there is, stick it in the buffer.
233 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
234 char *secemailaddrbuf, size_t secemailaddrbuf_len,
236 int local_addrs_only)
238 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
241 int IsDirectoryAddress;
242 int saved_instance = 0;
244 /* Go through the vCard searching for *all* Internet email addresses
246 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
247 k = vcard_get_prop(v, "email", 1, instance, 1);
248 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
251 if (!IsEmptyStr(addr)) {
252 IsDirectoryAddress = IsDirectory(addr, 1);
253 if ( IsDirectoryAddress || !local_addrs_only)
256 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
257 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
259 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
260 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
262 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
263 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
264 < secemailaddrbuf_len ) {
265 strcat(secemailaddrbuf, "|");
266 strcat(secemailaddrbuf, addr);
270 if (!IsDirectoryAddress && local_addrs_only)
272 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
273 StrBufAppendBufPlain(CCC->StatusMessage, addr, -1, 0);
274 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
275 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
287 * See if there is a name / screen name / friendly name in a vCard to use for outbound
288 * Internet messages. If there is, stick it in the buffer.
290 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
294 s = vcard_get_prop(v, "fn", 1, 0, 0);
296 s = vcard_get_prop(v, "n", 1, 0, 0);
300 safestrncpy(namebuf, s, namebuf_len);
306 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
308 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
309 void *content, char *cbtype, char *cbcharset, size_t length,
310 char *encoding, char *cbid, void *cbuserdata)
312 struct vCard **v = (struct vCard **) cbuserdata;
314 if ( (!strcasecmp(cbtype, "text/x-vcard"))
315 || (!strcasecmp(cbtype, "text/vcard")) ) {
317 syslog(LOG_DEBUG, "Part %s contains a vCard! Loading...", partnum);
321 *v = vcard_load(content);
327 * This handler detects whether the user is attempting to save a new
328 * vCard as part of his/her personal configuration, and handles the replace
329 * function accordingly (delete the user's existing vCard in the config room
330 * and in the global address book).
332 int vcard_upload_beforesave(struct CtdlMessage *msg, recptypes *recp) {
333 struct CitContext *CCC = CC;
336 struct ctdluser usbuf;
338 struct vCard *v = NULL;
341 int yes_my_citadel_config = 0;
342 int yes_any_vcard_room = 0;
344 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
346 /* Is this some user's "My Citadel Config" room? */
347 if (((CCC->room.QRflags & QR_MAILBOX) != 0) &&
348 (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
349 /* Yes, we want to do this */
350 yes_my_citadel_config = 1;
351 #ifdef VCARD_SAVES_BY_AIDES_ONLY
352 /* Prevent non-aides from performing registration changes, but ldap is ok. */
353 if ((CCC->user.axlevel < AxAideU) && (CCC->vcard_updated_by_ldap==0)) {
360 /* Is this a room with an address book in it? */
361 if (CCC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
362 yes_any_vcard_room = 1;
365 /* If neither condition exists, don't run this hook. */
366 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
370 /* If this isn't a MIME message, don't bother. */
371 if (msg->cm_format_type != 4) return(0);
373 /* Ok, if we got this far, look into the situation further... */
375 if (CM_IsEmpty(msg, eMesageText)) return(0);
377 mime_parser(CM_RANGE(msg, eMesageText),
378 *vcard_extract_vcard,
380 &v, /* user data ptr - put the vcard here */
384 if (v == NULL) return(0); /* no vCards were found in this message */
386 /* If users cannot create their own accounts, they cannot re-register either. */
387 if ( (yes_my_citadel_config) &&
388 (config.c_disable_newu) &&
389 (CCC->user.axlevel < AxAideU) &&
390 (CCC->vcard_updated_by_ldap==0) )
395 vcard_get_prop(v, "fn", 1, 0, 0);
398 if (yes_my_citadel_config) {
399 /* Bingo! The user is uploading a new vCard, so
400 * delete the old one. First, figure out which user
401 * is being re-registered...
403 what_user = atol(CCC->room.QRname);
405 if (what_user == CCC->user.usernum) {
406 /* It's the logged in user. That was easy. */
407 memcpy(&usbuf, &CCC->user, sizeof(struct ctdluser));
410 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
411 /* We fetched a valid user record */
415 /* somebody set up us the bomb! */
416 yes_my_citadel_config = 0;
420 if (yes_my_citadel_config) {
421 /* Delete the user's old vCard. This would probably
422 * get taken care of by the replication check, but we
423 * want to make sure there is absolutely only one
424 * vCard in the user's config room at all times.
427 CtdlDeleteMessages(CCC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
429 /* Make the author of the message the name of the user. */
430 CM_SetField(msg, eAuthor, usbuf.fullname, strlen(usbuf.fullname));
433 /* Insert or replace RFC2739-compliant free/busy URL */
434 if (yes_my_citadel_config) {
435 sprintf(buf, "http://%s/%s.vfb",
438 for (i=0; buf[i]; ++i) {
439 if (buf[i] == ' ') buf[i] = '_';
441 vcard_set_prop(v, "FBURL;PREF", buf, 0);
445 s = vcard_get_prop(v, "UID", 1, 0, 0);
446 if (s == NULL) { /* Note LDAP auth sets UID from the LDAP UUID, use that if it exists. */
447 /* Enforce local UID policy if applicable */
448 if (yes_my_citadel_config) {
449 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields[eAuthor], NODENAME);
451 /* If the vCard has no UID, then give it one. */
454 vcard_set_prop(v, "UID", buf, 0);
459 * Set the EUID of the message to the UID of the vCard.
461 CM_FlushField(msg, eExclusiveID);
463 s = vcard_get_prop(v, "UID", 1, 0, 0);
465 CM_SetField(msg, eExclusiveID, s, strlen(s));
466 if (CM_IsEmpty(msg, eMsgSubject)) {
467 CM_CopyField(msg, eMsgSubject, eExclusiveID);
472 * Set the Subject to the name in the vCard.
474 s = vcard_get_prop(v, "FN", 1, 0, 0);
476 s = vcard_get_prop(v, "N", 1, 0, 0);
479 CM_SetField(msg, eMsgSubject, s, strlen(s));
482 /* Re-serialize it back into the msg body */
483 ser = vcard_serialize(v);
488 serlen = strlen(ser);
489 buf = NewStrBufPlain(NULL, serlen + 1024);
491 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
492 StrBufAppendBufPlain(buf, ser, serlen, 0);
493 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
494 CM_SetAsFieldSB(msg, eMesageText, &buf);
498 /* Now allow the save to complete. */
506 * This handler detects whether the user is attempting to save a new
507 * vCard as part of his/her personal configuration, and handles the replace
508 * function accordingly (copy the vCard from the config room to the global
511 int vcard_upload_aftersave(struct CtdlMessage *msg, recptypes *recp) {
512 struct CitContext *CCC = CC;
518 int is_MY_UserConf=0;
520 char roomname[ROOMNAMELEN];
522 if (msg->cm_format_type != 4) return(0);
523 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
525 /* We're interested in user config rooms only. */
527 if ( (strlen(CCC->room.QRname) >= 12) && (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
528 is_UserConf = 1; /* It's someone's config room */
530 CtdlMailboxName(roomname, sizeof roomname, &CCC->user, USERCONFIGROOM);
531 if (!strcasecmp(CCC->room.QRname, roomname)) {
533 is_MY_UserConf = 1; /* It's MY config room */
535 if (!strcasecmp(CCC->room.QRname, ADDRESS_BOOK_ROOM)) {
536 is_GAB = 1; /* It's the Global Address Book */
539 if (!is_UserConf && !is_GAB) return(0);
541 if (CM_IsEmpty(msg, eMesageText))
544 ptr = msg->cm_fields[eMesageText];
546 CCC->vcard_updated_by_ldap=0; /* As this will write LDAP's previous changes, disallow LDAP change auth until next LDAP change. */
548 NewStrBufDupAppendFlush(&CCC->StatusMessage, NULL, NULL, 0);
550 StrBufPrintf(CCC->StatusMessage, "%d\n", LISTING_FOLLOWS);
552 while (ptr != NULL) {
554 linelen = strcspn(ptr, "\n");
555 if (linelen == 0) return(0); /* end of headers */
557 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
558 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
560 * Bingo! The user is uploading a new vCard, so
561 * copy it to the Global Address Book room.
564 I = atol(msg->cm_fields[eVltMsgNum]);
565 if (I <= 0L) return(0);
567 /* Store our Internet return address in memory */
568 if (is_MY_UserConf) {
569 v = vcard_load(msg->cm_fields[eMesageText]);
570 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
571 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
573 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
578 { // This is not the GAB
579 /* Put it in the Global Address Book room... */
580 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
583 /* ...and also in the directory database. */
584 vcard_add_to_directory(I, NULL);
586 /* Some sites want an Aide to be notified when a
587 * user registers or re-registers
588 * But if the user was an Aide or was edited by an Aide then we can
589 * Assume they don't need validating.
591 if (CCC->user.axlevel >= AxAideU) {
592 CtdlLockGetCurrentUser();
593 CCC->user.flags |= US_REGIS;
594 CtdlPutCurrentUserLock();
600 /* ...which also means we need to flag the user */
601 CtdlLockGetCurrentUser();
602 CCC->user.flags |= (US_REGIS|US_NEEDVALID);
603 CtdlPutCurrentUserLock();
608 ptr = strchr((char *)ptr, '\n');
609 if (ptr != NULL) ++ptr;
618 * back end function used for callbacks
620 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
623 msgnum = (long *) userdata;
624 *msgnum = supplied_msgnum;
629 * If this user has a vcard on disk, read it into memory, otherwise allocate
630 * and return an empty vCard.
632 struct vCard *vcard_get_user(struct ctdluser *u) {
633 struct CitContext *CCC = CC;
634 char hold_rm[ROOMNAMELEN];
635 char config_rm[ROOMNAMELEN];
636 struct CtdlMessage *msg = NULL;
640 strcpy(hold_rm, CCC->room.QRname); /* save current room */
641 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
643 if (CtdlGetRoom(&CCC->room, config_rm) != 0) {
644 CtdlGetRoom(&CCC->room, hold_rm);
648 /* We want the last (and probably only) vcard in this room */
650 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
651 NULL, vcard_gu_backend, (void *)&VCmsgnum );
652 CtdlGetRoom(&CCC->room, hold_rm); /* return to saved room */
654 if (VCmsgnum < 0L) return vcard_new();
656 msg = CtdlFetchMessage(VCmsgnum, 1, 1);
657 if (msg == NULL) return vcard_new();
659 v = vcard_load(msg->cm_fields[eMesageText]);
666 * Store this user's vCard in the appropriate place
669 * Write our config to disk
671 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
674 ser = vcard_serialize(v);
676 ser = strdup("begin:vcard\r\nend:vcard\r\n");
680 /* This handy API function does all the work for us.
681 * NOTE: normally we would want to set that last argument to 1, to
682 * force the system to delete the user's old vCard. But it doesn't
683 * have to, because the vcard_upload_beforesave() hook above
684 * is going to notice what we're trying to do, and delete the old vCard.
686 CtdlWriteObject(USERCONFIGROOM, /* which room */
687 VCARD_MIME_TYPE, /* MIME type */
689 strlen(ser)+1, /* length */
692 0, /* don't delete others of this type */
701 * Old style "enter registration info" command. This function simply honors
702 * the REGI protocol command, translates the entered parameters into a vCard,
703 * and enters the vCard into the user's configuration.
705 void cmd_regi(char *argbuf) {
706 struct CitContext *CCC = CC;
709 struct vCard *my_vcard;
715 char tmpaddress[SIZ];
716 char tmpcountry[SIZ];
720 if (!(CCC->logged_in)) {
721 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
725 /* If users cannot create their own accounts, they cannot re-register either. */
726 if ( (config.c_disable_newu) && (CCC->user.axlevel < AxAideU) ) {
727 cprintf("%d Self-service registration is not allowed here.\n",
728 ERROR + HIGHER_ACCESS_REQUIRED);
731 my_vcard = vcard_get_user(&CCC->user);
734 strcpy(tmpstate, "");
736 strcpy(tmpcountry, "USA");
738 cprintf("%d Send registration...\n", SEND_LISTING);
740 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
741 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
742 if (a==1) strcpy(tmpaddr, buf);
743 if (a==2) strcpy(tmpcity, buf);
744 if (a==3) strcpy(tmpstate, buf);
746 for (c=0; buf[c]; ++c) {
747 if ((buf[c]>='0') && (buf[c]<='9')) {
754 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
755 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
756 if (a==7) strcpy(tmpcountry, buf);
760 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
761 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
762 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
763 vcard_write_user(&CCC->user, my_vcard);
764 vcard_free(my_vcard);
769 * Protocol command to fetch registration info for a user
771 void cmd_greg(char *argbuf)
773 struct CitContext *CCC = CC;
774 struct ctdluser usbuf;
777 char who[USERNAME_SIZE];
781 extract_token(who, argbuf, 0, '|', sizeof who);
783 if (!(CCC->logged_in)) {
784 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
788 if (!strcasecmp(who,"_SELF_")) strcpy(who,CCC->curr_user);
790 if ((CCC->user.axlevel < AxAideU) && (strcasecmp(who,CCC->curr_user))) {
791 cprintf("%d Higher access required.\n",
792 ERROR + HIGHER_ACCESS_REQUIRED);
796 if (CtdlGetUser(&usbuf, who) != 0) {
797 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
801 v = vcard_get_user(&usbuf);
803 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
804 cprintf("%ld\n", usbuf.usernum);
805 cprintf("%s\n", usbuf.password);
806 s = vcard_get_prop(v, "n", 1, 0, 0);
807 cprintf("%s\n", s ? s : " "); /* name */
809 s = vcard_get_prop(v, "adr", 1, 0, 0);
810 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
812 extract_token(buf, adr, 2, ';', sizeof buf);
813 cprintf("%s\n", buf); /* street */
814 extract_token(buf, adr, 3, ';', sizeof buf);
815 cprintf("%s\n", buf); /* city */
816 extract_token(buf, adr, 4, ';', sizeof buf);
817 cprintf("%s\n", buf); /* state */
818 extract_token(buf, adr, 5, ';', sizeof buf);
819 cprintf("%s\n", buf); /* zip */
821 s = vcard_get_prop(v, "tel", 1, 0, 0);
822 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
830 cprintf("%d\n", usbuf.axlevel);
832 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
833 cprintf("%s\n", s ? s : " ");
834 s = vcard_get_prop(v, "adr", 0, 0, 0);
835 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
837 extract_token(buf, adr, 6, ';', sizeof buf);
838 cprintf("%s\n", buf); /* country */
846 * When a user is being created, create his/her vCard.
848 void vcard_newuser(struct ctdluser *usbuf) {
853 int need_default_vcard;
855 need_default_vcard =1;
856 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
857 syslog(LOG_DEBUG, "Converted <%s> to <%s>", usbuf->fullname, vname);
859 /* Create and save the vCard */
861 if (v == NULL) return;
862 vcard_add_prop(v, "fn", usbuf->fullname);
863 vcard_add_prop(v, "n", vname);
864 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
866 #ifdef HAVE_GETPWUID_R
867 /* If using host auth mode, we add an email address based on the login */
868 if (config.c_auth_mode == AUTHMODE_HOST) {
870 char pwd_buffer[SIZ];
872 #ifdef SOLARIS_GETPWUID
873 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
874 #else // SOLARIS_GETPWUID
875 struct passwd *result = NULL;
876 syslog(LOG_DEBUG, "Searching for uid %d", usbuf->uid);
877 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
878 #endif // HAVE_GETPWUID_R
879 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
880 vcard_add_prop(v, "email;internet", buf);
881 need_default_vcard=0;
889 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
890 * into the user's vCard.
892 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
897 found_user = CtdlTryUserLDAP(usbuf->fullname, ldap_dn, sizeof ldap_dn, ldap_cn, sizeof ldap_cn, &usbuf->uid,1);
898 if (found_user == 0) {
899 if (Ctdl_LDAP_to_vCard(ldap_dn, v)) {
900 /* Allow global address book and internet directory update without login long enough to write this. */
901 CC->vcard_updated_by_ldap++; /* Otherwise we'll only update the user config. */
902 need_default_vcard=0;
903 syslog(LOG_DEBUG, "LDAP Created Initial Vcard for %s\n",usbuf->fullname);
908 if (need_default_vcard!=0) {
909 /* Everyone gets an email address based on their display name */
910 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
911 for (i=0; buf[i]; ++i) {
912 if (buf[i] == ' ') buf[i] = '_';
914 vcard_add_prop(v, "email;internet", buf);
917 vcard_write_user(usbuf, v);
923 * When a user is being deleted, we have to remove his/her vCard.
924 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
925 * field, and the same Exclusive ID as the existing card.
927 void vcard_purge(struct ctdluser *usbuf) {
928 struct CtdlMessage *msg;
932 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
933 if (msg == NULL) return;
934 memset(msg, 0, sizeof(struct CtdlMessage));
936 msg->cm_magic = CTDLMESSAGE_MAGIC;
937 msg->cm_anon_type = MES_NORMAL;
938 msg->cm_format_type = 0;
939 CM_SetField(msg, eAuthor, usbuf->fullname, strlen(usbuf->fullname));
940 CM_SetField(msg, eOriginalRoom, HKEY(ADDRESS_BOOK_ROOM));
941 CM_SetField(msg, eNodeName, CFG_KEY(c_nodename));
942 CM_SetField(msg, eMesageText, HKEY("Purge this vCard\n"));
944 len = snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
945 msg->cm_fields[eAuthor], NODENAME);
946 CM_SetField(msg, eExclusiveID, buf, len);
948 CM_SetField(msg, eSpecialField, HKEY("CANCEL"));
950 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
956 * Grab vCard directory stuff out of incoming network messages
958 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
962 if (msg == NULL) return(0);
964 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
968 if (msg->cm_format_type != 4) return(0);
970 if (CM_IsEmpty(msg, eMesageText))
973 ptr = msg->cm_fields[eMesageText];
975 while (ptr != NULL) {
977 linelen = strcspn(ptr, "\n");
978 if (linelen == 0) return(0); /* end of headers */
980 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
981 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
982 /* It's a vCard. Add it to the directory. */
983 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
987 ptr = strchr((char *)ptr, '\n');
988 if (ptr != NULL) ++ptr;
997 * When a vCard is being removed from the Global Address Book room, remove it
998 * from the directory as well.
1000 void vcard_delete_remove(char *room, long msgnum) {
1001 struct CtdlMessage *msg;
1005 if (msgnum <= 0L) return;
1007 if (room == NULL) return;
1009 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
1013 msg = CtdlFetchMessage(msgnum, 1, 1);
1014 if (msg == NULL) return;
1016 if (CM_IsEmpty(msg, eMesageText))
1019 ptr = msg->cm_fields[eMesageText];
1021 while (ptr != NULL) {
1022 linelen = strcspn(ptr, "\n");
1023 if (linelen == 0) goto EOH;
1025 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
1026 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
1027 /* Bingo! A vCard is being deleted. */
1028 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
1030 ptr = strchr((char *)ptr, '\n');
1031 if (ptr != NULL) ++ptr;
1040 * Get Valid Screen Names
1042 void cmd_gvsn(char *argbuf)
1044 struct CitContext *CCC = CC;
1046 if (CtdlAccessCheck(ac_logged_in)) return;
1048 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
1049 cprintf("%s\n", CCC->user.fullname);
1050 if ( (!IsEmptyStr(CCC->cs_inet_fn)) && (strcasecmp(CCC->user.fullname, CCC->cs_inet_fn)) ) {
1051 cprintf("%s\n", CCC->cs_inet_fn);
1058 * Get Valid Email Addresses
1060 void cmd_gvea(char *argbuf)
1062 struct CitContext *CCC = CC;
1063 int num_secondary_emails = 0;
1067 if (CtdlAccessCheck(ac_logged_in)) return;
1069 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
1070 if (!IsEmptyStr(CCC->cs_inet_email)) {
1071 cprintf("%s\n", CCC->cs_inet_email);
1073 if (!IsEmptyStr(CCC->cs_inet_other_emails)) {
1074 num_secondary_emails = num_tokens(CCC->cs_inet_other_emails, '|');
1075 for (i=0; i<num_secondary_emails; ++i) {
1076 extract_token(buf, CCC->cs_inet_other_emails,i,'|',sizeof CCC->cs_inet_other_emails);
1077 cprintf("%s\n", buf);
1087 * Callback function for cmd_dvca() that hunts for vCard content types
1088 * and outputs any email addresses found within.
1090 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1091 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1092 char *cbid, void *cbuserdata) {
1095 char displayname[256] = "";
1096 int displayname_len;
1097 char emailaddr[256] = "";
1101 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1105 v = vcard_load(content);
1106 if (v == NULL) return;
1108 extract_friendly_name(displayname, sizeof displayname, v);
1109 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1111 displayname_len = strlen(displayname);
1112 for (i=0; i<displayname_len; ++i) {
1113 if (displayname[i] == '\"') displayname[i] = ' ';
1114 if (displayname[i] == ';') displayname[i] = ',';
1115 if (displayname[i] == ',') has_commas = 1;
1117 striplt(displayname);
1119 cprintf("%s%s%s <%s>\n",
1120 (has_commas ? "\"" : ""),
1122 (has_commas ? "\"" : ""),
1131 * Back end callback function for cmd_dvca()
1133 * It's basically just passed a list of message numbers, which we're going
1134 * to fetch off the disk and then pass along to the MIME parser via another
1135 * layer of callback...
1137 void dvca_callback(long msgnum, void *userdata) {
1138 struct CtdlMessage *msg = NULL;
1140 msg = CtdlFetchMessage(msgnum, 1, 1);
1141 if (msg == NULL) return;
1142 mime_parser(CM_RANGE(msg, eMesageText),
1143 *dvca_mime_callback, /* callback function */
1145 NULL, /* user data */
1153 * Dump VCard Addresses
1155 void cmd_dvca(char *argbuf)
1157 if (CtdlAccessCheck(ac_logged_in)) return;
1159 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1160 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1168 void cmd_qdir(char *argbuf) {
1169 char citadel_addr[256];
1170 char internet_addr[256];
1172 if (CtdlAccessCheck(ac_logged_in)) return;
1174 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1176 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1177 cprintf("%d %s was not found.\n",
1178 ERROR + NO_SUCH_USER, internet_addr);
1182 cprintf("%d %s\n", CIT_OK, citadel_addr);
1186 * Query Directory, in fact an alias to match postfix tcp auth.
1188 void check_get(void) {
1189 char internet_addr[256];
1194 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1195 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1196 syslog(LOG_CRIT, "vcard client disconnected: ending session.");
1197 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1200 syslog(LOG_INFO, ": %s", cmdbuf);
1201 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1202 syslog(LOG_INFO, "[ %s]", cmdbuf);
1204 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1207 char *argbuf = &cmdbuf[4];
1209 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1210 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1211 if ((rcpt != NULL)&&
1213 (*rcpt->recp_local != '\0')||
1214 (*rcpt->recp_room != '\0')||
1215 (*rcpt->recp_ignet != '\0')))
1218 cprintf("200 OK %s\n", internet_addr);
1219 syslog(LOG_INFO, "sending 200 OK for the room %s", rcpt->display_recp);
1223 cprintf("500 REJECT noone here by that name.\n");
1225 syslog(LOG_INFO, "sending 500 REJECT no one here by that name: %s", internet_addr);
1228 free_recipients(rcpt);
1231 cprintf("500 REJECT invalid Query.\n");
1232 syslog(LOG_INFO, "sending 500 REJECT invalid query: %s", internet_addr);
1236 void check_get_greeting(void) {
1237 /* dummy function, we have no greeting in this verry simple protocol. */
1242 * We don't know if the Contacts room exists so we just create it at login
1244 void vcard_CtdlCreateRoom(void)
1249 /* Create the calendar room if it doesn't already exist */
1250 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1252 /* Set expiration policy to manual; otherwise objects will be lost! */
1253 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1254 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!");
1257 qr.QRep.expire_mode = EXPIRE_MANUAL;
1258 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1259 CtdlPutRoomLock(&qr);
1261 /* Set the view to a calendar view */
1262 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1263 vbuf.v_view = 2; /* 2 = address book view */
1264 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1273 * When a user logs in...
1275 void vcard_session_login_hook(void) {
1276 struct vCard *v = NULL;
1277 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1281 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1282 * into the user's vCard.
1284 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1285 v = vcard_get_user(&CCC->user);
1287 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1288 CCC->vcard_updated_by_ldap++; /* Make sure changes make it to the global address book and internet directory, not just the user config. */
1289 syslog(LOG_DEBUG, "LDAP Detected vcard change.\n");
1290 vcard_write_user(&CCC->user, v);
1297 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1298 * These are inserted into the session data for various message entry commands to use.
1300 v = vcard_get_user(&CCC->user);
1302 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1303 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1306 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1311 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1313 vcard_CtdlCreateRoom();
1318 * Turn an arbitrary RFC822 address into a struct vCard for possible
1319 * inclusion into an address book.
1321 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1323 char user[256], node[256], name[256], email[256], n[256], uid[256];
1327 if (v == NULL) return(NULL);
1329 process_rfc822_addr(addr, user, node, name);
1330 vcard_set_prop(v, "fn", name, 0);
1332 vcard_fn_to_n(n, name, sizeof n);
1333 vcard_set_prop(v, "n", n, 0);
1335 snprintf(email, sizeof email, "%s@%s", user, node);
1336 vcard_set_prop(v, "email;internet", email, 0);
1338 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1339 for (i=0; uid[i]; ++i) {
1340 if (isspace(uid[i])) uid[i] = '_';
1341 uid[i] = tolower(uid[i]);
1343 vcard_set_prop(v, "UID", uid, 0);
1351 * This is called by store_harvested_addresses() to remove from the
1352 * list any addresses we already have in our address book.
1354 void strip_addresses_already_have(long msgnum, void *userdata) {
1355 char *collected_addresses;
1356 struct CtdlMessage *msg = NULL;
1360 char addr[256], user[256], node[256], name[256];
1362 collected_addresses = (char *)userdata;
1364 msg = CtdlFetchMessage(msgnum, 1, 1);
1365 if (msg == NULL) return;
1366 v = vcard_load(msg->cm_fields[eMesageText]);
1370 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1372 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1373 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1375 /* Remove the address if we already have it! */
1376 process_rfc822_addr(addr, user, node, name);
1377 snprintf(addr, sizeof addr, "%s@%s", user, node);
1378 if (!strcasecmp(value, addr)) {
1379 remove_token(collected_addresses, j, ',');
1391 * Back end function for store_harvested_addresses()
1393 void store_this_ha(struct addresses_to_be_filed *aptr) {
1394 struct CtdlMessage *vmsg = NULL;
1396 struct vCard *v = NULL;
1397 char recipient[256];
1400 /* First remove any addresses we already have in the address book */
1401 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL, NULL, NULL);
1402 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1403 strip_addresses_already_have, aptr->collected_addresses);
1405 if (!IsEmptyStr(aptr->collected_addresses))
1406 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1408 /* Make a vCard out of each address */
1409 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1411 v = vcard_new_from_rfc822_addr(recipient);
1414 vmsg = malloc(sizeof(struct CtdlMessage));
1415 memset(vmsg, 0, sizeof(struct CtdlMessage));
1416 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1417 vmsg->cm_anon_type = MES_NORMAL;
1418 vmsg->cm_format_type = FMT_RFC822;
1419 CM_SetField(vmsg, eAuthor, HKEY("Citadel"));
1420 s = vcard_get_prop(v, "UID", 1, 0, 0);
1421 CM_SetField(vmsg, eExclusiveID, s, strlen(s));
1422 ser = vcard_serialize(v);
1427 serlen = strlen(ser);
1428 buf = NewStrBufPlain(NULL, serlen + 1024);
1430 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
1431 StrBufAppendBufPlain(buf, ser, serlen, 0);
1432 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
1433 CM_SetAsFieldSB(vmsg, eMesageText, &buf);
1438 syslog(LOG_DEBUG, "Adding contact: %s", recipient);
1439 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1444 free(aptr->roomname);
1445 free(aptr->collected_addresses);
1451 * When a user sends a message, we may harvest one or more email addresses
1452 * from the recipient list to be added to the user's address book. But we
1453 * want to do this asynchronously so it doesn't keep the user waiting.
1455 void store_harvested_addresses(void) {
1457 struct addresses_to_be_filed *aptr = NULL;
1459 if (atbf == NULL) return;
1461 begin_critical_section(S_ATBF);
1462 while (atbf != NULL) {
1465 end_critical_section(S_ATBF);
1466 store_this_ha(aptr);
1467 begin_critical_section(S_ATBF);
1469 end_critical_section(S_ATBF);
1474 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1475 * really this is just so we expose the vCard data to the full text indexer.
1477 void vcard_fixed_output(char *ptr, int len) {
1478 char *serialized_vcard;
1483 serialized_vcard = malloc(len + 1);
1484 safestrncpy(serialized_vcard, ptr, len+1);
1485 v = vcard_load(serialized_vcard);
1486 free(serialized_vcard);
1489 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1490 value = vcard_get_prop(v, "", 0, i++, 0);
1491 cprintf("%s\n", value);
1498 const char *CitadelServiceDICT_TCP="DICT_TCP";
1500 CTDL_MODULE_INIT(vcard)
1509 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN, PRIO_LOGIN + 70);
1510 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1511 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1512 CtdlRegisterDeleteHook(vcard_delete_remove);
1513 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1514 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1515 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1516 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1517 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1518 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1519 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1520 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1521 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1522 CtdlRegisterNetprocHook(vcard_extract_from_network);
1523 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER, PRIO_CLEANUP + 470);
1524 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1525 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1527 /* Create the Global ADdress Book room if necessary */
1528 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1530 /* Set expiration policy to manual; otherwise objects will be lost! */
1531 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1532 qr.QRep.expire_mode = EXPIRE_MANUAL;
1533 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1534 CtdlPutRoomLock(&qr);
1537 * Also make sure it has a netconfig file, so the networker runs
1538 * on this room even if we don't share it with any other nodes.
1539 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1542 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1543 fp = fopen(filename, "a");
1544 if (fp != NULL) fclose(fp);
1545 rv = chown(filename, CTDLUID, (-1));
1547 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]",
1548 filename, strerror(errno));
1549 rv = chmod(filename, 0600);
1551 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]",
1552 filename, strerror(errno));
1555 /* for postfix tcpdict */
1556 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1561 CitadelServiceDICT_TCP);
1564 /* return our module name for the log */