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);
366 if (yes_my_citadel_config) {
367 /* Bingo! The user is uploading a new vCard, so
368 * delete the old one. First, figure out which user
369 * is being re-registered...
371 what_user = atol(CC->room.QRname);
373 if (what_user == CC->user.usernum) {
374 /* It's the logged in user. That was easy. */
375 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
378 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
379 /* We fetched a valid user record */
383 /* somebody set up us the bomb! */
384 yes_my_citadel_config = 0;
388 if (yes_my_citadel_config) {
389 /* Delete the user's old vCard. This would probably
390 * get taken care of by the replication check, but we
391 * want to make sure there is absolutely only one
392 * vCard in the user's config room at all times.
395 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
397 /* Make the author of the message the name of the user. */
398 if (msg->cm_fields['A'] != NULL) {
399 free(msg->cm_fields['A']);
401 msg->cm_fields['A'] = strdup(usbuf.fullname);
404 /* Insert or replace RFC2739-compliant free/busy URL */
405 if (yes_my_citadel_config) {
406 sprintf(buf, "http://%s/%s.vfb",
409 for (i=0; buf[i]; ++i) {
410 if (buf[i] == ' ') buf[i] = '_';
412 vcard_set_prop(v, "FBURL;PREF", buf, 0);
415 /* If the vCard has no UID, then give it one. */
416 s = vcard_get_prop(v, "UID", 1, 0, 0);
419 vcard_set_prop(v, "UID", buf, 0);
422 /* Enforce local UID policy if applicable */
423 if (yes_my_citadel_config) {
424 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
425 vcard_set_prop(v, "UID", buf, 0);
429 * Set the EUID of the message to the UID of the vCard.
431 if (msg->cm_fields['E'] != NULL)
433 free(msg->cm_fields['E']);
434 msg->cm_fields['E'] = NULL;
436 s = vcard_get_prop(v, "UID", 1, 0, 0);
438 msg->cm_fields['E'] = strdup(s);
439 if (msg->cm_fields['U'] == NULL) {
440 msg->cm_fields['U'] = strdup(s);
445 * Set the Subject to the name in the vCard.
447 s = vcard_get_prop(v, "FN", 1, 0, 0);
449 s = vcard_get_prop(v, "N", 1, 0, 0);
452 if (msg->cm_fields['U'] != NULL) {
453 free(msg->cm_fields['U']);
455 msg->cm_fields['U'] = strdup(s);
458 /* Re-serialize it back into the msg body */
459 ser = vcard_serialize(v);
461 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], strlen(ser) + 1024);
462 sprintf(msg->cm_fields['M'],
463 "Content-type: " VCARD_MIME_TYPE
464 "\r\n\r\n%s\r\n", ser);
468 /* Now allow the save to complete. */
476 * This handler detects whether the user is attempting to save a new
477 * vCard as part of his/her personal configuration, and handles the replace
478 * function accordingly (copy the vCard from the config room to the global
481 int vcard_upload_aftersave(struct CtdlMessage *msg) {
487 int is_MY_UserConf=0;
489 char roomname[ROOMNAMELEN];
491 if (msg->cm_format_type != 4) return(0);
492 if (!CC->logged_in) return(0); /* Only do this if logged in. */
494 /* We're interested in user config rooms only. */
496 if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
497 is_UserConf = 1; /* It's someone's config room */
499 CtdlMailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
500 if (!strcasecmp(CC->room.QRname, roomname)) {
502 is_MY_UserConf = 1; /* It's MY config room */
504 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
505 is_GAB = 1; /* It's the Global Address Book */
508 if (!is_UserConf && !is_GAB) return(0);
510 ptr = msg->cm_fields['M'];
511 if (ptr == NULL) return(0);
512 while (ptr != NULL) {
514 linelen = strcspn(ptr, "\n");
515 if (linelen == 0) return(0); /* end of headers */
517 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
518 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
520 * Bingo! The user is uploading a new vCard, so
521 * copy it to the Global Address Book room.
524 I = atol(msg->cm_fields['3']);
525 if (I <= 0L) return(0);
527 /* Store our Internet return address in memory */
528 if (is_MY_UserConf) {
529 v = vcard_load(msg->cm_fields['M']);
530 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
531 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
533 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
538 { // This is not the GAB
539 /* Put it in the Global Address Book room... */
540 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
543 /* ...and also in the directory database. */
544 vcard_add_to_directory(I, NULL);
546 /* Some sites want an Aide to be notified when a
547 * user registers or re-registers
548 * But if the user was an Aide or was edited by an Aide then we can
549 * Assume they don't need validating.
551 if (CC->user.axlevel >= AxAideU) {
552 CtdlGetUserLock(&CC->user, CC->curr_user);
553 CC->user.flags |= US_REGIS;
554 CtdlPutUserLock(&CC->user);
560 /* ...which also means we need to flag the user */
561 CtdlGetUserLock(&CC->user, CC->curr_user);
562 CC->user.flags |= (US_REGIS|US_NEEDVALID);
563 CtdlPutUserLock(&CC->user);
568 ptr = strchr((char *)ptr, '\n');
569 if (ptr != NULL) ++ptr;
578 * back end function used for callbacks
580 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
583 msgnum = (long *) userdata;
584 *msgnum = supplied_msgnum;
589 * If this user has a vcard on disk, read it into memory, otherwise allocate
590 * and return an empty vCard.
592 struct vCard *vcard_get_user(struct ctdluser *u) {
593 char hold_rm[ROOMNAMELEN];
594 char config_rm[ROOMNAMELEN];
595 struct CtdlMessage *msg = NULL;
599 strcpy(hold_rm, CC->room.QRname); /* save current room */
600 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
602 if (CtdlGetRoom(&CC->room, config_rm) != 0) {
603 CtdlGetRoom(&CC->room, hold_rm);
607 /* We want the last (and probably only) vcard in this room */
609 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
610 NULL, vcard_gu_backend, (void *)&VCmsgnum );
611 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
613 if (VCmsgnum < 0L) return vcard_new();
615 msg = CtdlFetchMessage(VCmsgnum, 1);
616 if (msg == NULL) return vcard_new();
618 v = vcard_load(msg->cm_fields['M']);
619 CtdlFreeMessage(msg);
625 * Store this user's vCard in the appropriate place
628 * Write our config to disk
630 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
633 ser = vcard_serialize(v);
635 ser = strdup("begin:vcard\r\nend:vcard\r\n");
639 /* This handy API function does all the work for us.
640 * NOTE: normally we would want to set that last argument to 1, to
641 * force the system to delete the user's old vCard. But it doesn't
642 * have to, because the vcard_upload_beforesave() hook above
643 * is going to notice what we're trying to do, and delete the old vCard.
645 CtdlWriteObject(USERCONFIGROOM, /* which room */
646 VCARD_MIME_TYPE, /* MIME type */
648 strlen(ser)+1, /* length */
651 0, /* don't delete others of this type */
660 * Old style "enter registration info" command. This function simply honors
661 * the REGI protocol command, translates the entered parameters into a vCard,
662 * and enters the vCard into the user's configuration.
664 void cmd_regi(char *argbuf) {
667 struct vCard *my_vcard;
673 char tmpaddress[SIZ];
674 char tmpcountry[SIZ];
678 if (!(CC->logged_in)) {
679 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
683 /* If users cannot create their own accounts, they cannot re-register either. */
684 if ( (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
685 cprintf("%d Self-service registration is not allowed here.\n",
686 ERROR + HIGHER_ACCESS_REQUIRED);
689 my_vcard = vcard_get_user(&CC->user);
692 strcpy(tmpstate, "");
694 strcpy(tmpcountry, "USA");
696 cprintf("%d Send registration...\n", SEND_LISTING);
698 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
699 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
700 if (a==1) strcpy(tmpaddr, buf);
701 if (a==2) strcpy(tmpcity, buf);
702 if (a==3) strcpy(tmpstate, buf);
704 for (c=0; buf[c]; ++c) {
705 if ((buf[c]>='0') && (buf[c]<='9')) {
712 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
713 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
714 if (a==7) strcpy(tmpcountry, buf);
718 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
719 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
720 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
721 vcard_write_user(&CC->user, my_vcard);
722 vcard_free(my_vcard);
727 * Protocol command to fetch registration info for a user
729 void cmd_greg(char *argbuf)
731 struct ctdluser usbuf;
734 char who[USERNAME_SIZE];
738 extract_token(who, argbuf, 0, '|', sizeof who);
740 if (!(CC->logged_in)) {
741 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
745 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
747 if ((CC->user.axlevel < AxAideU) && (strcasecmp(who,CC->curr_user))) {
748 cprintf("%d Higher access required.\n",
749 ERROR + HIGHER_ACCESS_REQUIRED);
753 if (CtdlGetUser(&usbuf, who) != 0) {
754 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
758 v = vcard_get_user(&usbuf);
760 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
761 cprintf("%ld\n", usbuf.usernum);
762 cprintf("%s\n", usbuf.password);
763 s = vcard_get_prop(v, "n", 1, 0, 0);
764 cprintf("%s\n", s ? s : " "); /* name */
766 s = vcard_get_prop(v, "adr", 1, 0, 0);
767 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
769 extract_token(buf, adr, 2, ';', sizeof buf);
770 cprintf("%s\n", buf); /* street */
771 extract_token(buf, adr, 3, ';', sizeof buf);
772 cprintf("%s\n", buf); /* city */
773 extract_token(buf, adr, 4, ';', sizeof buf);
774 cprintf("%s\n", buf); /* state */
775 extract_token(buf, adr, 5, ';', sizeof buf);
776 cprintf("%s\n", buf); /* zip */
778 s = vcard_get_prop(v, "tel", 1, 0, 0);
779 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
787 cprintf("%d\n", usbuf.axlevel);
789 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
790 cprintf("%s\n", s ? s : " ");
791 s = vcard_get_prop(v, "adr", 0, 0, 0);
792 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
794 extract_token(buf, adr, 6, ';', sizeof buf);
795 cprintf("%s\n", buf); /* country */
803 * When a user is being created, create his/her vCard.
805 void vcard_newuser(struct ctdluser *usbuf) {
811 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
812 syslog(LOG_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
814 /* Create and save the vCard */
816 if (v == NULL) return;
817 vcard_add_prop(v, "fn", usbuf->fullname);
818 vcard_add_prop(v, "n", vname);
819 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
821 #ifdef HAVE_GETPWUID_R
822 /* If using host auth mode, we add an email address based on the login */
823 if (config.c_auth_mode == AUTHMODE_HOST) {
825 char pwd_buffer[SIZ];
827 #ifdef SOLARIS_GETPWUID
828 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
829 #else // SOLARIS_GETPWUID
830 struct passwd *result = NULL;
831 syslog(LOG_DEBUG, "Searching for uid %d\n", usbuf->uid);
832 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
833 #endif // HAVE_GETPWUID_R
834 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
835 vcard_add_prop(v, "email;internet", buf);
840 /* Everyone gets an email address based on their display name */
841 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
842 for (i=0; buf[i]; ++i) {
843 if (buf[i] == ' ') buf[i] = '_';
845 vcard_add_prop(v, "email;internet", buf);
848 vcard_write_user(usbuf, v);
854 * When a user is being deleted, we have to remove his/her vCard.
855 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
856 * field, and the same Exclusive ID as the existing card.
858 void vcard_purge(struct ctdluser *usbuf) {
859 struct CtdlMessage *msg;
862 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
863 if (msg == NULL) return;
864 memset(msg, 0, sizeof(struct CtdlMessage));
866 msg->cm_magic = CTDLMESSAGE_MAGIC;
867 msg->cm_anon_type = MES_NORMAL;
868 msg->cm_format_type = 0;
869 msg->cm_fields['A'] = strdup(usbuf->fullname);
870 msg->cm_fields['O'] = strdup(ADDRESS_BOOK_ROOM);
871 msg->cm_fields['N'] = strdup(NODENAME);
872 msg->cm_fields['M'] = strdup("Purge this vCard\n");
874 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
875 msg->cm_fields['A'], NODENAME);
876 msg->cm_fields['E'] = strdup(buf);
878 msg->cm_fields['S'] = strdup("CANCEL");
880 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
881 CtdlFreeMessage(msg);
886 * Grab vCard directory stuff out of incoming network messages
888 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
892 if (msg == NULL) return(0);
894 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
898 if (msg->cm_format_type != 4) return(0);
900 ptr = msg->cm_fields['M'];
901 if (ptr == NULL) return(0);
902 while (ptr != NULL) {
904 linelen = strcspn(ptr, "\n");
905 if (linelen == 0) return(0); /* end of headers */
907 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
908 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
909 /* It's a vCard. Add it to the directory. */
910 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
914 ptr = strchr((char *)ptr, '\n');
915 if (ptr != NULL) ++ptr;
924 * When a vCard is being removed from the Global Address Book room, remove it
925 * from the directory as well.
927 void vcard_delete_remove(char *room, long msgnum) {
928 struct CtdlMessage *msg;
932 if (msgnum <= 0L) return;
934 if (room == NULL) return;
936 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
940 msg = CtdlFetchMessage(msgnum, 1);
941 if (msg == NULL) return;
943 ptr = msg->cm_fields['M'];
944 if (ptr == NULL) goto EOH;
945 while (ptr != NULL) {
946 linelen = strcspn(ptr, "\n");
947 if (linelen == 0) goto EOH;
949 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
950 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
951 /* Bingo! A vCard is being deleted. */
952 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
954 ptr = strchr((char *)ptr, '\n');
955 if (ptr != NULL) ++ptr;
958 EOH: CtdlFreeMessage(msg);
964 * Get Valid Screen Names
966 void cmd_gvsn(char *argbuf)
968 if (CtdlAccessCheck(ac_logged_in)) return;
970 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
971 cprintf("%s\n", CC->user.fullname);
972 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
973 cprintf("%s\n", CC->cs_inet_fn);
980 * Get Valid Email Addresses
982 void cmd_gvea(char *argbuf)
984 int num_secondary_emails = 0;
988 if (CtdlAccessCheck(ac_logged_in)) return;
990 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
991 if (!IsEmptyStr(CC->cs_inet_email)) {
992 cprintf("%s\n", CC->cs_inet_email);
994 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
995 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
996 for (i=0; i<num_secondary_emails; ++i) {
997 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
998 cprintf("%s\n", buf);
1008 * Callback function for cmd_dvca() that hunts for vCard content types
1009 * and outputs any email addresses found within.
1011 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1012 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1013 char *cbid, void *cbuserdata) {
1016 char displayname[256];
1017 int displayname_len;
1018 char emailaddr[256];
1022 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1026 v = vcard_load(content);
1027 if (v == NULL) return;
1029 extract_friendly_name(displayname, sizeof displayname, v);
1030 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1032 displayname_len = strlen(displayname);
1033 for (i=0; i<displayname_len; ++i) {
1034 if (displayname[i] == '\"') displayname[i] = ' ';
1035 if (displayname[i] == ';') displayname[i] = ',';
1036 if (displayname[i] == ',') has_commas = 1;
1038 striplt(displayname);
1040 cprintf("%s%s%s <%s>\n",
1041 (has_commas ? "\"" : ""),
1043 (has_commas ? "\"" : ""),
1052 * Back end callback function for cmd_dvca()
1054 * It's basically just passed a list of message numbers, which we're going
1055 * to fetch off the disk and then pass along to the MIME parser via another
1056 * layer of callback...
1058 void dvca_callback(long msgnum, void *userdata) {
1059 struct CtdlMessage *msg = NULL;
1061 msg = CtdlFetchMessage(msgnum, 1);
1062 if (msg == NULL) return;
1063 mime_parser(msg->cm_fields['M'],
1065 *dvca_mime_callback, /* callback function */
1067 NULL, /* user data */
1070 CtdlFreeMessage(msg);
1075 * Dump VCard Addresses
1077 void cmd_dvca(char *argbuf)
1079 if (CtdlAccessCheck(ac_logged_in)) return;
1081 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1082 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1090 void cmd_qdir(char *argbuf) {
1091 char citadel_addr[256];
1092 char internet_addr[256];
1094 if (CtdlAccessCheck(ac_logged_in)) return;
1096 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1098 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1099 cprintf("%d %s was not found.\n",
1100 ERROR + NO_SUCH_USER, internet_addr);
1104 cprintf("%d %s\n", CIT_OK, citadel_addr);
1108 * Query Directory, in fact an alias to match postfix tcp auth.
1110 void check_get(void) {
1111 char internet_addr[256];
1116 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1117 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1118 syslog(LOG_CRIT, "vcard client disconnected: ending session.\n");
1119 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1122 syslog(LOG_INFO, ": %s\n", cmdbuf);
1123 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1124 syslog(LOG_INFO, "[ %s]\n", cmdbuf);
1126 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1128 struct recptypes *rcpt;
1129 char *argbuf = &cmdbuf[4];
1131 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1132 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1133 if ((rcpt != NULL)&&
1135 (*rcpt->recp_local != '\0')||
1136 (*rcpt->recp_room != '\0')||
1137 (*rcpt->recp_ignet != '\0')))
1140 cprintf("200 OK %s\n", internet_addr);
1141 syslog(LOG_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
1145 cprintf("500 REJECT noone here by that name.\n");
1147 syslog(LOG_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
1150 free_recipients(rcpt);
1154 cprintf("500 REJECT invalid Query.\n");
1156 syslog(LOG_INFO, "sending 500 REJECT invalid Query: %s\n", internet_addr);
1160 void check_get_greeting(void) {
1161 /* dummy function, we have no greeting in this verry simple protocol. */
1166 * We don't know if the Contacts room exists so we just create it at login
1168 void vcard_CtdlCreateRoom(void)
1173 /* Create the calendar room if it doesn't already exist */
1174 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1176 /* Set expiration policy to manual; otherwise objects will be lost! */
1177 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1178 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!\n");
1181 qr.QRep.expire_mode = EXPIRE_MANUAL;
1182 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1183 CtdlPutRoomLock(&qr);
1185 /* Set the view to a calendar view */
1186 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1187 vbuf.v_view = 2; /* 2 = address book view */
1188 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1197 * When a user logs in...
1199 void vcard_session_login_hook(void) {
1200 struct vCard *v = NULL;
1201 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1205 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1206 * into the user's vCard.
1208 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1209 v = vcard_get_user(&CCC->user);
1211 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1212 vcard_write_user(&CCC->user, v);
1219 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1220 * These are inserted into the session data for various message entry commands to use.
1222 v = vcard_get_user(&CCC->user);
1224 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1225 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1228 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1233 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1235 vcard_CtdlCreateRoom();
1240 * Turn an arbitrary RFC822 address into a struct vCard for possible
1241 * inclusion into an address book.
1243 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1245 char user[256], node[256], name[256], email[256], n[256], uid[256];
1249 if (v == NULL) return(NULL);
1251 process_rfc822_addr(addr, user, node, name);
1252 vcard_set_prop(v, "fn", name, 0);
1254 vcard_fn_to_n(n, name, sizeof n);
1255 vcard_set_prop(v, "n", n, 0);
1257 snprintf(email, sizeof email, "%s@%s", user, node);
1258 vcard_set_prop(v, "email;internet", email, 0);
1260 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1261 for (i=0; uid[i]; ++i) {
1262 if (isspace(uid[i])) uid[i] = '_';
1263 uid[i] = tolower(uid[i]);
1265 vcard_set_prop(v, "UID", uid, 0);
1273 * This is called by store_harvested_addresses() to remove from the
1274 * list any addresses we already have in our address book.
1276 void strip_addresses_already_have(long msgnum, void *userdata) {
1277 char *collected_addresses;
1278 struct CtdlMessage *msg = NULL;
1282 char addr[256], user[256], node[256], name[256];
1284 collected_addresses = (char *)userdata;
1286 msg = CtdlFetchMessage(msgnum, 1);
1287 if (msg == NULL) return;
1288 v = vcard_load(msg->cm_fields['M']);
1289 CtdlFreeMessage(msg);
1292 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1294 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1295 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1297 /* Remove the address if we already have it! */
1298 process_rfc822_addr(addr, user, node, name);
1299 snprintf(addr, sizeof addr, "%s@%s", user, node);
1300 if (!strcasecmp(value, addr)) {
1301 remove_token(collected_addresses, j, ',');
1313 * Back end function for store_harvested_addresses()
1315 void store_this_ha(struct addresses_to_be_filed *aptr) {
1316 struct CtdlMessage *vmsg = NULL;
1318 struct vCard *v = NULL;
1319 char recipient[256];
1322 /* First remove any addresses we already have in the address book */
1323 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
1324 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1325 strip_addresses_already_have, aptr->collected_addresses);
1327 if (!IsEmptyStr(aptr->collected_addresses))
1328 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1330 /* Make a vCard out of each address */
1331 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1333 v = vcard_new_from_rfc822_addr(recipient);
1335 vmsg = malloc(sizeof(struct CtdlMessage));
1336 memset(vmsg, 0, sizeof(struct CtdlMessage));
1337 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1338 vmsg->cm_anon_type = MES_NORMAL;
1339 vmsg->cm_format_type = FMT_RFC822;
1340 vmsg->cm_fields['A'] = strdup("Citadel");
1341 vmsg->cm_fields['E'] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1342 ser = vcard_serialize(v);
1344 vmsg->cm_fields['M'] = malloc(strlen(ser) + 1024);
1345 sprintf(vmsg->cm_fields['M'],
1346 "Content-type: " VCARD_MIME_TYPE
1347 "\r\n\r\n%s\r\n", ser);
1352 syslog(LOG_DEBUG, "Adding contact: %s\n", recipient);
1353 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1354 CtdlFreeMessage(vmsg);
1358 free(aptr->roomname);
1359 free(aptr->collected_addresses);
1365 * When a user sends a message, we may harvest one or more email addresses
1366 * from the recipient list to be added to the user's address book. But we
1367 * want to do this asynchronously so it doesn't keep the user waiting.
1369 void store_harvested_addresses(void) {
1371 struct addresses_to_be_filed *aptr = NULL;
1373 if (atbf == NULL) return;
1375 begin_critical_section(S_ATBF);
1376 while (atbf != NULL) {
1379 end_critical_section(S_ATBF);
1380 store_this_ha(aptr);
1381 begin_critical_section(S_ATBF);
1383 end_critical_section(S_ATBF);
1388 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1389 * really this is just so we expose the vCard data to the full text indexer.
1391 void vcard_fixed_output(char *ptr, int len) {
1392 char *serialized_vcard;
1397 serialized_vcard = malloc(len + 1);
1398 safestrncpy(serialized_vcard, ptr, len+1);
1399 v = vcard_load(serialized_vcard);
1400 free(serialized_vcard);
1403 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1404 value = vcard_get_prop(v, "", 0, i++, 0);
1405 cprintf("%s\n", value);
1412 const char *CitadelServiceDICT_TCP="DICT_TCP";
1414 CTDL_MODULE_INIT(vcard)
1423 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN);
1424 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1425 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1426 CtdlRegisterDeleteHook(vcard_delete_remove);
1427 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1428 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1429 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1430 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1431 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1432 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1433 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1434 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1435 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1436 CtdlRegisterNetprocHook(vcard_extract_from_network);
1437 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER);
1438 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1439 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1441 /* Create the Global ADdress Book room if necessary */
1442 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1444 /* Set expiration policy to manual; otherwise objects will be lost! */
1445 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1446 qr.QRep.expire_mode = EXPIRE_MANUAL;
1447 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1448 CtdlPutRoomLock(&qr);
1451 * Also make sure it has a netconfig file, so the networker runs
1452 * on this room even if we don't share it with any other nodes.
1453 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1456 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1457 fp = fopen(filename, "a");
1458 if (fp != NULL) fclose(fp);
1459 rv = chown(filename, CTDLUID, (-1));
1461 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
1462 filename, strerror(errno));
1465 /* for postfix tcpdict */
1466 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1471 CitadelServiceDICT_TCP);
1474 /* return our module name for the log */