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 (CM_IsEmpty(msg, eAuthor)) return;
98 if (CM_IsEmpty(msg, eNodeName)) 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;
335 struct ctdluser usbuf;
337 struct vCard *v = NULL;
340 int yes_my_citadel_config = 0;
341 int yes_any_vcard_room = 0;
343 if (!CCC->logged_in) return(0); /* Only do this if logged in. */
345 /* Is this some user's "My Citadel Config" room? */
346 if (((CCC->room.QRflags & QR_MAILBOX) != 0) &&
347 (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
348 /* Yes, we want to do this */
349 yes_my_citadel_config = 1;
351 #ifdef VCARD_SAVES_BY_AIDES_ONLY
352 /* Prevent non-aides from performing registration changes */
353 if (CCC->user.axlevel < AxAideU) {
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(msg->cm_fields[eMesageText],
379 *vcard_extract_vcard,
381 &v, /* user data ptr - put the vcard here */
385 if (v == NULL) return(0); /* no vCards were found in this message */
387 /* If users cannot create their own accounts, they cannot re-register either. */
388 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CCC->user.axlevel < AxAideU) ) {
392 vcard_get_prop(v, "fn", 1, 0, 0);
394 if (yes_my_citadel_config) {
395 /* Bingo! The user is uploading a new vCard, so
396 * delete the old one. First, figure out which user
397 * is being re-registered...
399 what_user = atol(CCC->room.QRname);
401 if (what_user == CCC->user.usernum) {
402 /* It's the logged in user. That was easy. */
403 memcpy(&usbuf, &CCC->user, sizeof(struct ctdluser));
406 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
407 /* We fetched a valid user record */
411 /* somebody set up us the bomb! */
412 yes_my_citadel_config = 0;
416 if (yes_my_citadel_config) {
417 /* Delete the user's old vCard. This would probably
418 * get taken care of by the replication check, but we
419 * want to make sure there is absolutely only one
420 * vCard in the user's config room at all times.
423 CtdlDeleteMessages(CCC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
425 /* Make the author of the message the name of the user. */
426 CM_SetField(msg, eAuthor, usbuf.fullname, strlen(usbuf.fullname));
429 /* Insert or replace RFC2739-compliant free/busy URL */
430 if (yes_my_citadel_config) {
431 sprintf(buf, "http://%s/%s.vfb",
434 for (i=0; buf[i]; ++i) {
435 if (buf[i] == ' ') buf[i] = '_';
437 vcard_set_prop(v, "FBURL;PREF", buf, 0);
440 /* If the vCard has no UID, then give it one. */
441 s = vcard_get_prop(v, "UID", 1, 0, 0);
444 vcard_set_prop(v, "UID", buf, 0);
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);
450 vcard_set_prop(v, "UID", buf, 0);
454 * Set the EUID of the message to the UID of the vCard.
456 CM_FlushField(msg, eExclusiveID);
458 s = vcard_get_prop(v, "UID", 1, 0, 0);
460 CM_SetField(msg, eExclusiveID, s, strlen(s));
461 if (CM_IsEmpty(msg, eMsgSubject)) {
462 CM_CopyField(msg, eMsgSubject, eExclusiveID);
467 * Set the Subject to the name in the vCard.
469 s = vcard_get_prop(v, "FN", 1, 0, 0);
471 s = vcard_get_prop(v, "N", 1, 0, 0);
474 CM_SetField(msg, eMsgSubject, s, strlen(s));
477 /* Re-serialize it back into the msg body */
478 ser = vcard_serialize(v);
483 serlen = strlen(ser);
484 buf = NewStrBufPlain(NULL, serlen + 1024);
486 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
487 StrBufAppendBufPlain(buf, ser, serlen, 0);
488 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
489 CM_SetAsFieldSB(msg, eMesageText, &buf);
493 /* Now allow the save to complete. */
501 * This handler detects whether the user is attempting to save a new
502 * vCard as part of his/her personal configuration, and handles the replace
503 * function accordingly (copy the vCard from the config room to the global
506 int vcard_upload_aftersave(struct CtdlMessage *msg) {
507 struct CitContext *CCC = CC;
513 int is_MY_UserConf=0;
515 char roomname[ROOMNAMELEN];
517 if (msg->cm_format_type != 4) return(0);
518 if (!CCC->logged_in) return(0); /* Only do this if logged in. */
520 /* We're interested in user config rooms only. */
522 if ( (strlen(CCC->room.QRname) >= 12) && (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
523 is_UserConf = 1; /* It's someone's config room */
525 CtdlMailboxName(roomname, sizeof roomname, &CCC->user, USERCONFIGROOM);
526 if (!strcasecmp(CCC->room.QRname, roomname)) {
528 is_MY_UserConf = 1; /* It's MY config room */
530 if (!strcasecmp(CCC->room.QRname, ADDRESS_BOOK_ROOM)) {
531 is_GAB = 1; /* It's the Global Address Book */
534 if (!is_UserConf && !is_GAB) return(0);
536 if (CM_IsEmpty(msg, eMesageText))
539 ptr = msg->cm_fields[eMesageText];
541 NewStrBufDupAppendFlush(&CCC->StatusMessage, NULL, NULL, 0);
543 StrBufPrintf(CCC->StatusMessage, "%d\n", LISTING_FOLLOWS);
545 while (ptr != NULL) {
547 linelen = strcspn(ptr, "\n");
548 if (linelen == 0) return(0); /* end of headers */
550 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
551 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
553 * Bingo! The user is uploading a new vCard, so
554 * copy it to the Global Address Book room.
557 I = atol(msg->cm_fields[eVltMsgNum]);
558 if (I <= 0L) return(0);
560 /* Store our Internet return address in memory */
561 if (is_MY_UserConf) {
562 v = vcard_load(msg->cm_fields[eMesageText]);
563 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
564 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
566 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
571 { // This is not the GAB
572 /* Put it in the Global Address Book room... */
573 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
576 /* ...and also in the directory database. */
577 vcard_add_to_directory(I, NULL);
579 /* Some sites want an Aide to be notified when a
580 * user registers or re-registers
581 * But if the user was an Aide or was edited by an Aide then we can
582 * Assume they don't need validating.
584 if (CCC->user.axlevel >= AxAideU) {
585 CtdlGetUserLock(&CCC->user, CCC->curr_user);
586 CCC->user.flags |= US_REGIS;
587 CtdlPutUserLock(&CCC->user);
593 /* ...which also means we need to flag the user */
594 CtdlGetUserLock(&CCC->user, CCC->curr_user);
595 CCC->user.flags |= (US_REGIS|US_NEEDVALID);
596 CtdlPutUserLock(&CCC->user);
601 ptr = strchr((char *)ptr, '\n');
602 if (ptr != NULL) ++ptr;
611 * back end function used for callbacks
613 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
616 msgnum = (long *) userdata;
617 *msgnum = supplied_msgnum;
622 * If this user has a vcard on disk, read it into memory, otherwise allocate
623 * and return an empty vCard.
625 struct vCard *vcard_get_user(struct ctdluser *u) {
626 struct CitContext *CCC = CC;
627 char hold_rm[ROOMNAMELEN];
628 char config_rm[ROOMNAMELEN];
629 struct CtdlMessage *msg = NULL;
633 strcpy(hold_rm, CCC->room.QRname); /* save current room */
634 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
636 if (CtdlGetRoom(&CCC->room, config_rm) != 0) {
637 CtdlGetRoom(&CCC->room, hold_rm);
641 /* We want the last (and probably only) vcard in this room */
643 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
644 NULL, vcard_gu_backend, (void *)&VCmsgnum );
645 CtdlGetRoom(&CCC->room, hold_rm); /* return to saved room */
647 if (VCmsgnum < 0L) return vcard_new();
649 msg = CtdlFetchMessage(VCmsgnum, 1);
650 if (msg == NULL) return vcard_new();
652 v = vcard_load(msg->cm_fields[eMesageText]);
653 CtdlFreeMessage(msg);
659 * Store this user's vCard in the appropriate place
662 * Write our config to disk
664 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
667 ser = vcard_serialize(v);
669 ser = strdup("begin:vcard\r\nend:vcard\r\n");
673 /* This handy API function does all the work for us.
674 * NOTE: normally we would want to set that last argument to 1, to
675 * force the system to delete the user's old vCard. But it doesn't
676 * have to, because the vcard_upload_beforesave() hook above
677 * is going to notice what we're trying to do, and delete the old vCard.
679 CtdlWriteObject(USERCONFIGROOM, /* which room */
680 VCARD_MIME_TYPE, /* MIME type */
682 strlen(ser)+1, /* length */
685 0, /* don't delete others of this type */
694 * Old style "enter registration info" command. This function simply honors
695 * the REGI protocol command, translates the entered parameters into a vCard,
696 * and enters the vCard into the user's configuration.
698 void cmd_regi(char *argbuf) {
699 struct CitContext *CCC = CC;
702 struct vCard *my_vcard;
708 char tmpaddress[SIZ];
709 char tmpcountry[SIZ];
713 if (!(CCC->logged_in)) {
714 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
718 /* If users cannot create their own accounts, they cannot re-register either. */
719 if ( (config.c_disable_newu) && (CCC->user.axlevel < AxAideU) ) {
720 cprintf("%d Self-service registration is not allowed here.\n",
721 ERROR + HIGHER_ACCESS_REQUIRED);
724 my_vcard = vcard_get_user(&CCC->user);
727 strcpy(tmpstate, "");
729 strcpy(tmpcountry, "USA");
731 cprintf("%d Send registration...\n", SEND_LISTING);
733 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
734 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
735 if (a==1) strcpy(tmpaddr, buf);
736 if (a==2) strcpy(tmpcity, buf);
737 if (a==3) strcpy(tmpstate, buf);
739 for (c=0; buf[c]; ++c) {
740 if ((buf[c]>='0') && (buf[c]<='9')) {
747 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
748 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
749 if (a==7) strcpy(tmpcountry, buf);
753 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
754 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
755 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
756 vcard_write_user(&CCC->user, my_vcard);
757 vcard_free(my_vcard);
762 * Protocol command to fetch registration info for a user
764 void cmd_greg(char *argbuf)
766 struct CitContext *CCC = CC;
767 struct ctdluser usbuf;
770 char who[USERNAME_SIZE];
774 extract_token(who, argbuf, 0, '|', sizeof who);
776 if (!(CCC->logged_in)) {
777 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
781 if (!strcasecmp(who,"_SELF_")) strcpy(who,CCC->curr_user);
783 if ((CCC->user.axlevel < AxAideU) && (strcasecmp(who,CCC->curr_user))) {
784 cprintf("%d Higher access required.\n",
785 ERROR + HIGHER_ACCESS_REQUIRED);
789 if (CtdlGetUser(&usbuf, who) != 0) {
790 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
794 v = vcard_get_user(&usbuf);
796 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
797 cprintf("%ld\n", usbuf.usernum);
798 cprintf("%s\n", usbuf.password);
799 s = vcard_get_prop(v, "n", 1, 0, 0);
800 cprintf("%s\n", s ? s : " "); /* name */
802 s = vcard_get_prop(v, "adr", 1, 0, 0);
803 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
805 extract_token(buf, adr, 2, ';', sizeof buf);
806 cprintf("%s\n", buf); /* street */
807 extract_token(buf, adr, 3, ';', sizeof buf);
808 cprintf("%s\n", buf); /* city */
809 extract_token(buf, adr, 4, ';', sizeof buf);
810 cprintf("%s\n", buf); /* state */
811 extract_token(buf, adr, 5, ';', sizeof buf);
812 cprintf("%s\n", buf); /* zip */
814 s = vcard_get_prop(v, "tel", 1, 0, 0);
815 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
823 cprintf("%d\n", usbuf.axlevel);
825 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
826 cprintf("%s\n", s ? s : " ");
827 s = vcard_get_prop(v, "adr", 0, 0, 0);
828 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
830 extract_token(buf, adr, 6, ';', sizeof buf);
831 cprintf("%s\n", buf); /* country */
839 * When a user is being created, create his/her vCard.
841 void vcard_newuser(struct ctdluser *usbuf) {
847 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
848 syslog(LOG_DEBUG, "Converted <%s> to <%s>", usbuf->fullname, vname);
850 /* Create and save the vCard */
852 if (v == NULL) return;
853 vcard_add_prop(v, "fn", usbuf->fullname);
854 vcard_add_prop(v, "n", vname);
855 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
857 #ifdef HAVE_GETPWUID_R
858 /* If using host auth mode, we add an email address based on the login */
859 if (config.c_auth_mode == AUTHMODE_HOST) {
861 char pwd_buffer[SIZ];
863 #ifdef SOLARIS_GETPWUID
864 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
865 #else // SOLARIS_GETPWUID
866 struct passwd *result = NULL;
867 syslog(LOG_DEBUG, "Searching for uid %d", usbuf->uid);
868 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
869 #endif // HAVE_GETPWUID_R
870 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
871 vcard_add_prop(v, "email;internet", buf);
876 /* Everyone gets an email address based on their display name */
877 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
878 for (i=0; buf[i]; ++i) {
879 if (buf[i] == ' ') buf[i] = '_';
881 vcard_add_prop(v, "email;internet", buf);
884 vcard_write_user(usbuf, v);
890 * When a user is being deleted, we have to remove his/her vCard.
891 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
892 * field, and the same Exclusive ID as the existing card.
894 void vcard_purge(struct ctdluser *usbuf) {
895 struct CtdlMessage *msg;
899 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
900 if (msg == NULL) return;
901 memset(msg, 0, sizeof(struct CtdlMessage));
903 msg->cm_magic = CTDLMESSAGE_MAGIC;
904 msg->cm_anon_type = MES_NORMAL;
905 msg->cm_format_type = 0;
906 CM_SetField(msg, eAuthor, usbuf->fullname, strlen(usbuf->fullname));
907 CM_SetField(msg, eOriginalRoom, HKEY(ADDRESS_BOOK_ROOM));
908 CM_SetField(msg, eNodeName, NODENAME, strlen(NODENAME));
909 CM_SetField(msg, eMesageText, HKEY("Purge this vCard\n"));
911 len = snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
912 msg->cm_fields[eAuthor], NODENAME);
913 CM_SetField(msg, eExclusiveID, buf, len);
915 CM_SetField(msg, eSpecialField, HKEY("CANCEL"));
917 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
918 CtdlFreeMessage(msg);
923 * Grab vCard directory stuff out of incoming network messages
925 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
929 if (msg == NULL) return(0);
931 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
935 if (msg->cm_format_type != 4) return(0);
937 if (CM_IsEmpty(msg, eMesageText))
940 ptr = msg->cm_fields[eMesageText];
942 while (ptr != NULL) {
944 linelen = strcspn(ptr, "\n");
945 if (linelen == 0) return(0); /* end of headers */
947 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
948 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
949 /* It's a vCard. Add it to the directory. */
950 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
954 ptr = strchr((char *)ptr, '\n');
955 if (ptr != NULL) ++ptr;
964 * When a vCard is being removed from the Global Address Book room, remove it
965 * from the directory as well.
967 void vcard_delete_remove(char *room, long msgnum) {
968 struct CtdlMessage *msg;
972 if (msgnum <= 0L) return;
974 if (room == NULL) return;
976 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
980 msg = CtdlFetchMessage(msgnum, 1);
981 if (msg == NULL) return;
983 if (CM_IsEmpty(msg, eMesageText))
986 ptr = msg->cm_fields[eMesageText];
988 while (ptr != NULL) {
989 linelen = strcspn(ptr, "\n");
990 if (linelen == 0) goto EOH;
992 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
993 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
994 /* Bingo! A vCard is being deleted. */
995 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
997 ptr = strchr((char *)ptr, '\n');
998 if (ptr != NULL) ++ptr;
1001 EOH: CtdlFreeMessage(msg);
1007 * Get Valid Screen Names
1009 void cmd_gvsn(char *argbuf)
1011 struct CitContext *CCC = CC;
1013 if (CtdlAccessCheck(ac_logged_in)) return;
1015 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
1016 cprintf("%s\n", CCC->user.fullname);
1017 if ( (!IsEmptyStr(CCC->cs_inet_fn)) && (strcasecmp(CCC->user.fullname, CCC->cs_inet_fn)) ) {
1018 cprintf("%s\n", CCC->cs_inet_fn);
1025 * Get Valid Email Addresses
1027 void cmd_gvea(char *argbuf)
1029 struct CitContext *CCC = CC;
1030 int num_secondary_emails = 0;
1034 if (CtdlAccessCheck(ac_logged_in)) return;
1036 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
1037 if (!IsEmptyStr(CCC->cs_inet_email)) {
1038 cprintf("%s\n", CCC->cs_inet_email);
1040 if (!IsEmptyStr(CCC->cs_inet_other_emails)) {
1041 num_secondary_emails = num_tokens(CCC->cs_inet_other_emails, '|');
1042 for (i=0; i<num_secondary_emails; ++i) {
1043 extract_token(buf, CCC->cs_inet_other_emails,i,'|',sizeof CCC->cs_inet_other_emails);
1044 cprintf("%s\n", buf);
1054 * Callback function for cmd_dvca() that hunts for vCard content types
1055 * and outputs any email addresses found within.
1057 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1058 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1059 char *cbid, void *cbuserdata) {
1062 char displayname[256] = "";
1063 int displayname_len;
1064 char emailaddr[256] = "";
1068 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1072 v = vcard_load(content);
1073 if (v == NULL) return;
1075 extract_friendly_name(displayname, sizeof displayname, v);
1076 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1078 displayname_len = strlen(displayname);
1079 for (i=0; i<displayname_len; ++i) {
1080 if (displayname[i] == '\"') displayname[i] = ' ';
1081 if (displayname[i] == ';') displayname[i] = ',';
1082 if (displayname[i] == ',') has_commas = 1;
1084 striplt(displayname);
1086 cprintf("%s%s%s <%s>\n",
1087 (has_commas ? "\"" : ""),
1089 (has_commas ? "\"" : ""),
1098 * Back end callback function for cmd_dvca()
1100 * It's basically just passed a list of message numbers, which we're going
1101 * to fetch off the disk and then pass along to the MIME parser via another
1102 * layer of callback...
1104 void dvca_callback(long msgnum, void *userdata) {
1105 struct CtdlMessage *msg = NULL;
1107 msg = CtdlFetchMessage(msgnum, 1);
1108 if (msg == NULL) return;
1109 mime_parser(msg->cm_fields[eMesageText],
1111 *dvca_mime_callback, /* callback function */
1113 NULL, /* user data */
1116 CtdlFreeMessage(msg);
1121 * Dump VCard Addresses
1123 void cmd_dvca(char *argbuf)
1125 if (CtdlAccessCheck(ac_logged_in)) return;
1127 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1128 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1136 void cmd_qdir(char *argbuf) {
1137 char citadel_addr[256];
1138 char internet_addr[256];
1140 if (CtdlAccessCheck(ac_logged_in)) return;
1142 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1144 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1145 cprintf("%d %s was not found.\n",
1146 ERROR + NO_SUCH_USER, internet_addr);
1150 cprintf("%d %s\n", CIT_OK, citadel_addr);
1154 * Query Directory, in fact an alias to match postfix tcp auth.
1156 void check_get(void) {
1157 char internet_addr[256];
1162 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1163 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1164 syslog(LOG_CRIT, "vcard client disconnected: ending session.");
1165 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1168 syslog(LOG_INFO, ": %s", cmdbuf);
1169 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1170 syslog(LOG_INFO, "[ %s]", cmdbuf);
1172 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1174 struct recptypes *rcpt;
1175 char *argbuf = &cmdbuf[4];
1177 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1178 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1179 if ((rcpt != NULL)&&
1181 (*rcpt->recp_local != '\0')||
1182 (*rcpt->recp_room != '\0')||
1183 (*rcpt->recp_ignet != '\0')))
1186 cprintf("200 OK %s\n", internet_addr);
1187 syslog(LOG_INFO, "sending 200 OK for the room %s", rcpt->display_recp);
1191 cprintf("500 REJECT noone here by that name.\n");
1193 syslog(LOG_INFO, "sending 500 REJECT no one here by that name: %s", internet_addr);
1196 free_recipients(rcpt);
1199 cprintf("500 REJECT invalid Query.\n");
1200 syslog(LOG_INFO, "sending 500 REJECT invalid query: %s", internet_addr);
1204 void check_get_greeting(void) {
1205 /* dummy function, we have no greeting in this verry simple protocol. */
1210 * We don't know if the Contacts room exists so we just create it at login
1212 void vcard_CtdlCreateRoom(void)
1217 /* Create the calendar room if it doesn't already exist */
1218 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1220 /* Set expiration policy to manual; otherwise objects will be lost! */
1221 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1222 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!");
1225 qr.QRep.expire_mode = EXPIRE_MANUAL;
1226 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1227 CtdlPutRoomLock(&qr);
1229 /* Set the view to a calendar view */
1230 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1231 vbuf.v_view = 2; /* 2 = address book view */
1232 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1241 * When a user logs in...
1243 void vcard_session_login_hook(void) {
1244 struct vCard *v = NULL;
1245 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1249 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1250 * into the user's vCard.
1252 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1253 v = vcard_get_user(&CCC->user);
1255 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1256 vcard_write_user(&CCC->user, v);
1263 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1264 * These are inserted into the session data for various message entry commands to use.
1266 v = vcard_get_user(&CCC->user);
1268 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1269 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1272 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1277 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1279 vcard_CtdlCreateRoom();
1284 * Turn an arbitrary RFC822 address into a struct vCard for possible
1285 * inclusion into an address book.
1287 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1289 char user[256], node[256], name[256], email[256], n[256], uid[256];
1293 if (v == NULL) return(NULL);
1295 process_rfc822_addr(addr, user, node, name);
1296 vcard_set_prop(v, "fn", name, 0);
1298 vcard_fn_to_n(n, name, sizeof n);
1299 vcard_set_prop(v, "n", n, 0);
1301 snprintf(email, sizeof email, "%s@%s", user, node);
1302 vcard_set_prop(v, "email;internet", email, 0);
1304 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1305 for (i=0; uid[i]; ++i) {
1306 if (isspace(uid[i])) uid[i] = '_';
1307 uid[i] = tolower(uid[i]);
1309 vcard_set_prop(v, "UID", uid, 0);
1317 * This is called by store_harvested_addresses() to remove from the
1318 * list any addresses we already have in our address book.
1320 void strip_addresses_already_have(long msgnum, void *userdata) {
1321 char *collected_addresses;
1322 struct CtdlMessage *msg = NULL;
1326 char addr[256], user[256], node[256], name[256];
1328 collected_addresses = (char *)userdata;
1330 msg = CtdlFetchMessage(msgnum, 1);
1331 if (msg == NULL) return;
1332 v = vcard_load(msg->cm_fields[eMesageText]);
1333 CtdlFreeMessage(msg);
1336 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1338 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1339 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1341 /* Remove the address if we already have it! */
1342 process_rfc822_addr(addr, user, node, name);
1343 snprintf(addr, sizeof addr, "%s@%s", user, node);
1344 if (!strcasecmp(value, addr)) {
1345 remove_token(collected_addresses, j, ',');
1357 * Back end function for store_harvested_addresses()
1359 void store_this_ha(struct addresses_to_be_filed *aptr) {
1360 struct CtdlMessage *vmsg = NULL;
1362 struct vCard *v = NULL;
1363 char recipient[256];
1366 /* First remove any addresses we already have in the address book */
1367 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
1368 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1369 strip_addresses_already_have, aptr->collected_addresses);
1371 if (!IsEmptyStr(aptr->collected_addresses))
1372 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1374 /* Make a vCard out of each address */
1375 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1377 v = vcard_new_from_rfc822_addr(recipient);
1380 vmsg = malloc(sizeof(struct CtdlMessage));
1381 memset(vmsg, 0, sizeof(struct CtdlMessage));
1382 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1383 vmsg->cm_anon_type = MES_NORMAL;
1384 vmsg->cm_format_type = FMT_RFC822;
1385 CM_SetField(vmsg, eAuthor, HKEY("Citadel"));
1386 s = vcard_get_prop(v, "UID", 1, 0, 0);
1387 CM_SetField(vmsg, eExclusiveID, s, strlen(s));
1388 ser = vcard_serialize(v);
1393 serlen = strlen(ser);
1394 buf = NewStrBufPlain(NULL, serlen + 1024);
1396 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
1397 StrBufAppendBufPlain(buf, ser, serlen, 0);
1398 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
1399 CM_SetAsFieldSB(vmsg, eMesageText, &buf);
1404 syslog(LOG_DEBUG, "Adding contact: %s", recipient);
1405 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1406 CtdlFreeMessage(vmsg);
1410 free(aptr->roomname);
1411 free(aptr->collected_addresses);
1417 * When a user sends a message, we may harvest one or more email addresses
1418 * from the recipient list to be added to the user's address book. But we
1419 * want to do this asynchronously so it doesn't keep the user waiting.
1421 void store_harvested_addresses(void) {
1423 struct addresses_to_be_filed *aptr = NULL;
1425 if (atbf == NULL) return;
1427 begin_critical_section(S_ATBF);
1428 while (atbf != NULL) {
1431 end_critical_section(S_ATBF);
1432 store_this_ha(aptr);
1433 begin_critical_section(S_ATBF);
1435 end_critical_section(S_ATBF);
1440 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1441 * really this is just so we expose the vCard data to the full text indexer.
1443 void vcard_fixed_output(char *ptr, int len) {
1444 char *serialized_vcard;
1449 serialized_vcard = malloc(len + 1);
1450 safestrncpy(serialized_vcard, ptr, len+1);
1451 v = vcard_load(serialized_vcard);
1452 free(serialized_vcard);
1455 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1456 value = vcard_get_prop(v, "", 0, i++, 0);
1457 cprintf("%s\n", value);
1464 const char *CitadelServiceDICT_TCP="DICT_TCP";
1466 CTDL_MODULE_INIT(vcard)
1475 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN, PRIO_LOGIN + 70);
1476 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1477 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1478 CtdlRegisterDeleteHook(vcard_delete_remove);
1479 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1480 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1481 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1482 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1483 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1484 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1485 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1486 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1487 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1488 CtdlRegisterNetprocHook(vcard_extract_from_network);
1489 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER, PRIO_CLEANUP + 470);
1490 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1491 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1493 /* Create the Global ADdress Book room if necessary */
1494 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1496 /* Set expiration policy to manual; otherwise objects will be lost! */
1497 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1498 qr.QRep.expire_mode = EXPIRE_MANUAL;
1499 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1500 CtdlPutRoomLock(&qr);
1503 * Also make sure it has a netconfig file, so the networker runs
1504 * on this room even if we don't share it with any other nodes.
1505 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1508 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1509 fp = fopen(filename, "a");
1510 if (fp != NULL) fclose(fp);
1511 rv = chown(filename, CTDLUID, (-1));
1513 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]",
1514 filename, strerror(errno));
1515 rv = chmod(filename, 0600);
1517 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]",
1518 filename, strerror(errno));
1521 /* for postfix tcpdict */
1522 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1527 CitadelServiceDICT_TCP);
1530 /* return our module name for the log */