2 * A server-side module for Citadel which supports address book information
3 * using the standard vCard format.
5 * Copyright (c) 1999-2017 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) {
78 begin_critical_section(S_CONTROL);
79 flags = CtdlGetConfigInt("MMflags");
80 flags = flags | MM_VALID ;
81 CtdlSetConfigInt("MMflags", flags);
82 end_critical_section(S_CONTROL);
88 * Extract Internet e-mail addresses from a message containing a vCard, and
89 * perform a callback for any found.
91 void vcard_extract_internet_addresses(struct CtdlMessage *msg, int (*callback)(char *, char *) ) {
96 char citadel_address[SIZ];
98 int found_something = 0;
100 if (CM_IsEmpty(msg, eAuthor)) return;
101 if (CM_IsEmpty(msg, eNodeName)) return;
102 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
103 msg->cm_fields[eAuthor], msg->cm_fields[eNodeName]);
105 v = vcard_load(msg->cm_fields[eMesageText]);
106 if (v == NULL) return;
108 /* Go through the vCard searching for *all* instances of
109 * the "email;internet" key
112 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
113 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
114 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
117 if (!IsEmptyStr(addr)) {
118 if (callback != NULL) {
119 callback(addr, citadel_address);
128 } while(found_something);
139 * See if there is a valid Internet address in a vCard to use for outbound
140 * Internet messages. If there is, stick it in the buffer.
142 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
143 char *secemailaddrbuf, size_t secemailaddrbuf_len,
145 int local_addrs_only)
147 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
150 int IsDirectoryAddress;
151 int saved_instance = 0;
153 /* Go through the vCard searching for *all* Internet email addresses
155 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
156 k = vcard_get_prop(v, "email", 1, instance, 1);
157 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
160 if (!IsEmptyStr(addr)) {
161 IsDirectoryAddress = IsDirectory(addr, 1);
162 if ( IsDirectoryAddress || !local_addrs_only)
165 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
166 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
168 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
169 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
171 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
172 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
173 < secemailaddrbuf_len ) {
174 strcat(secemailaddrbuf, "|");
175 strcat(secemailaddrbuf, addr);
179 if (!IsDirectoryAddress && local_addrs_only)
181 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
182 StrBufAppendBufPlain(CCC->StatusMessage, addr, -1, 0);
183 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
184 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
196 * See if there is a name / screen name / friendly name in a vCard to use for outbound
197 * Internet messages. If there is, stick it in the buffer.
199 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
203 s = vcard_get_prop(v, "fn", 1, 0, 0);
205 s = vcard_get_prop(v, "n", 1, 0, 0);
209 safestrncpy(namebuf, s, namebuf_len);
215 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
217 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
218 void *content, char *cbtype, char *cbcharset, size_t length,
219 char *encoding, char *cbid, void *cbuserdata)
221 struct vCard **v = (struct vCard **) cbuserdata;
223 if ( (!strcasecmp(cbtype, "text/x-vcard"))
224 || (!strcasecmp(cbtype, "text/vcard")) ) {
226 syslog(LOG_DEBUG, "Part %s contains a vCard! Loading...", partnum);
230 *v = vcard_load(content);
236 * This handler detects whether the user is attempting to save a new
237 * vCard as part of his/her personal configuration, and handles the replace
238 * function accordingly (delete the user's existing vCard in the config room
239 * and in the global address book).
241 int vcard_upload_beforesave(struct CtdlMessage *msg, recptypes *recp) {
242 struct CitContext *CCC = CC;
245 struct ctdluser usbuf;
247 struct vCard *v = NULL;
250 int yes_my_citadel_config = 0;
251 int yes_any_vcard_room = 0;
253 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
255 /* Is this some user's "My Citadel Config" room? */
256 if (((CCC->room.QRflags & QR_MAILBOX) != 0) &&
257 (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
258 /* Yes, we want to do this */
259 yes_my_citadel_config = 1;
260 #ifdef VCARD_SAVES_BY_AIDES_ONLY
261 /* Prevent non-aides from performing registration changes, but ldap is ok. */
262 if ((CCC->user.axlevel < AxAideU) && (CCC->vcard_updated_by_ldap==0)) {
269 /* Is this a room with an address book in it? */
270 if (CCC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
271 yes_any_vcard_room = 1;
274 /* If neither condition exists, don't run this hook. */
275 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
279 /* If this isn't a MIME message, don't bother. */
280 if (msg->cm_format_type != 4) return(0);
282 /* Ok, if we got this far, look into the situation further... */
284 if (CM_IsEmpty(msg, eMesageText)) return(0);
286 mime_parser(CM_RANGE(msg, eMesageText),
287 *vcard_extract_vcard,
289 &v, /* user data ptr - put the vcard here */
293 if (v == NULL) return(0); /* no vCards were found in this message */
295 /* If users cannot create their own accounts, they cannot re-register either. */
296 if ( (yes_my_citadel_config) &&
297 (CtdlGetConfigInt("c_disable_newu")) &&
298 (CCC->user.axlevel < AxAideU) &&
299 (CCC->vcard_updated_by_ldap==0) )
304 vcard_get_prop(v, "fn", 1, 0, 0);
307 if (yes_my_citadel_config) {
308 /* Bingo! The user is uploading a new vCard, so
309 * delete the old one. First, figure out which user
310 * is being re-registered...
312 what_user = atol(CCC->room.QRname);
314 if (what_user == CCC->user.usernum) {
315 /* It's the logged in user. That was easy. */
316 memcpy(&usbuf, &CCC->user, sizeof(struct ctdluser));
319 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
320 /* We fetched a valid user record */
324 /* somebody set up us the bomb! */
325 yes_my_citadel_config = 0;
329 if (yes_my_citadel_config) {
330 /* Delete the user's old vCard. This would probably
331 * get taken care of by the replication check, but we
332 * want to make sure there is absolutely only one
333 * vCard in the user's config room at all times.
336 CtdlDeleteMessages(CCC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
338 /* Make the author of the message the name of the user. */
339 if (!IsEmptyStr(usbuf.fullname)) {
340 CM_SetField(msg, eAuthor, usbuf.fullname, strlen(usbuf.fullname));
344 /* Insert or replace RFC2739-compliant free/busy URL */
345 if (yes_my_citadel_config) {
346 sprintf(buf, "http://%s/%s.vfb",
347 CtdlGetConfigStr("c_fqdn"),
349 for (i=0; buf[i]; ++i) {
350 if (buf[i] == ' ') buf[i] = '_';
352 vcard_set_prop(v, "FBURL;PREF", buf, 0);
356 s = vcard_get_prop(v, "UID", 1, 0, 0);
357 if (s == NULL) { /* Note LDAP auth sets UID from the LDAP UUID, use that if it exists. */
358 /* Enforce local UID policy if applicable */
359 if (yes_my_citadel_config) {
360 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields[eAuthor], NODENAME);
362 /* If the vCard has no UID, then give it one. */
365 vcard_set_prop(v, "UID", buf, 0);
370 * Set the EUID of the message to the UID of the vCard.
372 CM_FlushField(msg, eExclusiveID);
374 s = vcard_get_prop(v, "UID", 1, 0, 0);
375 if (!IsEmptyStr(s)) {
376 CM_SetField(msg, eExclusiveID, s, strlen(s));
377 if (CM_IsEmpty(msg, eMsgSubject)) {
378 CM_CopyField(msg, eMsgSubject, eExclusiveID);
383 * Set the Subject to the name in the vCard.
385 s = vcard_get_prop(v, "FN", 1, 0, 0);
387 s = vcard_get_prop(v, "N", 1, 0, 0);
389 if (!IsEmptyStr(s)) {
390 CM_SetField(msg, eMsgSubject, s, strlen(s));
393 /* Re-serialize it back into the msg body */
394 ser = vcard_serialize(v);
395 if (!IsEmptyStr(ser)) {
399 serlen = strlen(ser);
400 buf = NewStrBufPlain(NULL, serlen + 1024);
402 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
403 StrBufAppendBufPlain(buf, ser, serlen, 0);
404 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
405 CM_SetAsFieldSB(msg, eMesageText, &buf);
409 /* Now allow the save to complete. */
417 * This handler detects whether the user is attempting to save a new
418 * vCard as part of his/her personal configuration, and handles the replace
419 * function accordingly (copy the vCard from the config room to the global
422 int vcard_upload_aftersave(struct CtdlMessage *msg, recptypes *recp) {
423 struct CitContext *CCC = CC;
429 int is_MY_UserConf=0;
431 char roomname[ROOMNAMELEN];
433 if (msg->cm_format_type != 4) return(0);
434 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
436 /* We're interested in user config rooms only. */
438 if ( !IsEmptyStr(CCC->room.QRname) &&
439 (strlen(CCC->room.QRname) >= 12) &&
440 (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
441 is_UserConf = 1; /* It's someone's config room */
443 CtdlMailboxName(roomname, sizeof roomname, &CCC->user, USERCONFIGROOM);
444 if (!strcasecmp(CCC->room.QRname, roomname)) {
446 is_MY_UserConf = 1; /* It's MY config room */
448 if (!strcasecmp(CCC->room.QRname, ADDRESS_BOOK_ROOM)) {
449 is_GAB = 1; /* It's the Global Address Book */
452 if (!is_UserConf && !is_GAB) return(0);
454 if (CM_IsEmpty(msg, eMesageText))
457 ptr = msg->cm_fields[eMesageText];
459 CCC->vcard_updated_by_ldap=0; /* As this will write LDAP's previous changes, disallow LDAP change auth until next LDAP change. */
461 NewStrBufDupAppendFlush(&CCC->StatusMessage, NULL, NULL, 0);
463 StrBufPrintf(CCC->StatusMessage, "%d\n", LISTING_FOLLOWS);
465 while (ptr != NULL) {
467 linelen = strcspn(ptr, "\n");
468 if (linelen == 0) return(0); /* end of headers */
470 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
471 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
473 * Bingo! The user is uploading a new vCard, so
474 * copy it to the Global Address Book room.
477 I = atol(msg->cm_fields[eVltMsgNum]);
478 if (I <= 0L) return(0);
480 /* Store our Internet return address in memory */
481 if (is_MY_UserConf) {
482 v = vcard_load(msg->cm_fields[eMesageText]);
483 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
484 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
486 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
491 { // This is not the GAB
492 /* Put it in the Global Address Book room... */
493 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
496 /* Some sites want an Aide to be notified when a
497 * user registers or re-registers
498 * But if the user was an Aide or was edited by an Aide then we can
499 * Assume they don't need validating.
501 if (CCC->user.axlevel >= AxAideU) {
502 CtdlLockGetCurrentUser();
503 CCC->user.flags |= US_REGIS;
504 CtdlPutCurrentUserLock();
510 /* ...which also means we need to flag the user */
511 CtdlLockGetCurrentUser();
512 CCC->user.flags |= (US_REGIS|US_NEEDVALID);
513 CtdlPutCurrentUserLock();
518 ptr = strchr((char *)ptr, '\n');
519 if (ptr != NULL) ++ptr;
528 * back end function used for callbacks
530 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
533 msgnum = (long *) userdata;
534 *msgnum = supplied_msgnum;
539 * If this user has a vcard on disk, read it into memory, otherwise allocate
540 * and return an empty vCard.
542 struct vCard *vcard_get_user(struct ctdluser *u) {
543 struct CitContext *CCC = CC;
544 char hold_rm[ROOMNAMELEN];
545 char config_rm[ROOMNAMELEN];
546 struct CtdlMessage *msg = NULL;
550 strcpy(hold_rm, CCC->room.QRname); /* save current room */
551 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
553 if (CtdlGetRoom(&CCC->room, config_rm) != 0) {
554 CtdlGetRoom(&CCC->room, hold_rm);
558 /* We want the last (and probably only) vcard in this room */
560 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
561 NULL, vcard_gu_backend, (void *)&VCmsgnum );
562 CtdlGetRoom(&CCC->room, hold_rm); /* return to saved room */
564 if (VCmsgnum < 0L) return vcard_new();
566 msg = CtdlFetchMessage(VCmsgnum, 1, 1);
567 if (msg == NULL) return vcard_new();
569 v = vcard_load(msg->cm_fields[eMesageText]);
576 * Store this user's vCard in the appropriate place
579 * Write our config to disk
581 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
584 ser = vcard_serialize(v);
586 ser = strdup("begin:vcard\r\nend:vcard\r\n");
588 if (ser == NULL) return;
590 /* This handy API function does all the work for us.
591 * NOTE: normally we would want to set that last argument to 1, to
592 * force the system to delete the user's old vCard. But it doesn't
593 * have to, because the vcard_upload_beforesave() hook above
594 * is going to notice what we're trying to do, and delete the old vCard.
596 CtdlWriteObject(USERCONFIGROOM, /* which room */
597 VCARD_MIME_TYPE, /* MIME type */
599 strlen(ser)+1, /* length */
602 0, /* don't delete others of this type */
611 * Old style "enter registration info" command. This function simply honors
612 * the REGI protocol command, translates the entered parameters into a vCard,
613 * and enters the vCard into the user's configuration.
615 void cmd_regi(char *argbuf) {
616 struct CitContext *CCC = CC;
619 struct vCard *my_vcard;
625 char tmpaddress[SIZ];
626 char tmpcountry[SIZ];
630 if (!(CCC->logged_in)) {
631 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
635 /* If users cannot create their own accounts, they cannot re-register either. */
636 if ( (CtdlGetConfigInt("c_disable_newu")) && (CCC->user.axlevel < AxAideU) ) {
637 cprintf("%d Self-service registration is not allowed here.\n",
638 ERROR + HIGHER_ACCESS_REQUIRED);
641 my_vcard = vcard_get_user(&CCC->user);
644 strcpy(tmpstate, "");
646 strcpy(tmpcountry, "USA");
648 cprintf("%d Send registration...\n", SEND_LISTING);
650 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
651 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
652 if (a==1) strcpy(tmpaddr, buf);
653 if (a==2) strcpy(tmpcity, buf);
654 if (a==3) strcpy(tmpstate, buf);
656 for (c=0; buf[c]; ++c) {
657 if ((buf[c]>='0') && (buf[c]<='9')) {
664 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
665 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
666 if (a==7) strcpy(tmpcountry, buf);
670 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
671 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
672 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
673 vcard_write_user(&CCC->user, my_vcard);
674 vcard_free(my_vcard);
679 * Protocol command to fetch registration info for a user
681 void cmd_greg(char *argbuf)
683 struct CitContext *CCC = CC;
684 struct ctdluser usbuf;
687 char who[USERNAME_SIZE];
691 extract_token(who, argbuf, 0, '|', sizeof who);
693 if (!(CCC->logged_in)) {
694 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
698 if (!strcasecmp(who,"_SELF_")) strcpy(who,CCC->curr_user);
700 if ((CCC->user.axlevel < AxAideU) && (strcasecmp(who,CCC->curr_user))) {
701 cprintf("%d Higher access required.\n",
702 ERROR + HIGHER_ACCESS_REQUIRED);
706 if (CtdlGetUser(&usbuf, who) != 0) {
707 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
711 v = vcard_get_user(&usbuf);
713 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
714 cprintf("%ld\n", usbuf.usernum);
715 cprintf("%s\n", usbuf.password);
716 s = vcard_get_prop(v, "n", 1, 0, 0);
717 cprintf("%s\n", s ? s : " "); /* name */
719 s = vcard_get_prop(v, "adr", 1, 0, 0);
720 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
722 extract_token(buf, adr, 2, ';', sizeof buf);
723 cprintf("%s\n", buf); /* street */
724 extract_token(buf, adr, 3, ';', sizeof buf);
725 cprintf("%s\n", buf); /* city */
726 extract_token(buf, adr, 4, ';', sizeof buf);
727 cprintf("%s\n", buf); /* state */
728 extract_token(buf, adr, 5, ';', sizeof buf);
729 cprintf("%s\n", buf); /* zip */
731 s = vcard_get_prop(v, "tel", 1, 0, 0);
732 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
740 cprintf("%d\n", usbuf.axlevel);
742 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
743 cprintf("%s\n", s ? s : " ");
744 s = vcard_get_prop(v, "adr", 0, 0, 0);
745 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
747 extract_token(buf, adr, 6, ';', sizeof buf);
748 cprintf("%s\n", buf); /* country */
756 * When a user is being created, create his/her vCard.
758 void vcard_newuser(struct ctdluser *usbuf) {
763 int need_default_vcard;
765 need_default_vcard =1;
766 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
767 syslog(LOG_DEBUG, "Converted <%s> to <%s>", usbuf->fullname, vname);
769 /* Create and save the vCard */
771 if (v == NULL) return;
772 vcard_add_prop(v, "fn", usbuf->fullname);
773 vcard_add_prop(v, "n", vname);
774 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
776 #ifdef HAVE_GETPWUID_R
777 /* If using host auth mode, we add an email address based on the login */
778 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
780 char pwd_buffer[SIZ];
782 #ifdef SOLARIS_GETPWUID
783 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
784 #else // SOLARIS_GETPWUID
785 struct passwd *result = NULL;
786 syslog(LOG_DEBUG, "Searching for uid %d", usbuf->uid);
787 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
788 #endif // HAVE_GETPWUID_R
789 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, CtdlGetConfigStr("c_fqdn"));
790 vcard_add_prop(v, "email;internet", buf);
791 need_default_vcard = 0;
799 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
800 * into the user's vCard.
802 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
807 found_user = CtdlTryUserLDAP(usbuf->fullname, ldap_dn, sizeof ldap_dn, ldap_cn, sizeof ldap_cn, &usbuf->uid,1);
808 if (found_user == 0) {
809 if (Ctdl_LDAP_to_vCard(ldap_dn, v)) {
810 /* Allow global address book and internet directory update without login long enough to write this. */
811 CC->vcard_updated_by_ldap++; /* Otherwise we'll only update the user config. */
812 need_default_vcard = 0;
813 syslog(LOG_DEBUG, "LDAP Created Initial Vcard for %s\n",usbuf->fullname);
818 if (need_default_vcard!=0) {
819 /* Everyone gets an email address based on their display name */
820 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, CtdlGetConfigStr("c_fqdn"));
821 for (i=0; buf[i]; ++i) {
822 if (buf[i] == ' ') buf[i] = '_';
824 vcard_add_prop(v, "email;internet", buf);
827 vcard_write_user(usbuf, v);
833 * When a user is being deleted, we have to remove his/her vCard.
834 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
835 * field, and the same Exclusive ID as the existing card.
837 void vcard_purge(struct ctdluser *usbuf) {
838 struct CtdlMessage *msg;
842 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
843 if (msg == NULL) return;
844 memset(msg, 0, sizeof(struct CtdlMessage));
846 msg->cm_magic = CTDLMESSAGE_MAGIC;
847 msg->cm_anon_type = MES_NORMAL;
848 msg->cm_format_type = 0;
849 if (!IsEmptyStr(usbuf->fullname)) {
850 CM_SetField(msg, eAuthor, usbuf->fullname, strlen(usbuf->fullname));
852 CM_SetField(msg, eOriginalRoom, HKEY(ADDRESS_BOOK_ROOM));
853 CM_SetField(msg, eNodeName, CtdlGetConfigStr("c_nodename"), strlen(CtdlGetConfigStr("c_nodename")));
854 CM_SetField(msg, eMesageText, HKEY("Purge this vCard\n"));
856 len = snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
857 msg->cm_fields[eAuthor], NODENAME);
858 CM_SetField(msg, eExclusiveID, buf, len);
860 CM_SetField(msg, eSpecialField, HKEY("CANCEL"));
862 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
868 * Grab vCard directory stuff out of incoming network messages
870 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
874 if (msg == NULL) return(0);
876 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
880 if (msg->cm_format_type != 4) return(0);
882 if (CM_IsEmpty(msg, eMesageText))
885 ptr = msg->cm_fields[eMesageText];
887 while (ptr != NULL) {
889 linelen = strcspn(ptr, "\n");
890 if (linelen == 0) return(0); /* end of headers */
892 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
893 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
894 /* It's a vCard. Add it to the directory. */
895 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
899 ptr = strchr((char *)ptr, '\n');
900 if (ptr != NULL) ++ptr;
909 * When a vCard is being removed from the Global Address Book room, remove it
910 * from the directory as well.
912 void vcard_delete_remove(char *room, long msgnum) {
913 struct CtdlMessage *msg;
917 if (msgnum <= 0L) return;
919 if (room == NULL) return;
921 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
925 msg = CtdlFetchMessage(msgnum, 1, 1);
926 if (msg == NULL) return;
928 if (CM_IsEmpty(msg, eMesageText))
931 ptr = msg->cm_fields[eMesageText];
933 while (ptr != NULL) {
934 linelen = strcspn(ptr, "\n");
935 if (linelen == 0) goto EOH;
937 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
938 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
939 /* Bingo! A vCard is being deleted. */
940 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
942 ptr = strchr((char *)ptr, '\n');
943 if (ptr != NULL) ++ptr;
952 * Get Valid Screen Names
954 void cmd_gvsn(char *argbuf)
956 struct CitContext *CCC = CC;
958 if (CtdlAccessCheck(ac_logged_in)) return;
960 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
961 cprintf("%s\n", CCC->user.fullname);
962 if ( (!IsEmptyStr(CCC->cs_inet_fn)) && (strcasecmp(CCC->user.fullname, CCC->cs_inet_fn)) ) {
963 cprintf("%s\n", CCC->cs_inet_fn);
970 * Get Valid Email Addresses
972 void cmd_gvea(char *argbuf)
974 struct CitContext *CCC = CC;
975 int num_secondary_emails = 0;
979 if (CtdlAccessCheck(ac_logged_in)) return;
981 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
982 if (!IsEmptyStr(CCC->cs_inet_email)) {
983 cprintf("%s\n", CCC->cs_inet_email);
985 if (!IsEmptyStr(CCC->cs_inet_other_emails)) {
986 num_secondary_emails = num_tokens(CCC->cs_inet_other_emails, '|');
987 for (i=0; i<num_secondary_emails; ++i) {
988 extract_token(buf, CCC->cs_inet_other_emails,i,'|',sizeof CCC->cs_inet_other_emails);
989 cprintf("%s\n", buf);
999 * Callback function for cmd_dvca() that hunts for vCard content types
1000 * and outputs any email addresses found within.
1002 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1003 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1004 char *cbid, void *cbuserdata) {
1007 char displayname[256] = "";
1008 int displayname_len;
1009 char emailaddr[256] = "";
1013 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1017 v = vcard_load(content);
1018 if (v == NULL) return;
1020 extract_friendly_name(displayname, sizeof displayname, v);
1021 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1023 displayname_len = strlen(displayname);
1024 for (i=0; i<displayname_len; ++i) {
1025 if (displayname[i] == '\"') displayname[i] = ' ';
1026 if (displayname[i] == ';') displayname[i] = ',';
1027 if (displayname[i] == ',') has_commas = 1;
1029 striplt(displayname);
1031 cprintf("%s%s%s <%s>\n",
1032 (has_commas ? "\"" : ""),
1034 (has_commas ? "\"" : ""),
1043 * Back end callback function for cmd_dvca()
1045 * It's basically just passed a list of message numbers, which we're going
1046 * to fetch off the disk and then pass along to the MIME parser via another
1047 * layer of callback...
1049 void dvca_callback(long msgnum, void *userdata) {
1050 struct CtdlMessage *msg = NULL;
1052 msg = CtdlFetchMessage(msgnum, 1, 1);
1053 if (msg == NULL) return;
1054 mime_parser(CM_RANGE(msg, eMesageText),
1055 *dvca_mime_callback, /* callback function */
1057 NULL, /* user data */
1065 * Dump VCard Addresses
1067 void cmd_dvca(char *argbuf)
1069 if (CtdlAccessCheck(ac_logged_in)) return;
1071 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1072 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1080 void cmd_qdir(char *argbuf) {
1081 char citadel_addr[256];
1082 char internet_addr[256];
1084 if (CtdlAccessCheck(ac_logged_in)) return;
1086 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1088 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1089 cprintf("%d %s was not found.\n",
1090 ERROR + NO_SUCH_USER, internet_addr);
1094 cprintf("%d %s\n", CIT_OK, citadel_addr);
1098 * Query Directory, in fact an alias to match postfix tcp auth.
1100 void check_get(void) {
1101 char internet_addr[256];
1106 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1107 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1108 syslog(LOG_CRIT, "vcard client disconnected: ending session.");
1109 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1112 syslog(LOG_INFO, ": %s", cmdbuf);
1113 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1114 syslog(LOG_INFO, "[ %s]", cmdbuf);
1116 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1119 char *argbuf = &cmdbuf[4];
1121 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1122 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1123 if ((rcpt != NULL)&&
1125 (*rcpt->recp_local != '\0')||
1126 (*rcpt->recp_room != '\0')||
1127 (*rcpt->recp_ignet != '\0')))
1130 cprintf("200 OK %s\n", internet_addr);
1131 syslog(LOG_INFO, "sending 200 OK for the room %s", rcpt->display_recp);
1135 cprintf("500 REJECT noone here by that name.\n");
1137 syslog(LOG_INFO, "sending 500 REJECT no one here by that name: %s", internet_addr);
1140 free_recipients(rcpt);
1143 cprintf("500 REJECT invalid Query.\n");
1144 syslog(LOG_INFO, "sending 500 REJECT invalid query: %s", internet_addr);
1148 void check_get_greeting(void) {
1149 /* dummy function, we have no greeting in this verry simple protocol. */
1154 * We don't know if the Contacts room exists so we just create it at login
1156 void vcard_CtdlCreateRoom(void)
1161 /* Create the calendar room if it doesn't already exist */
1162 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1164 /* Set expiration policy to manual; otherwise objects will be lost! */
1165 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1166 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!");
1169 qr.QRep.expire_mode = EXPIRE_MANUAL;
1170 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1171 CtdlPutRoomLock(&qr);
1173 /* Set the view to a calendar view */
1174 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1175 vbuf.v_view = 2; /* 2 = address book view */
1176 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1185 * When a user logs in...
1187 void vcard_session_login_hook(void) {
1188 struct vCard *v = NULL;
1189 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1193 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1194 * into the user's vCard.
1196 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
1197 v = vcard_get_user(&CCC->user);
1199 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1200 CCC->vcard_updated_by_ldap++; /* Make sure changes make it to the global address book and internet directory, not just the user config. */
1201 syslog(LOG_DEBUG, "LDAP Detected vcard change.\n");
1202 vcard_write_user(&CCC->user, v);
1209 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1210 * These are inserted into the session data for various message entry commands to use.
1212 v = vcard_get_user(&CCC->user);
1214 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1215 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1218 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1223 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1225 vcard_CtdlCreateRoom();
1230 * Turn an arbitrary RFC822 address into a struct vCard for possible
1231 * inclusion into an address book.
1233 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1235 char user[256], node[256], name[256], email[256], n[256], uid[256];
1239 if (v == NULL) return(NULL);
1241 process_rfc822_addr(addr, user, node, name);
1242 vcard_set_prop(v, "fn", name, 0);
1244 vcard_fn_to_n(n, name, sizeof n);
1245 vcard_set_prop(v, "n", n, 0);
1247 snprintf(email, sizeof email, "%s@%s", user, node);
1248 vcard_set_prop(v, "email;internet", email, 0);
1250 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1251 for (i=0; uid[i]; ++i) {
1252 if (isspace(uid[i])) uid[i] = '_';
1253 uid[i] = tolower(uid[i]);
1255 vcard_set_prop(v, "UID", uid, 0);
1263 * This is called by store_harvested_addresses() to remove from the
1264 * list any addresses we already have in our address book.
1266 void strip_addresses_already_have(long msgnum, void *userdata) {
1267 char *collected_addresses;
1268 struct CtdlMessage *msg = NULL;
1272 char addr[256], user[256], node[256], name[256];
1274 collected_addresses = (char *)userdata;
1276 msg = CtdlFetchMessage(msgnum, 1, 1);
1277 if (msg == NULL) return;
1278 v = vcard_load(msg->cm_fields[eMesageText]);
1282 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1284 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1285 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1287 /* Remove the address if we already have it! */
1288 process_rfc822_addr(addr, user, node, name);
1289 snprintf(addr, sizeof addr, "%s@%s", user, node);
1290 if (!strcasecmp(value, addr)) {
1291 remove_token(collected_addresses, j, ',');
1303 * Back end function for store_harvested_addresses()
1305 void store_this_ha(struct addresses_to_be_filed *aptr) {
1306 struct CtdlMessage *vmsg = NULL;
1308 struct vCard *v = NULL;
1309 char recipient[256];
1312 /* First remove any addresses we already have in the address book */
1313 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL, NULL, NULL);
1314 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1315 strip_addresses_already_have, aptr->collected_addresses);
1317 if (!IsEmptyStr(aptr->collected_addresses))
1318 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1320 /* Make a vCard out of each address */
1321 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1323 v = vcard_new_from_rfc822_addr(recipient);
1326 vmsg = malloc(sizeof(struct CtdlMessage));
1327 memset(vmsg, 0, sizeof(struct CtdlMessage));
1328 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1329 vmsg->cm_anon_type = MES_NORMAL;
1330 vmsg->cm_format_type = FMT_RFC822;
1331 CM_SetField(vmsg, eAuthor, HKEY("Citadel"));
1332 s = vcard_get_prop(v, "UID", 1, 0, 0);
1333 if (!IsEmptyStr(s)) {
1334 CM_SetField(vmsg, eExclusiveID, s, strlen(s));
1336 ser = vcard_serialize(v);
1341 serlen = strlen(ser);
1342 buf = NewStrBufPlain(NULL, serlen + 1024);
1344 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
1345 StrBufAppendBufPlain(buf, ser, serlen, 0);
1346 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
1347 CM_SetAsFieldSB(vmsg, eMesageText, &buf);
1352 syslog(LOG_DEBUG, "Adding contact: %s", recipient);
1353 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1358 free(aptr->roomname);
1359 free(aptr->collected_addresses);
1365 * When a user sends a message, we may harvest one or more email addresses
1366 * from the recipient list to be added to the user's address book. But we
1367 * want to do this asynchronously so it doesn't keep the user waiting.
1369 void store_harvested_addresses(void) {
1371 struct addresses_to_be_filed *aptr = NULL;
1373 if (atbf == NULL) return;
1375 begin_critical_section(S_ATBF);
1376 while (atbf != NULL) {
1379 end_critical_section(S_ATBF);
1380 store_this_ha(aptr);
1381 begin_critical_section(S_ATBF);
1383 end_critical_section(S_ATBF);
1388 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1389 * really this is just so we expose the vCard data to the full text indexer.
1391 void vcard_fixed_output(char *ptr, int len) {
1392 char *serialized_vcard;
1397 serialized_vcard = malloc(len + 1);
1398 safestrncpy(serialized_vcard, ptr, len+1);
1399 v = vcard_load(serialized_vcard);
1400 free(serialized_vcard);
1403 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1404 value = vcard_get_prop(v, "", 0, i++, 0);
1405 cprintf("%s\n", value);
1412 const char *CitadelServiceDICT_TCP="DICT_TCP";
1414 CTDL_MODULE_INIT(vcard)
1417 //char filename[256];
1423 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN, PRIO_LOGIN + 70);
1424 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1425 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1426 CtdlRegisterDeleteHook(vcard_delete_remove);
1427 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1428 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1429 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1430 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1431 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1432 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1433 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1434 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1435 CtdlRegisterNetprocHook(vcard_extract_from_network);
1436 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER, PRIO_CLEANUP + 470);
1437 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1438 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1440 /* Create the Global Address Book room if necessary */
1441 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1443 /* Set expiration policy to manual; otherwise objects will be lost! */
1444 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1445 qr.QRep.expire_mode = EXPIRE_MANUAL;
1446 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1447 CtdlPutRoomLock(&qr);
1450 * Also make sure it has a netconfig file, so the networker runs
1451 * on this room even if we don't share it with any other nodes.
1452 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1455 * FIXME this no longer works
1458 //assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1459 //fp = fopen(filename, "a");
1462 //rv = chown(filename, CTDLUID, (-1));
1464 //syslog(LOG_ERR, "Failed to adjust ownership of %s: %s", filename, strerror(errno));
1466 //rv = chmod(filename, 0600);
1468 //syslog(LOG_ERR, "Failed to adjust ownership of %s: %s", filename, strerror(errno));
1472 //syslog(LOG_ERR, "Cannot create %s: %s", filename, strerror(errno));
1476 /* for postfix tcpdict */
1477 CtdlRegisterServiceHook(CtdlGetConfigInt("c_pftcpdict_port"), /* Postfix */
1482 CitadelServiceDICT_TCP);
1485 /* return our module name for the log */