2 * A server-side module for Citadel which supports address book information
3 * using the standard vCard format.
5 * Copyright (c) 1999-2018 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", msg->cm_fields[eAuthor], msg->cm_fields[eNodeName]);
104 v = vcard_load(msg->cm_fields[eMesageText]);
105 if (v == NULL) return;
107 /* Go through the vCard searching for *all* instances of
108 * the "email;internet" key
111 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
112 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
113 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
116 if (!IsEmptyStr(addr)) {
117 if (callback != NULL) {
118 callback(addr, citadel_address);
127 } while(found_something);
138 * See if there is a valid Internet address in a vCard to use for outbound
139 * Internet messages. If there is, stick it in the buffer.
141 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
142 char *secemailaddrbuf, size_t secemailaddrbuf_len,
146 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
149 int IsDirectoryAddress;
150 int saved_instance = 0;
152 /* Go through the vCard searching for *all* Internet email addresses
154 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
155 k = vcard_get_prop(v, "email", 1, instance, 1);
156 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
159 if (!IsEmptyStr(addr)) {
160 IsDirectoryAddress = IsDirectory(addr, 1);
162 syslog(LOG_DEBUG, "EVQ: addr=<%s> IsDirectoryAddress=<%d> local_addrs_only=<%d>", addr, IsDirectoryAddress, local_addrs_only);
164 if ( IsDirectoryAddress || !local_addrs_only)
167 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
168 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
170 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
171 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
173 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
174 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
175 < secemailaddrbuf_len ) {
176 strcat(secemailaddrbuf, "|");
177 strcat(secemailaddrbuf, addr);
181 if (!IsDirectoryAddress && local_addrs_only)
183 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
184 StrBufAppendBufPlain(CCC->StatusMessage, addr, -1, 0);
185 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
186 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
198 * See if there is a name / screen name / friendly name in a vCard to use for outbound
199 * Internet messages. If there is, stick it in the buffer.
201 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
205 s = vcard_get_prop(v, "fn", 1, 0, 0);
207 s = vcard_get_prop(v, "n", 1, 0, 0);
211 safestrncpy(namebuf, s, namebuf_len);
217 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
219 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
220 void *content, char *cbtype, char *cbcharset, size_t length,
221 char *encoding, char *cbid, void *cbuserdata)
223 struct vCard **v = (struct vCard **) cbuserdata;
225 if ( (!strcasecmp(cbtype, "text/x-vcard"))
226 || (!strcasecmp(cbtype, "text/vcard")) ) {
228 syslog(LOG_DEBUG, "vcard: part %s contains a vCard! Loading...", partnum);
232 *v = vcard_load(content);
238 * This handler detects whether the user is attempting to save a new
239 * vCard as part of his/her personal configuration, and handles the replace
240 * function accordingly (delete the user's existing vCard in the config room
241 * and in the global address book).
243 int vcard_upload_beforesave(struct CtdlMessage *msg, recptypes *recp) {
244 struct CitContext *CCC = CC;
247 struct ctdluser usbuf;
249 struct vCard *v = NULL;
252 int yes_my_citadel_config = 0;
253 int yes_any_vcard_room = 0;
255 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
257 /* Is this some user's "My Citadel Config" room? */
258 if (((CCC->room.QRflags & QR_MAILBOX) != 0) &&
259 (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
260 /* Yes, we want to do this */
261 yes_my_citadel_config = 1;
262 #ifdef VCARD_SAVES_BY_AIDES_ONLY
263 /* Prevent non-aides from performing registration changes, but ldap is ok. */
264 if ((CCC->user.axlevel < AxAideU) && (CCC->vcard_updated_by_ldap==0)) {
271 /* Is this a room with an address book in it? */
272 if (CCC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
273 yes_any_vcard_room = 1;
276 /* If neither condition exists, don't run this hook. */
277 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
281 /* If this isn't a MIME message, don't bother. */
282 if (msg->cm_format_type != 4) return(0);
284 /* Ok, if we got this far, look into the situation further... */
286 if (CM_IsEmpty(msg, eMesageText)) return(0);
288 mime_parser(CM_RANGE(msg, eMesageText),
289 *vcard_extract_vcard,
291 &v, /* user data ptr - put the vcard here */
295 if (v == NULL) return(0); /* no vCards were found in this message */
297 /* If users cannot create their own accounts, they cannot re-register either. */
298 if ( (yes_my_citadel_config) &&
299 (CtdlGetConfigInt("c_disable_newu")) &&
300 (CCC->user.axlevel < AxAideU) &&
301 (CCC->vcard_updated_by_ldap==0) )
306 vcard_get_prop(v, "fn", 1, 0, 0);
309 if (yes_my_citadel_config) {
310 /* Bingo! The user is uploading a new vCard, so
311 * delete the old one. First, figure out which user
312 * is being re-registered...
314 what_user = atol(CCC->room.QRname);
316 if (what_user == CCC->user.usernum) {
317 /* It's the logged in user. That was easy. */
318 memcpy(&usbuf, &CCC->user, sizeof(struct ctdluser));
321 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
322 /* We fetched a valid user record */
326 /* somebody set up us the bomb! */
327 yes_my_citadel_config = 0;
331 if (yes_my_citadel_config) {
332 /* Delete the user's old vCard. This would probably
333 * get taken care of by the replication check, but we
334 * want to make sure there is absolutely only one
335 * vCard in the user's config room at all times.
338 CtdlDeleteMessages(CCC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
340 /* Make the author of the message the name of the user. */
341 if (!IsEmptyStr(usbuf.fullname)) {
342 CM_SetField(msg, eAuthor, usbuf.fullname, strlen(usbuf.fullname));
346 /* Insert or replace RFC2739-compliant free/busy URL */
347 if (yes_my_citadel_config) {
348 sprintf(buf, "http://%s/%s.vfb",
349 CtdlGetConfigStr("c_fqdn"),
351 for (i=0; buf[i]; ++i) {
352 if (buf[i] == ' ') buf[i] = '_';
354 vcard_set_prop(v, "FBURL;PREF", buf, 0);
358 s = vcard_get_prop(v, "UID", 1, 0, 0);
359 if (s == NULL) { /* Note LDAP auth sets UID from the LDAP UUID, use that if it exists. */
360 /* Enforce local UID policy if applicable */
361 if (yes_my_citadel_config) {
362 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields[eAuthor], NODENAME);
364 /* If the vCard has no UID, then give it one. */
367 vcard_set_prop(v, "UID", buf, 0);
372 * Set the EUID of the message to the UID of the vCard.
374 CM_FlushField(msg, eExclusiveID);
376 s = vcard_get_prop(v, "UID", 1, 0, 0);
377 if (!IsEmptyStr(s)) {
378 CM_SetField(msg, eExclusiveID, s, strlen(s));
379 if (CM_IsEmpty(msg, eMsgSubject)) {
380 CM_CopyField(msg, eMsgSubject, eExclusiveID);
385 * Set the Subject to the name in the vCard.
387 s = vcard_get_prop(v, "FN", 1, 0, 0);
389 s = vcard_get_prop(v, "N", 1, 0, 0);
391 if (!IsEmptyStr(s)) {
392 CM_SetField(msg, eMsgSubject, s, strlen(s));
395 /* Re-serialize it back into the msg body */
396 ser = vcard_serialize(v);
397 if (!IsEmptyStr(ser)) {
401 serlen = strlen(ser);
402 buf = NewStrBufPlain(NULL, serlen + 1024);
404 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
405 StrBufAppendBufPlain(buf, ser, serlen, 0);
406 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
407 CM_SetAsFieldSB(msg, eMesageText, &buf);
411 /* Now allow the save to complete. */
419 * This handler detects whether the user is attempting to save a new
420 * vCard as part of his/her personal configuration, and handles the replace
421 * function accordingly (copy the vCard from the config room to the global
424 int vcard_upload_aftersave(struct CtdlMessage *msg, recptypes *recp) {
425 struct CitContext *CCC = CC;
431 int is_MY_UserConf=0;
433 char roomname[ROOMNAMELEN];
435 if (msg->cm_format_type != 4) return(0);
436 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
438 /* We're interested in user config rooms only. */
440 if ( !IsEmptyStr(CCC->room.QRname) &&
441 (strlen(CCC->room.QRname) >= 12) &&
442 (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
443 is_UserConf = 1; /* It's someone's config room */
445 CtdlMailboxName(roomname, sizeof roomname, &CCC->user, USERCONFIGROOM);
446 if (!strcasecmp(CCC->room.QRname, roomname)) {
448 is_MY_UserConf = 1; /* It's MY config room */
450 if (!strcasecmp(CCC->room.QRname, ADDRESS_BOOK_ROOM)) {
451 is_GAB = 1; /* It's the Global Address Book */
454 if (!is_UserConf && !is_GAB) return(0);
456 if (CM_IsEmpty(msg, eMesageText))
459 ptr = msg->cm_fields[eMesageText];
461 CCC->vcard_updated_by_ldap=0; /* As this will write LDAP's previous changes, disallow LDAP change auth until next LDAP change. */
463 NewStrBufDupAppendFlush(&CCC->StatusMessage, NULL, NULL, 0);
465 StrBufPrintf(CCC->StatusMessage, "%d\n", LISTING_FOLLOWS);
467 while (ptr != NULL) {
469 linelen = strcspn(ptr, "\n");
470 if (linelen == 0) return(0); /* end of headers */
472 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
473 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
475 * Bingo! The user is uploading a new vCard, so
476 * copy it to the Global Address Book room.
479 I = atol(msg->cm_fields[eVltMsgNum]);
480 if (I <= 0L) return(0);
482 /* Store our friendly/display name in memory */
483 if (is_MY_UserConf) {
484 v = vcard_load(msg->cm_fields[eMesageText]);
485 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
490 { // This is not the GAB
491 /* Put it in the Global Address Book room... */
492 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
495 /* Some sites want an Aide to be notified when a
496 * user registers or re-registers
497 * But if the user was an Aide or was edited by an Aide then we can
498 * Assume they don't need validating.
500 if (CCC->user.axlevel >= AxAideU) {
501 CtdlLockGetCurrentUser();
502 CCC->user.flags |= US_REGIS;
503 CtdlPutCurrentUserLock();
509 /* ...which also means we need to flag the user */
510 CtdlLockGetCurrentUser();
511 CCC->user.flags |= (US_REGIS|US_NEEDVALID);
512 CtdlPutCurrentUserLock();
517 ptr = strchr((char *)ptr, '\n');
518 if (ptr != NULL) ++ptr;
527 * back end function used for callbacks
529 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
532 msgnum = (long *) userdata;
533 *msgnum = supplied_msgnum;
538 * If this user has a vcard on disk, read it into memory, otherwise allocate
539 * and return an empty vCard.
541 struct vCard *vcard_get_user(struct ctdluser *u) {
542 struct CitContext *CCC = CC;
543 char hold_rm[ROOMNAMELEN];
544 char config_rm[ROOMNAMELEN];
545 struct CtdlMessage *msg = NULL;
549 strcpy(hold_rm, CCC->room.QRname); /* save current room */
550 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
552 if (CtdlGetRoom(&CCC->room, config_rm) != 0) {
553 CtdlGetRoom(&CCC->room, hold_rm);
557 /* We want the last (and probably only) vcard in this room */
559 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
560 NULL, vcard_gu_backend, (void *)&VCmsgnum );
561 CtdlGetRoom(&CCC->room, hold_rm); /* return to saved room */
563 if (VCmsgnum < 0L) return vcard_new();
565 msg = CtdlFetchMessage(VCmsgnum, 1, 1);
566 if (msg == NULL) return vcard_new();
568 v = vcard_load(msg->cm_fields[eMesageText]);
575 * Store this user's vCard in the appropriate place
578 * Write our config to disk
580 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
583 ser = vcard_serialize(v);
585 ser = strdup("begin:vcard\r\nend:vcard\r\n");
587 if (ser == NULL) return;
589 /* This handy API function does all the work for us.
590 * NOTE: normally we would want to set that last argument to 1, to
591 * force the system to delete the user's old vCard. But it doesn't
592 * have to, because the vcard_upload_beforesave() hook above
593 * is going to notice what we're trying to do, and delete the old vCard.
595 CtdlWriteObject(USERCONFIGROOM, /* which room */
596 VCARD_MIME_TYPE, /* MIME type */
598 strlen(ser)+1, /* length */
601 0, /* don't delete others of this type */
610 * Old style "enter registration info" command. This function simply honors
611 * the REGI protocol command, translates the entered parameters into a vCard,
612 * and enters the vCard into the user's configuration.
614 void cmd_regi(char *argbuf) {
615 struct CitContext *CCC = CC;
618 struct vCard *my_vcard;
624 char tmpaddress[SIZ];
625 char tmpcountry[SIZ];
629 if (!(CCC->logged_in)) {
630 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
634 /* If users cannot create their own accounts, they cannot re-register either. */
635 if ( (CtdlGetConfigInt("c_disable_newu")) && (CCC->user.axlevel < AxAideU) ) {
636 cprintf("%d Self-service registration is not allowed here.\n",
637 ERROR + HIGHER_ACCESS_REQUIRED);
640 my_vcard = vcard_get_user(&CCC->user);
643 strcpy(tmpstate, "");
645 strcpy(tmpcountry, "USA");
647 cprintf("%d Send registration...\n", SEND_LISTING);
649 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
650 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
651 if (a==1) strcpy(tmpaddr, buf);
652 if (a==2) strcpy(tmpcity, buf);
653 if (a==3) strcpy(tmpstate, buf);
655 for (c=0; buf[c]; ++c) {
656 if ((buf[c]>='0') && (buf[c]<='9')) {
663 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
664 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
665 if (a==7) strcpy(tmpcountry, buf);
669 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
670 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
671 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
672 vcard_write_user(&CCC->user, my_vcard);
673 vcard_free(my_vcard);
678 * Protocol command to fetch registration info for a user
680 void cmd_greg(char *argbuf)
682 struct CitContext *CCC = CC;
683 struct ctdluser usbuf;
686 char who[USERNAME_SIZE];
690 extract_token(who, argbuf, 0, '|', sizeof who);
692 if (!(CCC->logged_in)) {
693 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
697 if (!strcasecmp(who,"_SELF_")) strcpy(who,CCC->curr_user);
699 if ((CCC->user.axlevel < AxAideU) && (strcasecmp(who,CCC->curr_user))) {
700 cprintf("%d Higher access required.\n", ERROR + HIGHER_ACCESS_REQUIRED);
704 if (CtdlGetUser(&usbuf, who) != 0) {
705 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
709 v = vcard_get_user(&usbuf);
711 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
712 cprintf("%ld\n", usbuf.usernum);
713 cprintf("%s\n", usbuf.password);
714 s = vcard_get_prop(v, "n", 1, 0, 0);
715 cprintf("%s\n", s ? s : " "); /* name */
716 s = vcard_get_prop(v, "adr", 1, 0, 0);
717 snprintf(adr, sizeof adr, "%s", s ? s : " "); /* address */
718 extract_token(buf, adr, 2, ';', sizeof buf);
719 cprintf("%s\n", buf); /* street */
720 extract_token(buf, adr, 3, ';', sizeof buf);
721 cprintf("%s\n", buf); /* city */
722 extract_token(buf, adr, 4, ';', sizeof buf);
723 cprintf("%s\n", buf); /* state */
724 extract_token(buf, adr, 5, ';', sizeof buf);
725 cprintf("%s\n", buf); /* zip */
727 s = vcard_get_prop(v, "tel", 1, 0, 0);
728 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
736 cprintf("%d\n", usbuf.axlevel);
738 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
739 cprintf("%s\n", s ? s : " ");
740 s = vcard_get_prop(v, "adr", 0, 0, 0);
741 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
743 extract_token(buf, adr, 6, ';', sizeof buf);
744 cprintf("%s\n", buf); /* country */
752 * When a user is being created, create his/her vCard.
754 void vcard_newuser(struct ctdluser *usbuf) {
759 int need_default_vcard;
761 need_default_vcard =1;
762 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
763 syslog(LOG_DEBUG, "vcard: converted <%s> to <%s>", usbuf->fullname, vname);
765 /* Create and save the vCard */
767 if (v == NULL) return;
768 vcard_add_prop(v, "fn", usbuf->fullname);
769 vcard_add_prop(v, "n", vname);
770 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
772 #ifdef HAVE_GETPWUID_R
773 /* If using host auth mode, we add an email address based on the login */
774 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
776 char pwd_buffer[SIZ];
778 #ifdef SOLARIS_GETPWUID
779 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
780 #else // SOLARIS_GETPWUID
781 struct passwd *result = NULL;
782 syslog(LOG_DEBUG, "vcard: searching for uid %d", usbuf->uid);
783 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
784 #endif // HAVE_GETPWUID_R
785 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, CtdlGetConfigStr("c_fqdn"));
786 vcard_add_prop(v, "email;internet", buf);
787 need_default_vcard = 0;
795 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
796 * into the user's vCard.
798 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
804 syslog(LOG_DEBUG, "\033[31m FIXME BORK BORK BORK try lookup by uid , or maybe dn?\033[0m");
806 found_user = CtdlTryUserLDAP(usbuf->fullname, ldap_dn, sizeof ldap_dn, ldap_cn, sizeof ldap_cn, &usbuf->uid);
807 if (found_user == 0) {
808 if (Ctdl_LDAP_to_vCard(ldap_dn, v)) {
809 /* Allow global address book and internet directory update without login long enough to write this. */
810 CC->vcard_updated_by_ldap++; /* Otherwise we'll only update the user config. */
811 need_default_vcard = 0;
812 syslog(LOG_DEBUG, "vcard: LDAP Created Initial vCard for %s\n",usbuf->fullname);
817 if (need_default_vcard!=0) {
818 /* Everyone gets an email address based on their display name */
819 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, CtdlGetConfigStr("c_fqdn"));
820 for (i=0; buf[i]; ++i) {
821 if (buf[i] == ' ') buf[i] = '_';
823 vcard_add_prop(v, "email;internet", buf);
825 vcard_write_user(usbuf, v);
831 * When a user is being deleted, we have to remove his/her vCard.
832 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
833 * field, and the same Exclusive ID as the existing card.
835 void vcard_purge(struct ctdluser *usbuf) {
836 struct CtdlMessage *msg;
840 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
841 if (msg == NULL) return;
842 memset(msg, 0, sizeof(struct CtdlMessage));
844 msg->cm_magic = CTDLMESSAGE_MAGIC;
845 msg->cm_anon_type = MES_NORMAL;
846 msg->cm_format_type = 0;
847 if (!IsEmptyStr(usbuf->fullname)) {
848 CM_SetField(msg, eAuthor, usbuf->fullname, strlen(usbuf->fullname));
850 CM_SetField(msg, eOriginalRoom, HKEY(ADDRESS_BOOK_ROOM));
851 CM_SetField(msg, eNodeName, CtdlGetConfigStr("c_nodename"), strlen(CtdlGetConfigStr("c_nodename")));
852 CM_SetField(msg, eMesageText, HKEY("Purge this vCard\n"));
854 len = snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields[eAuthor], NODENAME);
855 CM_SetField(msg, eExclusiveID, buf, len);
856 CM_SetField(msg, eSpecialField, HKEY("CANCEL"));
857 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
863 * Grab vCard directory stuff out of incoming network messages
865 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
869 if (msg == NULL) return(0);
871 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
875 if (msg->cm_format_type != 4) return(0);
877 if (CM_IsEmpty(msg, eMesageText))
880 ptr = msg->cm_fields[eMesageText];
882 while (ptr != NULL) {
884 linelen = strcspn(ptr, "\n");
885 if (linelen == 0) return(0); /* end of headers */
887 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
888 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
889 /* It's a vCard. Add it to the directory. */
890 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
894 ptr = strchr((char *)ptr, '\n');
895 if (ptr != NULL) ++ptr;
904 * When a vCard is being removed from the Global Address Book room, remove it
905 * from the directory as well.
907 void vcard_delete_remove(char *room, long msgnum) {
908 struct CtdlMessage *msg;
912 if (msgnum <= 0L) return;
914 if (room == NULL) return;
916 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
920 msg = CtdlFetchMessage(msgnum, 1, 1);
921 if (msg == NULL) return;
923 if (CM_IsEmpty(msg, eMesageText))
926 ptr = msg->cm_fields[eMesageText];
928 while (ptr != NULL) {
929 linelen = strcspn(ptr, "\n");
930 if (linelen == 0) goto EOH;
932 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
933 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
934 /* Bingo! A vCard is being deleted. */
935 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
937 ptr = strchr((char *)ptr, '\n');
938 if (ptr != NULL) ++ptr;
947 * Get Valid Screen Names
949 void cmd_gvsn(char *argbuf)
951 struct CitContext *CCC = CC;
953 if (CtdlAccessCheck(ac_logged_in)) return;
955 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
956 cprintf("%s\n", CCC->user.fullname);
957 if ( (!IsEmptyStr(CCC->cs_inet_fn)) && (strcasecmp(CCC->user.fullname, CCC->cs_inet_fn)) ) {
958 cprintf("%s\n", CCC->cs_inet_fn);
965 * Get Valid Email Addresses
966 * FIXME this doesn't belong in serv_vcard.c anymore , maybe move it to internet_addressing.c
968 void cmd_gvea(char *argbuf)
970 struct CitContext *CCC = CC;
971 int num_secondary_emails = 0;
975 if (CtdlAccessCheck(ac_logged_in)) return;
977 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
978 if (!IsEmptyStr(CCC->cs_inet_email)) {
979 cprintf("%s\n", CCC->cs_inet_email);
981 if (!IsEmptyStr(CCC->cs_inet_other_emails)) {
982 num_secondary_emails = num_tokens(CCC->cs_inet_other_emails, '|');
983 for (i=0; i<num_secondary_emails; ++i) {
984 extract_token(buf, CCC->cs_inet_other_emails,i,'|',sizeof CCC->cs_inet_other_emails);
985 cprintf("%s\n", buf);
993 * Callback function for cmd_dvca() that hunts for vCard content types
994 * and outputs any email addresses found within.
996 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
997 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
998 char *cbid, void *cbuserdata) {
1001 char displayname[256] = "";
1002 int displayname_len;
1003 char emailaddr[256] = "";
1007 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1011 v = vcard_load(content);
1012 if (v == NULL) return;
1014 extract_friendly_name(displayname, sizeof displayname, v);
1015 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1017 displayname_len = strlen(displayname);
1018 for (i=0; i<displayname_len; ++i) {
1019 if (displayname[i] == '\"') displayname[i] = ' ';
1020 if (displayname[i] == ';') displayname[i] = ',';
1021 if (displayname[i] == ',') has_commas = 1;
1023 striplt(displayname);
1025 cprintf("%s%s%s <%s>\n",
1026 (has_commas ? "\"" : ""),
1028 (has_commas ? "\"" : ""),
1037 * Back end callback function for cmd_dvca()
1039 * It's basically just passed a list of message numbers, which we're going
1040 * to fetch off the disk and then pass along to the MIME parser via another
1041 * layer of callback...
1043 void dvca_callback(long msgnum, void *userdata) {
1044 struct CtdlMessage *msg = NULL;
1046 msg = CtdlFetchMessage(msgnum, 1, 1);
1047 if (msg == NULL) return;
1048 mime_parser(CM_RANGE(msg, eMesageText),
1049 *dvca_mime_callback, /* callback function */
1051 NULL, /* user data */
1059 * Dump VCard Addresses
1061 void cmd_dvca(char *argbuf)
1063 if (CtdlAccessCheck(ac_logged_in)) return;
1065 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1066 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1074 void cmd_qdir(char *argbuf) {
1075 char citadel_addr[256];
1076 char internet_addr[256];
1078 if (CtdlAccessCheck(ac_logged_in)) return;
1080 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1082 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1083 cprintf("%d %s was not found.\n",
1084 ERROR + NO_SUCH_USER, internet_addr);
1088 cprintf("%d %s\n", CIT_OK, citadel_addr);
1093 * Query Directory, in fact an alias to match postfix tcp auth.
1095 void check_get(void) {
1096 char internet_addr[256];
1101 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1102 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1103 syslog(LOG_ERR, "vcard: client disconnected: ending session.");
1104 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1107 syslog(LOG_INFO, ": %s", cmdbuf);
1108 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1109 syslog(LOG_INFO, "[ %s]", cmdbuf);
1111 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1114 char *argbuf = &cmdbuf[4];
1116 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1117 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1118 if ( (rcpt != NULL) &&
1120 (*rcpt->recp_local != '\0') ||
1121 (*rcpt->recp_room != '\0')
1124 cprintf("200 OK %s\n", internet_addr);
1125 syslog(LOG_INFO, "vcard: sending 200 OK for the room %s", rcpt->display_recp);
1129 cprintf("500 REJECT noone here by that name.\n");
1131 syslog(LOG_INFO, "vcard: sending 500 REJECT no one here by that name: %s", internet_addr);
1134 free_recipients(rcpt);
1137 cprintf("500 REJECT invalid Query.\n");
1138 syslog(LOG_INFO, "vcard: sending 500 REJECT invalid query: %s", internet_addr);
1142 void check_get_greeting(void) {
1143 /* dummy function, we have no greeting in this verry simple protocol. */
1148 * We don't know if the Contacts room exists so we just create it at login
1150 void vcard_CtdlCreateRoom(void)
1155 /* Create the calendar room if it doesn't already exist */
1156 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1158 /* Set expiration policy to manual; otherwise objects will be lost! */
1159 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1160 syslog(LOG_ERR, "vcard: couldn't get the user CONTACTS room!");
1163 qr.QRep.expire_mode = EXPIRE_MANUAL;
1164 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1165 CtdlPutRoomLock(&qr);
1167 /* Set the view to a calendar view */
1168 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1169 vbuf.v_view = 2; /* 2 = address book view */
1170 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1179 * When a user logs in...
1181 void vcard_session_login_hook(void) {
1182 struct vCard *v = NULL;
1183 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1187 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1188 * into the user's vCard.
1190 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
1191 v = vcard_get_user(&CCC->user);
1193 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1194 CCC->vcard_updated_by_ldap++; /* Make sure changes make it to the global address book and internet directory, not just the user config. */
1195 syslog(LOG_DEBUG, "vcard: LDAP Detected vcard change");
1196 vcard_write_user(&CCC->user, v);
1203 * Extract the user's friendly/screen name
1204 * These are inserted into the session data for various message entry commands to use.
1206 v = vcard_get_user(&CCC->user);
1208 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1213 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1215 vcard_CtdlCreateRoom();
1220 * Turn an arbitrary RFC822 address into a struct vCard for possible
1221 * inclusion into an address book.
1223 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1225 char user[256], node[256], name[256], email[256], n[256], uid[256];
1229 if (v == NULL) return(NULL);
1231 process_rfc822_addr(addr, user, node, name);
1232 vcard_set_prop(v, "fn", name, 0);
1234 vcard_fn_to_n(n, name, sizeof n);
1235 vcard_set_prop(v, "n", n, 0);
1237 snprintf(email, sizeof email, "%s@%s", user, node);
1238 vcard_set_prop(v, "email;internet", email, 0);
1240 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1241 for (i=0; uid[i]; ++i) {
1242 if (isspace(uid[i])) uid[i] = '_';
1243 uid[i] = tolower(uid[i]);
1245 vcard_set_prop(v, "UID", uid, 0);
1253 * This is called by store_harvested_addresses() to remove from the
1254 * list any addresses we already have in our address book.
1256 void strip_addresses_already_have(long msgnum, void *userdata) {
1257 char *collected_addresses;
1258 struct CtdlMessage *msg = NULL;
1262 char addr[256], user[256], node[256], name[256];
1264 collected_addresses = (char *)userdata;
1266 msg = CtdlFetchMessage(msgnum, 1, 1);
1267 if (msg == NULL) return;
1268 v = vcard_load(msg->cm_fields[eMesageText]);
1272 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1274 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1275 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1277 /* Remove the address if we already have it! */
1278 process_rfc822_addr(addr, user, node, name);
1279 snprintf(addr, sizeof addr, "%s@%s", user, node);
1280 if (!strcasecmp(value, addr)) {
1281 remove_token(collected_addresses, j, ',');
1293 * Back end function for store_harvested_addresses()
1295 void store_this_ha(struct addresses_to_be_filed *aptr) {
1296 struct CtdlMessage *vmsg = NULL;
1298 struct vCard *v = NULL;
1299 char recipient[256];
1302 /* First remove any addresses we already have in the address book */
1303 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL, NULL, NULL);
1304 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1305 strip_addresses_already_have, aptr->collected_addresses);
1307 if (!IsEmptyStr(aptr->collected_addresses))
1308 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1310 /* Make a vCard out of each address */
1311 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1313 v = vcard_new_from_rfc822_addr(recipient);
1316 vmsg = malloc(sizeof(struct CtdlMessage));
1317 memset(vmsg, 0, sizeof(struct CtdlMessage));
1318 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1319 vmsg->cm_anon_type = MES_NORMAL;
1320 vmsg->cm_format_type = FMT_RFC822;
1321 CM_SetField(vmsg, eAuthor, HKEY("Citadel"));
1322 s = vcard_get_prop(v, "UID", 1, 0, 0);
1323 if (!IsEmptyStr(s)) {
1324 CM_SetField(vmsg, eExclusiveID, s, strlen(s));
1326 ser = vcard_serialize(v);
1331 serlen = strlen(ser);
1332 buf = NewStrBufPlain(NULL, serlen + 1024);
1334 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
1335 StrBufAppendBufPlain(buf, ser, serlen, 0);
1336 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
1337 CM_SetAsFieldSB(vmsg, eMesageText, &buf);
1342 syslog(LOG_DEBUG, "vcard: adding contact: %s", recipient);
1343 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1348 free(aptr->roomname);
1349 free(aptr->collected_addresses);
1355 * When a user sends a message, we may harvest one or more email addresses
1356 * from the recipient list to be added to the user's address book. But we
1357 * want to do this asynchronously so it doesn't keep the user waiting.
1359 void store_harvested_addresses(void) {
1361 struct addresses_to_be_filed *aptr = NULL;
1363 if (atbf == NULL) return;
1365 begin_critical_section(S_ATBF);
1366 while (atbf != NULL) {
1369 end_critical_section(S_ATBF);
1370 store_this_ha(aptr);
1371 begin_critical_section(S_ATBF);
1373 end_critical_section(S_ATBF);
1378 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1379 * really this is just so we expose the vCard data to the full text indexer.
1381 void vcard_fixed_output(char *ptr, int len) {
1382 char *serialized_vcard;
1387 serialized_vcard = malloc(len + 1);
1388 safestrncpy(serialized_vcard, ptr, len+1);
1389 v = vcard_load(serialized_vcard);
1390 free(serialized_vcard);
1393 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1394 value = vcard_get_prop(v, "", 0, i++, 0);
1395 cprintf("%s\n", value);
1402 const char *CitadelServiceDICT_TCP="DICT_TCP";
1404 CTDL_MODULE_INIT(vcard)
1407 //char filename[256];
1413 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN, PRIO_LOGIN + 70);
1414 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1415 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1416 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1417 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1418 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1419 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1420 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1421 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1422 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1423 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1425 CtdlRegisterDeleteHook(vcard_delete_remove); // FIXME this is obsolete, right?
1426 CtdlRegisterNetprocHook(vcard_extract_from_network); // FIXME this is obsolete, right?
1428 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER, PRIO_CLEANUP + 470);
1429 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1430 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1432 /* Create the Global Address Book room if necessary */
1433 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1435 /* Set expiration policy to manual; otherwise objects will be lost! */
1436 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1437 qr.QRep.expire_mode = EXPIRE_MANUAL;
1438 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1439 CtdlPutRoomLock(&qr);
1442 /* for postfix tcpdict */
1443 CtdlRegisterServiceHook(CtdlGetConfigInt("c_pftcpdict_port"), /* Postfix */
1448 CitadelServiceDICT_TCP);
1451 /* return our module name for the log */