4 * A server-side module for Citadel which supports address book information
5 * using the standard vCard format.
7 * Copyright (c) 1999-2009 by the citadel.org team
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * Format of the "Exclusive ID" field of the message containing a user's
26 * vCard. Doesn't matter what it really looks like as long as it's both
27 * unique and consistent (because we use it for replication checking to
28 * delete the old vCard network-wide when the user enters a new one).
30 #define VCARD_EXT_FORMAT "Citadel vCard: personal card for %s at %s"
33 * Citadel will accept either text/vcard or text/x-vcard as the MIME type
34 * for a vCard. The following definition determines which one it *generates*
37 #define VCARD_MIME_TYPE "text/x-vcard"
48 #include <sys/types.h>
50 #if TIME_WITH_SYS_TIME
51 # include <sys/time.h>
55 # include <sys/time.h>
64 #include <libcitadel.h>
67 #include "citserver.h"
76 #include "internet_addressing.h"
77 #include "serv_vcard.h"
78 #include "citadel_ldap.h"
79 #include "ctdl_module.h"
82 * set global flag calling for an aide to validate new users
84 void set_mm_valid(void) {
85 begin_critical_section(S_CONTROL);
87 CitControl.MMflags = CitControl.MMflags | MM_VALID ;
89 end_critical_section(S_CONTROL);
95 * Extract Internet e-mail addresses from a message containing a vCard, and
96 * perform a callback for any found.
98 void vcard_extract_internet_addresses(struct CtdlMessage *msg, void (*callback)(char *, char *) ) {
103 char citadel_address[SIZ];
105 int found_something = 0;
107 if (msg->cm_fields['A'] == NULL) return;
108 if (msg->cm_fields['N'] == NULL) return;
109 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
110 msg->cm_fields['A'], msg->cm_fields['N']);
112 v = vcard_load(msg->cm_fields['M']);
113 if (v == NULL) return;
115 /* Go through the vCard searching for *all* instances of
116 * the "email;internet" key
119 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
120 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
121 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
124 if (!IsEmptyStr(addr)) {
125 if (callback != NULL) {
126 callback(addr, citadel_address);
135 } while(found_something);
142 * Callback for vcard_add_to_directory()
143 * (Lotsa ugly nested callbacks. Oh well.)
145 void vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
148 /* We have to validate that we're not stepping on someone else's
149 * email address ... but only if we're logged in. Otherwise it's
150 * probably just the networker or something.
153 CtdlLogPrintf(CTDL_DEBUG, "Checking for <%s>...\n", internet_addr);
154 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
155 if (strcasecmp(buf, citadel_addr)) {
156 /* This address belongs to someone else.
157 * Bail out silently without saving.
159 CtdlLogPrintf(CTDL_DEBUG, "DOOP!\n");
164 CtdlLogPrintf(CTDL_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
165 CtdlDirectoryAddUser(internet_addr, citadel_addr);
170 * Back end function for cmd_igab()
172 void vcard_add_to_directory(long msgnum, void *data) {
173 struct CtdlMessage *msg;
175 msg = CtdlFetchMessage(msgnum, 1);
177 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
180 CtdlFreeMessage(msg);
185 * Initialize Global Adress Book
187 void cmd_igab(char *argbuf) {
188 char hold_rm[ROOMNAMELEN];
190 if (CtdlAccessCheck(ac_aide)) return;
192 strcpy(hold_rm, CC->room.QRname); /* save current room */
194 if (getroom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
195 getroom(&CC->room, hold_rm);
196 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
200 /* Empty the existing database first.
204 /* We want *all* vCards in this room */
205 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
206 NULL, vcard_add_to_directory, NULL);
208 getroom(&CC->room, hold_rm); /* return to saved room */
209 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
216 * See if there is a valid Internet address in a vCard to use for outbound
217 * Internet messages. If there is, stick it in the buffer.
219 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
220 char *secemailaddrbuf, size_t secemailaddrbuf_len,
221 struct vCard *v, int local_addrs_only) {
224 int saved_instance = 0;
226 /* Go through the vCard searching for *all* Internet email addresses
228 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
229 k = vcard_get_prop(v, "email", 1, instance, 1);
230 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
233 if (!IsEmptyStr(addr)) {
234 if ( (IsDirectory(addr, 1)) ||
235 (!local_addrs_only) ) {
237 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
238 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
240 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
241 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
243 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
244 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
245 < secemailaddrbuf_len ) {
246 strcat(secemailaddrbuf, "|");
247 strcat(secemailaddrbuf, addr);
261 * See if there is a name / screen name / friendly name in a vCard to use for outbound
262 * Internet messages. If there is, stick it in the buffer.
264 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
268 s = vcard_get_prop(v, "fn", 1, 0, 0);
270 s = vcard_get_prop(v, "n", 1, 0, 0);
274 safestrncpy(namebuf, s, namebuf_len);
280 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
282 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
283 void *content, char *cbtype, char *cbcharset, size_t length,
284 char *encoding, char *cbid, void *cbuserdata)
286 struct vCard **v = (struct vCard **) cbuserdata;
288 if ( (!strcasecmp(cbtype, "text/x-vcard"))
289 || (!strcasecmp(cbtype, "text/vcard")) ) {
291 CtdlLogPrintf(CTDL_DEBUG, "Part %s contains a vCard! Loading...\n", partnum);
295 *v = vcard_load(content);
301 * This handler detects whether the user is attempting to save a new
302 * vCard as part of his/her personal configuration, and handles the replace
303 * function accordingly (delete the user's existing vCard in the config room
304 * and in the global address book).
306 int vcard_upload_beforesave(struct CtdlMessage *msg) {
310 struct ctdluser usbuf;
312 struct vCard *v = NULL;
315 int yes_my_citadel_config = 0;
316 int yes_any_vcard_room = 0;
318 if (!CC->logged_in) return(0); /* Only do this if logged in. */
320 /* Is this some user's "My Citadel Config" room? */
321 if ( (CC->room.QRflags && QR_MAILBOX)
322 && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
323 /* Yes, we want to do this */
324 yes_my_citadel_config = 1;
326 #ifdef VCARD_SAVES_BY_AIDES_ONLY
327 /* Prevent non-aides from performing registration changes */
328 if (CC->user.axlevel < 6) {
335 /* Is this a room with an address book in it? */
336 if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
337 yes_any_vcard_room = 1;
340 /* If neither condition exists, don't run this hook. */
341 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
345 /* If this isn't a MIME message, don't bother. */
346 if (msg->cm_format_type != 4) return(0);
348 /* Ok, if we got this far, look into the situation further... */
350 ptr = msg->cm_fields['M'];
351 if (ptr == NULL) return(0);
353 mime_parser(msg->cm_fields['M'],
355 *vcard_extract_vcard,
357 &v, /* user data ptr - put the vcard here */
361 if (v == NULL) return(0); /* no vCards were found in this message */
363 /* If users cannot create their own accounts, they cannot re-register either. */
364 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < 6) ) {
368 s = vcard_get_prop(v, "fn", 1, 0, 0);
369 if (s) CtdlLogPrintf(CTDL_DEBUG, "vCard beforesave hook running for <%s>\n", s);
371 if (yes_my_citadel_config) {
372 /* Bingo! The user is uploading a new vCard, so
373 * delete the old one. First, figure out which user
374 * is being re-registered...
376 what_user = atol(CC->room.QRname);
378 if (what_user == CC->user.usernum) {
379 /* It's the logged in user. That was easy. */
380 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
383 else if (getuserbynumber(&usbuf, what_user) == 0) {
384 /* We fetched a valid user record */
388 /* somebody set up us the bomb! */
389 yes_my_citadel_config = 0;
393 if (yes_my_citadel_config) {
394 /* Delete the user's old vCard. This would probably
395 * get taken care of by the replication check, but we
396 * want to make sure there is absolutely only one
397 * vCard in the user's config room at all times.
400 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
402 /* Make the author of the message the name of the user. */
403 if (msg->cm_fields['A'] != NULL) {
404 free(msg->cm_fields['A']);
406 msg->cm_fields['A'] = strdup(usbuf.fullname);
409 /* Insert or replace RFC2739-compliant free/busy URL */
410 if (yes_my_citadel_config) {
411 sprintf(buf, "http://%s/%s.vfb",
414 for (i=0; buf[i]; ++i) {
415 if (buf[i] == ' ') buf[i] = '_';
417 vcard_set_prop(v, "FBURL;PREF", buf, 0);
420 /* If the vCard has no UID, then give it one. */
421 s = vcard_get_prop(v, "UID", 1, 0, 0);
424 vcard_set_prop(v, "UID", buf, 0);
427 /* Enforce local UID policy if applicable */
428 if (yes_my_citadel_config) {
429 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
430 vcard_set_prop(v, "UID", buf, 0);
434 * Set the EUID of the message to the UID of the vCard.
436 if (msg->cm_fields['E'] != NULL)
438 free(msg->cm_fields['E']);
439 msg->cm_fields['E'] = NULL;
441 s = vcard_get_prop(v, "UID", 1, 0, 0);
443 msg->cm_fields['E'] = strdup(s);
444 if (msg->cm_fields['U'] == NULL) {
445 msg->cm_fields['U'] = strdup(s);
450 * Set the Subject to the name in the vCard.
452 s = vcard_get_prop(v, "FN", 1, 0, 0);
454 s = vcard_get_prop(v, "N", 1, 0, 0);
457 if (msg->cm_fields['U'] != NULL) {
458 free(msg->cm_fields['U']);
460 msg->cm_fields['U'] = strdup(s);
463 /* Re-serialize it back into the msg body */
464 ser = vcard_serialize(v);
466 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], strlen(ser) + 1024);
467 sprintf(msg->cm_fields['M'],
468 "Content-type: " VCARD_MIME_TYPE
469 "\r\n\r\n%s\r\n", ser);
473 /* Now allow the save to complete. */
481 * This handler detects whether the user is attempting to save a new
482 * vCard as part of his/her personal configuration, and handles the replace
483 * function accordingly (copy the vCard from the config room to the global
486 int vcard_upload_aftersave(struct CtdlMessage *msg) {
492 int is_MY_UserConf=0;
494 char roomname[ROOMNAMELEN];
496 if (msg->cm_format_type != 4) return(0);
497 if (!CC->logged_in) return(0); /* Only do this if logged in. */
499 /* We're interested in user config rooms only. */
501 if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
502 is_UserConf = 1; /* It's someone's config room */
504 MailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
505 if (!strcasecmp(CC->room.QRname, roomname)) {
507 is_MY_UserConf = 1; /* It's MY config room */
509 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
510 is_GAB = 1; /* It's the Global Address Book */
513 if (!is_UserConf && !is_GAB) return(0);
515 ptr = msg->cm_fields['M'];
516 if (ptr == NULL) return(0);
517 while (ptr != NULL) {
519 linelen = strcspn(ptr, "\n");
520 if (linelen == 0) return(0); /* end of headers */
522 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
523 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
525 * Bingo! The user is uploading a new vCard, so
526 * copy it to the Global Address Book room.
529 I = atol(msg->cm_fields['I']);
530 if (I < 0L) return(0);
532 /* Store our Internet return address in memory */
533 if (is_MY_UserConf) {
534 v = vcard_load(msg->cm_fields['M']);
535 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
536 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
538 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
543 { // This is not the GAB
544 /* Put it in the Global Address Book room... */
545 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
548 /* ...and also in the directory database. */
549 vcard_add_to_directory(I, NULL);
551 /* Some sites want an Aide to be notified when a
552 * user registers or re-registers
553 * But if the user was an Aide or was edited by an Aide then we can
554 * Assume they don't need validating.
556 if (CC->user.axlevel >= 6) {
557 lgetuser(&CC->user, CC->curr_user);
558 CC->user.flags |= US_REGIS;
565 /* ...which also means we need to flag the user */
566 lgetuser(&CC->user, CC->curr_user);
567 CC->user.flags |= (US_REGIS|US_NEEDVALID);
573 ptr = strchr((char *)ptr, '\n');
574 if (ptr != NULL) ++ptr;
583 * back end function used for callbacks
585 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
588 msgnum = (long *) userdata;
589 *msgnum = supplied_msgnum;
594 * If this user has a vcard on disk, read it into memory, otherwise allocate
595 * and return an empty vCard.
597 struct vCard *vcard_get_user(struct ctdluser *u) {
598 char hold_rm[ROOMNAMELEN];
599 char config_rm[ROOMNAMELEN];
600 struct CtdlMessage *msg = NULL;
604 strcpy(hold_rm, CC->room.QRname); /* save current room */
605 MailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
607 if (getroom(&CC->room, config_rm) != 0) {
608 getroom(&CC->room, hold_rm);
612 /* We want the last (and probably only) vcard in this room */
614 CtdlForEachMessage(MSGS_LAST, 1, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
615 NULL, vcard_gu_backend, (void *)&VCmsgnum );
616 getroom(&CC->room, hold_rm); /* return to saved room */
618 if (VCmsgnum < 0L) return vcard_new();
620 msg = CtdlFetchMessage(VCmsgnum, 1);
621 if (msg == NULL) return vcard_new();
623 v = vcard_load(msg->cm_fields['M']);
624 CtdlFreeMessage(msg);
630 * Store this user's vCard in the appropriate place
633 * Write our config to disk
635 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
638 ser = vcard_serialize(v);
640 ser = strdup("begin:vcard\r\nend:vcard\r\n");
644 /* This handy API function does all the work for us.
645 * NOTE: normally we would want to set that last argument to 1, to
646 * force the system to delete the user's old vCard. But it doesn't
647 * have to, because the vcard_upload_beforesave() hook above
648 * is going to notice what we're trying to do, and delete the old vCard.
650 CtdlWriteObject(USERCONFIGROOM, /* which room */
651 VCARD_MIME_TYPE, /* MIME type */
653 strlen(ser)+1, /* length */
656 0, /* don't delete others of this type */
665 * Old style "enter registration info" command. This function simply honors
666 * the REGI protocol command, translates the entered parameters into a vCard,
667 * and enters the vCard into the user's configuration.
669 void cmd_regi(char *argbuf) {
672 struct vCard *my_vcard;
678 char tmpaddress[SIZ];
679 char tmpcountry[SIZ];
683 if (!(CC->logged_in)) {
684 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
688 /* If users cannot create their own accounts, they cannot re-register either. */
689 if ( (config.c_disable_newu) && (CC->user.axlevel < 6) ) {
690 cprintf("%d Self-service registration is not allowed here.\n",
691 ERROR + HIGHER_ACCESS_REQUIRED);
694 my_vcard = vcard_get_user(&CC->user);
697 strcpy(tmpstate, "");
699 strcpy(tmpcountry, "USA");
701 cprintf("%d Send registration...\n", SEND_LISTING);
703 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
704 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
705 if (a==1) strcpy(tmpaddr, buf);
706 if (a==2) strcpy(tmpcity, buf);
707 if (a==3) strcpy(tmpstate, buf);
709 for (c=0; buf[c]; ++c) {
710 if ((buf[c]>='0') && (buf[c]<='9')) {
717 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
718 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
719 if (a==7) strcpy(tmpcountry, buf);
723 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
724 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
725 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
726 vcard_write_user(&CC->user, my_vcard);
727 vcard_free(my_vcard);
732 * Protocol command to fetch registration info for a user
734 void cmd_greg(char *argbuf)
736 struct ctdluser usbuf;
739 char who[USERNAME_SIZE];
743 extract_token(who, argbuf, 0, '|', sizeof who);
745 if (!(CC->logged_in)) {
746 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
750 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
752 if ((CC->user.axlevel < 6) && (strcasecmp(who,CC->curr_user))) {
753 cprintf("%d Higher access required.\n",
754 ERROR + HIGHER_ACCESS_REQUIRED);
758 if (getuser(&usbuf, who) != 0) {
759 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
763 v = vcard_get_user(&usbuf);
765 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
766 cprintf("%ld\n", usbuf.usernum);
767 cprintf("%s\n", usbuf.password);
768 s = vcard_get_prop(v, "n", 1, 0, 0);
769 cprintf("%s\n", s ? s : " "); /* name */
771 s = vcard_get_prop(v, "adr", 1, 0, 0);
772 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
774 extract_token(buf, adr, 2, ';', sizeof buf);
775 cprintf("%s\n", buf); /* street */
776 extract_token(buf, adr, 3, ';', sizeof buf);
777 cprintf("%s\n", buf); /* city */
778 extract_token(buf, adr, 4, ';', sizeof buf);
779 cprintf("%s\n", buf); /* state */
780 extract_token(buf, adr, 5, ';', sizeof buf);
781 cprintf("%s\n", buf); /* zip */
783 s = vcard_get_prop(v, "tel", 1, 0, 0);
784 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
792 cprintf("%d\n", usbuf.axlevel);
794 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
795 cprintf("%s\n", s ? s : " ");
796 s = vcard_get_prop(v, "adr", 0, 0, 0);
797 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
799 extract_token(buf, adr, 6, ';', sizeof buf);
800 cprintf("%s\n", buf); /* country */
808 * When a user is being created, create his/her vCard.
810 void vcard_newuser(struct ctdluser *usbuf) {
816 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
817 CtdlLogPrintf(CTDL_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
819 /* Create and save the vCard */
821 if (v == NULL) return;
822 vcard_add_prop(v, "fn", usbuf->fullname);
823 vcard_add_prop(v, "n", vname);
824 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
826 #ifdef HAVE_GETPWUID_R
827 /* If using host auth mode, we add an email address based on the login */
828 if (config.c_auth_mode == AUTHMODE_HOST) {
830 char pwd_buffer[SIZ];
832 #ifdef SOLARIS_GETPWUID
833 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
834 #else // SOLARIS_GETPWUID
835 struct passwd *result = NULL;
836 CtdlLogPrintf(CTDL_DEBUG, "Searching for uid %d\n", usbuf->uid);
837 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
838 #endif // HAVE_GETPWUID_R
839 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
840 vcard_add_prop(v, "email;internet", buf);
845 /* Everyone gets an email address based on their display name */
846 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
847 for (i=0; buf[i]; ++i) {
848 if (buf[i] == ' ') buf[i] = '_';
850 vcard_add_prop(v, "email;internet", buf);
853 vcard_write_user(usbuf, v);
859 * When a user is being deleted, we have to remove his/her vCard.
860 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
861 * field, and the same Exclusive ID as the existing card.
863 void vcard_purge(struct ctdluser *usbuf) {
864 struct CtdlMessage *msg;
867 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
868 if (msg == NULL) return;
869 memset(msg, 0, sizeof(struct CtdlMessage));
871 msg->cm_magic = CTDLMESSAGE_MAGIC;
872 msg->cm_anon_type = MES_NORMAL;
873 msg->cm_format_type = 0;
874 msg->cm_fields['A'] = strdup(usbuf->fullname);
875 msg->cm_fields['O'] = strdup(ADDRESS_BOOK_ROOM);
876 msg->cm_fields['N'] = strdup(NODENAME);
877 msg->cm_fields['M'] = strdup("Purge this vCard\n");
879 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
880 msg->cm_fields['A'], NODENAME);
881 msg->cm_fields['E'] = strdup(buf);
883 msg->cm_fields['S'] = strdup("CANCEL");
885 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
886 CtdlFreeMessage(msg);
891 * Grab vCard directory stuff out of incoming network messages
893 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
897 if (msg == NULL) return(0);
899 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
903 if (msg->cm_format_type != 4) return(0);
905 ptr = msg->cm_fields['M'];
906 if (ptr == NULL) return(0);
907 while (ptr != NULL) {
909 linelen = strcspn(ptr, "\n");
910 if (linelen == 0) return(0); /* end of headers */
912 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
913 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
914 /* It's a vCard. Add it to the directory. */
915 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
919 ptr = strchr((char *)ptr, '\n');
920 if (ptr != NULL) ++ptr;
929 * When a vCard is being removed from the Global Address Book room, remove it
930 * from the directory as well.
932 void vcard_delete_remove(char *room, long msgnum) {
933 struct CtdlMessage *msg;
937 if (msgnum <= 0L) return;
939 if (room == NULL) return;
941 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
945 msg = CtdlFetchMessage(msgnum, 1);
946 if (msg == NULL) return;
948 ptr = msg->cm_fields['M'];
949 if (ptr == NULL) goto EOH;
950 while (ptr != NULL) {
951 linelen = strcspn(ptr, "\n");
952 if (linelen == 0) goto EOH;
954 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
955 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
956 /* Bingo! A vCard is being deleted. */
957 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
959 ptr = strchr((char *)ptr, '\n');
960 if (ptr != NULL) ++ptr;
963 EOH: CtdlFreeMessage(msg);
969 * Get Valid Screen Names
971 void cmd_gvsn(char *argbuf)
973 if (CtdlAccessCheck(ac_logged_in)) return;
975 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
976 cprintf("%s\n", CC->user.fullname);
977 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
978 cprintf("%s\n", CC->cs_inet_fn);
985 * Get Valid Email Addresses
987 void cmd_gvea(char *argbuf)
989 int num_secondary_emails = 0;
993 if (CtdlAccessCheck(ac_logged_in)) return;
995 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
996 if (!IsEmptyStr(CC->cs_inet_email)) {
997 cprintf("%s\n", CC->cs_inet_email);
999 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
1000 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
1001 for (i=0; i<num_secondary_emails; ++i) {
1002 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
1003 cprintf("%s\n", buf);
1013 * Callback function for cmd_dvca() that hunts for vCard content types
1014 * and outputs any email addresses found within.
1016 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1017 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1018 char *cbid, void *cbuserdata) {
1021 char displayname[256];
1022 int displayname_len;
1023 char emailaddr[256];
1027 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1031 v = vcard_load(content);
1032 if (v == NULL) return;
1034 extract_friendly_name(displayname, sizeof displayname, v);
1035 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1037 displayname_len = strlen(displayname);
1038 for (i=0; i<displayname_len; ++i) {
1039 if (displayname[i] == '\"') displayname[i] = ' ';
1040 if (displayname[i] == ';') displayname[i] = ',';
1041 if (displayname[i] == ',') has_commas = 1;
1043 striplt(displayname);
1045 cprintf("%s%s%s <%s>\n",
1046 (has_commas ? "\"" : ""),
1048 (has_commas ? "\"" : ""),
1057 * Back end callback function for cmd_dvca()
1059 * It's basically just passed a list of message numbers, which we're going
1060 * to fetch off the disk and then pass along to the MIME parser via another
1061 * layer of callback...
1063 void dvca_callback(long msgnum, void *userdata) {
1064 struct CtdlMessage *msg = NULL;
1066 msg = CtdlFetchMessage(msgnum, 1);
1067 if (msg == NULL) return;
1068 mime_parser(msg->cm_fields['M'],
1070 *dvca_mime_callback, /* callback function */
1072 NULL, /* user data */
1075 CtdlFreeMessage(msg);
1080 * Dump VCard Addresses
1082 void cmd_dvca(char *argbuf)
1084 if (CtdlAccessCheck(ac_logged_in)) return;
1086 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1087 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1095 void cmd_qdir(char *argbuf) {
1096 char citadel_addr[256];
1097 char internet_addr[256];
1099 if (CtdlAccessCheck(ac_logged_in)) return;
1101 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1103 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1104 cprintf("%d %s was not found.\n",
1105 ERROR + NO_SUCH_USER, internet_addr);
1109 cprintf("%d %s\n", CIT_OK, citadel_addr);
1113 * Query Directory, in fact an alias to match postfix tcp auth.
1115 void check_get(void) {
1116 char internet_addr[256];
1121 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1122 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1123 CtdlLogPrintf(CTDL_CRIT, "Client disconnected: ending session.\n");
1127 CtdlLogPrintf(CTDL_INFO, ": %s\n", cmdbuf);
1128 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1130 if (strcasecmp(cmdbuf, "GET "));
1132 struct recptypes *rcpt;
1133 char *argbuf = &cmdbuf[4];
1135 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1136 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1137 if ((rcpt != NULL)&&
1139 (*rcpt->recp_local != '\0')||
1140 (*rcpt->recp_room != '\0')||
1141 (*rcpt->recp_ignet != '\0')))
1144 cprintf("200 OK %s\n", internet_addr);
1145 CtdlLogPrintf(CTDL_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
1149 cprintf("500 REJECT noone here by that name.\n");
1151 CtdlLogPrintf(CTDL_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
1153 if (rcpt != NULL) free_recipients(rcpt);
1157 void check_get_greeting(void) {
1158 /* dummy function, we have no greeting in this verry simple protocol. */
1163 * We don't know if the Contacts room exists so we just create it at login
1165 void vcard_create_room(void)
1170 /* Create the calendar room if it doesn't already exist */
1171 create_room(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1173 /* Set expiration policy to manual; otherwise objects will be lost! */
1174 if (lgetroom(&qr, USERCONTACTSROOM)) {
1175 CtdlLogPrintf(CTDL_ERR, "Couldn't get the user CONTACTS room!\n");
1178 qr.QRep.expire_mode = EXPIRE_MANUAL;
1179 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1182 /* Set the view to a calendar view */
1183 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1184 vbuf.v_view = 2; /* 2 = address book view */
1185 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1194 * When a user logs in...
1196 void vcard_session_login_hook(void) {
1197 struct vCard *v = NULL;
1198 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1202 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1203 * into the user's vCard.
1205 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1206 v = vcard_get_user(&CCC->user);
1208 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1209 vcard_write_user(&CCC->user, v);
1216 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1217 * These are inserted into the session data for various message entry commands to use.
1219 v = vcard_get_user(&CCC->user);
1221 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1222 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1225 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1230 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1232 vcard_create_room();
1237 * Turn an arbitrary RFC822 address into a struct vCard for possible
1238 * inclusion into an address book.
1240 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1242 char user[256], node[256], name[256], email[256], n[256], uid[256];
1246 if (v == NULL) return(NULL);
1248 process_rfc822_addr(addr, user, node, name);
1249 vcard_set_prop(v, "fn", name, 0);
1251 vcard_fn_to_n(n, name, sizeof n);
1252 vcard_set_prop(v, "n", n, 0);
1254 snprintf(email, sizeof email, "%s@%s", user, node);
1255 vcard_set_prop(v, "email;internet", email, 0);
1257 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1258 for (i=0; uid[i]; ++i) {
1259 if (isspace(uid[i])) uid[i] = '_';
1260 uid[i] = tolower(uid[i]);
1262 vcard_set_prop(v, "UID", uid, 0);
1270 * This is called by store_harvested_addresses() to remove from the
1271 * list any addresses we already have in our address book.
1273 void strip_addresses_already_have(long msgnum, void *userdata) {
1274 char *collected_addresses;
1275 struct CtdlMessage *msg = NULL;
1279 char addr[256], user[256], node[256], name[256];
1281 collected_addresses = (char *)userdata;
1283 msg = CtdlFetchMessage(msgnum, 1);
1284 if (msg == NULL) return;
1285 v = vcard_load(msg->cm_fields['M']);
1286 CtdlFreeMessage(msg);
1289 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1291 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1292 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1294 /* Remove the address if we already have it! */
1295 process_rfc822_addr(addr, user, node, name);
1296 snprintf(addr, sizeof addr, "%s@%s", user, node);
1297 if (!strcasecmp(value, addr)) {
1298 remove_token(collected_addresses, j, ',');
1310 * Back end function for store_harvested_addresses()
1312 void store_this_ha(struct addresses_to_be_filed *aptr) {
1313 struct CtdlMessage *vmsg = NULL;
1314 long vmsgnum = (-1L);
1316 struct vCard *v = NULL;
1317 char recipient[256];
1320 /* First remove any addresses we already have in the address book */
1321 usergoto(aptr->roomname, 0, 0, NULL, NULL);
1322 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1323 strip_addresses_already_have, aptr->collected_addresses);
1325 if (!IsEmptyStr(aptr->collected_addresses))
1326 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1328 /* Make a vCard out of each address */
1329 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1331 v = vcard_new_from_rfc822_addr(recipient);
1333 vmsg = malloc(sizeof(struct CtdlMessage));
1334 memset(vmsg, 0, sizeof(struct CtdlMessage));
1335 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1336 vmsg->cm_anon_type = MES_NORMAL;
1337 vmsg->cm_format_type = FMT_RFC822;
1338 vmsg->cm_fields['A'] = strdup("Citadel");
1339 vmsg->cm_fields['E'] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1340 ser = vcard_serialize(v);
1342 vmsg->cm_fields['M'] = malloc(strlen(ser) + 1024);
1343 sprintf(vmsg->cm_fields['M'],
1344 "Content-type: " VCARD_MIME_TYPE
1345 "\r\n\r\n%s\r\n", ser);
1350 CtdlLogPrintf(CTDL_DEBUG, "Adding contact: %s\n", recipient);
1351 vmsgnum = CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1352 CtdlFreeMessage(vmsg);
1356 free(aptr->roomname);
1357 free(aptr->collected_addresses);
1363 * When a user sends a message, we may harvest one or more email addresses
1364 * from the recipient list to be added to the user's address book. But we
1365 * want to do this asynchronously so it doesn't keep the user waiting.
1367 void store_harvested_addresses(void) {
1369 struct addresses_to_be_filed *aptr = NULL;
1371 if (atbf == NULL) return;
1373 begin_critical_section(S_ATBF);
1374 while (atbf != NULL) {
1377 end_critical_section(S_ATBF);
1378 store_this_ha(aptr);
1379 begin_critical_section(S_ATBF);
1381 end_critical_section(S_ATBF);
1386 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1387 * really this is just so we expose the vCard data to the full text indexer.
1389 void vcard_fixed_output(char *ptr, int len) {
1390 char *serialized_vcard;
1395 serialized_vcard = malloc(len + 1);
1396 safestrncpy(serialized_vcard, ptr, len+1);
1397 v = vcard_load(serialized_vcard);
1398 free(serialized_vcard);
1401 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1402 value = vcard_get_prop(v, "", 0, i++, 0);
1403 cprintf("%s\n", value);
1410 const char *CitadelServiceDICT_TCP="DICT_TCP";
1412 CTDL_MODULE_INIT(vcard)
1421 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN);
1422 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1423 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1424 CtdlRegisterDeleteHook(vcard_delete_remove);
1425 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1426 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1427 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1428 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1429 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1430 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1431 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1432 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1433 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1434 CtdlRegisterNetprocHook(vcard_extract_from_network);
1435 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER);
1436 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1437 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1439 /* Create the Global ADdress Book room if necessary */
1440 create_room(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1442 /* Set expiration policy to manual; otherwise objects will be lost! */
1443 if (!lgetroom(&qr, ADDRESS_BOOK_ROOM)) {
1444 qr.QRep.expire_mode = EXPIRE_MANUAL;
1445 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1449 * Also make sure it has a netconfig file, so the networker runs
1450 * on this room even if we don't share it with any other nodes.
1451 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1454 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1455 fp = fopen(filename, "a");
1456 if (fp != NULL) fclose(fp);
1457 rv = chown(filename, CTDLUID, (-1));
1460 /* for postfix tcpdict */
1461 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1466 CitadelServiceDICT_TCP);
1469 /* return our Subversion id for the Log */