4 * A server-side module for Citadel which supports address book information
5 * using the standard vCard format.
7 * Copyright (c) 1999-2007 / released under the GNU General Public License
11 * Format of the "Exclusive ID" field of the message containing a user's
12 * vCard. Doesn't matter what it really looks like as long as it's both
13 * unique and consistent (because we use it for replication checking to
14 * delete the old vCard network-wide when the user enters a new one).
16 #define VCARD_EXT_FORMAT "Citadel vCard: personal card for %s at %s"
19 * Citadel will accept either text/vcard or text/x-vcard as the MIME type
20 * for a vCard. The following definition determines which one it *generates*
23 #define VCARD_MIME_TYPE "text/x-vcard"
34 #include <sys/types.h>
36 #if TIME_WITH_SYS_TIME
37 # include <sys/time.h>
41 # include <sys/time.h>
50 #include <libcitadel.h>
53 #include "citserver.h"
62 #include "internet_addressing.h"
63 #include "serv_vcard.h"
65 #include "ctdl_module.h"
70 * set global flag calling for an aide to validate new users
72 void set_mm_valid(void) {
73 begin_critical_section(S_CONTROL);
75 CitControl.MMflags = CitControl.MMflags | MM_VALID ;
77 end_critical_section(S_CONTROL);
83 * Extract Internet e-mail addresses from a message containing a vCard, and
84 * perform a callback for any found.
86 void vcard_extract_internet_addresses(struct CtdlMessage *msg,
87 void (*callback)(char *, char *) ) {
92 char citadel_address[SIZ];
94 int found_something = 0;
96 if (msg->cm_fields['A'] == NULL) return;
97 if (msg->cm_fields['N'] == NULL) return;
98 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
99 msg->cm_fields['A'], msg->cm_fields['N']);
101 v = vcard_load(msg->cm_fields['M']);
102 if (v == NULL) return;
104 /* Go through the vCard searching for *all* instances of
105 * the "email;internet" key
108 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
109 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
110 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
113 if (!IsEmptyStr(addr)) {
114 if (callback != NULL) {
115 callback(addr, citadel_address);
124 } while(found_something);
131 * Callback for vcard_add_to_directory()
132 * (Lotsa ugly nested callbacks. Oh well.)
134 void vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
137 /* We have to validate that we're not stepping on someone else's
138 * email address ... but only if we're logged in. Otherwise it's
139 * probably just the networker or something.
142 CtdlLogPrintf(CTDL_DEBUG, "Checking for <%s>...\n", internet_addr);
143 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
144 if (strcasecmp(buf, citadel_addr)) {
145 /* This address belongs to someone else.
146 * Bail out silently without saving.
148 CtdlLogPrintf(CTDL_DEBUG, "DOOP!\n");
153 CtdlLogPrintf(CTDL_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
154 CtdlDirectoryAddUser(internet_addr, citadel_addr);
159 * Back end function for cmd_igab()
161 void vcard_add_to_directory(long msgnum, void *data) {
162 struct CtdlMessage *msg;
164 msg = CtdlFetchMessage(msgnum, 1);
166 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
169 CtdlFreeMessage(msg);
174 * Initialize Global Adress Book
176 void cmd_igab(char *argbuf) {
177 char hold_rm[ROOMNAMELEN];
179 if (CtdlAccessCheck(ac_aide)) return;
181 strcpy(hold_rm, CC->room.QRname); /* save current room */
183 if (getroom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
184 getroom(&CC->room, hold_rm);
185 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
189 /* Empty the existing database first.
193 /* We want *all* vCards in this room */
194 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
195 NULL, vcard_add_to_directory, NULL);
197 getroom(&CC->room, hold_rm); /* return to saved room */
198 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
205 * See if there is a valid Internet address in a vCard to use for outbound
206 * Internet messages. If there is, stick it in the buffer.
208 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
209 char *secemailaddrbuf, size_t secemailaddrbuf_len,
210 struct vCard *v, int local_addrs_only) {
213 int saved_instance = 0;
215 /* Go through the vCard searching for *all* Internet email addresses
217 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
218 k = vcard_get_prop(v, "email", 1, instance, 1);
219 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
222 if (!IsEmptyStr(addr)) {
223 if ( (IsDirectory(addr, 1)) ||
224 (!local_addrs_only) ) {
226 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
227 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
229 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
230 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
232 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
233 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
234 < secemailaddrbuf_len ) {
235 strcat(secemailaddrbuf, "|");
236 strcat(secemailaddrbuf, addr);
250 * See if there is a name / screen name / friendly name in a vCard to use for outbound
251 * Internet messages. If there is, stick it in the buffer.
253 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
257 s = vcard_get_prop(v, "fn", 1, 0, 0);
259 s = vcard_get_prop(v, "n", 1, 0, 0);
263 safestrncpy(namebuf, s, namebuf_len);
269 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
271 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
272 void *content, char *cbtype, char *cbcharset, size_t length,
273 char *encoding, char *cbid, void *cbuserdata)
275 struct vCard **v = (struct vCard **) cbuserdata;
277 if ( (!strcasecmp(cbtype, "text/x-vcard"))
278 || (!strcasecmp(cbtype, "text/vcard")) ) {
280 CtdlLogPrintf(CTDL_DEBUG, "Part %s contains a vCard! Loading...\n", partnum);
284 *v = vcard_load(content);
290 * This handler detects whether the user is attempting to save a new
291 * vCard as part of his/her personal configuration, and handles the replace
292 * function accordingly (delete the user's existing vCard in the config room
293 * and in the global address book).
295 int vcard_upload_beforesave(struct CtdlMessage *msg) {
299 struct ctdluser usbuf;
301 struct vCard *v = NULL;
304 int yes_my_citadel_config = 0;
305 int yes_any_vcard_room = 0;
307 if (!CC->logged_in) return(0); /* Only do this if logged in. */
309 /* Is this some user's "My Citadel Config" room? */
310 if ( (CC->room.QRflags && QR_MAILBOX)
311 && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
312 /* Yes, we want to do this */
313 yes_my_citadel_config = 1;
315 #ifdef VCARD_SAVES_BY_AIDES_ONLY
316 /* Prevent non-aides from performing registration changes */
317 if (CC->user.axlevel < 6) {
324 /* Is this a room with an address book in it? */
325 if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
326 yes_any_vcard_room = 1;
329 /* If neither condition exists, don't run this hook. */
330 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
334 /* If this isn't a MIME message, don't bother. */
335 if (msg->cm_format_type != 4) return(0);
337 /* Ok, if we got this far, look into the situation further... */
339 ptr = msg->cm_fields['M'];
340 if (ptr == NULL) return(0);
342 mime_parser(msg->cm_fields['M'],
344 *vcard_extract_vcard,
346 &v, /* user data ptr - put the vcard here */
350 if (v == NULL) return(0); /* no vCards were found in this message */
352 /* If users cannot create their own accounts, they cannot re-register either. */
353 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < 6) ) {
357 s = vcard_get_prop(v, "fn", 1, 0, 0);
358 if (s) CtdlLogPrintf(CTDL_DEBUG, "vCard beforesave hook running for <%s>\n", s);
360 if (yes_my_citadel_config) {
361 /* Bingo! The user is uploading a new vCard, so
362 * delete the old one. First, figure out which user
363 * is being re-registered...
365 what_user = atol(CC->room.QRname);
367 if (what_user == CC->user.usernum) {
368 /* It's the logged in user. That was easy. */
369 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
372 else if (getuserbynumber(&usbuf, what_user) == 0) {
373 /* We fetched a valid user record */
377 /* somebody set up us the bomb! */
378 yes_my_citadel_config = 0;
382 if (yes_my_citadel_config) {
383 /* Delete the user's old vCard. This would probably
384 * get taken care of by the replication check, but we
385 * want to make sure there is absolutely only one
386 * vCard in the user's config room at all times.
389 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
391 /* Make the author of the message the name of the user. */
392 if (msg->cm_fields['A'] != NULL) {
393 free(msg->cm_fields['A']);
395 msg->cm_fields['A'] = strdup(usbuf.fullname);
398 /* Insert or replace RFC2739-compliant free/busy URL */
399 if (yes_my_citadel_config) {
400 sprintf(buf, "http://%s/%s.vfb",
403 for (i=0; buf[i]; ++i) {
404 if (buf[i] == ' ') buf[i] = '_';
406 vcard_set_prop(v, "FBURL;PREF", buf, 0);
409 /* If the vCard has no UID, then give it one. */
410 s = vcard_get_prop(v, "UID", 1, 0, 0);
413 vcard_set_prop(v, "UID", buf, 0);
416 /* Enforce local UID policy if applicable */
417 if (yes_my_citadel_config) {
418 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
419 vcard_set_prop(v, "UID", buf, 0);
423 * Set the EUID of the message to the UID of the vCard.
425 if (msg->cm_fields['E'] != NULL)
427 free(msg->cm_fields['E']);
428 msg->cm_fields['E'] = NULL;
430 s = vcard_get_prop(v, "UID", 1, 0, 0);
432 msg->cm_fields['E'] = strdup(s);
433 if (msg->cm_fields['U'] == NULL) {
434 msg->cm_fields['U'] = strdup(s);
439 * Set the Subject to the name in the vCard.
441 s = vcard_get_prop(v, "FN", 1, 0, 0);
443 s = vcard_get_prop(v, "N", 1, 0, 0);
446 if (msg->cm_fields['U'] != NULL) {
447 free(msg->cm_fields['U']);
449 msg->cm_fields['U'] = strdup(s);
452 /* Re-serialize it back into the msg body */
453 ser = vcard_serialize(v);
455 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], strlen(ser) + 1024);
456 sprintf(msg->cm_fields['M'],
457 "Content-type: " VCARD_MIME_TYPE
458 "\r\n\r\n%s\r\n", ser);
462 /* Now allow the save to complete. */
470 * This handler detects whether the user is attempting to save a new
471 * vCard as part of his/her personal configuration, and handles the replace
472 * function accordingly (copy the vCard from the config room to the global
475 int vcard_upload_aftersave(struct CtdlMessage *msg) {
481 int is_MY_UserConf=0;
483 char roomname[ROOMNAMELEN];
485 if (msg->cm_format_type != 4) return(0);
486 if (!CC->logged_in) return(0); /* Only do this if logged in. */
488 /* We're interested in user config rooms only. */
490 if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
491 is_UserConf = 1; /* It's someone's config room */
493 MailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
494 if (!strcasecmp(CC->room.QRname, roomname)) {
496 is_MY_UserConf = 1; /* It's MY config room */
498 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
499 is_GAB = 1; /* It's the Global Address Book */
502 if (!is_UserConf && !is_GAB) return(0);
504 ptr = msg->cm_fields['M'];
505 if (ptr == NULL) return(0);
506 while (ptr != NULL) {
508 linelen = strcspn(ptr, "\n");
509 if (linelen == 0) return(0); /* end of headers */
511 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
512 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
514 * Bingo! The user is uploading a new vCard, so
515 * copy it to the Global Address Book room.
518 I = atol(msg->cm_fields['I']);
519 if (I < 0L) return(0);
521 /* Store our Internet return address in memory */
522 if (is_MY_UserConf) {
523 v = vcard_load(msg->cm_fields['M']);
524 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
525 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
527 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
532 { // This is not the GAB
533 /* Put it in the Global Address Book room... */
534 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
537 /* ...and also in the directory database. */
538 vcard_add_to_directory(I, NULL);
540 /* Some sites want an Aide to be notified when a
541 * user registers or re-registers
542 * But if the user was an Aide or was edited by an Aide then we can
543 * Assume they don't need validating.
545 if (CC->user.axlevel >= 6) {
546 lgetuser(&CC->user, CC->curr_user);
547 CC->user.flags |= US_REGIS;
554 /* ...which also means we need to flag the user */
555 lgetuser(&CC->user, CC->curr_user);
556 CC->user.flags |= (US_REGIS|US_NEEDVALID);
562 ptr = strchr((char *)ptr, '\n');
563 if (ptr != NULL) ++ptr;
572 * back end function used for callbacks
574 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
577 msgnum = (long *) userdata;
578 *msgnum = supplied_msgnum;
583 * If this user has a vcard on disk, read it into memory, otherwise allocate
584 * and return an empty vCard.
586 struct vCard *vcard_get_user(struct ctdluser *u) {
587 char hold_rm[ROOMNAMELEN];
588 char config_rm[ROOMNAMELEN];
589 struct CtdlMessage *msg = NULL;
593 strcpy(hold_rm, CC->room.QRname); /* save current room */
594 MailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
596 if (getroom(&CC->room, config_rm) != 0) {
597 getroom(&CC->room, hold_rm);
601 /* We want the last (and probably only) vcard in this room */
603 CtdlForEachMessage(MSGS_LAST, 1, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
604 NULL, vcard_gu_backend, (void *)&VCmsgnum );
605 getroom(&CC->room, hold_rm); /* return to saved room */
607 if (VCmsgnum < 0L) return vcard_new();
609 msg = CtdlFetchMessage(VCmsgnum, 1);
610 if (msg == NULL) return vcard_new();
612 v = vcard_load(msg->cm_fields['M']);
613 CtdlFreeMessage(msg);
619 * Store this user's vCard in the appropriate place
622 * Write our config to disk
624 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
627 ser = vcard_serialize(v);
629 ser = strdup("begin:vcard\r\nend:vcard\r\n");
633 /* This handy API function does all the work for us.
634 * NOTE: normally we would want to set that last argument to 1, to
635 * force the system to delete the user's old vCard. But it doesn't
636 * have to, because the vcard_upload_beforesave() hook above
637 * is going to notice what we're trying to do, and delete the old vCard.
639 CtdlWriteObject(USERCONFIGROOM, /* which room */
640 VCARD_MIME_TYPE, /* MIME type */
642 strlen(ser)+1, /* length */
645 0, /* don't delete others of this type */
654 * Old style "enter registration info" command. This function simply honors
655 * the REGI protocol command, translates the entered parameters into a vCard,
656 * and enters the vCard into the user's configuration.
658 void cmd_regi(char *argbuf) {
661 struct vCard *my_vcard;
667 char tmpaddress[SIZ];
668 char tmpcountry[SIZ];
672 if (!(CC->logged_in)) {
673 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
677 /* If users cannot create their own accounts, they cannot re-register either. */
678 if ( (config.c_disable_newu) && (CC->user.axlevel < 6) ) {
679 cprintf("%d Self-service registration is not allowed here.\n",
680 ERROR + HIGHER_ACCESS_REQUIRED);
683 my_vcard = vcard_get_user(&CC->user);
686 strcpy(tmpstate, "");
688 strcpy(tmpcountry, "USA");
690 cprintf("%d Send registration...\n", SEND_LISTING);
692 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
693 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
694 if (a==1) strcpy(tmpaddr, buf);
695 if (a==2) strcpy(tmpcity, buf);
696 if (a==3) strcpy(tmpstate, buf);
698 for (c=0; buf[c]; ++c) {
699 if ((buf[c]>='0') && (buf[c]<='9')) {
706 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
707 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
708 if (a==7) strcpy(tmpcountry, buf);
712 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
713 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
714 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
715 vcard_write_user(&CC->user, my_vcard);
716 vcard_free(my_vcard);
721 * Protocol command to fetch registration info for a user
723 void cmd_greg(char *argbuf)
725 struct ctdluser usbuf;
728 char who[USERNAME_SIZE];
732 extract_token(who, argbuf, 0, '|', sizeof who);
734 if (!(CC->logged_in)) {
735 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
739 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
741 if ((CC->user.axlevel < 6) && (strcasecmp(who,CC->curr_user))) {
742 cprintf("%d Higher access required.\n",
743 ERROR + HIGHER_ACCESS_REQUIRED);
747 if (getuser(&usbuf, who) != 0) {
748 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
752 v = vcard_get_user(&usbuf);
754 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
755 cprintf("%ld\n", usbuf.usernum);
756 cprintf("%s\n", usbuf.password);
757 s = vcard_get_prop(v, "n", 1, 0, 0);
758 cprintf("%s\n", s ? s : " "); /* name */
760 s = vcard_get_prop(v, "adr", 1, 0, 0);
761 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
763 extract_token(buf, adr, 2, ';', sizeof buf);
764 cprintf("%s\n", buf); /* street */
765 extract_token(buf, adr, 3, ';', sizeof buf);
766 cprintf("%s\n", buf); /* city */
767 extract_token(buf, adr, 4, ';', sizeof buf);
768 cprintf("%s\n", buf); /* state */
769 extract_token(buf, adr, 5, ';', sizeof buf);
770 cprintf("%s\n", buf); /* zip */
772 s = vcard_get_prop(v, "tel", 1, 0, 0);
773 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
781 cprintf("%d\n", usbuf.axlevel);
783 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
784 cprintf("%s\n", s ? s : " ");
785 s = vcard_get_prop(v, "adr", 0, 0, 0);
786 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
788 extract_token(buf, adr, 6, ';', sizeof buf);
789 cprintf("%s\n", buf); /* country */
797 * When a user is being created, create his/her vCard.
799 void vcard_newuser(struct ctdluser *usbuf) {
805 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
806 CtdlLogPrintf(CTDL_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
808 /* Create and save the vCard */
810 if (v == NULL) return;
811 vcard_add_prop(v, "fn", usbuf->fullname);
812 vcard_add_prop(v, "n", vname);
813 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
815 #ifdef HAVE_GETPWUID_R
816 /* If using host auth mode, we add an email address based on the login */
817 if (config.c_auth_mode == AUTHMODE_HOST) {
819 char pwd_buffer[SIZ];
821 #ifdef SOLARIS_GETPWUID
822 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
823 #else // SOLARIS_GETPWUID
824 struct passwd *result = NULL;
825 CtdlLogPrintf(CTDL_DEBUG, "Searching for uid %d\n", usbuf->uid);
826 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
827 #endif // HAVE_GETPWUID_R
828 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
829 vcard_add_prop(v, "email;internet", buf);
834 /* Everyone gets an email address based on their display name */
835 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
836 for (i=0; buf[i]; ++i) {
837 if (buf[i] == ' ') buf[i] = '_';
839 vcard_add_prop(v, "email;internet", buf);
842 vcard_write_user(usbuf, v);
848 * When a user is being deleted, we have to remove his/her vCard.
849 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
850 * field, and the same Exclusive ID as the existing card.
852 void vcard_purge(struct ctdluser *usbuf) {
853 struct CtdlMessage *msg;
856 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
857 if (msg == NULL) return;
858 memset(msg, 0, sizeof(struct CtdlMessage));
860 msg->cm_magic = CTDLMESSAGE_MAGIC;
861 msg->cm_anon_type = MES_NORMAL;
862 msg->cm_format_type = 0;
863 msg->cm_fields['A'] = strdup(usbuf->fullname);
864 msg->cm_fields['O'] = strdup(ADDRESS_BOOK_ROOM);
865 msg->cm_fields['N'] = strdup(NODENAME);
866 msg->cm_fields['M'] = strdup("Purge this vCard\n");
868 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
869 msg->cm_fields['A'], NODENAME);
870 msg->cm_fields['E'] = strdup(buf);
872 msg->cm_fields['S'] = strdup("CANCEL");
874 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
875 CtdlFreeMessage(msg);
880 * Grab vCard directory stuff out of incoming network messages
882 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
886 if (msg == NULL) return(0);
888 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
892 if (msg->cm_format_type != 4) return(0);
894 ptr = msg->cm_fields['M'];
895 if (ptr == NULL) return(0);
896 while (ptr != NULL) {
898 linelen = strcspn(ptr, "\n");
899 if (linelen == 0) return(0); /* end of headers */
901 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
902 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
903 /* It's a vCard. Add it to the directory. */
904 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
908 ptr = strchr((char *)ptr, '\n');
909 if (ptr != NULL) ++ptr;
918 * When a vCard is being removed from the Global Address Book room, remove it
919 * from the directory as well.
921 void vcard_delete_remove(char *room, long msgnum) {
922 struct CtdlMessage *msg;
926 if (msgnum <= 0L) return;
928 if (room == NULL) return;
930 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
934 msg = CtdlFetchMessage(msgnum, 1);
935 if (msg == NULL) return;
937 ptr = msg->cm_fields['M'];
938 if (ptr == NULL) goto EOH;
939 while (ptr != NULL) {
940 linelen = strcspn(ptr, "\n");
941 if (linelen == 0) goto EOH;
943 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
944 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
945 /* Bingo! A vCard is being deleted. */
946 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
948 ptr = strchr((char *)ptr, '\n');
949 if (ptr != NULL) ++ptr;
952 EOH: CtdlFreeMessage(msg);
958 * Get Valid Screen Names
960 void cmd_gvsn(char *argbuf)
962 if (CtdlAccessCheck(ac_logged_in)) return;
964 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
965 cprintf("%s\n", CC->user.fullname);
966 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
967 cprintf("%s\n", CC->cs_inet_fn);
974 * Get Valid Email Addresses
976 void cmd_gvea(char *argbuf)
978 int num_secondary_emails = 0;
982 if (CtdlAccessCheck(ac_logged_in)) return;
984 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
985 if (!IsEmptyStr(CC->cs_inet_email)) {
986 cprintf("%s\n", CC->cs_inet_email);
988 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
989 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
990 for (i=0; i<num_secondary_emails; ++i) {
991 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
992 cprintf("%s\n", buf);
1002 * Callback function for cmd_dvca() that hunts for vCard content types
1003 * and outputs any email addresses found within.
1005 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1006 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1007 char *cbid, void *cbuserdata) {
1010 char displayname[256];
1011 int displayname_len;
1012 char emailaddr[256];
1016 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1020 v = vcard_load(content);
1021 if (v == NULL) return;
1023 extract_friendly_name(displayname, sizeof displayname, v);
1024 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1026 displayname_len = strlen(displayname);
1027 for (i=0; i<displayname_len; ++i) {
1028 if (displayname[i] == '\"') displayname[i] = ' ';
1029 if (displayname[i] == ';') displayname[i] = ',';
1030 if (displayname[i] == ',') has_commas = 1;
1032 striplt(displayname);
1034 cprintf("%s%s%s <%s>\n",
1035 (has_commas ? "\"" : ""),
1037 (has_commas ? "\"" : ""),
1046 * Back end callback function for cmd_dvca()
1048 * It's basically just passed a list of message numbers, which we're going
1049 * to fetch off the disk and then pass along to the MIME parser via another
1050 * layer of callback...
1052 void dvca_callback(long msgnum, void *userdata) {
1053 struct CtdlMessage *msg = NULL;
1055 msg = CtdlFetchMessage(msgnum, 1);
1056 if (msg == NULL) return;
1057 mime_parser(msg->cm_fields['M'],
1059 *dvca_mime_callback, /* callback function */
1061 NULL, /* user data */
1064 CtdlFreeMessage(msg);
1069 * Dump VCard Addresses
1071 void cmd_dvca(char *argbuf)
1073 if (CtdlAccessCheck(ac_logged_in)) return;
1075 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1076 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1084 void cmd_qdir(char *argbuf) {
1085 char citadel_addr[256];
1086 char internet_addr[256];
1088 if (CtdlAccessCheck(ac_logged_in)) return;
1090 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1092 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1093 cprintf("%d %s was not found.\n",
1094 ERROR + NO_SUCH_USER, internet_addr);
1098 cprintf("%d %s\n", CIT_OK, citadel_addr);
1102 * Query Directory, in fact an alias to match postfix tcp auth.
1104 void check_get(void) {
1105 char internet_addr[256];
1110 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1111 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1112 CtdlLogPrintf(CTDL_CRIT, "Client disconnected: ending session.\n");
1116 CtdlLogPrintf(CTDL_INFO, ": %s\n", cmdbuf);
1117 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1119 if (strcasecmp(cmdbuf, "GET "));
1121 struct recptypes *rcpt;
1122 char *argbuf = &cmdbuf[4];
1124 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1125 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1126 if ((rcpt != NULL)&&
1128 (*rcpt->recp_local != '\0')||
1129 (*rcpt->recp_room != '\0')||
1130 (*rcpt->recp_ignet != '\0')))
1133 cprintf("200 OK %s\n", internet_addr);
1134 CtdlLogPrintf(CTDL_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
1138 cprintf("500 REJECT noone here by that name.\n");
1140 CtdlLogPrintf(CTDL_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
1142 if (rcpt != NULL) free_recipients(rcpt);
1146 void check_get_greeting(void) {
1147 /* dummy function, we have no greeting in this verry simple protocol. */
1152 * We don't know if the Contacts room exists so we just create it at login
1154 void vcard_create_room(void)
1159 /* Create the calendar room if it doesn't already exist */
1160 create_room(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1162 /* Set expiration policy to manual; otherwise objects will be lost! */
1163 if (lgetroom(&qr, USERCONTACTSROOM)) {
1164 CtdlLogPrintf(CTDL_ERR, "Couldn't get the user CONTACTS room!\n");
1167 qr.QRep.expire_mode = EXPIRE_MANUAL;
1168 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1171 /* Set the view to a calendar view */
1172 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1173 vbuf.v_view = 2; /* 2 = address book view */
1174 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1183 * When a user logs in...
1185 void vcard_session_login_hook(void) {
1186 struct vCard *v = NULL;
1189 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1190 * into the user's vCard.
1192 /* FIXME THIS IS NOT IMPLEMENTED YET */
1195 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1196 * These are inserted into the session data for various message entry commands to use.
1198 v = vcard_get_user(&CC->user);
1200 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
1201 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
1204 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
1209 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1211 vcard_create_room();
1216 * Turn an arbitrary RFC822 address into a struct vCard for possible
1217 * inclusion into an address book.
1219 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1221 char user[256], node[256], name[256], email[256], n[256], uid[256];
1225 if (v == NULL) return(NULL);
1227 process_rfc822_addr(addr, user, node, name);
1228 vcard_set_prop(v, "fn", name, 0);
1230 vcard_fn_to_n(n, name, sizeof n);
1231 vcard_set_prop(v, "n", n, 0);
1233 snprintf(email, sizeof email, "%s@%s", user, node);
1234 vcard_set_prop(v, "email;internet", email, 0);
1236 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1237 for (i=0; uid[i]; ++i) {
1238 if (isspace(uid[i])) uid[i] = '_';
1239 uid[i] = tolower(uid[i]);
1241 vcard_set_prop(v, "UID", uid, 0);
1249 * This is called by store_harvested_addresses() to remove from the
1250 * list any addresses we already have in our address book.
1252 void strip_addresses_already_have(long msgnum, void *userdata) {
1253 char *collected_addresses;
1254 struct CtdlMessage *msg = NULL;
1258 char addr[256], user[256], node[256], name[256];
1260 collected_addresses = (char *)userdata;
1262 msg = CtdlFetchMessage(msgnum, 1);
1263 if (msg == NULL) return;
1264 v = vcard_load(msg->cm_fields['M']);
1265 CtdlFreeMessage(msg);
1268 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1270 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1271 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1273 /* Remove the address if we already have it! */
1274 process_rfc822_addr(addr, user, node, name);
1275 snprintf(addr, sizeof addr, "%s@%s", user, node);
1276 if (!strcasecmp(value, addr)) {
1277 remove_token(collected_addresses, j, ',');
1289 * Back end function for store_harvested_addresses()
1291 void store_this_ha(struct addresses_to_be_filed *aptr) {
1292 struct CtdlMessage *vmsg = NULL;
1293 long vmsgnum = (-1L);
1295 struct vCard *v = NULL;
1296 char recipient[256];
1299 /* First remove any addresses we already have in the address book */
1300 usergoto(aptr->roomname, 0, 0, NULL, NULL);
1301 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1302 strip_addresses_already_have, aptr->collected_addresses);
1304 if (!IsEmptyStr(aptr->collected_addresses))
1305 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1307 /* Make a vCard out of each address */
1308 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1310 v = vcard_new_from_rfc822_addr(recipient);
1312 vmsg = malloc(sizeof(struct CtdlMessage));
1313 memset(vmsg, 0, sizeof(struct CtdlMessage));
1314 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1315 vmsg->cm_anon_type = MES_NORMAL;
1316 vmsg->cm_format_type = FMT_RFC822;
1317 vmsg->cm_fields['A'] = strdup("Citadel");
1318 vmsg->cm_fields['E'] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1319 ser = vcard_serialize(v);
1321 vmsg->cm_fields['M'] = malloc(strlen(ser) + 1024);
1322 sprintf(vmsg->cm_fields['M'],
1323 "Content-type: " VCARD_MIME_TYPE
1324 "\r\n\r\n%s\r\n", ser);
1329 CtdlLogPrintf(CTDL_DEBUG, "Adding contact: %s\n", recipient);
1330 vmsgnum = CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1331 CtdlFreeMessage(vmsg);
1335 free(aptr->roomname);
1336 free(aptr->collected_addresses);
1342 * When a user sends a message, we may harvest one or more email addresses
1343 * from the recipient list to be added to the user's address book. But we
1344 * want to do this asynchronously so it doesn't keep the user waiting.
1346 void store_harvested_addresses(void) {
1348 struct addresses_to_be_filed *aptr = NULL;
1350 if (atbf == NULL) return;
1352 begin_critical_section(S_ATBF);
1353 while (atbf != NULL) {
1356 end_critical_section(S_ATBF);
1357 store_this_ha(aptr);
1358 begin_critical_section(S_ATBF);
1360 end_critical_section(S_ATBF);
1365 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1366 * really this is just so we expose the vCard data to the full text indexer.
1368 void vcard_fixed_output(char *ptr, int len) {
1369 char *serialized_vcard;
1374 serialized_vcard = malloc(len + 1);
1375 safestrncpy(serialized_vcard, ptr, len+1);
1376 v = vcard_load(serialized_vcard);
1377 free(serialized_vcard);
1380 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1381 value = vcard_get_prop(v, "", 0, i++, 0);
1382 cprintf("%s\n", value);
1389 const char *CitadelServiceDICT_TCP="DICT_TCP";
1391 CTDL_MODULE_INIT(vcard)
1400 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN);
1401 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1402 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1403 CtdlRegisterDeleteHook(vcard_delete_remove);
1404 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1405 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1406 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1407 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1408 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1409 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1410 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1411 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1412 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1413 CtdlRegisterNetprocHook(vcard_extract_from_network);
1414 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER);
1415 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1416 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1418 /* Create the Global ADdress Book room if necessary */
1419 create_room(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1421 /* Set expiration policy to manual; otherwise objects will be lost! */
1422 if (!lgetroom(&qr, ADDRESS_BOOK_ROOM)) {
1423 qr.QRep.expire_mode = EXPIRE_MANUAL;
1424 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1428 * Also make sure it has a netconfig file, so the networker runs
1429 * on this room even if we don't share it with any other nodes.
1430 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1433 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1434 fp = fopen(filename, "a");
1435 if (fp != NULL) fclose(fp);
1436 rv = chown(filename, CTDLUID, (-1));
1439 /* for postfix tcpdict */
1440 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1445 CitadelServiceDICT_TCP);
1448 /* return our Subversion id for the Log */