2 * A server-side module for Citadel which supports address book information
3 * using the standard vCard format.
5 * Copyright (c) 1999-2022 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"
31 #include "../../sysdep.h"
40 #include <sys/types.h>
45 #include <libcitadel.h>
46 #include "../../citadel_defs.h"
47 #include "../../server.h"
48 #include "../../citserver.h"
49 #include "../../support.h"
50 #include "../../config.h"
51 #include "../../control.h"
52 #include "../../user_ops.h"
53 #include "../../database.h"
54 #include "../../msgbase.h"
55 #include "../../room_ops.h"
56 #include "../../internet_addressing.h"
57 #include "../../serv_vcard.h"
58 #include "../../citadel_ldap.h"
59 #include "../../ctdl_module.h"
62 * set global flag calling for an aide to validate new users
64 void set_mm_valid(void) {
67 begin_critical_section(S_CONTROL);
68 flags = CtdlGetConfigInt("MMflags");
69 flags = flags | MM_VALID ;
70 CtdlSetConfigInt("MMflags", flags);
71 end_critical_section(S_CONTROL);
79 * See if there is a valid Internet address in a vCard to use for outbound
80 * Internet messages. If there is, stick it in the buffer.
82 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
83 char *secemailaddrbuf, size_t secemailaddrbuf_len,
89 int IsDirectoryAddress;
90 int saved_instance = 0;
92 /* Go through the vCard searching for *all* Internet email addresses
94 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
95 k = vcard_get_prop(v, "email", 1, instance, 1);
96 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
99 if (!IsEmptyStr(addr)) {
100 IsDirectoryAddress = IsDirectory(addr, 1);
102 syslog(LOG_DEBUG, "EVQ: addr=<%s> IsDirectoryAddress=<%d> local_addrs_only=<%d>", addr, IsDirectoryAddress, local_addrs_only);
104 if ( IsDirectoryAddress || !local_addrs_only)
107 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
108 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
110 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
111 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
113 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
114 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
115 < secemailaddrbuf_len ) {
116 strcat(secemailaddrbuf, "|");
117 strcat(secemailaddrbuf, addr);
121 if (!IsDirectoryAddress && local_addrs_only)
123 StrBufAppendPrintf(CC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
124 StrBufAppendBufPlain(CC->StatusMessage, addr, -1, 0);
125 StrBufAppendBufPlain(CC->StatusMessage, HKEY("|"), 0);
126 StrBufAppendBufPlain(CC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
137 * See if there is a name / screen name / friendly name in a vCard to use for outbound
138 * Internet messages. If there is, stick it in the buffer.
140 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
144 s = vcard_get_prop(v, "fn", 1, 0, 0);
146 s = vcard_get_prop(v, "n", 1, 0, 0);
150 safestrncpy(namebuf, s, namebuf_len);
156 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
158 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
159 void *content, char *cbtype, char *cbcharset, size_t length,
160 char *encoding, char *cbid, void *cbuserdata)
162 struct vCard **v = (struct vCard **) cbuserdata;
164 if ( (!strcasecmp(cbtype, "text/x-vcard"))
165 || (!strcasecmp(cbtype, "text/vcard")) ) {
167 syslog(LOG_DEBUG, "vcard: part %s contains a vCard! Loading...", partnum);
171 *v = vcard_load(content);
177 * This handler detects whether the user is attempting to save a new
178 * vCard as part of his/her personal configuration, and handles the replace
179 * function accordingly (delete the user's existing vCard in the config room
180 * and in the global address book).
182 int vcard_upload_beforesave(struct CtdlMessage *msg, struct recptypes *recp) {
185 struct ctdluser usbuf;
187 struct vCard *v = NULL;
190 int yes_my_citadel_config = 0;
191 int yes_any_vcard_room = 0;
193 if ((!CC->logged_in) && (CC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
195 /* Is this some user's "My Citadel Config" room? */
196 if (((CC->room.QRflags & QR_MAILBOX) != 0) &&
197 (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
198 /* Yes, we want to do this */
199 yes_my_citadel_config = 1;
200 #ifdef VCARD_SAVES_BY_AIDES_ONLY
201 /* Prevent non-aides from performing registration changes, but ldap is ok. */
202 if ((CC->user.axlevel < AxAideU) && (CC->vcard_updated_by_ldap==0)) {
209 /* Is this a room with an address book in it? */
210 if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
211 yes_any_vcard_room = 1;
214 /* If neither condition exists, don't run this hook. */
215 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
219 /* If this isn't a MIME message, don't bother. */
220 if (msg->cm_format_type != 4) return(0);
222 /* Ok, if we got this far, look into the situation further... */
224 if (CM_IsEmpty(msg, eMesageText)) return(0);
226 mime_parser(CM_RANGE(msg, eMesageText),
227 *vcard_extract_vcard,
229 &v, /* user data ptr - put the vcard here */
233 if (v == NULL) return(0); /* no vCards were found in this message */
235 /* If users cannot create their own accounts, they cannot re-register either. */
236 if ( (yes_my_citadel_config) &&
237 (CtdlGetConfigInt("c_disable_newu")) &&
238 (CC->user.axlevel < AxAideU) &&
239 (CC->vcard_updated_by_ldap==0) )
244 vcard_get_prop(v, "fn", 1, 0, 0);
247 if (yes_my_citadel_config) {
248 /* Bingo! The user is uploading a new vCard, so
249 * delete the old one. First, figure out which user
250 * is being re-registered...
252 what_user = atol(CC->room.QRname);
254 if (what_user == CC->user.usernum) {
255 /* It's the logged in user. That was easy. */
256 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
259 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
260 /* We fetched a valid user record */
264 /* somebody set up us the bomb! */
265 yes_my_citadel_config = 0;
269 if (yes_my_citadel_config) {
270 /* Delete the user's old vCard. This would probably
271 * get taken care of by the replication check, but we
272 * want to make sure there is absolutely only one
273 * vCard in the user's config room at all times.
276 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
278 /* Make the author of the message the name of the user. */
279 if (!IsEmptyStr(usbuf.fullname)) {
280 CM_SetField(msg, eAuthor, usbuf.fullname, strlen(usbuf.fullname));
284 /* Insert or replace RFC2739-compliant free/busy URL */
285 if (yes_my_citadel_config) {
286 sprintf(buf, "http://%s/%s.vfb",
287 CtdlGetConfigStr("c_fqdn"),
289 for (i=0; buf[i]; ++i) {
290 if (buf[i] == ' ') buf[i] = '_';
292 vcard_set_prop(v, "FBURL;PREF", buf, 0);
296 s = vcard_get_prop(v, "UID", 1, 0, 0);
297 if (s == NULL) { /* Note LDAP auth sets UID from the LDAP UUID, use that if it exists. */
298 /* Enforce local UID policy if applicable */
299 if (yes_my_citadel_config) {
300 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields[eAuthor], NODENAME);
302 /* If the vCard has no UID, then give it one. */
305 vcard_set_prop(v, "UID", buf, 0);
310 * Set the EUID of the message to the UID of the vCard.
312 CM_FlushField(msg, eExclusiveID);
314 s = vcard_get_prop(v, "UID", 1, 0, 0);
315 if (!IsEmptyStr(s)) {
316 CM_SetField(msg, eExclusiveID, s, strlen(s));
317 if (CM_IsEmpty(msg, eMsgSubject)) {
318 CM_CopyField(msg, eMsgSubject, eExclusiveID);
323 * Set the Subject to the name in the vCard.
325 s = vcard_get_prop(v, "FN", 1, 0, 0);
327 s = vcard_get_prop(v, "N", 1, 0, 0);
329 if (!IsEmptyStr(s)) {
330 CM_SetField(msg, eMsgSubject, s, strlen(s));
333 /* Re-serialize it back into the msg body */
334 ser = vcard_serialize(v);
335 if (!IsEmptyStr(ser)) {
339 serlen = strlen(ser);
340 buf = NewStrBufPlain(NULL, serlen + 1024);
342 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
343 StrBufAppendBufPlain(buf, ser, serlen, 0);
344 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
345 CM_SetAsFieldSB(msg, eMesageText, &buf);
349 /* Now allow the save to complete. */
356 * This handler detects whether the user is attempting to save a new
357 * vCard as part of his/her personal configuration, and handles the replace
358 * function accordingly (copy the vCard from the config room to the global
361 int vcard_upload_aftersave(struct CtdlMessage *msg, struct recptypes *recp) {
367 int is_MY_UserConf=0;
369 char roomname[ROOMNAMELEN];
371 if (msg->cm_format_type != 4) return(0);
372 if ((!CC->logged_in) && (CC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
374 /* We're interested in user config rooms only. */
376 if ( !IsEmptyStr(CC->room.QRname) &&
377 (strlen(CC->room.QRname) >= 12) &&
378 (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
379 is_UserConf = 1; /* It's someone's config room */
381 CtdlMailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
382 if (!strcasecmp(CC->room.QRname, roomname)) {
384 is_MY_UserConf = 1; /* It's MY config room */
386 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
387 is_GAB = 1; /* It's the Global Address Book */
390 if (!is_UserConf && !is_GAB) return(0);
392 if (CM_IsEmpty(msg, eMesageText))
395 ptr = msg->cm_fields[eMesageText];
397 CC->vcard_updated_by_ldap=0; /* As this will write LDAP's previous changes, disallow LDAP change auth until next LDAP change. */
399 NewStrBufDupAppendFlush(&CC->StatusMessage, NULL, NULL, 0);
401 StrBufPrintf(CC->StatusMessage, "%d\n", LISTING_FOLLOWS);
403 while (ptr != NULL) {
405 linelen = strcspn(ptr, "\n");
406 if (linelen == 0) return(0); /* end of headers */
408 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
409 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
411 * Bingo! The user is uploading a new vCard, so
412 * copy it to the Global Address Book room.
415 I = atol(msg->cm_fields[eVltMsgNum]);
416 if (I <= 0L) return(0);
418 /* Store our friendly/display name in memory */
419 if (is_MY_UserConf) {
420 v = vcard_load(msg->cm_fields[eMesageText]);
421 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
426 { // This is not the GAB
427 /* Put it in the Global Address Book room... */
428 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
431 /* Some sites want an Aide to be notified when a
432 * user registers or re-registers
433 * But if the user was an Aide or was edited by an Aide then we can
434 * Assume they don't need validating.
436 if (CC->user.axlevel >= AxAideU) {
437 CtdlLockGetCurrentUser();
438 CC->user.flags |= US_REGIS;
439 CtdlPutCurrentUserLock();
445 /* ...which also means we need to flag the user */
446 CtdlLockGetCurrentUser();
447 CC->user.flags |= (US_REGIS|US_NEEDVALID);
448 CtdlPutCurrentUserLock();
453 ptr = strchr((char *)ptr, '\n');
454 if (ptr != NULL) ++ptr;
463 * back end function used for callbacks
465 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
468 msgnum = (long *) userdata;
469 *msgnum = supplied_msgnum;
474 * If this user has a vcard on disk, read it into memory, otherwise allocate
475 * and return an empty vCard.
477 struct vCard *vcard_get_user(struct ctdluser *u) {
478 char hold_rm[ROOMNAMELEN];
479 char config_rm[ROOMNAMELEN];
480 struct CtdlMessage *msg = NULL;
484 strcpy(hold_rm, CC->room.QRname); /* save current room */
485 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
487 if (CtdlGetRoom(&CC->room, config_rm) != 0) {
488 CtdlGetRoom(&CC->room, hold_rm);
492 /* We want the last (and probably only) vcard in this room */
494 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
495 NULL, vcard_gu_backend, (void *)&VCmsgnum );
496 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
498 if (VCmsgnum < 0L) return vcard_new();
500 msg = CtdlFetchMessage(VCmsgnum, 1);
501 if (msg == NULL) return vcard_new();
503 v = vcard_load(msg->cm_fields[eMesageText]);
510 * Store this user's vCard in the appropriate place
513 * Write our config to disk
515 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
518 ser = vcard_serialize(v);
520 ser = strdup("begin:vcard\r\nend:vcard\r\n");
522 if (ser == NULL) return;
524 /* This handy API function does all the work for us.
525 * NOTE: normally we would want to set that last argument to 1, to
526 * force the system to delete the user's old vCard. But it doesn't
527 * have to, because the vcard_upload_beforesave() hook above
528 * is going to notice what we're trying to do, and delete the old vCard.
530 CtdlWriteObject(USERCONFIGROOM, /* which room */
531 VCARD_MIME_TYPE, /* MIME type */
533 strlen(ser)+1, /* length */
544 * Old style "enter registration info" command. This function simply honors
545 * the REGI protocol command, translates the entered parameters into a vCard,
546 * and enters the vCard into the user's configuration.
548 void cmd_regi(char *argbuf) {
551 struct vCard *my_vcard;
557 char tmpaddress[SIZ];
558 char tmpcountry[SIZ];
562 if (!(CC->logged_in)) {
563 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
567 /* If users cannot create their own accounts, they cannot re-register either. */
568 if ( (CtdlGetConfigInt("c_disable_newu")) && (CC->user.axlevel < AxAideU) ) {
569 cprintf("%d Self-service registration is not allowed here.\n",
570 ERROR + HIGHER_ACCESS_REQUIRED);
573 my_vcard = vcard_get_user(&CC->user);
576 strcpy(tmpstate, "");
578 strcpy(tmpcountry, "USA");
580 cprintf("%d Send registration...\n", SEND_LISTING);
582 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
583 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
584 if (a==1) strcpy(tmpaddr, buf);
585 if (a==2) strcpy(tmpcity, buf);
586 if (a==3) strcpy(tmpstate, buf);
588 for (c=0; buf[c]; ++c) {
589 if ((buf[c]>='0') && (buf[c]<='9')) {
596 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
597 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
598 if (a==7) strcpy(tmpcountry, buf);
602 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
603 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
604 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
605 vcard_write_user(&CC->user, my_vcard);
606 vcard_free(my_vcard);
611 * Protocol command to fetch registration info for a user
613 void cmd_greg(char *argbuf)
615 struct ctdluser usbuf;
618 char who[USERNAME_SIZE];
622 extract_token(who, argbuf, 0, '|', sizeof who);
624 if (!(CC->logged_in)) {
625 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
629 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
631 if ((CC->user.axlevel < AxAideU) && (strcasecmp(who,CC->curr_user))) {
632 cprintf("%d Higher access required.\n", ERROR + HIGHER_ACCESS_REQUIRED);
636 if (CtdlGetUser(&usbuf, who) != 0) {
637 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
641 v = vcard_get_user(&usbuf);
643 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
644 cprintf("%ld\n", usbuf.usernum);
645 cprintf("%s\n", usbuf.password);
646 s = vcard_get_prop(v, "n", 1, 0, 0);
647 cprintf("%s\n", s ? s : " "); /* name */
648 s = vcard_get_prop(v, "adr", 1, 0, 0);
649 snprintf(adr, sizeof adr, "%s", s ? s : " "); /* address */
650 extract_token(buf, adr, 2, ';', sizeof buf);
651 cprintf("%s\n", buf); /* street */
652 extract_token(buf, adr, 3, ';', sizeof buf);
653 cprintf("%s\n", buf); /* city */
654 extract_token(buf, adr, 4, ';', sizeof buf);
655 cprintf("%s\n", buf); /* state */
656 extract_token(buf, adr, 5, ';', sizeof buf);
657 cprintf("%s\n", buf); /* zip */
659 s = vcard_get_prop(v, "tel", 1, 0, 0);
660 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
668 cprintf("%d\n", usbuf.axlevel);
670 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
671 cprintf("%s\n", s ? s : " ");
672 s = vcard_get_prop(v, "adr", 0, 0, 0);
673 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
675 extract_token(buf, adr, 6, ';', sizeof buf);
676 cprintf("%s\n", buf); /* country */
684 * When a user is being created, create his/her vCard.
686 void vcard_newuser(struct ctdluser *usbuf) {
691 int need_default_vcard;
693 need_default_vcard =1;
694 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
695 syslog(LOG_DEBUG, "vcard: converted <%s> to <%s>", usbuf->fullname, vname);
697 /* Create and save the vCard */
699 if (v == NULL) return;
700 vcard_add_prop(v, "fn", usbuf->fullname);
701 vcard_add_prop(v, "n", vname);
702 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
704 #ifdef HAVE_GETPWUID_R
705 /* If using host auth mode, we add an email address based on the login */
706 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
708 char pwd_buffer[SIZ];
709 struct passwd *result = NULL;
710 syslog(LOG_DEBUG, "vcard: searching for uid %d", usbuf->uid);
711 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
712 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, CtdlGetConfigStr("c_fqdn"));
713 vcard_add_prop(v, "email;internet", buf);
714 need_default_vcard = 0;
720 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
721 * into the user's vCard.
723 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
729 syslog(LOG_DEBUG, "\033[31m FIXME BORK BORK BORK try lookup by uid , or maybe dn?\033[0m");
731 found_user = CtdlTryUserLDAP(usbuf->fullname, ldap_dn, sizeof ldap_dn, ldap_cn, sizeof ldap_cn, &usbuf->uid);
732 if (found_user == 0) {
733 if (Ctdl_LDAP_to_vCard(ldap_dn, v)) {
734 /* Allow global address book and internet directory update without login long enough to write this. */
735 CC->vcard_updated_by_ldap++; /* Otherwise we'll only update the user config. */
736 need_default_vcard = 0;
737 syslog(LOG_DEBUG, "vcard: LDAP Created Initial vCard for %s\n",usbuf->fullname);
742 if (need_default_vcard!=0) {
743 /* Everyone gets an email address based on their display name */
744 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, CtdlGetConfigStr("c_fqdn"));
745 for (i=0; buf[i]; ++i) {
746 if (buf[i] == ' ') buf[i] = '_';
748 vcard_add_prop(v, "email;internet", buf);
750 vcard_write_user(usbuf, v);
756 * Get Valid Screen Names
758 void cmd_gvsn(char *argbuf)
760 if (CtdlAccessCheck(ac_logged_in)) return;
762 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
763 cprintf("%s\n", CC->user.fullname);
764 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
765 cprintf("%s\n", CC->cs_inet_fn);
772 * Get Valid Email Addresses
773 * FIXME this doesn't belong in serv_vcard.c anymore , maybe move it to internet_addressing.c
775 void cmd_gvea(char *argbuf)
777 int num_secondary_emails = 0;
781 if (CtdlAccessCheck(ac_logged_in)) return;
783 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
784 if (!IsEmptyStr(CC->cs_inet_email)) {
785 cprintf("%s\n", CC->cs_inet_email);
787 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
788 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
789 for (i=0; i<num_secondary_emails; ++i) {
790 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
791 cprintf("%s\n", buf);
799 * Callback function for cmd_dvca() that hunts for vCard content types
800 * and outputs any email addresses found within.
802 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
803 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
804 char *cbid, void *cbuserdata) {
807 char displayname[256] = "";
809 char emailaddr[256] = "";
813 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
817 v = vcard_load(content);
818 if (v == NULL) return;
820 extract_friendly_name(displayname, sizeof displayname, v);
821 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
823 displayname_len = strlen(displayname);
824 for (i=0; i<displayname_len; ++i) {
825 if (displayname[i] == '\"') displayname[i] = ' ';
826 if (displayname[i] == ';') displayname[i] = ',';
827 if (displayname[i] == ',') has_commas = 1;
829 string_trim(displayname);
831 cprintf("%s%s%s <%s>\n",
832 (has_commas ? "\"" : ""),
834 (has_commas ? "\"" : ""),
843 * Back end callback function for cmd_dvca()
845 * It's basically just passed a list of message numbers, which we're going
846 * to fetch off the disk and then pass along to the MIME parser via another
847 * layer of callback...
849 void dvca_callback(long msgnum, void *userdata) {
850 struct CtdlMessage *msg = NULL;
852 msg = CtdlFetchMessage(msgnum, 1);
853 if (msg == NULL) return;
854 mime_parser(CM_RANGE(msg, eMesageText),
855 *dvca_mime_callback, /* callback function */
857 NULL, /* user data */
865 * Dump VCard Addresses
867 void cmd_dvca(char *argbuf)
869 if (CtdlAccessCheck(ac_logged_in)) return;
871 cprintf("%d addresses:\n", LISTING_FOLLOWS);
872 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
880 void cmd_qdir(char *argbuf) {
881 char citadel_addr[256];
882 char internet_addr[256];
884 if (CtdlAccessCheck(ac_logged_in)) return;
886 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
888 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
889 cprintf("%d %s was not found.\n",
890 ERROR + NO_SUCH_USER, internet_addr);
894 cprintf("%d %s\n", CIT_OK, citadel_addr);
899 * Query Directory, in fact an alias to match postfix tcp auth.
901 void check_get(void) {
902 char internet_addr[256];
907 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
908 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
909 syslog(LOG_ERR, "vcard: client disconnected: ending session.");
910 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
913 syslog(LOG_INFO, ": %s", cmdbuf);
914 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
915 syslog(LOG_INFO, "[ %s]", cmdbuf);
917 if (strncasecmp(cmdbuf, "GET ", 4)==0)
919 struct recptypes *rcpt;
920 char *argbuf = &cmdbuf[4];
922 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
923 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXIST);
924 if ( (rcpt != NULL) &&
926 (*rcpt->recp_local != '\0') ||
927 (*rcpt->recp_room != '\0')
930 cprintf("200 OK %s\n", internet_addr);
931 syslog(LOG_INFO, "vcard: sending 200 OK for the room %s", rcpt->display_recp);
935 cprintf("500 REJECT no one here by that name.\n");
937 syslog(LOG_INFO, "vcard: sending 500 REJECT no one here by that name: %s", internet_addr);
940 free_recipients(rcpt);
943 cprintf("500 REJECT invalid Query.\n");
944 syslog(LOG_INFO, "vcard: sending 500 REJECT invalid query: %s", internet_addr);
949 void check_get_greeting(void) {
950 /* dummy function, we have no greeting in this very simple protocol. */
955 * We don't know if the Contacts room exists so we just create it at login
957 void vcard_CtdlCreateRoom(void)
962 /* Create the calendar room if it doesn't already exist */
963 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
965 /* Set expiration policy to manual; otherwise objects will be lost! */
966 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
967 syslog(LOG_ERR, "vcard: couldn't get the user CONTACTS room!");
970 qr.QRep.expire_mode = EXPIRE_MANUAL;
971 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
972 CtdlPutRoomLock(&qr);
974 /* Set the view to a calendar view */
975 CtdlGetRelationship(&vbuf, &CC->user, &qr);
976 vbuf.v_view = 2; /* 2 = address book view */
977 CtdlSetRelationship(&vbuf, &CC->user, &qr);
986 * When a user logs in...
988 void vcard_session_login_hook(void) {
989 struct vCard *v = NULL;
992 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
993 * into the user's vCard.
995 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
996 v = vcard_get_user(&CC->user);
998 if (Ctdl_LDAP_to_vCard(CC->ldap_dn, v)) {
999 CC->vcard_updated_by_ldap++; /* Make sure changes make it to the global address book and internet directory, not just the user config. */
1000 syslog(LOG_DEBUG, "vcard: LDAP Detected vcard change");
1001 vcard_write_user(&CC->user, v);
1007 * Extract the user's friendly/screen name
1008 * These are inserted into the session data for various message entry commands to use.
1010 v = vcard_get_user(&CC->user);
1012 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
1017 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1019 vcard_CtdlCreateRoom();
1024 * Turn an arbitrary RFC822 address into a struct vCard for possible
1025 * inclusion into an address book.
1027 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1029 char user[256], node[256], name[256], email[256], n[256], uid[256];
1033 if (v == NULL) return(NULL);
1035 process_rfc822_addr(addr, user, node, name);
1036 vcard_set_prop(v, "fn", name, 0);
1038 vcard_fn_to_n(n, name, sizeof n);
1039 vcard_set_prop(v, "n", n, 0);
1041 snprintf(email, sizeof email, "%s@%s", user, node);
1042 vcard_set_prop(v, "email;internet", email, 0);
1044 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1045 for (i=0; uid[i]; ++i) {
1046 if (isspace(uid[i])) uid[i] = '_';
1047 uid[i] = tolower(uid[i]);
1049 vcard_set_prop(v, "UID", uid, 0);
1056 * This is called by store_harvested_addresses() to remove from the
1057 * list any addresses we already have in our address book.
1059 void strip_addresses_already_have(long msgnum, void *userdata) {
1060 char *collected_addresses;
1061 struct CtdlMessage *msg = NULL;
1065 char addr[256], user[256], node[256], name[256];
1067 collected_addresses = (char *)userdata;
1069 msg = CtdlFetchMessage(msgnum, 1);
1070 if (msg == NULL) return;
1071 v = vcard_load(msg->cm_fields[eMesageText]);
1075 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1077 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1078 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1080 /* Remove the address if we already have it! */
1081 process_rfc822_addr(addr, user, node, name);
1082 snprintf(addr, sizeof addr, "%s@%s", user, node);
1083 if (!strcasecmp(value, addr)) {
1084 remove_token(collected_addresses, j, ',');
1096 * Back end function for store_harvested_addresses()
1098 void store_this_ha(struct addresses_to_be_filed *aptr) {
1099 struct CtdlMessage *vmsg = NULL;
1101 struct vCard *v = NULL;
1102 char recipient[256];
1105 /* First remove any addresses we already have in the address book */
1106 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL, NULL, NULL);
1107 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1108 strip_addresses_already_have, aptr->collected_addresses);
1110 if (!IsEmptyStr(aptr->collected_addresses))
1111 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1113 /* Make a vCard out of each address */
1114 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1115 string_trim(recipient);
1116 v = vcard_new_from_rfc822_addr(recipient);
1119 vmsg = malloc(sizeof(struct CtdlMessage));
1120 memset(vmsg, 0, sizeof(struct CtdlMessage));
1121 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1122 vmsg->cm_anon_type = MES_NORMAL;
1123 vmsg->cm_format_type = FMT_RFC822;
1124 CM_SetField(vmsg, eAuthor, HKEY("Citadel"));
1125 s = vcard_get_prop(v, "UID", 1, 0, 0);
1126 if (!IsEmptyStr(s)) {
1127 CM_SetField(vmsg, eExclusiveID, s, strlen(s));
1129 ser = vcard_serialize(v);
1134 serlen = strlen(ser);
1135 buf = NewStrBufPlain(NULL, serlen + 1024);
1137 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
1138 StrBufAppendBufPlain(buf, ser, serlen, 0);
1139 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
1140 CM_SetAsFieldSB(vmsg, eMesageText, &buf);
1145 syslog(LOG_DEBUG, "vcard: adding contact: %s", recipient);
1146 CtdlSubmitMsg(vmsg, NULL, aptr->roomname);
1151 free(aptr->roomname);
1152 free(aptr->collected_addresses);
1158 * When a user sends a message, we may harvest one or more email addresses
1159 * from the recipient list to be added to the user's address book. But we
1160 * want to do this asynchronously so it doesn't keep the user waiting.
1162 void store_harvested_addresses(void) {
1164 struct addresses_to_be_filed *aptr = NULL;
1166 if (atbf == NULL) return;
1168 begin_critical_section(S_ATBF);
1169 while (atbf != NULL) {
1172 end_critical_section(S_ATBF);
1173 store_this_ha(aptr);
1174 begin_critical_section(S_ATBF);
1176 end_critical_section(S_ATBF);
1181 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1182 * really this is just so we expose the vCard data to the full text indexer.
1184 void vcard_fixed_output(char *ptr, int len) {
1185 char *serialized_vcard;
1190 serialized_vcard = malloc(len + 1);
1191 safestrncpy(serialized_vcard, ptr, len+1);
1192 v = vcard_load(serialized_vcard);
1193 free(serialized_vcard);
1196 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1197 value = vcard_get_prop(v, "", 0, i++, 0);
1198 cprintf("%s\n", value);
1204 const char *CitadelServiceDICT_TCP="DICT_TCP";
1207 // Initialization function, called from modules_init.c
1208 char *ctdl_module_init_vcard(void) {
1212 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN, PRIO_LOGIN + 70);
1213 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1214 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1215 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1216 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1217 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1218 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1219 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1220 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1221 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1222 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER, PRIO_CLEANUP + 470);
1223 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1224 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1226 /* Create the Global Address Book room if necessary */
1227 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1229 /* Set expiration policy to manual; otherwise objects will be lost! */
1230 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1231 qr.QRep.expire_mode = EXPIRE_MANUAL;
1232 qr.QRdefaultview = VIEW_ADDRESSBOOK; // 2 = address book view
1233 CtdlPutRoomLock(&qr);
1236 /* for postfix tcpdict */
1237 CtdlRegisterServiceHook(CtdlGetConfigInt("c_pftcpdict_port"), // Postfix
1242 CitadelServiceDICT_TCP
1246 /* return our module name for the log */