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. */
418 * This handler detects whether the user is attempting to save a new
419 * vCard as part of his/her personal configuration, and handles the replace
420 * function accordingly (copy the vCard from the config room to the global
423 int vcard_upload_aftersave(struct CtdlMessage *msg, recptypes *recp) {
424 struct CitContext *CCC = CC;
430 int is_MY_UserConf=0;
432 char roomname[ROOMNAMELEN];
434 if (msg->cm_format_type != 4) return(0);
435 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
437 /* We're interested in user config rooms only. */
439 if ( !IsEmptyStr(CCC->room.QRname) &&
440 (strlen(CCC->room.QRname) >= 12) &&
441 (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
442 is_UserConf = 1; /* It's someone's config room */
444 CtdlMailboxName(roomname, sizeof roomname, &CCC->user, USERCONFIGROOM);
445 if (!strcasecmp(CCC->room.QRname, roomname)) {
447 is_MY_UserConf = 1; /* It's MY config room */
449 if (!strcasecmp(CCC->room.QRname, ADDRESS_BOOK_ROOM)) {
450 is_GAB = 1; /* It's the Global Address Book */
453 if (!is_UserConf && !is_GAB) return(0);
455 if (CM_IsEmpty(msg, eMesageText))
458 ptr = msg->cm_fields[eMesageText];
460 CCC->vcard_updated_by_ldap=0; /* As this will write LDAP's previous changes, disallow LDAP change auth until next LDAP change. */
462 NewStrBufDupAppendFlush(&CCC->StatusMessage, NULL, NULL, 0);
464 StrBufPrintf(CCC->StatusMessage, "%d\n", LISTING_FOLLOWS);
466 while (ptr != NULL) {
468 linelen = strcspn(ptr, "\n");
469 if (linelen == 0) return(0); /* end of headers */
471 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
472 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
474 * Bingo! The user is uploading a new vCard, so
475 * copy it to the Global Address Book room.
478 I = atol(msg->cm_fields[eVltMsgNum]);
479 if (I <= 0L) return(0);
481 /* Store our friendly/display name in memory */
482 if (is_MY_UserConf) {
483 v = vcard_load(msg->cm_fields[eMesageText]);
484 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
489 { // This is not the GAB
490 /* Put it in the Global Address Book room... */
491 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
494 /* Some sites want an Aide to be notified when a
495 * user registers or re-registers
496 * But if the user was an Aide or was edited by an Aide then we can
497 * Assume they don't need validating.
499 if (CCC->user.axlevel >= AxAideU) {
500 CtdlLockGetCurrentUser();
501 CCC->user.flags |= US_REGIS;
502 CtdlPutCurrentUserLock();
508 /* ...which also means we need to flag the user */
509 CtdlLockGetCurrentUser();
510 CCC->user.flags |= (US_REGIS|US_NEEDVALID);
511 CtdlPutCurrentUserLock();
516 ptr = strchr((char *)ptr, '\n');
517 if (ptr != NULL) ++ptr;
526 * back end function used for callbacks
528 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
531 msgnum = (long *) userdata;
532 *msgnum = supplied_msgnum;
537 * If this user has a vcard on disk, read it into memory, otherwise allocate
538 * and return an empty vCard.
540 struct vCard *vcard_get_user(struct ctdluser *u) {
541 struct CitContext *CCC = CC;
542 char hold_rm[ROOMNAMELEN];
543 char config_rm[ROOMNAMELEN];
544 struct CtdlMessage *msg = NULL;
548 strcpy(hold_rm, CCC->room.QRname); /* save current room */
549 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
551 if (CtdlGetRoom(&CCC->room, config_rm) != 0) {
552 CtdlGetRoom(&CCC->room, hold_rm);
556 /* We want the last (and probably only) vcard in this room */
558 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
559 NULL, vcard_gu_backend, (void *)&VCmsgnum );
560 CtdlGetRoom(&CCC->room, hold_rm); /* return to saved room */
562 if (VCmsgnum < 0L) return vcard_new();
564 msg = CtdlFetchMessage(VCmsgnum, 1, 1);
565 if (msg == NULL) return vcard_new();
567 v = vcard_load(msg->cm_fields[eMesageText]);
574 * Store this user's vCard in the appropriate place
577 * Write our config to disk
579 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
582 ser = vcard_serialize(v);
584 ser = strdup("begin:vcard\r\nend:vcard\r\n");
586 if (ser == NULL) return;
588 /* This handy API function does all the work for us.
589 * NOTE: normally we would want to set that last argument to 1, to
590 * force the system to delete the user's old vCard. But it doesn't
591 * have to, because the vcard_upload_beforesave() hook above
592 * is going to notice what we're trying to do, and delete the old vCard.
594 CtdlWriteObject(USERCONFIGROOM, /* which room */
595 VCARD_MIME_TYPE, /* MIME type */
597 strlen(ser)+1, /* length */
600 0, /* don't delete others of this type */
609 * Old style "enter registration info" command. This function simply honors
610 * the REGI protocol command, translates the entered parameters into a vCard,
611 * and enters the vCard into the user's configuration.
613 void cmd_regi(char *argbuf) {
614 struct CitContext *CCC = CC;
617 struct vCard *my_vcard;
623 char tmpaddress[SIZ];
624 char tmpcountry[SIZ];
628 if (!(CCC->logged_in)) {
629 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
633 /* If users cannot create their own accounts, they cannot re-register either. */
634 if ( (CtdlGetConfigInt("c_disable_newu")) && (CCC->user.axlevel < AxAideU) ) {
635 cprintf("%d Self-service registration is not allowed here.\n",
636 ERROR + HIGHER_ACCESS_REQUIRED);
639 my_vcard = vcard_get_user(&CCC->user);
642 strcpy(tmpstate, "");
644 strcpy(tmpcountry, "USA");
646 cprintf("%d Send registration...\n", SEND_LISTING);
648 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
649 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
650 if (a==1) strcpy(tmpaddr, buf);
651 if (a==2) strcpy(tmpcity, buf);
652 if (a==3) strcpy(tmpstate, buf);
654 for (c=0; buf[c]; ++c) {
655 if ((buf[c]>='0') && (buf[c]<='9')) {
662 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
663 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
664 if (a==7) strcpy(tmpcountry, buf);
668 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
669 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
670 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
671 vcard_write_user(&CCC->user, my_vcard);
672 vcard_free(my_vcard);
677 * Protocol command to fetch registration info for a user
679 void cmd_greg(char *argbuf)
681 struct CitContext *CCC = CC;
682 struct ctdluser usbuf;
685 char who[USERNAME_SIZE];
689 extract_token(who, argbuf, 0, '|', sizeof who);
691 if (!(CCC->logged_in)) {
692 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
696 if (!strcasecmp(who,"_SELF_")) strcpy(who,CCC->curr_user);
698 if ((CCC->user.axlevel < AxAideU) && (strcasecmp(who,CCC->curr_user))) {
699 cprintf("%d Higher access required.\n", ERROR + HIGHER_ACCESS_REQUIRED);
703 if (CtdlGetUser(&usbuf, who) != 0) {
704 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
708 v = vcard_get_user(&usbuf);
710 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
711 cprintf("%ld\n", usbuf.usernum);
712 cprintf("%s\n", usbuf.password);
713 s = vcard_get_prop(v, "n", 1, 0, 0);
714 cprintf("%s\n", s ? s : " "); /* name */
715 s = vcard_get_prop(v, "adr", 1, 0, 0);
716 snprintf(adr, sizeof adr, "%s", s ? s : " "); /* address */
717 extract_token(buf, adr, 2, ';', sizeof buf);
718 cprintf("%s\n", buf); /* street */
719 extract_token(buf, adr, 3, ';', sizeof buf);
720 cprintf("%s\n", buf); /* city */
721 extract_token(buf, adr, 4, ';', sizeof buf);
722 cprintf("%s\n", buf); /* state */
723 extract_token(buf, adr, 5, ';', sizeof buf);
724 cprintf("%s\n", buf); /* zip */
726 s = vcard_get_prop(v, "tel", 1, 0, 0);
727 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
735 cprintf("%d\n", usbuf.axlevel);
737 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
738 cprintf("%s\n", s ? s : " ");
739 s = vcard_get_prop(v, "adr", 0, 0, 0);
740 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
742 extract_token(buf, adr, 6, ';', sizeof buf);
743 cprintf("%s\n", buf); /* country */
751 * When a user is being created, create his/her vCard.
753 void vcard_newuser(struct ctdluser *usbuf) {
758 int need_default_vcard;
760 need_default_vcard =1;
761 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
762 syslog(LOG_DEBUG, "vcard: converted <%s> to <%s>", usbuf->fullname, vname);
764 /* Create and save the vCard */
766 if (v == NULL) return;
767 vcard_add_prop(v, "fn", usbuf->fullname);
768 vcard_add_prop(v, "n", vname);
769 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
771 #ifdef HAVE_GETPWUID_R
772 /* If using host auth mode, we add an email address based on the login */
773 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
775 char pwd_buffer[SIZ];
777 #ifdef SOLARIS_GETPWUID
778 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
779 #else // SOLARIS_GETPWUID
780 struct passwd *result = NULL;
781 syslog(LOG_DEBUG, "vcard: searching for uid %d", usbuf->uid);
782 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
783 #endif // HAVE_GETPWUID_R
784 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, CtdlGetConfigStr("c_fqdn"));
785 vcard_add_prop(v, "email;internet", buf);
786 need_default_vcard = 0;
794 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
795 * into the user's vCard.
797 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
803 syslog(LOG_DEBUG, "\033[31m FIXME BORK BORK BORK try lookup by uid , or maybe dn?\033[0m");
805 found_user = CtdlTryUserLDAP(usbuf->fullname, ldap_dn, sizeof ldap_dn, ldap_cn, sizeof ldap_cn, &usbuf->uid);
806 if (found_user == 0) {
807 if (Ctdl_LDAP_to_vCard(ldap_dn, v)) {
808 /* Allow global address book and internet directory update without login long enough to write this. */
809 CC->vcard_updated_by_ldap++; /* Otherwise we'll only update the user config. */
810 need_default_vcard = 0;
811 syslog(LOG_DEBUG, "vcard: LDAP Created Initial vCard for %s\n",usbuf->fullname);
816 if (need_default_vcard!=0) {
817 /* Everyone gets an email address based on their display name */
818 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, CtdlGetConfigStr("c_fqdn"));
819 for (i=0; buf[i]; ++i) {
820 if (buf[i] == ' ') buf[i] = '_';
822 vcard_add_prop(v, "email;internet", buf);
824 vcard_write_user(usbuf, v);
830 * When a user is being deleted, we have to remove his/her vCard.
831 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
832 * field, and the same Exclusive ID as the existing card.
834 void vcard_purge(struct ctdluser *usbuf) {
835 struct CtdlMessage *msg;
839 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
840 if (msg == NULL) return;
841 memset(msg, 0, sizeof(struct CtdlMessage));
843 msg->cm_magic = CTDLMESSAGE_MAGIC;
844 msg->cm_anon_type = MES_NORMAL;
845 msg->cm_format_type = 0;
846 if (!IsEmptyStr(usbuf->fullname)) {
847 CM_SetField(msg, eAuthor, usbuf->fullname, strlen(usbuf->fullname));
849 CM_SetField(msg, eOriginalRoom, HKEY(ADDRESS_BOOK_ROOM));
850 CM_SetField(msg, eNodeName, CtdlGetConfigStr("c_nodename"), strlen(CtdlGetConfigStr("c_nodename")));
851 CM_SetField(msg, eMesageText, HKEY("Purge this vCard\n"));
853 len = snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields[eAuthor], NODENAME);
854 CM_SetField(msg, eExclusiveID, buf, len);
855 CM_SetField(msg, eSpecialField, HKEY("CANCEL"));
856 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
862 * Grab vCard directory stuff out of incoming network messages
864 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
868 if (msg == NULL) return(0);
870 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
874 if (msg->cm_format_type != 4) return(0);
876 if (CM_IsEmpty(msg, eMesageText))
879 ptr = msg->cm_fields[eMesageText];
881 while (ptr != NULL) {
883 linelen = strcspn(ptr, "\n");
884 if (linelen == 0) return(0); /* end of headers */
886 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
887 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
888 /* It's a vCard. Add it to the directory. */
889 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
893 ptr = strchr((char *)ptr, '\n');
894 if (ptr != NULL) ++ptr;
903 * When a vCard is being removed from the Global Address Book room, remove it
904 * from the directory as well.
906 void vcard_delete_remove(char *room, long msgnum) {
907 struct CtdlMessage *msg;
911 if (msgnum <= 0L) return;
913 if (room == NULL) return;
915 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
919 msg = CtdlFetchMessage(msgnum, 1, 1);
920 if (msg == NULL) return;
922 if (CM_IsEmpty(msg, eMesageText))
925 ptr = msg->cm_fields[eMesageText];
927 while (ptr != NULL) {
928 linelen = strcspn(ptr, "\n");
929 if (linelen == 0) goto EOH;
931 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
932 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
933 /* Bingo! A vCard is being deleted. */
934 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
936 ptr = strchr((char *)ptr, '\n');
937 if (ptr != NULL) ++ptr;
945 * Get Valid Screen Names
947 void cmd_gvsn(char *argbuf)
949 struct CitContext *CCC = CC;
951 if (CtdlAccessCheck(ac_logged_in)) return;
953 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
954 cprintf("%s\n", CCC->user.fullname);
955 if ( (!IsEmptyStr(CCC->cs_inet_fn)) && (strcasecmp(CCC->user.fullname, CCC->cs_inet_fn)) ) {
956 cprintf("%s\n", CCC->cs_inet_fn);
963 * Get Valid Email Addresses
964 * FIXME this doesn't belong in serv_vcard.c anymore , maybe move it to internet_addressing.c
966 void cmd_gvea(char *argbuf)
968 struct CitContext *CCC = CC;
969 int num_secondary_emails = 0;
973 if (CtdlAccessCheck(ac_logged_in)) return;
975 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
976 if (!IsEmptyStr(CCC->cs_inet_email)) {
977 cprintf("%s\n", CCC->cs_inet_email);
979 if (!IsEmptyStr(CCC->cs_inet_other_emails)) {
980 num_secondary_emails = num_tokens(CCC->cs_inet_other_emails, '|');
981 for (i=0; i<num_secondary_emails; ++i) {
982 extract_token(buf, CCC->cs_inet_other_emails,i,'|',sizeof CCC->cs_inet_other_emails);
983 cprintf("%s\n", buf);
991 * Callback function for cmd_dvca() that hunts for vCard content types
992 * and outputs any email addresses found within.
994 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
995 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
996 char *cbid, void *cbuserdata) {
999 char displayname[256] = "";
1000 int displayname_len;
1001 char emailaddr[256] = "";
1005 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1009 v = vcard_load(content);
1010 if (v == NULL) return;
1012 extract_friendly_name(displayname, sizeof displayname, v);
1013 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1015 displayname_len = strlen(displayname);
1016 for (i=0; i<displayname_len; ++i) {
1017 if (displayname[i] == '\"') displayname[i] = ' ';
1018 if (displayname[i] == ';') displayname[i] = ',';
1019 if (displayname[i] == ',') has_commas = 1;
1021 striplt(displayname);
1023 cprintf("%s%s%s <%s>\n",
1024 (has_commas ? "\"" : ""),
1026 (has_commas ? "\"" : ""),
1035 * Back end callback function for cmd_dvca()
1037 * It's basically just passed a list of message numbers, which we're going
1038 * to fetch off the disk and then pass along to the MIME parser via another
1039 * layer of callback...
1041 void dvca_callback(long msgnum, void *userdata) {
1042 struct CtdlMessage *msg = NULL;
1044 msg = CtdlFetchMessage(msgnum, 1, 1);
1045 if (msg == NULL) return;
1046 mime_parser(CM_RANGE(msg, eMesageText),
1047 *dvca_mime_callback, /* callback function */
1049 NULL, /* user data */
1057 * Dump VCard Addresses
1059 void cmd_dvca(char *argbuf)
1061 if (CtdlAccessCheck(ac_logged_in)) return;
1063 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1064 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1072 void cmd_qdir(char *argbuf) {
1073 char citadel_addr[256];
1074 char internet_addr[256];
1076 if (CtdlAccessCheck(ac_logged_in)) return;
1078 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1080 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1081 cprintf("%d %s was not found.\n",
1082 ERROR + NO_SUCH_USER, internet_addr);
1086 cprintf("%d %s\n", CIT_OK, citadel_addr);
1091 * Query Directory, in fact an alias to match postfix tcp auth.
1093 void check_get(void) {
1094 char internet_addr[256];
1099 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1100 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1101 syslog(LOG_ERR, "vcard: client disconnected: ending session.");
1102 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1105 syslog(LOG_INFO, ": %s", cmdbuf);
1106 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1107 syslog(LOG_INFO, "[ %s]", cmdbuf);
1109 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1112 char *argbuf = &cmdbuf[4];
1114 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1115 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1116 if ( (rcpt != NULL) &&
1118 (*rcpt->recp_local != '\0') ||
1119 (*rcpt->recp_room != '\0')
1122 cprintf("200 OK %s\n", internet_addr);
1123 syslog(LOG_INFO, "vcard: sending 200 OK for the room %s", rcpt->display_recp);
1127 cprintf("500 REJECT noone here by that name.\n");
1129 syslog(LOG_INFO, "vcard: sending 500 REJECT no one here by that name: %s", internet_addr);
1132 free_recipients(rcpt);
1135 cprintf("500 REJECT invalid Query.\n");
1136 syslog(LOG_INFO, "vcard: sending 500 REJECT invalid query: %s", internet_addr);
1141 void check_get_greeting(void) {
1142 /* dummy function, we have no greeting in this very simple protocol. */
1147 * We don't know if the Contacts room exists so we just create it at login
1149 void vcard_CtdlCreateRoom(void)
1154 /* Create the calendar room if it doesn't already exist */
1155 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1157 /* Set expiration policy to manual; otherwise objects will be lost! */
1158 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1159 syslog(LOG_ERR, "vcard: couldn't get the user CONTACTS room!");
1162 qr.QRep.expire_mode = EXPIRE_MANUAL;
1163 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1164 CtdlPutRoomLock(&qr);
1166 /* Set the view to a calendar view */
1167 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1168 vbuf.v_view = 2; /* 2 = address book view */
1169 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1178 * When a user logs in...
1180 void vcard_session_login_hook(void) {
1181 struct vCard *v = NULL;
1182 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1186 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1187 * into the user's vCard.
1189 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
1190 v = vcard_get_user(&CCC->user);
1192 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1193 CCC->vcard_updated_by_ldap++; /* Make sure changes make it to the global address book and internet directory, not just the user config. */
1194 syslog(LOG_DEBUG, "vcard: LDAP Detected vcard change");
1195 vcard_write_user(&CCC->user, v);
1202 * Extract the user's friendly/screen name
1203 * These are inserted into the session data for various message entry commands to use.
1205 v = vcard_get_user(&CCC->user);
1207 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1212 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1214 vcard_CtdlCreateRoom();
1219 * Turn an arbitrary RFC822 address into a struct vCard for possible
1220 * inclusion into an address book.
1222 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1224 char user[256], node[256], name[256], email[256], n[256], uid[256];
1228 if (v == NULL) return(NULL);
1230 process_rfc822_addr(addr, user, node, name);
1231 vcard_set_prop(v, "fn", name, 0);
1233 vcard_fn_to_n(n, name, sizeof n);
1234 vcard_set_prop(v, "n", n, 0);
1236 snprintf(email, sizeof email, "%s@%s", user, node);
1237 vcard_set_prop(v, "email;internet", email, 0);
1239 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1240 for (i=0; uid[i]; ++i) {
1241 if (isspace(uid[i])) uid[i] = '_';
1242 uid[i] = tolower(uid[i]);
1244 vcard_set_prop(v, "UID", uid, 0);
1251 * This is called by store_harvested_addresses() to remove from the
1252 * list any addresses we already have in our address book.
1254 void strip_addresses_already_have(long msgnum, void *userdata) {
1255 char *collected_addresses;
1256 struct CtdlMessage *msg = NULL;
1260 char addr[256], user[256], node[256], name[256];
1262 collected_addresses = (char *)userdata;
1264 msg = CtdlFetchMessage(msgnum, 1, 1);
1265 if (msg == NULL) return;
1266 v = vcard_load(msg->cm_fields[eMesageText]);
1270 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1272 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1273 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1275 /* Remove the address if we already have it! */
1276 process_rfc822_addr(addr, user, node, name);
1277 snprintf(addr, sizeof addr, "%s@%s", user, node);
1278 if (!strcasecmp(value, addr)) {
1279 remove_token(collected_addresses, j, ',');
1291 * Back end function for store_harvested_addresses()
1293 void store_this_ha(struct addresses_to_be_filed *aptr) {
1294 struct CtdlMessage *vmsg = NULL;
1296 struct vCard *v = NULL;
1297 char recipient[256];
1300 /* First remove any addresses we already have in the address book */
1301 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL, NULL, NULL);
1302 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1303 strip_addresses_already_have, aptr->collected_addresses);
1305 if (!IsEmptyStr(aptr->collected_addresses))
1306 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1308 /* Make a vCard out of each address */
1309 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1311 v = vcard_new_from_rfc822_addr(recipient);
1314 vmsg = malloc(sizeof(struct CtdlMessage));
1315 memset(vmsg, 0, sizeof(struct CtdlMessage));
1316 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1317 vmsg->cm_anon_type = MES_NORMAL;
1318 vmsg->cm_format_type = FMT_RFC822;
1319 CM_SetField(vmsg, eAuthor, HKEY("Citadel"));
1320 s = vcard_get_prop(v, "UID", 1, 0, 0);
1321 if (!IsEmptyStr(s)) {
1322 CM_SetField(vmsg, eExclusiveID, s, strlen(s));
1324 ser = vcard_serialize(v);
1329 serlen = strlen(ser);
1330 buf = NewStrBufPlain(NULL, serlen + 1024);
1332 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
1333 StrBufAppendBufPlain(buf, ser, serlen, 0);
1334 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
1335 CM_SetAsFieldSB(vmsg, eMesageText, &buf);
1340 syslog(LOG_DEBUG, "vcard: adding contact: %s", recipient);
1341 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1346 free(aptr->roomname);
1347 free(aptr->collected_addresses);
1353 * When a user sends a message, we may harvest one or more email addresses
1354 * from the recipient list to be added to the user's address book. But we
1355 * want to do this asynchronously so it doesn't keep the user waiting.
1357 void store_harvested_addresses(void) {
1359 struct addresses_to_be_filed *aptr = NULL;
1361 if (atbf == NULL) return;
1363 begin_critical_section(S_ATBF);
1364 while (atbf != NULL) {
1367 end_critical_section(S_ATBF);
1368 store_this_ha(aptr);
1369 begin_critical_section(S_ATBF);
1371 end_critical_section(S_ATBF);
1376 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1377 * really this is just so we expose the vCard data to the full text indexer.
1379 void vcard_fixed_output(char *ptr, int len) {
1380 char *serialized_vcard;
1385 serialized_vcard = malloc(len + 1);
1386 safestrncpy(serialized_vcard, ptr, len+1);
1387 v = vcard_load(serialized_vcard);
1388 free(serialized_vcard);
1391 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1392 value = vcard_get_prop(v, "", 0, i++, 0);
1393 cprintf("%s\n", value);
1400 const char *CitadelServiceDICT_TCP="DICT_TCP";
1402 CTDL_MODULE_INIT(vcard)
1405 //char filename[256];
1411 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN, PRIO_LOGIN + 70);
1412 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1413 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1414 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1415 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1416 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1417 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1418 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1419 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1420 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1421 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER); // FIXME stop doing this
1422 CtdlRegisterDeleteHook(vcard_delete_remove); // FIXME this is obsolete, right?
1423 CtdlRegisterNetprocHook(vcard_extract_from_network); // FIXME this is obsolete, right?
1424 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER, PRIO_CLEANUP + 470);
1425 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1426 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1428 /* Create the Global Address Book room if necessary */
1429 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1431 /* Set expiration policy to manual; otherwise objects will be lost! */
1432 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1433 qr.QRep.expire_mode = EXPIRE_MANUAL;
1434 qr.QRdefaultview = VIEW_ADDRESSBOOK; // 2 = address book view
1435 CtdlPutRoomLock(&qr);
1438 /* for postfix tcpdict */
1439 CtdlRegisterServiceHook(CtdlGetConfigInt("c_pftcpdict_port"), // Postfix
1444 CitadelServiceDICT_TCP
1448 /* return our module name for the log */