2 * A server-side module for Citadel which supports address book information
3 * using the standard vCard format.
5 * Copyright (c) 1999-2009 by the citadel.org team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * Format of the "Exclusive ID" field of the message containing a user's
24 * vCard. Doesn't matter what it really looks like as long as it's both
25 * unique and consistent (because we use it for replication checking to
26 * delete the old vCard network-wide when the user enters a new one).
28 #define VCARD_EXT_FORMAT "Citadel vCard: personal card for %s at %s"
31 * Citadel will accept either text/vcard or text/x-vcard as the MIME type
32 * for a vCard. The following definition determines which one it *generates*
35 #define VCARD_MIME_TYPE "text/x-vcard"
46 #include <sys/types.h>
48 #if TIME_WITH_SYS_TIME
49 # include <sys/time.h>
53 # include <sys/time.h>
62 #include <libcitadel.h>
65 #include "citserver.h"
72 #include "internet_addressing.h"
73 #include "serv_vcard.h"
74 #include "citadel_ldap.h"
75 #include "ctdl_module.h"
78 * set global flag calling for an aide to validate new users
80 void set_mm_valid(void) {
81 begin_critical_section(S_CONTROL);
83 CitControl.MMflags = CitControl.MMflags | MM_VALID ;
85 end_critical_section(S_CONTROL);
91 * Extract Internet e-mail addresses from a message containing a vCard, and
92 * perform a callback for any found.
94 void vcard_extract_internet_addresses(struct CtdlMessage *msg, void (*callback)(char *, char *) ) {
99 char citadel_address[SIZ];
101 int found_something = 0;
103 if (msg->cm_fields['A'] == NULL) return;
104 if (msg->cm_fields['N'] == NULL) return;
105 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
106 msg->cm_fields['A'], msg->cm_fields['N']);
108 v = vcard_load(msg->cm_fields['M']);
109 if (v == NULL) return;
111 /* Go through the vCard searching for *all* instances of
112 * the "email;internet" key
115 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
116 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
117 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
120 if (!IsEmptyStr(addr)) {
121 if (callback != NULL) {
122 callback(addr, citadel_address);
131 } while(found_something);
138 * Callback for vcard_add_to_directory()
139 * (Lotsa ugly nested callbacks. Oh well.)
141 void vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
144 /* We have to validate that we're not stepping on someone else's
145 * email address ... but only if we're logged in. Otherwise it's
146 * probably just the networker or something.
149 syslog(LOG_DEBUG, "Checking for <%s>...\n", internet_addr);
150 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
151 if (strcasecmp(buf, citadel_addr)) {
152 /* This address belongs to someone else.
153 * Bail out silently without saving.
155 syslog(LOG_DEBUG, "DOOP!\n");
160 syslog(LOG_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
161 CtdlDirectoryAddUser(internet_addr, citadel_addr);
166 * Back end function for cmd_igab()
168 void vcard_add_to_directory(long msgnum, void *data) {
169 struct CtdlMessage *msg;
171 msg = CtdlFetchMessage(msgnum, 1);
173 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
176 CtdlFreeMessage(msg);
181 * Initialize Global Adress Book
183 void cmd_igab(char *argbuf) {
184 char hold_rm[ROOMNAMELEN];
186 if (CtdlAccessCheck(ac_aide)) return;
188 strcpy(hold_rm, CC->room.QRname); /* save current room */
190 if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
191 CtdlGetRoom(&CC->room, hold_rm);
192 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
196 /* Empty the existing database first.
200 /* We want *all* vCards in this room */
201 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
202 NULL, vcard_add_to_directory, NULL);
204 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
205 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
212 * See if there is a valid Internet address in a vCard to use for outbound
213 * Internet messages. If there is, stick it in the buffer.
215 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
216 char *secemailaddrbuf, size_t secemailaddrbuf_len,
217 struct vCard *v, int local_addrs_only) {
220 int saved_instance = 0;
222 /* Go through the vCard searching for *all* Internet email addresses
224 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
225 k = vcard_get_prop(v, "email", 1, instance, 1);
226 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
229 if (!IsEmptyStr(addr)) {
230 if ( (IsDirectory(addr, 1)) ||
231 (!local_addrs_only) ) {
233 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
234 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
236 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
237 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
239 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
240 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
241 < secemailaddrbuf_len ) {
242 strcat(secemailaddrbuf, "|");
243 strcat(secemailaddrbuf, addr);
257 * See if there is a name / screen name / friendly name in a vCard to use for outbound
258 * Internet messages. If there is, stick it in the buffer.
260 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
264 s = vcard_get_prop(v, "fn", 1, 0, 0);
266 s = vcard_get_prop(v, "n", 1, 0, 0);
270 safestrncpy(namebuf, s, namebuf_len);
276 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
278 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
279 void *content, char *cbtype, char *cbcharset, size_t length,
280 char *encoding, char *cbid, void *cbuserdata)
282 struct vCard **v = (struct vCard **) cbuserdata;
284 if ( (!strcasecmp(cbtype, "text/x-vcard"))
285 || (!strcasecmp(cbtype, "text/vcard")) ) {
287 syslog(LOG_DEBUG, "Part %s contains a vCard! Loading...\n", partnum);
291 *v = vcard_load(content);
297 * This handler detects whether the user is attempting to save a new
298 * vCard as part of his/her personal configuration, and handles the replace
299 * function accordingly (delete the user's existing vCard in the config room
300 * and in the global address book).
302 int vcard_upload_beforesave(struct CtdlMessage *msg) {
306 struct ctdluser usbuf;
308 struct vCard *v = NULL;
311 int yes_my_citadel_config = 0;
312 int yes_any_vcard_room = 0;
314 if (!CC->logged_in) return(0); /* Only do this if logged in. */
316 /* Is this some user's "My Citadel Config" room? */
317 if ( (CC->room.QRflags && QR_MAILBOX)
318 && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
319 /* Yes, we want to do this */
320 yes_my_citadel_config = 1;
322 #ifdef VCARD_SAVES_BY_AIDES_ONLY
323 /* Prevent non-aides from performing registration changes */
324 if (CC->user.axlevel < AxAideU) {
331 /* Is this a room with an address book in it? */
332 if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
333 yes_any_vcard_room = 1;
336 /* If neither condition exists, don't run this hook. */
337 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
341 /* If this isn't a MIME message, don't bother. */
342 if (msg->cm_format_type != 4) return(0);
344 /* Ok, if we got this far, look into the situation further... */
346 ptr = msg->cm_fields['M'];
347 if (ptr == NULL) return(0);
349 mime_parser(msg->cm_fields['M'],
351 *vcard_extract_vcard,
353 &v, /* user data ptr - put the vcard here */
357 if (v == NULL) return(0); /* no vCards were found in this message */
359 /* If users cannot create their own accounts, they cannot re-register either. */
360 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
364 s = vcard_get_prop(v, "fn", 1, 0, 0);
365 if (s) syslog(LOG_DEBUG, "vCard beforesave hook running for <%s>\n", s);
367 if (yes_my_citadel_config) {
368 /* Bingo! The user is uploading a new vCard, so
369 * delete the old one. First, figure out which user
370 * is being re-registered...
372 what_user = atol(CC->room.QRname);
374 if (what_user == CC->user.usernum) {
375 /* It's the logged in user. That was easy. */
376 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
379 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
380 /* We fetched a valid user record */
384 /* somebody set up us the bomb! */
385 yes_my_citadel_config = 0;
389 if (yes_my_citadel_config) {
390 /* Delete the user's old vCard. This would probably
391 * get taken care of by the replication check, but we
392 * want to make sure there is absolutely only one
393 * vCard in the user's config room at all times.
396 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
398 /* Make the author of the message the name of the user. */
399 if (msg->cm_fields['A'] != NULL) {
400 free(msg->cm_fields['A']);
402 msg->cm_fields['A'] = strdup(usbuf.fullname);
405 /* Insert or replace RFC2739-compliant free/busy URL */
406 if (yes_my_citadel_config) {
407 sprintf(buf, "http://%s/%s.vfb",
410 for (i=0; buf[i]; ++i) {
411 if (buf[i] == ' ') buf[i] = '_';
413 vcard_set_prop(v, "FBURL;PREF", buf, 0);
416 /* If the vCard has no UID, then give it one. */
417 s = vcard_get_prop(v, "UID", 1, 0, 0);
420 vcard_set_prop(v, "UID", buf, 0);
423 /* Enforce local UID policy if applicable */
424 if (yes_my_citadel_config) {
425 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
426 vcard_set_prop(v, "UID", buf, 0);
430 * Set the EUID of the message to the UID of the vCard.
432 if (msg->cm_fields['E'] != NULL)
434 free(msg->cm_fields['E']);
435 msg->cm_fields['E'] = NULL;
437 s = vcard_get_prop(v, "UID", 1, 0, 0);
439 msg->cm_fields['E'] = strdup(s);
440 if (msg->cm_fields['U'] == NULL) {
441 msg->cm_fields['U'] = strdup(s);
446 * Set the Subject to the name in the vCard.
448 s = vcard_get_prop(v, "FN", 1, 0, 0);
450 s = vcard_get_prop(v, "N", 1, 0, 0);
453 if (msg->cm_fields['U'] != NULL) {
454 free(msg->cm_fields['U']);
456 msg->cm_fields['U'] = strdup(s);
459 /* Re-serialize it back into the msg body */
460 ser = vcard_serialize(v);
462 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], strlen(ser) + 1024);
463 sprintf(msg->cm_fields['M'],
464 "Content-type: " VCARD_MIME_TYPE
465 "\r\n\r\n%s\r\n", ser);
469 /* Now allow the save to complete. */
477 * This handler detects whether the user is attempting to save a new
478 * vCard as part of his/her personal configuration, and handles the replace
479 * function accordingly (copy the vCard from the config room to the global
482 int vcard_upload_aftersave(struct CtdlMessage *msg) {
488 int is_MY_UserConf=0;
490 char roomname[ROOMNAMELEN];
492 if (msg->cm_format_type != 4) return(0);
493 if (!CC->logged_in) return(0); /* Only do this if logged in. */
495 /* We're interested in user config rooms only. */
497 if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
498 is_UserConf = 1; /* It's someone's config room */
500 CtdlMailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
501 if (!strcasecmp(CC->room.QRname, roomname)) {
503 is_MY_UserConf = 1; /* It's MY config room */
505 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
506 is_GAB = 1; /* It's the Global Address Book */
509 if (!is_UserConf && !is_GAB) return(0);
511 ptr = msg->cm_fields['M'];
512 if (ptr == NULL) return(0);
513 while (ptr != NULL) {
515 linelen = strcspn(ptr, "\n");
516 if (linelen == 0) return(0); /* end of headers */
518 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
519 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
521 * Bingo! The user is uploading a new vCard, so
522 * copy it to the Global Address Book room.
525 I = atol(msg->cm_fields['I']);
526 if (I < 0L) return(0);
528 /* Store our Internet return address in memory */
529 if (is_MY_UserConf) {
530 v = vcard_load(msg->cm_fields['M']);
531 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
532 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
534 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
539 { // This is not the GAB
540 /* Put it in the Global Address Book room... */
541 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
544 /* ...and also in the directory database. */
545 vcard_add_to_directory(I, NULL);
547 /* Some sites want an Aide to be notified when a
548 * user registers or re-registers
549 * But if the user was an Aide or was edited by an Aide then we can
550 * Assume they don't need validating.
552 if (CC->user.axlevel >= AxAideU) {
553 CtdlGetUserLock(&CC->user, CC->curr_user);
554 CC->user.flags |= US_REGIS;
555 CtdlPutUserLock(&CC->user);
561 /* ...which also means we need to flag the user */
562 CtdlGetUserLock(&CC->user, CC->curr_user);
563 CC->user.flags |= (US_REGIS|US_NEEDVALID);
564 CtdlPutUserLock(&CC->user);
569 ptr = strchr((char *)ptr, '\n');
570 if (ptr != NULL) ++ptr;
579 * back end function used for callbacks
581 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
584 msgnum = (long *) userdata;
585 *msgnum = supplied_msgnum;
590 * If this user has a vcard on disk, read it into memory, otherwise allocate
591 * and return an empty vCard.
593 struct vCard *vcard_get_user(struct ctdluser *u) {
594 char hold_rm[ROOMNAMELEN];
595 char config_rm[ROOMNAMELEN];
596 struct CtdlMessage *msg = NULL;
600 strcpy(hold_rm, CC->room.QRname); /* save current room */
601 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
603 if (CtdlGetRoom(&CC->room, config_rm) != 0) {
604 CtdlGetRoom(&CC->room, hold_rm);
608 /* We want the last (and probably only) vcard in this room */
610 CtdlForEachMessage(MSGS_LAST, 1, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
611 NULL, vcard_gu_backend, (void *)&VCmsgnum );
612 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
614 if (VCmsgnum < 0L) return vcard_new();
616 msg = CtdlFetchMessage(VCmsgnum, 1);
617 if (msg == NULL) return vcard_new();
619 v = vcard_load(msg->cm_fields['M']);
620 CtdlFreeMessage(msg);
626 * Store this user's vCard in the appropriate place
629 * Write our config to disk
631 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
634 ser = vcard_serialize(v);
636 ser = strdup("begin:vcard\r\nend:vcard\r\n");
640 /* This handy API function does all the work for us.
641 * NOTE: normally we would want to set that last argument to 1, to
642 * force the system to delete the user's old vCard. But it doesn't
643 * have to, because the vcard_upload_beforesave() hook above
644 * is going to notice what we're trying to do, and delete the old vCard.
646 CtdlWriteObject(USERCONFIGROOM, /* which room */
647 VCARD_MIME_TYPE, /* MIME type */
649 strlen(ser)+1, /* length */
652 0, /* don't delete others of this type */
661 * Old style "enter registration info" command. This function simply honors
662 * the REGI protocol command, translates the entered parameters into a vCard,
663 * and enters the vCard into the user's configuration.
665 void cmd_regi(char *argbuf) {
668 struct vCard *my_vcard;
674 char tmpaddress[SIZ];
675 char tmpcountry[SIZ];
679 if (!(CC->logged_in)) {
680 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
684 /* If users cannot create their own accounts, they cannot re-register either. */
685 if ( (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
686 cprintf("%d Self-service registration is not allowed here.\n",
687 ERROR + HIGHER_ACCESS_REQUIRED);
690 my_vcard = vcard_get_user(&CC->user);
693 strcpy(tmpstate, "");
695 strcpy(tmpcountry, "USA");
697 cprintf("%d Send registration...\n", SEND_LISTING);
699 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
700 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
701 if (a==1) strcpy(tmpaddr, buf);
702 if (a==2) strcpy(tmpcity, buf);
703 if (a==3) strcpy(tmpstate, buf);
705 for (c=0; buf[c]; ++c) {
706 if ((buf[c]>='0') && (buf[c]<='9')) {
713 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
714 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
715 if (a==7) strcpy(tmpcountry, buf);
719 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
720 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
721 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
722 vcard_write_user(&CC->user, my_vcard);
723 vcard_free(my_vcard);
728 * Protocol command to fetch registration info for a user
730 void cmd_greg(char *argbuf)
732 struct ctdluser usbuf;
735 char who[USERNAME_SIZE];
739 extract_token(who, argbuf, 0, '|', sizeof who);
741 if (!(CC->logged_in)) {
742 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
746 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
748 if ((CC->user.axlevel < AxAideU) && (strcasecmp(who,CC->curr_user))) {
749 cprintf("%d Higher access required.\n",
750 ERROR + HIGHER_ACCESS_REQUIRED);
754 if (CtdlGetUser(&usbuf, who) != 0) {
755 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
759 v = vcard_get_user(&usbuf);
761 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
762 cprintf("%ld\n", usbuf.usernum);
763 cprintf("%s\n", usbuf.password);
764 s = vcard_get_prop(v, "n", 1, 0, 0);
765 cprintf("%s\n", s ? s : " "); /* name */
767 s = vcard_get_prop(v, "adr", 1, 0, 0);
768 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
770 extract_token(buf, adr, 2, ';', sizeof buf);
771 cprintf("%s\n", buf); /* street */
772 extract_token(buf, adr, 3, ';', sizeof buf);
773 cprintf("%s\n", buf); /* city */
774 extract_token(buf, adr, 4, ';', sizeof buf);
775 cprintf("%s\n", buf); /* state */
776 extract_token(buf, adr, 5, ';', sizeof buf);
777 cprintf("%s\n", buf); /* zip */
779 s = vcard_get_prop(v, "tel", 1, 0, 0);
780 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
788 cprintf("%d\n", usbuf.axlevel);
790 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
791 cprintf("%s\n", s ? s : " ");
792 s = vcard_get_prop(v, "adr", 0, 0, 0);
793 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
795 extract_token(buf, adr, 6, ';', sizeof buf);
796 cprintf("%s\n", buf); /* country */
804 * When a user is being created, create his/her vCard.
806 void vcard_newuser(struct ctdluser *usbuf) {
812 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
813 syslog(LOG_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
815 /* Create and save the vCard */
817 if (v == NULL) return;
818 vcard_add_prop(v, "fn", usbuf->fullname);
819 vcard_add_prop(v, "n", vname);
820 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
822 #ifdef HAVE_GETPWUID_R
823 /* If using host auth mode, we add an email address based on the login */
824 if (config.c_auth_mode == AUTHMODE_HOST) {
826 char pwd_buffer[SIZ];
828 #ifdef SOLARIS_GETPWUID
829 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
830 #else // SOLARIS_GETPWUID
831 struct passwd *result = NULL;
832 syslog(LOG_DEBUG, "Searching for uid %d\n", usbuf->uid);
833 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
834 #endif // HAVE_GETPWUID_R
835 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
836 vcard_add_prop(v, "email;internet", buf);
841 /* Everyone gets an email address based on their display name */
842 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
843 for (i=0; buf[i]; ++i) {
844 if (buf[i] == ' ') buf[i] = '_';
846 vcard_add_prop(v, "email;internet", buf);
849 vcard_write_user(usbuf, v);
855 * When a user is being deleted, we have to remove his/her vCard.
856 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
857 * field, and the same Exclusive ID as the existing card.
859 void vcard_purge(struct ctdluser *usbuf) {
860 struct CtdlMessage *msg;
863 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
864 if (msg == NULL) return;
865 memset(msg, 0, sizeof(struct CtdlMessage));
867 msg->cm_magic = CTDLMESSAGE_MAGIC;
868 msg->cm_anon_type = MES_NORMAL;
869 msg->cm_format_type = 0;
870 msg->cm_fields['A'] = strdup(usbuf->fullname);
871 msg->cm_fields['O'] = strdup(ADDRESS_BOOK_ROOM);
872 msg->cm_fields['N'] = strdup(NODENAME);
873 msg->cm_fields['M'] = strdup("Purge this vCard\n");
875 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
876 msg->cm_fields['A'], NODENAME);
877 msg->cm_fields['E'] = strdup(buf);
879 msg->cm_fields['S'] = strdup("CANCEL");
881 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
882 CtdlFreeMessage(msg);
887 * Grab vCard directory stuff out of incoming network messages
889 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
893 if (msg == NULL) return(0);
895 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
899 if (msg->cm_format_type != 4) return(0);
901 ptr = msg->cm_fields['M'];
902 if (ptr == NULL) return(0);
903 while (ptr != NULL) {
905 linelen = strcspn(ptr, "\n");
906 if (linelen == 0) return(0); /* end of headers */
908 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
909 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
910 /* It's a vCard. Add it to the directory. */
911 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
915 ptr = strchr((char *)ptr, '\n');
916 if (ptr != NULL) ++ptr;
925 * When a vCard is being removed from the Global Address Book room, remove it
926 * from the directory as well.
928 void vcard_delete_remove(char *room, long msgnum) {
929 struct CtdlMessage *msg;
933 if (msgnum <= 0L) return;
935 if (room == NULL) return;
937 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
941 msg = CtdlFetchMessage(msgnum, 1);
942 if (msg == NULL) return;
944 ptr = msg->cm_fields['M'];
945 if (ptr == NULL) goto EOH;
946 while (ptr != NULL) {
947 linelen = strcspn(ptr, "\n");
948 if (linelen == 0) goto EOH;
950 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
951 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
952 /* Bingo! A vCard is being deleted. */
953 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
955 ptr = strchr((char *)ptr, '\n');
956 if (ptr != NULL) ++ptr;
959 EOH: CtdlFreeMessage(msg);
965 * Get Valid Screen Names
967 void cmd_gvsn(char *argbuf)
969 if (CtdlAccessCheck(ac_logged_in)) return;
971 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
972 cprintf("%s\n", CC->user.fullname);
973 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
974 cprintf("%s\n", CC->cs_inet_fn);
981 * Get Valid Email Addresses
983 void cmd_gvea(char *argbuf)
985 int num_secondary_emails = 0;
989 if (CtdlAccessCheck(ac_logged_in)) return;
991 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
992 if (!IsEmptyStr(CC->cs_inet_email)) {
993 cprintf("%s\n", CC->cs_inet_email);
995 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
996 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
997 for (i=0; i<num_secondary_emails; ++i) {
998 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
999 cprintf("%s\n", buf);
1009 * Callback function for cmd_dvca() that hunts for vCard content types
1010 * and outputs any email addresses found within.
1012 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1013 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1014 char *cbid, void *cbuserdata) {
1017 char displayname[256];
1018 int displayname_len;
1019 char emailaddr[256];
1023 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1027 v = vcard_load(content);
1028 if (v == NULL) return;
1030 extract_friendly_name(displayname, sizeof displayname, v);
1031 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1033 displayname_len = strlen(displayname);
1034 for (i=0; i<displayname_len; ++i) {
1035 if (displayname[i] == '\"') displayname[i] = ' ';
1036 if (displayname[i] == ';') displayname[i] = ',';
1037 if (displayname[i] == ',') has_commas = 1;
1039 striplt(displayname);
1041 cprintf("%s%s%s <%s>\n",
1042 (has_commas ? "\"" : ""),
1044 (has_commas ? "\"" : ""),
1053 * Back end callback function for cmd_dvca()
1055 * It's basically just passed a list of message numbers, which we're going
1056 * to fetch off the disk and then pass along to the MIME parser via another
1057 * layer of callback...
1059 void dvca_callback(long msgnum, void *userdata) {
1060 struct CtdlMessage *msg = NULL;
1062 msg = CtdlFetchMessage(msgnum, 1);
1063 if (msg == NULL) return;
1064 mime_parser(msg->cm_fields['M'],
1066 *dvca_mime_callback, /* callback function */
1068 NULL, /* user data */
1071 CtdlFreeMessage(msg);
1076 * Dump VCard Addresses
1078 void cmd_dvca(char *argbuf)
1080 if (CtdlAccessCheck(ac_logged_in)) return;
1082 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1083 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1091 void cmd_qdir(char *argbuf) {
1092 char citadel_addr[256];
1093 char internet_addr[256];
1095 if (CtdlAccessCheck(ac_logged_in)) return;
1097 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1099 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1100 cprintf("%d %s was not found.\n",
1101 ERROR + NO_SUCH_USER, internet_addr);
1105 cprintf("%d %s\n", CIT_OK, citadel_addr);
1109 * Query Directory, in fact an alias to match postfix tcp auth.
1111 void check_get(void) {
1112 char internet_addr[256];
1117 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1118 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1119 syslog(LOG_CRIT, "Client disconnected: ending session.\n");
1120 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1123 syslog(LOG_INFO, ": %s\n", cmdbuf);
1124 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1125 syslog(LOG_INFO, "[ %s]\n", cmdbuf);
1127 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1129 struct recptypes *rcpt;
1130 char *argbuf = &cmdbuf[4];
1132 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1133 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1134 if ((rcpt != NULL)&&
1136 (*rcpt->recp_local != '\0')||
1137 (*rcpt->recp_room != '\0')||
1138 (*rcpt->recp_ignet != '\0')))
1141 cprintf("200 OK %s\n", internet_addr);
1142 syslog(LOG_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
1146 cprintf("500 REJECT noone here by that name.\n");
1148 syslog(LOG_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
1151 free_recipients(rcpt);
1155 cprintf("500 REJECT invalid Query.\n");
1157 syslog(LOG_INFO, "sending 500 REJECT invalid Query: %s\n", internet_addr);
1161 void check_get_greeting(void) {
1162 /* dummy function, we have no greeting in this verry simple protocol. */
1167 * We don't know if the Contacts room exists so we just create it at login
1169 void vcard_CtdlCreateRoom(void)
1174 /* Create the calendar room if it doesn't already exist */
1175 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1177 /* Set expiration policy to manual; otherwise objects will be lost! */
1178 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1179 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!\n");
1182 qr.QRep.expire_mode = EXPIRE_MANUAL;
1183 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1184 CtdlPutRoomLock(&qr);
1186 /* Set the view to a calendar view */
1187 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1188 vbuf.v_view = 2; /* 2 = address book view */
1189 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1198 * When a user logs in...
1200 void vcard_session_login_hook(void) {
1201 struct vCard *v = NULL;
1202 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1206 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1207 * into the user's vCard.
1209 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1210 v = vcard_get_user(&CCC->user);
1212 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1213 vcard_write_user(&CCC->user, v);
1220 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1221 * These are inserted into the session data for various message entry commands to use.
1223 v = vcard_get_user(&CCC->user);
1225 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1226 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1229 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1234 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1236 vcard_CtdlCreateRoom();
1241 * Turn an arbitrary RFC822 address into a struct vCard for possible
1242 * inclusion into an address book.
1244 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1246 char user[256], node[256], name[256], email[256], n[256], uid[256];
1250 if (v == NULL) return(NULL);
1252 process_rfc822_addr(addr, user, node, name);
1253 vcard_set_prop(v, "fn", name, 0);
1255 vcard_fn_to_n(n, name, sizeof n);
1256 vcard_set_prop(v, "n", n, 0);
1258 snprintf(email, sizeof email, "%s@%s", user, node);
1259 vcard_set_prop(v, "email;internet", email, 0);
1261 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1262 for (i=0; uid[i]; ++i) {
1263 if (isspace(uid[i])) uid[i] = '_';
1264 uid[i] = tolower(uid[i]);
1266 vcard_set_prop(v, "UID", uid, 0);
1274 * This is called by store_harvested_addresses() to remove from the
1275 * list any addresses we already have in our address book.
1277 void strip_addresses_already_have(long msgnum, void *userdata) {
1278 char *collected_addresses;
1279 struct CtdlMessage *msg = NULL;
1283 char addr[256], user[256], node[256], name[256];
1285 collected_addresses = (char *)userdata;
1287 msg = CtdlFetchMessage(msgnum, 1);
1288 if (msg == NULL) return;
1289 v = vcard_load(msg->cm_fields['M']);
1290 CtdlFreeMessage(msg);
1293 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1295 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1296 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1298 /* Remove the address if we already have it! */
1299 process_rfc822_addr(addr, user, node, name);
1300 snprintf(addr, sizeof addr, "%s@%s", user, node);
1301 if (!strcasecmp(value, addr)) {
1302 remove_token(collected_addresses, j, ',');
1314 * Back end function for store_harvested_addresses()
1316 void store_this_ha(struct addresses_to_be_filed *aptr) {
1317 struct CtdlMessage *vmsg = NULL;
1318 long vmsgnum = (-1L);
1320 struct vCard *v = NULL;
1321 char recipient[256];
1324 /* First remove any addresses we already have in the address book */
1325 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
1326 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1327 strip_addresses_already_have, aptr->collected_addresses);
1329 if (!IsEmptyStr(aptr->collected_addresses))
1330 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1332 /* Make a vCard out of each address */
1333 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1335 v = vcard_new_from_rfc822_addr(recipient);
1337 vmsg = malloc(sizeof(struct CtdlMessage));
1338 memset(vmsg, 0, sizeof(struct CtdlMessage));
1339 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1340 vmsg->cm_anon_type = MES_NORMAL;
1341 vmsg->cm_format_type = FMT_RFC822;
1342 vmsg->cm_fields['A'] = strdup("Citadel");
1343 vmsg->cm_fields['E'] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1344 ser = vcard_serialize(v);
1346 vmsg->cm_fields['M'] = malloc(strlen(ser) + 1024);
1347 sprintf(vmsg->cm_fields['M'],
1348 "Content-type: " VCARD_MIME_TYPE
1349 "\r\n\r\n%s\r\n", ser);
1354 syslog(LOG_DEBUG, "Adding contact: %s\n", recipient);
1355 vmsgnum = CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1356 CtdlFreeMessage(vmsg);
1360 free(aptr->roomname);
1361 free(aptr->collected_addresses);
1367 * When a user sends a message, we may harvest one or more email addresses
1368 * from the recipient list to be added to the user's address book. But we
1369 * want to do this asynchronously so it doesn't keep the user waiting.
1371 void store_harvested_addresses(void) {
1373 struct addresses_to_be_filed *aptr = NULL;
1375 if (atbf == NULL) return;
1377 begin_critical_section(S_ATBF);
1378 while (atbf != NULL) {
1381 end_critical_section(S_ATBF);
1382 store_this_ha(aptr);
1383 begin_critical_section(S_ATBF);
1385 end_critical_section(S_ATBF);
1390 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1391 * really this is just so we expose the vCard data to the full text indexer.
1393 void vcard_fixed_output(char *ptr, int len) {
1394 char *serialized_vcard;
1399 serialized_vcard = malloc(len + 1);
1400 safestrncpy(serialized_vcard, ptr, len+1);
1401 v = vcard_load(serialized_vcard);
1402 free(serialized_vcard);
1405 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1406 value = vcard_get_prop(v, "", 0, i++, 0);
1407 cprintf("%s\n", value);
1414 const char *CitadelServiceDICT_TCP="DICT_TCP";
1416 CTDL_MODULE_INIT(vcard)
1425 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN);
1426 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1427 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1428 CtdlRegisterDeleteHook(vcard_delete_remove);
1429 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1430 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1431 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1432 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1433 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1434 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1435 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1436 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1437 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1438 CtdlRegisterNetprocHook(vcard_extract_from_network);
1439 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER);
1440 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1441 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1443 /* Create the Global ADdress Book room if necessary */
1444 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1446 /* Set expiration policy to manual; otherwise objects will be lost! */
1447 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1448 qr.QRep.expire_mode = EXPIRE_MANUAL;
1449 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1450 CtdlPutRoomLock(&qr);
1453 * Also make sure it has a netconfig file, so the networker runs
1454 * on this room even if we don't share it with any other nodes.
1455 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1458 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1459 fp = fopen(filename, "a");
1460 if (fp != NULL) fclose(fp);
1461 rv = chown(filename, CTDLUID, (-1));
1464 /* for postfix tcpdict */
1465 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1470 CitadelServiceDICT_TCP);
1473 /* return our Subversion id for the Log */