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"
66 #include "internet_addressing.h"
67 #include "serv_vcard.h"
68 #include "citadel_ldap.h"
69 #include "ctdl_module.h"
72 * set global flag calling for an aide to validate new users
74 void set_mm_valid(void) {
75 begin_critical_section(S_CONTROL);
77 CitControl.MMflags = CitControl.MMflags | MM_VALID ;
79 end_critical_section(S_CONTROL);
85 * Extract Internet e-mail addresses from a message containing a vCard, and
86 * perform a callback for any found.
88 void vcard_extract_internet_addresses(struct CtdlMessage *msg, int (*callback)(char *, char *) ) {
93 char citadel_address[SIZ];
95 int found_something = 0;
97 if (msg->cm_fields[eAuthor] == NULL) return;
98 if (msg->cm_fields[eNodeName] == NULL) return;
99 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
100 msg->cm_fields[eAuthor], msg->cm_fields[eNodeName]);
102 v = vcard_load(msg->cm_fields[eMesageText]);
103 if (v == NULL) return;
105 /* Go through the vCard searching for *all* instances of
106 * the "email;internet" key
109 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
110 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
111 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
114 if (!IsEmptyStr(addr)) {
115 if (callback != NULL) {
116 callback(addr, citadel_address);
125 } while(found_something);
132 * Callback for vcard_add_to_directory()
133 * (Lotsa ugly nested callbacks. Oh well.)
135 int vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
136 struct CitContext *CCC = CC;
139 /* We have to validate that we're not stepping on someone else's
140 * email address ... but only if we're logged in. Otherwise it's
141 * probably just the networker or something.
143 if (CCC->logged_in) {
144 syslog(LOG_DEBUG, "Checking for <%s>...", internet_addr);
145 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
146 if (strcasecmp(buf, citadel_addr)) {
147 /* This address belongs to someone else.
148 * Bail out silently without saving.
150 syslog(LOG_DEBUG, "DOOP!");
152 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ALREADY_EXISTS);
153 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
154 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
155 StrBufAppendBufPlain(CCC->StatusMessage, _("Unable to add this email address again."), -1, 0);
156 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("\n"), 0);
161 syslog(LOG_INFO, "Adding %s (%s) to directory", citadel_addr, internet_addr);
162 if (CtdlDirectoryAddUser(internet_addr, citadel_addr))
164 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", CIT_OK);
165 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
166 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
167 StrBufAppendBufPlain(CCC->StatusMessage, _("Successfully added email address."), -1, 0);
172 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
173 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
174 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
175 StrBufAppendBufPlain(CCC->StatusMessage, _("Unable to add this email address. It does not match any local domain."), -1, 0);
182 * Back end function for cmd_igab()
184 void vcard_add_to_directory(long msgnum, void *data) {
185 struct CtdlMessage *msg;
187 msg = CtdlFetchMessage(msgnum, 1);
189 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
192 CtdlFreeMessage(msg);
197 * Initialize Global Adress Book
199 void cmd_igab(char *argbuf) {
200 char hold_rm[ROOMNAMELEN];
202 if (CtdlAccessCheck(ac_aide)) return;
204 strcpy(hold_rm, CC->room.QRname); /* save current room */
206 if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
207 CtdlGetRoom(&CC->room, hold_rm);
208 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
212 /* Empty the existing database first.
216 /* We want *all* vCards in this room */
217 NewStrBufDupAppendFlush(&CC->StatusMessage, NULL, NULL, 0);
218 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
219 NULL, vcard_add_to_directory, NULL);
221 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
222 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
229 * See if there is a valid Internet address in a vCard to use for outbound
230 * Internet messages. If there is, stick it in the buffer.
232 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
233 char *secemailaddrbuf, size_t secemailaddrbuf_len,
235 int local_addrs_only)
237 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
240 int IsDirectoryAddress;
241 int saved_instance = 0;
243 /* Go through the vCard searching for *all* Internet email addresses
245 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
246 k = vcard_get_prop(v, "email", 1, instance, 1);
247 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
250 if (!IsEmptyStr(addr)) {
251 IsDirectoryAddress = IsDirectory(addr, 1);
252 if ( IsDirectoryAddress || !local_addrs_only)
255 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
256 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
258 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
259 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
261 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
262 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
263 < secemailaddrbuf_len ) {
264 strcat(secemailaddrbuf, "|");
265 strcat(secemailaddrbuf, addr);
269 if (!IsDirectoryAddress && local_addrs_only)
271 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
272 StrBufAppendBufPlain(CCC->StatusMessage, addr, -1, 0);
273 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
274 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
286 * See if there is a name / screen name / friendly name in a vCard to use for outbound
287 * Internet messages. If there is, stick it in the buffer.
289 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
293 s = vcard_get_prop(v, "fn", 1, 0, 0);
295 s = vcard_get_prop(v, "n", 1, 0, 0);
299 safestrncpy(namebuf, s, namebuf_len);
305 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
307 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
308 void *content, char *cbtype, char *cbcharset, size_t length,
309 char *encoding, char *cbid, void *cbuserdata)
311 struct vCard **v = (struct vCard **) cbuserdata;
313 if ( (!strcasecmp(cbtype, "text/x-vcard"))
314 || (!strcasecmp(cbtype, "text/vcard")) ) {
316 syslog(LOG_DEBUG, "Part %s contains a vCard! Loading...", partnum);
320 *v = vcard_load(content);
326 * This handler detects whether the user is attempting to save a new
327 * vCard as part of his/her personal configuration, and handles the replace
328 * function accordingly (delete the user's existing vCard in the config room
329 * and in the global address book).
331 int vcard_upload_beforesave(struct CtdlMessage *msg) {
332 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) return(0); /* Only do this if logged in. */
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;
352 #ifdef VCARD_SAVES_BY_AIDES_ONLY
353 /* Prevent non-aides from performing registration changes */
354 if (CCC->user.axlevel < AxAideU) {
361 /* Is this a room with an address book in it? */
362 if (CCC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
363 yes_any_vcard_room = 1;
366 /* If neither condition exists, don't run this hook. */
367 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
371 /* If this isn't a MIME message, don't bother. */
372 if (msg->cm_format_type != 4) return(0);
374 /* Ok, if we got this far, look into the situation further... */
376 ptr = msg->cm_fields[eMesageText];
377 if (ptr == NULL) return(0);
379 mime_parser(msg->cm_fields[eMesageText],
381 *vcard_extract_vcard,
383 &v, /* user data ptr - put the vcard here */
387 if (v == NULL) return(0); /* no vCards were found in this message */
389 /* If users cannot create their own accounts, they cannot re-register either. */
390 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CCC->user.axlevel < AxAideU) ) {
394 vcard_get_prop(v, "fn", 1, 0, 0);
396 if (yes_my_citadel_config) {
397 /* Bingo! The user is uploading a new vCard, so
398 * delete the old one. First, figure out which user
399 * is being re-registered...
401 what_user = atol(CCC->room.QRname);
403 if (what_user == CCC->user.usernum) {
404 /* It's the logged in user. That was easy. */
405 memcpy(&usbuf, &CCC->user, sizeof(struct ctdluser));
408 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
409 /* We fetched a valid user record */
413 /* somebody set up us the bomb! */
414 yes_my_citadel_config = 0;
418 if (yes_my_citadel_config) {
419 /* Delete the user's old vCard. This would probably
420 * get taken care of by the replication check, but we
421 * want to make sure there is absolutely only one
422 * vCard in the user's config room at all times.
425 CtdlDeleteMessages(CCC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
427 /* Make the author of the message the name of the user. */
428 if (msg->cm_fields[eAuthor] != NULL) {
429 free(msg->cm_fields[eAuthor]);
431 msg->cm_fields[eAuthor] = strdup(usbuf.fullname);
434 /* Insert or replace RFC2739-compliant free/busy URL */
435 if (yes_my_citadel_config) {
436 sprintf(buf, "http://%s/%s.vfb",
439 for (i=0; buf[i]; ++i) {
440 if (buf[i] == ' ') buf[i] = '_';
442 vcard_set_prop(v, "FBURL;PREF", buf, 0);
445 /* If the vCard has no UID, then give it one. */
446 s = vcard_get_prop(v, "UID", 1, 0, 0);
449 vcard_set_prop(v, "UID", buf, 0);
452 /* Enforce local UID policy if applicable */
453 if (yes_my_citadel_config) {
454 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields[eAuthor], NODENAME);
455 vcard_set_prop(v, "UID", buf, 0);
459 * Set the EUID of the message to the UID of the vCard.
461 if (msg->cm_fields[eExclusiveID] != NULL)
463 free(msg->cm_fields[eExclusiveID]);
464 msg->cm_fields[eExclusiveID] = NULL;
466 s = vcard_get_prop(v, "UID", 1, 0, 0);
468 msg->cm_fields[eExclusiveID] = strdup(s);
469 if (msg->cm_fields[eMsgSubject] == NULL) {
470 msg->cm_fields[eMsgSubject] = strdup(s);
475 * Set the Subject to the name in the vCard.
477 s = vcard_get_prop(v, "FN", 1, 0, 0);
479 s = vcard_get_prop(v, "N", 1, 0, 0);
482 if (msg->cm_fields[eMsgSubject] != NULL) {
483 free(msg->cm_fields[eMsgSubject]);
485 msg->cm_fields[eMsgSubject] = strdup(s);
488 /* Re-serialize it back into the msg body */
489 ser = vcard_serialize(v);
491 msg->cm_fields[eMesageText] = realloc(msg->cm_fields[eMesageText], strlen(ser) + 1024);
492 sprintf(msg->cm_fields[eMesageText],
493 "Content-type: " VCARD_MIME_TYPE
494 "\r\n\r\n%s\r\n", ser);
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) {
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) return(0); /* Only do this if logged in. */
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 ptr = msg->cm_fields[eMesageText];
542 if (ptr == NULL) return(0);
544 NewStrBufDupAppendFlush(&CCC->StatusMessage, NULL, NULL, 0);
546 StrBufPrintf(CCC->StatusMessage, "%d\n", LISTING_FOLLOWS);
548 while (ptr != NULL) {
550 linelen = strcspn(ptr, "\n");
551 if (linelen == 0) return(0); /* end of headers */
553 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
554 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
556 * Bingo! The user is uploading a new vCard, so
557 * copy it to the Global Address Book room.
560 I = atol(msg->cm_fields[eVltMsgNum]);
561 if (I <= 0L) return(0);
563 /* Store our Internet return address in memory */
564 if (is_MY_UserConf) {
565 v = vcard_load(msg->cm_fields[eMesageText]);
566 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
567 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
569 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
574 { // This is not the GAB
575 /* Put it in the Global Address Book room... */
576 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
579 /* ...and also in the directory database. */
580 vcard_add_to_directory(I, NULL);
582 /* Some sites want an Aide to be notified when a
583 * user registers or re-registers
584 * But if the user was an Aide or was edited by an Aide then we can
585 * Assume they don't need validating.
587 if (CCC->user.axlevel >= AxAideU) {
588 CtdlGetUserLock(&CCC->user, CCC->curr_user);
589 CCC->user.flags |= US_REGIS;
590 CtdlPutUserLock(&CCC->user);
596 /* ...which also means we need to flag the user */
597 CtdlGetUserLock(&CCC->user, CCC->curr_user);
598 CCC->user.flags |= (US_REGIS|US_NEEDVALID);
599 CtdlPutUserLock(&CCC->user);
604 ptr = strchr((char *)ptr, '\n');
605 if (ptr != NULL) ++ptr;
614 * back end function used for callbacks
616 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
619 msgnum = (long *) userdata;
620 *msgnum = supplied_msgnum;
625 * If this user has a vcard on disk, read it into memory, otherwise allocate
626 * and return an empty vCard.
628 struct vCard *vcard_get_user(struct ctdluser *u) {
629 struct CitContext *CCC = CC;
630 char hold_rm[ROOMNAMELEN];
631 char config_rm[ROOMNAMELEN];
632 struct CtdlMessage *msg = NULL;
636 strcpy(hold_rm, CCC->room.QRname); /* save current room */
637 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
639 if (CtdlGetRoom(&CCC->room, config_rm) != 0) {
640 CtdlGetRoom(&CCC->room, hold_rm);
644 /* We want the last (and probably only) vcard in this room */
646 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
647 NULL, vcard_gu_backend, (void *)&VCmsgnum );
648 CtdlGetRoom(&CCC->room, hold_rm); /* return to saved room */
650 if (VCmsgnum < 0L) return vcard_new();
652 msg = CtdlFetchMessage(VCmsgnum, 1);
653 if (msg == NULL) return vcard_new();
655 v = vcard_load(msg->cm_fields[eMesageText]);
656 CtdlFreeMessage(msg);
662 * Store this user's vCard in the appropriate place
665 * Write our config to disk
667 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
670 ser = vcard_serialize(v);
672 ser = strdup("begin:vcard\r\nend:vcard\r\n");
676 /* This handy API function does all the work for us.
677 * NOTE: normally we would want to set that last argument to 1, to
678 * force the system to delete the user's old vCard. But it doesn't
679 * have to, because the vcard_upload_beforesave() hook above
680 * is going to notice what we're trying to do, and delete the old vCard.
682 CtdlWriteObject(USERCONFIGROOM, /* which room */
683 VCARD_MIME_TYPE, /* MIME type */
685 strlen(ser)+1, /* length */
688 0, /* don't delete others of this type */
697 * Old style "enter registration info" command. This function simply honors
698 * the REGI protocol command, translates the entered parameters into a vCard,
699 * and enters the vCard into the user's configuration.
701 void cmd_regi(char *argbuf) {
702 struct CitContext *CCC = CC;
705 struct vCard *my_vcard;
711 char tmpaddress[SIZ];
712 char tmpcountry[SIZ];
716 if (!(CCC->logged_in)) {
717 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
721 /* If users cannot create their own accounts, they cannot re-register either. */
722 if ( (config.c_disable_newu) && (CCC->user.axlevel < AxAideU) ) {
723 cprintf("%d Self-service registration is not allowed here.\n",
724 ERROR + HIGHER_ACCESS_REQUIRED);
727 my_vcard = vcard_get_user(&CCC->user);
730 strcpy(tmpstate, "");
732 strcpy(tmpcountry, "USA");
734 cprintf("%d Send registration...\n", SEND_LISTING);
736 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
737 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
738 if (a==1) strcpy(tmpaddr, buf);
739 if (a==2) strcpy(tmpcity, buf);
740 if (a==3) strcpy(tmpstate, buf);
742 for (c=0; buf[c]; ++c) {
743 if ((buf[c]>='0') && (buf[c]<='9')) {
750 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
751 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
752 if (a==7) strcpy(tmpcountry, buf);
756 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
757 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
758 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
759 vcard_write_user(&CCC->user, my_vcard);
760 vcard_free(my_vcard);
765 * Protocol command to fetch registration info for a user
767 void cmd_greg(char *argbuf)
769 struct CitContext *CCC = CC;
770 struct ctdluser usbuf;
773 char who[USERNAME_SIZE];
777 extract_token(who, argbuf, 0, '|', sizeof who);
779 if (!(CCC->logged_in)) {
780 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
784 if (!strcasecmp(who,"_SELF_")) strcpy(who,CCC->curr_user);
786 if ((CCC->user.axlevel < AxAideU) && (strcasecmp(who,CCC->curr_user))) {
787 cprintf("%d Higher access required.\n",
788 ERROR + HIGHER_ACCESS_REQUIRED);
792 if (CtdlGetUser(&usbuf, who) != 0) {
793 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
797 v = vcard_get_user(&usbuf);
799 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
800 cprintf("%ld\n", usbuf.usernum);
801 cprintf("%s\n", usbuf.password);
802 s = vcard_get_prop(v, "n", 1, 0, 0);
803 cprintf("%s\n", s ? s : " "); /* name */
805 s = vcard_get_prop(v, "adr", 1, 0, 0);
806 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
808 extract_token(buf, adr, 2, ';', sizeof buf);
809 cprintf("%s\n", buf); /* street */
810 extract_token(buf, adr, 3, ';', sizeof buf);
811 cprintf("%s\n", buf); /* city */
812 extract_token(buf, adr, 4, ';', sizeof buf);
813 cprintf("%s\n", buf); /* state */
814 extract_token(buf, adr, 5, ';', sizeof buf);
815 cprintf("%s\n", buf); /* zip */
817 s = vcard_get_prop(v, "tel", 1, 0, 0);
818 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
826 cprintf("%d\n", usbuf.axlevel);
828 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
829 cprintf("%s\n", s ? s : " ");
830 s = vcard_get_prop(v, "adr", 0, 0, 0);
831 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
833 extract_token(buf, adr, 6, ';', sizeof buf);
834 cprintf("%s\n", buf); /* country */
842 * When a user is being created, create his/her vCard.
844 void vcard_newuser(struct ctdluser *usbuf) {
850 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
851 syslog(LOG_DEBUG, "Converted <%s> to <%s>", usbuf->fullname, vname);
853 /* Create and save the vCard */
855 if (v == NULL) return;
856 vcard_add_prop(v, "fn", usbuf->fullname);
857 vcard_add_prop(v, "n", vname);
858 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
860 #ifdef HAVE_GETPWUID_R
861 /* If using host auth mode, we add an email address based on the login */
862 if (config.c_auth_mode == AUTHMODE_HOST) {
864 char pwd_buffer[SIZ];
866 #ifdef SOLARIS_GETPWUID
867 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
868 #else // SOLARIS_GETPWUID
869 struct passwd *result = NULL;
870 syslog(LOG_DEBUG, "Searching for uid %d", usbuf->uid);
871 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
872 #endif // HAVE_GETPWUID_R
873 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
874 vcard_add_prop(v, "email;internet", buf);
879 /* Everyone gets an email address based on their display name */
880 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
881 for (i=0; buf[i]; ++i) {
882 if (buf[i] == ' ') buf[i] = '_';
884 vcard_add_prop(v, "email;internet", buf);
887 vcard_write_user(usbuf, v);
893 * When a user is being deleted, we have to remove his/her vCard.
894 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
895 * field, and the same Exclusive ID as the existing card.
897 void vcard_purge(struct ctdluser *usbuf) {
898 struct CtdlMessage *msg;
901 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
902 if (msg == NULL) return;
903 memset(msg, 0, sizeof(struct CtdlMessage));
905 msg->cm_magic = CTDLMESSAGE_MAGIC;
906 msg->cm_anon_type = MES_NORMAL;
907 msg->cm_format_type = 0;
908 msg->cm_fields[eAuthor] = strdup(usbuf->fullname);
909 msg->cm_fields[eOriginalRoom] = strdup(ADDRESS_BOOK_ROOM);
910 msg->cm_fields[eNodeName] = strdup(NODENAME);
911 msg->cm_fields[eMesageText] = strdup("Purge this vCard\n");
913 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
914 msg->cm_fields[eAuthor], NODENAME);
915 msg->cm_fields[eExclusiveID] = strdup(buf);
917 msg->cm_fields[eSpecialField] = strdup("CANCEL");
919 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
920 CtdlFreeMessage(msg);
925 * Grab vCard directory stuff out of incoming network messages
927 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
931 if (msg == NULL) return(0);
933 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
937 if (msg->cm_format_type != 4) return(0);
939 ptr = msg->cm_fields[eMesageText];
940 if (ptr == NULL) return(0);
941 while (ptr != NULL) {
943 linelen = strcspn(ptr, "\n");
944 if (linelen == 0) return(0); /* end of headers */
946 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
947 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
948 /* It's a vCard. Add it to the directory. */
949 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
953 ptr = strchr((char *)ptr, '\n');
954 if (ptr != NULL) ++ptr;
963 * When a vCard is being removed from the Global Address Book room, remove it
964 * from the directory as well.
966 void vcard_delete_remove(char *room, long msgnum) {
967 struct CtdlMessage *msg;
971 if (msgnum <= 0L) return;
973 if (room == NULL) return;
975 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
979 msg = CtdlFetchMessage(msgnum, 1);
980 if (msg == NULL) return;
982 ptr = msg->cm_fields[eMesageText];
983 if (ptr == NULL) goto EOH;
984 while (ptr != NULL) {
985 linelen = strcspn(ptr, "\n");
986 if (linelen == 0) goto EOH;
988 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
989 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
990 /* Bingo! A vCard is being deleted. */
991 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
993 ptr = strchr((char *)ptr, '\n');
994 if (ptr != NULL) ++ptr;
997 EOH: CtdlFreeMessage(msg);
1003 * Get Valid Screen Names
1005 void cmd_gvsn(char *argbuf)
1007 struct CitContext *CCC = CC;
1009 if (CtdlAccessCheck(ac_logged_in)) return;
1011 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
1012 cprintf("%s\n", CCC->user.fullname);
1013 if ( (!IsEmptyStr(CCC->cs_inet_fn)) && (strcasecmp(CCC->user.fullname, CCC->cs_inet_fn)) ) {
1014 cprintf("%s\n", CCC->cs_inet_fn);
1021 * Get Valid Email Addresses
1023 void cmd_gvea(char *argbuf)
1025 struct CitContext *CCC = CC;
1026 int num_secondary_emails = 0;
1030 if (CtdlAccessCheck(ac_logged_in)) return;
1032 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
1033 if (!IsEmptyStr(CCC->cs_inet_email)) {
1034 cprintf("%s\n", CCC->cs_inet_email);
1036 if (!IsEmptyStr(CCC->cs_inet_other_emails)) {
1037 num_secondary_emails = num_tokens(CCC->cs_inet_other_emails, '|');
1038 for (i=0; i<num_secondary_emails; ++i) {
1039 extract_token(buf, CCC->cs_inet_other_emails,i,'|',sizeof CCC->cs_inet_other_emails);
1040 cprintf("%s\n", buf);
1050 * Callback function for cmd_dvca() that hunts for vCard content types
1051 * and outputs any email addresses found within.
1053 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1054 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1055 char *cbid, void *cbuserdata) {
1058 char displayname[256] = "";
1059 int displayname_len;
1060 char emailaddr[256] = "";
1064 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1068 v = vcard_load(content);
1069 if (v == NULL) return;
1071 extract_friendly_name(displayname, sizeof displayname, v);
1072 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1074 displayname_len = strlen(displayname);
1075 for (i=0; i<displayname_len; ++i) {
1076 if (displayname[i] == '\"') displayname[i] = ' ';
1077 if (displayname[i] == ';') displayname[i] = ',';
1078 if (displayname[i] == ',') has_commas = 1;
1080 striplt(displayname);
1082 cprintf("%s%s%s <%s>\n",
1083 (has_commas ? "\"" : ""),
1085 (has_commas ? "\"" : ""),
1094 * Back end callback function for cmd_dvca()
1096 * It's basically just passed a list of message numbers, which we're going
1097 * to fetch off the disk and then pass along to the MIME parser via another
1098 * layer of callback...
1100 void dvca_callback(long msgnum, void *userdata) {
1101 struct CtdlMessage *msg = NULL;
1103 msg = CtdlFetchMessage(msgnum, 1);
1104 if (msg == NULL) return;
1105 mime_parser(msg->cm_fields[eMesageText],
1107 *dvca_mime_callback, /* callback function */
1109 NULL, /* user data */
1112 CtdlFreeMessage(msg);
1117 * Dump VCard Addresses
1119 void cmd_dvca(char *argbuf)
1121 if (CtdlAccessCheck(ac_logged_in)) return;
1123 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1124 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1132 void cmd_qdir(char *argbuf) {
1133 char citadel_addr[256];
1134 char internet_addr[256];
1136 if (CtdlAccessCheck(ac_logged_in)) return;
1138 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1140 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1141 cprintf("%d %s was not found.\n",
1142 ERROR + NO_SUCH_USER, internet_addr);
1146 cprintf("%d %s\n", CIT_OK, citadel_addr);
1150 * Query Directory, in fact an alias to match postfix tcp auth.
1152 void check_get(void) {
1153 char internet_addr[256];
1158 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1159 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1160 syslog(LOG_CRIT, "vcard client disconnected: ending session.");
1161 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1164 syslog(LOG_INFO, ": %s", cmdbuf);
1165 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1166 syslog(LOG_INFO, "[ %s]", cmdbuf);
1168 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1170 struct recptypes *rcpt;
1171 char *argbuf = &cmdbuf[4];
1173 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1174 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1175 if ((rcpt != NULL)&&
1177 (*rcpt->recp_local != '\0')||
1178 (*rcpt->recp_room != '\0')||
1179 (*rcpt->recp_ignet != '\0')))
1182 cprintf("200 OK %s\n", internet_addr);
1183 syslog(LOG_INFO, "sending 200 OK for the room %s", rcpt->display_recp);
1187 cprintf("500 REJECT noone here by that name.\n");
1189 syslog(LOG_INFO, "sending 500 REJECT no one here by that name: %s", internet_addr);
1192 free_recipients(rcpt);
1195 cprintf("500 REJECT invalid Query.\n");
1196 syslog(LOG_INFO, "sending 500 REJECT invalid query: %s", internet_addr);
1200 void check_get_greeting(void) {
1201 /* dummy function, we have no greeting in this verry simple protocol. */
1206 * We don't know if the Contacts room exists so we just create it at login
1208 void vcard_CtdlCreateRoom(void)
1213 /* Create the calendar room if it doesn't already exist */
1214 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1216 /* Set expiration policy to manual; otherwise objects will be lost! */
1217 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1218 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!");
1221 qr.QRep.expire_mode = EXPIRE_MANUAL;
1222 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1223 CtdlPutRoomLock(&qr);
1225 /* Set the view to a calendar view */
1226 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1227 vbuf.v_view = 2; /* 2 = address book view */
1228 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1237 * When a user logs in...
1239 void vcard_session_login_hook(void) {
1240 struct vCard *v = NULL;
1241 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1245 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1246 * into the user's vCard.
1248 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1249 v = vcard_get_user(&CCC->user);
1251 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1252 vcard_write_user(&CCC->user, v);
1259 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1260 * These are inserted into the session data for various message entry commands to use.
1262 v = vcard_get_user(&CCC->user);
1264 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1265 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1268 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1273 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1275 vcard_CtdlCreateRoom();
1280 * Turn an arbitrary RFC822 address into a struct vCard for possible
1281 * inclusion into an address book.
1283 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1285 char user[256], node[256], name[256], email[256], n[256], uid[256];
1289 if (v == NULL) return(NULL);
1291 process_rfc822_addr(addr, user, node, name);
1292 vcard_set_prop(v, "fn", name, 0);
1294 vcard_fn_to_n(n, name, sizeof n);
1295 vcard_set_prop(v, "n", n, 0);
1297 snprintf(email, sizeof email, "%s@%s", user, node);
1298 vcard_set_prop(v, "email;internet", email, 0);
1300 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1301 for (i=0; uid[i]; ++i) {
1302 if (isspace(uid[i])) uid[i] = '_';
1303 uid[i] = tolower(uid[i]);
1305 vcard_set_prop(v, "UID", uid, 0);
1313 * This is called by store_harvested_addresses() to remove from the
1314 * list any addresses we already have in our address book.
1316 void strip_addresses_already_have(long msgnum, void *userdata) {
1317 char *collected_addresses;
1318 struct CtdlMessage *msg = NULL;
1322 char addr[256], user[256], node[256], name[256];
1324 collected_addresses = (char *)userdata;
1326 msg = CtdlFetchMessage(msgnum, 1);
1327 if (msg == NULL) return;
1328 v = vcard_load(msg->cm_fields[eMesageText]);
1329 CtdlFreeMessage(msg);
1332 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1334 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1335 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1337 /* Remove the address if we already have it! */
1338 process_rfc822_addr(addr, user, node, name);
1339 snprintf(addr, sizeof addr, "%s@%s", user, node);
1340 if (!strcasecmp(value, addr)) {
1341 remove_token(collected_addresses, j, ',');
1353 * Back end function for store_harvested_addresses()
1355 void store_this_ha(struct addresses_to_be_filed *aptr) {
1356 struct CtdlMessage *vmsg = NULL;
1358 struct vCard *v = NULL;
1359 char recipient[256];
1362 /* First remove any addresses we already have in the address book */
1363 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
1364 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1365 strip_addresses_already_have, aptr->collected_addresses);
1367 if (!IsEmptyStr(aptr->collected_addresses))
1368 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1370 /* Make a vCard out of each address */
1371 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1373 v = vcard_new_from_rfc822_addr(recipient);
1375 vmsg = malloc(sizeof(struct CtdlMessage));
1376 memset(vmsg, 0, sizeof(struct CtdlMessage));
1377 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1378 vmsg->cm_anon_type = MES_NORMAL;
1379 vmsg->cm_format_type = FMT_RFC822;
1380 vmsg->cm_fields[eAuthor] = strdup("Citadel");
1381 vmsg->cm_fields[eExclusiveID] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1382 ser = vcard_serialize(v);
1384 vmsg->cm_fields[eMesageText] = malloc(strlen(ser) + 1024);
1385 sprintf(vmsg->cm_fields[eMesageText],
1386 "Content-type: " VCARD_MIME_TYPE
1387 "\r\n\r\n%s\r\n", ser);
1392 syslog(LOG_DEBUG, "Adding contact: %s", recipient);
1393 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1394 CtdlFreeMessage(vmsg);
1398 free(aptr->roomname);
1399 free(aptr->collected_addresses);
1405 * When a user sends a message, we may harvest one or more email addresses
1406 * from the recipient list to be added to the user's address book. But we
1407 * want to do this asynchronously so it doesn't keep the user waiting.
1409 void store_harvested_addresses(void) {
1411 struct addresses_to_be_filed *aptr = NULL;
1413 if (atbf == NULL) return;
1415 begin_critical_section(S_ATBF);
1416 while (atbf != NULL) {
1419 end_critical_section(S_ATBF);
1420 store_this_ha(aptr);
1421 begin_critical_section(S_ATBF);
1423 end_critical_section(S_ATBF);
1428 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1429 * really this is just so we expose the vCard data to the full text indexer.
1431 void vcard_fixed_output(char *ptr, int len) {
1432 char *serialized_vcard;
1437 serialized_vcard = malloc(len + 1);
1438 safestrncpy(serialized_vcard, ptr, len+1);
1439 v = vcard_load(serialized_vcard);
1440 free(serialized_vcard);
1443 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1444 value = vcard_get_prop(v, "", 0, i++, 0);
1445 cprintf("%s\n", value);
1452 const char *CitadelServiceDICT_TCP="DICT_TCP";
1454 CTDL_MODULE_INIT(vcard)
1463 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN, PRIO_LOGIN + 70);
1464 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1465 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1466 CtdlRegisterDeleteHook(vcard_delete_remove);
1467 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1468 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1469 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1470 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1471 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1472 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1473 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1474 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1475 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1476 CtdlRegisterNetprocHook(vcard_extract_from_network);
1477 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER, PRIO_CLEANUP + 470);
1478 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1479 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1481 /* Create the Global ADdress Book room if necessary */
1482 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1484 /* Set expiration policy to manual; otherwise objects will be lost! */
1485 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1486 qr.QRep.expire_mode = EXPIRE_MANUAL;
1487 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1488 CtdlPutRoomLock(&qr);
1491 * Also make sure it has a netconfig file, so the networker runs
1492 * on this room even if we don't share it with any other nodes.
1493 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1496 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1497 fp = fopen(filename, "a");
1498 if (fp != NULL) fclose(fp);
1499 rv = chown(filename, CTDLUID, (-1));
1501 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]",
1502 filename, strerror(errno));
1503 rv = chmod(filename, 0600);
1505 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]",
1506 filename, strerror(errno));
1509 /* for postfix tcpdict */
1510 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1515 CitadelServiceDICT_TCP);
1518 /* return our module name for the log */