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, int (*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 int vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
142 struct CitContext *CCC = CC;
145 /* We have to validate that we're not stepping on someone else's
146 * email address ... but only if we're logged in. Otherwise it's
147 * probably just the networker or something.
149 if (CCC->logged_in) {
150 syslog(LOG_DEBUG, "Checking for <%s>...\n", internet_addr);
151 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
152 if (strcasecmp(buf, citadel_addr)) {
153 /* This address belongs to someone else.
154 * Bail out silently without saving.
156 syslog(LOG_DEBUG, "DOOP!\n");
158 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ALREADY_EXISTS);
159 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
160 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
161 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress again."), -1, 0);
162 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("\n"), 0);
167 syslog(LOG_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
168 if (CtdlDirectoryAddUser(internet_addr, citadel_addr))
170 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", CIT_OK);
171 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
172 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
173 StrBufAppendBufPlain(CCC->StatusMessage, _("successfully addded emailaddress."), -1, 0);
178 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
179 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
180 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
181 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
188 * Back end function for cmd_igab()
190 void vcard_add_to_directory(long msgnum, void *data) {
191 struct CtdlMessage *msg;
193 msg = CtdlFetchMessage(msgnum, 1);
195 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
198 CtdlFreeMessage(msg);
203 * Initialize Global Adress Book
205 void cmd_igab(char *argbuf) {
206 char hold_rm[ROOMNAMELEN];
208 if (CtdlAccessCheck(ac_aide)) return;
210 strcpy(hold_rm, CC->room.QRname); /* save current room */
212 if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
213 CtdlGetRoom(&CC->room, hold_rm);
214 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
218 /* Empty the existing database first.
222 /* We want *all* vCards in this room */
223 NewStrBufDupAppendFlush(&CC->StatusMessage, NULL, NULL, 0);
224 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
225 NULL, vcard_add_to_directory, NULL);
227 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
228 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
235 * See if there is a valid Internet address in a vCard to use for outbound
236 * Internet messages. If there is, stick it in the buffer.
238 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
239 char *secemailaddrbuf, size_t secemailaddrbuf_len,
241 int local_addrs_only)
243 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
246 int IsDirectoryAddress;
247 int saved_instance = 0;
249 /* Go through the vCard searching for *all* Internet email addresses
251 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
252 k = vcard_get_prop(v, "email", 1, instance, 1);
253 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
256 if (!IsEmptyStr(addr)) {
257 IsDirectoryAddress = IsDirectory(addr, 1);
258 if ( IsDirectoryAddress || !local_addrs_only)
261 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
262 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
264 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
265 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
267 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
268 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
269 < secemailaddrbuf_len ) {
270 strcat(secemailaddrbuf, "|");
271 strcat(secemailaddrbuf, addr);
275 if (!IsDirectoryAddress && local_addrs_only)
277 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
278 StrBufAppendBufPlain(CCC->StatusMessage, addr, -1, 0);
279 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
280 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
292 * See if there is a name / screen name / friendly name in a vCard to use for outbound
293 * Internet messages. If there is, stick it in the buffer.
295 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
299 s = vcard_get_prop(v, "fn", 1, 0, 0);
301 s = vcard_get_prop(v, "n", 1, 0, 0);
305 safestrncpy(namebuf, s, namebuf_len);
311 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
313 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
314 void *content, char *cbtype, char *cbcharset, size_t length,
315 char *encoding, char *cbid, void *cbuserdata)
317 struct vCard **v = (struct vCard **) cbuserdata;
319 if ( (!strcasecmp(cbtype, "text/x-vcard"))
320 || (!strcasecmp(cbtype, "text/vcard")) ) {
322 syslog(LOG_DEBUG, "Part %s contains a vCard! Loading...\n", partnum);
326 *v = vcard_load(content);
332 * This handler detects whether the user is attempting to save a new
333 * vCard as part of his/her personal configuration, and handles the replace
334 * function accordingly (delete the user's existing vCard in the config room
335 * and in the global address book).
337 int vcard_upload_beforesave(struct CtdlMessage *msg) {
341 struct ctdluser usbuf;
343 struct vCard *v = NULL;
346 int yes_my_citadel_config = 0;
347 int yes_any_vcard_room = 0;
349 if (!CC->logged_in) return(0); /* Only do this if logged in. */
351 /* Is this some user's "My Citadel Config" room? */
352 if ( (CC->room.QRflags && QR_MAILBOX)
353 && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
354 /* Yes, we want to do this */
355 yes_my_citadel_config = 1;
357 #ifdef VCARD_SAVES_BY_AIDES_ONLY
358 /* Prevent non-aides from performing registration changes */
359 if (CC->user.axlevel < AxAideU) {
366 /* Is this a room with an address book in it? */
367 if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
368 yes_any_vcard_room = 1;
371 /* If neither condition exists, don't run this hook. */
372 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
376 /* If this isn't a MIME message, don't bother. */
377 if (msg->cm_format_type != 4) return(0);
379 /* Ok, if we got this far, look into the situation further... */
381 ptr = msg->cm_fields['M'];
382 if (ptr == NULL) return(0);
384 mime_parser(msg->cm_fields['M'],
386 *vcard_extract_vcard,
388 &v, /* user data ptr - put the vcard here */
392 if (v == NULL) return(0); /* no vCards were found in this message */
394 /* If users cannot create their own accounts, they cannot re-register either. */
395 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
399 s = vcard_get_prop(v, "fn", 1, 0, 0);
400 if (s) syslog(LOG_DEBUG, "vCard beforesave hook running for <%s>\n", s);
402 if (yes_my_citadel_config) {
403 /* Bingo! The user is uploading a new vCard, so
404 * delete the old one. First, figure out which user
405 * is being re-registered...
407 what_user = atol(CC->room.QRname);
409 if (what_user == CC->user.usernum) {
410 /* It's the logged in user. That was easy. */
411 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
414 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
415 /* We fetched a valid user record */
419 /* somebody set up us the bomb! */
420 yes_my_citadel_config = 0;
424 if (yes_my_citadel_config) {
425 /* Delete the user's old vCard. This would probably
426 * get taken care of by the replication check, but we
427 * want to make sure there is absolutely only one
428 * vCard in the user's config room at all times.
431 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
433 /* Make the author of the message the name of the user. */
434 if (msg->cm_fields['A'] != NULL) {
435 free(msg->cm_fields['A']);
437 msg->cm_fields['A'] = strdup(usbuf.fullname);
440 /* Insert or replace RFC2739-compliant free/busy URL */
441 if (yes_my_citadel_config) {
442 sprintf(buf, "http://%s/%s.vfb",
445 for (i=0; buf[i]; ++i) {
446 if (buf[i] == ' ') buf[i] = '_';
448 vcard_set_prop(v, "FBURL;PREF", buf, 0);
451 /* If the vCard has no UID, then give it one. */
452 s = vcard_get_prop(v, "UID", 1, 0, 0);
455 vcard_set_prop(v, "UID", buf, 0);
458 /* Enforce local UID policy if applicable */
459 if (yes_my_citadel_config) {
460 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
461 vcard_set_prop(v, "UID", buf, 0);
465 * Set the EUID of the message to the UID of the vCard.
467 if (msg->cm_fields['E'] != NULL)
469 free(msg->cm_fields['E']);
470 msg->cm_fields['E'] = NULL;
472 s = vcard_get_prop(v, "UID", 1, 0, 0);
474 msg->cm_fields['E'] = strdup(s);
475 if (msg->cm_fields['U'] == NULL) {
476 msg->cm_fields['U'] = strdup(s);
481 * Set the Subject to the name in the vCard.
483 s = vcard_get_prop(v, "FN", 1, 0, 0);
485 s = vcard_get_prop(v, "N", 1, 0, 0);
488 if (msg->cm_fields['U'] != NULL) {
489 free(msg->cm_fields['U']);
491 msg->cm_fields['U'] = strdup(s);
494 /* Re-serialize it back into the msg body */
495 ser = vcard_serialize(v);
497 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], strlen(ser) + 1024);
498 sprintf(msg->cm_fields['M'],
499 "Content-type: " VCARD_MIME_TYPE
500 "\r\n\r\n%s\r\n", ser);
504 /* Now allow the save to complete. */
512 * This handler detects whether the user is attempting to save a new
513 * vCard as part of his/her personal configuration, and handles the replace
514 * function accordingly (copy the vCard from the config room to the global
517 int vcard_upload_aftersave(struct CtdlMessage *msg) {
523 int is_MY_UserConf=0;
525 char roomname[ROOMNAMELEN];
527 if (msg->cm_format_type != 4) return(0);
528 if (!CC->logged_in) return(0); /* Only do this if logged in. */
530 /* We're interested in user config rooms only. */
532 if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
533 is_UserConf = 1; /* It's someone's config room */
535 CtdlMailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
536 if (!strcasecmp(CC->room.QRname, roomname)) {
538 is_MY_UserConf = 1; /* It's MY config room */
540 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
541 is_GAB = 1; /* It's the Global Address Book */
544 if (!is_UserConf && !is_GAB) return(0);
546 ptr = msg->cm_fields['M'];
547 if (ptr == NULL) return(0);
549 NewStrBufDupAppendFlush(&CC->StatusMessage, NULL, NULL, 0);
551 StrBufPrintf(CC->StatusMessage, "%d\n", LISTING_FOLLOWS);
553 while (ptr != NULL) {
555 linelen = strcspn(ptr, "\n");
556 if (linelen == 0) return(0); /* end of headers */
558 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
559 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
561 * Bingo! The user is uploading a new vCard, so
562 * copy it to the Global Address Book room.
565 I = atol(msg->cm_fields['I']);
566 if (I < 0L) return(0);
568 /* Store our Internet return address in memory */
569 if (is_MY_UserConf) {
570 v = vcard_load(msg->cm_fields['M']);
571 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
572 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
574 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
579 { // This is not the GAB
580 /* Put it in the Global Address Book room... */
581 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
584 /* ...and also in the directory database. */
585 vcard_add_to_directory(I, NULL);
587 /* Some sites want an Aide to be notified when a
588 * user registers or re-registers
589 * But if the user was an Aide or was edited by an Aide then we can
590 * Assume they don't need validating.
592 if (CC->user.axlevel >= AxAideU) {
593 CtdlGetUserLock(&CC->user, CC->curr_user);
594 CC->user.flags |= US_REGIS;
595 CtdlPutUserLock(&CC->user);
601 /* ...which also means we need to flag the user */
602 CtdlGetUserLock(&CC->user, CC->curr_user);
603 CC->user.flags |= (US_REGIS|US_NEEDVALID);
604 CtdlPutUserLock(&CC->user);
609 ptr = strchr((char *)ptr, '\n');
610 if (ptr != NULL) ++ptr;
619 * back end function used for callbacks
621 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
624 msgnum = (long *) userdata;
625 *msgnum = supplied_msgnum;
630 * If this user has a vcard on disk, read it into memory, otherwise allocate
631 * and return an empty vCard.
633 struct vCard *vcard_get_user(struct ctdluser *u) {
634 char hold_rm[ROOMNAMELEN];
635 char config_rm[ROOMNAMELEN];
636 struct CtdlMessage *msg = NULL;
640 strcpy(hold_rm, CC->room.QRname); /* save current room */
641 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
643 if (CtdlGetRoom(&CC->room, config_rm) != 0) {
644 CtdlGetRoom(&CC->room, hold_rm);
648 /* We want the last (and probably only) vcard in this room */
650 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
651 NULL, vcard_gu_backend, (void *)&VCmsgnum );
652 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
654 if (VCmsgnum < 0L) return vcard_new();
656 msg = CtdlFetchMessage(VCmsgnum, 1);
657 if (msg == NULL) return vcard_new();
659 v = vcard_load(msg->cm_fields['M']);
660 CtdlFreeMessage(msg);
666 * Store this user's vCard in the appropriate place
669 * Write our config to disk
671 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
674 ser = vcard_serialize(v);
676 ser = strdup("begin:vcard\r\nend:vcard\r\n");
680 /* This handy API function does all the work for us.
681 * NOTE: normally we would want to set that last argument to 1, to
682 * force the system to delete the user's old vCard. But it doesn't
683 * have to, because the vcard_upload_beforesave() hook above
684 * is going to notice what we're trying to do, and delete the old vCard.
686 CtdlWriteObject(USERCONFIGROOM, /* which room */
687 VCARD_MIME_TYPE, /* MIME type */
689 strlen(ser)+1, /* length */
692 0, /* don't delete others of this type */
701 * Old style "enter registration info" command. This function simply honors
702 * the REGI protocol command, translates the entered parameters into a vCard,
703 * and enters the vCard into the user's configuration.
705 void cmd_regi(char *argbuf) {
708 struct vCard *my_vcard;
714 char tmpaddress[SIZ];
715 char tmpcountry[SIZ];
719 if (!(CC->logged_in)) {
720 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
724 /* If users cannot create their own accounts, they cannot re-register either. */
725 if ( (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
726 cprintf("%d Self-service registration is not allowed here.\n",
727 ERROR + HIGHER_ACCESS_REQUIRED);
730 my_vcard = vcard_get_user(&CC->user);
733 strcpy(tmpstate, "");
735 strcpy(tmpcountry, "USA");
737 cprintf("%d Send registration...\n", SEND_LISTING);
739 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
740 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
741 if (a==1) strcpy(tmpaddr, buf);
742 if (a==2) strcpy(tmpcity, buf);
743 if (a==3) strcpy(tmpstate, buf);
745 for (c=0; buf[c]; ++c) {
746 if ((buf[c]>='0') && (buf[c]<='9')) {
753 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
754 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
755 if (a==7) strcpy(tmpcountry, buf);
759 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
760 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
761 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
762 vcard_write_user(&CC->user, my_vcard);
763 vcard_free(my_vcard);
768 * Protocol command to fetch registration info for a user
770 void cmd_greg(char *argbuf)
772 struct ctdluser usbuf;
775 char who[USERNAME_SIZE];
779 extract_token(who, argbuf, 0, '|', sizeof who);
781 if (!(CC->logged_in)) {
782 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
786 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
788 if ((CC->user.axlevel < AxAideU) && (strcasecmp(who,CC->curr_user))) {
789 cprintf("%d Higher access required.\n",
790 ERROR + HIGHER_ACCESS_REQUIRED);
794 if (CtdlGetUser(&usbuf, who) != 0) {
795 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
799 v = vcard_get_user(&usbuf);
801 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
802 cprintf("%ld\n", usbuf.usernum);
803 cprintf("%s\n", usbuf.password);
804 s = vcard_get_prop(v, "n", 1, 0, 0);
805 cprintf("%s\n", s ? s : " "); /* name */
807 s = vcard_get_prop(v, "adr", 1, 0, 0);
808 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
810 extract_token(buf, adr, 2, ';', sizeof buf);
811 cprintf("%s\n", buf); /* street */
812 extract_token(buf, adr, 3, ';', sizeof buf);
813 cprintf("%s\n", buf); /* city */
814 extract_token(buf, adr, 4, ';', sizeof buf);
815 cprintf("%s\n", buf); /* state */
816 extract_token(buf, adr, 5, ';', sizeof buf);
817 cprintf("%s\n", buf); /* zip */
819 s = vcard_get_prop(v, "tel", 1, 0, 0);
820 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
828 cprintf("%d\n", usbuf.axlevel);
830 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
831 cprintf("%s\n", s ? s : " ");
832 s = vcard_get_prop(v, "adr", 0, 0, 0);
833 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
835 extract_token(buf, adr, 6, ';', sizeof buf);
836 cprintf("%s\n", buf); /* country */
844 * When a user is being created, create his/her vCard.
846 void vcard_newuser(struct ctdluser *usbuf) {
852 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
853 syslog(LOG_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
855 /* Create and save the vCard */
857 if (v == NULL) return;
858 vcard_add_prop(v, "fn", usbuf->fullname);
859 vcard_add_prop(v, "n", vname);
860 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
862 #ifdef HAVE_GETPWUID_R
863 /* If using host auth mode, we add an email address based on the login */
864 if (config.c_auth_mode == AUTHMODE_HOST) {
866 char pwd_buffer[SIZ];
868 #ifdef SOLARIS_GETPWUID
869 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
870 #else // SOLARIS_GETPWUID
871 struct passwd *result = NULL;
872 syslog(LOG_DEBUG, "Searching for uid %d\n", usbuf->uid);
873 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
874 #endif // HAVE_GETPWUID_R
875 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
876 vcard_add_prop(v, "email;internet", buf);
881 /* Everyone gets an email address based on their display name */
882 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
883 for (i=0; buf[i]; ++i) {
884 if (buf[i] == ' ') buf[i] = '_';
886 vcard_add_prop(v, "email;internet", buf);
889 vcard_write_user(usbuf, v);
895 * When a user is being deleted, we have to remove his/her vCard.
896 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
897 * field, and the same Exclusive ID as the existing card.
899 void vcard_purge(struct ctdluser *usbuf) {
900 struct CtdlMessage *msg;
903 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
904 if (msg == NULL) return;
905 memset(msg, 0, sizeof(struct CtdlMessage));
907 msg->cm_magic = CTDLMESSAGE_MAGIC;
908 msg->cm_anon_type = MES_NORMAL;
909 msg->cm_format_type = 0;
910 msg->cm_fields['A'] = strdup(usbuf->fullname);
911 msg->cm_fields['O'] = strdup(ADDRESS_BOOK_ROOM);
912 msg->cm_fields['N'] = strdup(NODENAME);
913 msg->cm_fields['M'] = strdup("Purge this vCard\n");
915 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
916 msg->cm_fields['A'], NODENAME);
917 msg->cm_fields['E'] = strdup(buf);
919 msg->cm_fields['S'] = strdup("CANCEL");
921 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
922 CtdlFreeMessage(msg);
927 * Grab vCard directory stuff out of incoming network messages
929 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
933 if (msg == NULL) return(0);
935 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
939 if (msg->cm_format_type != 4) return(0);
941 ptr = msg->cm_fields['M'];
942 if (ptr == NULL) return(0);
943 while (ptr != NULL) {
945 linelen = strcspn(ptr, "\n");
946 if (linelen == 0) return(0); /* end of headers */
948 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
949 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
950 /* It's a vCard. Add it to the directory. */
951 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
955 ptr = strchr((char *)ptr, '\n');
956 if (ptr != NULL) ++ptr;
965 * When a vCard is being removed from the Global Address Book room, remove it
966 * from the directory as well.
968 void vcard_delete_remove(char *room, long msgnum) {
969 struct CtdlMessage *msg;
973 if (msgnum <= 0L) return;
975 if (room == NULL) return;
977 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
981 msg = CtdlFetchMessage(msgnum, 1);
982 if (msg == NULL) return;
984 ptr = msg->cm_fields['M'];
985 if (ptr == NULL) goto EOH;
986 while (ptr != NULL) {
987 linelen = strcspn(ptr, "\n");
988 if (linelen == 0) goto EOH;
990 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
991 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
992 /* Bingo! A vCard is being deleted. */
993 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
995 ptr = strchr((char *)ptr, '\n');
996 if (ptr != NULL) ++ptr;
999 EOH: CtdlFreeMessage(msg);
1005 * Get Valid Screen Names
1007 void cmd_gvsn(char *argbuf)
1009 if (CtdlAccessCheck(ac_logged_in)) return;
1011 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
1012 cprintf("%s\n", CC->user.fullname);
1013 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
1014 cprintf("%s\n", CC->cs_inet_fn);
1021 * Get Valid Email Addresses
1023 void cmd_gvea(char *argbuf)
1025 int num_secondary_emails = 0;
1029 if (CtdlAccessCheck(ac_logged_in)) return;
1031 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
1032 if (!IsEmptyStr(CC->cs_inet_email)) {
1033 cprintf("%s\n", CC->cs_inet_email);
1035 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
1036 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
1037 for (i=0; i<num_secondary_emails; ++i) {
1038 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
1039 cprintf("%s\n", buf);
1049 * Callback function for cmd_dvca() that hunts for vCard content types
1050 * and outputs any email addresses found within.
1052 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1053 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1054 char *cbid, void *cbuserdata) {
1057 char displayname[256];
1058 int displayname_len;
1059 char emailaddr[256];
1063 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1067 v = vcard_load(content);
1068 if (v == NULL) return;
1070 extract_friendly_name(displayname, sizeof displayname, v);
1071 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1073 displayname_len = strlen(displayname);
1074 for (i=0; i<displayname_len; ++i) {
1075 if (displayname[i] == '\"') displayname[i] = ' ';
1076 if (displayname[i] == ';') displayname[i] = ',';
1077 if (displayname[i] == ',') has_commas = 1;
1079 striplt(displayname);
1081 cprintf("%s%s%s <%s>\n",
1082 (has_commas ? "\"" : ""),
1084 (has_commas ? "\"" : ""),
1093 * Back end callback function for cmd_dvca()
1095 * It's basically just passed a list of message numbers, which we're going
1096 * to fetch off the disk and then pass along to the MIME parser via another
1097 * layer of callback...
1099 void dvca_callback(long msgnum, void *userdata) {
1100 struct CtdlMessage *msg = NULL;
1102 msg = CtdlFetchMessage(msgnum, 1);
1103 if (msg == NULL) return;
1104 mime_parser(msg->cm_fields['M'],
1106 *dvca_mime_callback, /* callback function */
1108 NULL, /* user data */
1111 CtdlFreeMessage(msg);
1116 * Dump VCard Addresses
1118 void cmd_dvca(char *argbuf)
1120 if (CtdlAccessCheck(ac_logged_in)) return;
1122 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1123 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1131 void cmd_qdir(char *argbuf) {
1132 char citadel_addr[256];
1133 char internet_addr[256];
1135 if (CtdlAccessCheck(ac_logged_in)) return;
1137 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1139 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1140 cprintf("%d %s was not found.\n",
1141 ERROR + NO_SUCH_USER, internet_addr);
1145 cprintf("%d %s\n", CIT_OK, citadel_addr);
1149 * Query Directory, in fact an alias to match postfix tcp auth.
1151 void check_get(void) {
1152 char internet_addr[256];
1157 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1158 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1159 syslog(LOG_CRIT, "vcard client disconnected: ending session.\n");
1160 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1163 syslog(LOG_INFO, ": %s\n", cmdbuf);
1164 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1165 syslog(LOG_INFO, "[ %s]\n", cmdbuf);
1167 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1169 struct recptypes *rcpt;
1170 char *argbuf = &cmdbuf[4];
1172 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1173 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1174 if ((rcpt != NULL)&&
1176 (*rcpt->recp_local != '\0')||
1177 (*rcpt->recp_room != '\0')||
1178 (*rcpt->recp_ignet != '\0')))
1181 cprintf("200 OK %s\n", internet_addr);
1182 syslog(LOG_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
1186 cprintf("500 REJECT noone here by that name.\n");
1188 syslog(LOG_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
1191 free_recipients(rcpt);
1195 cprintf("500 REJECT invalid Query.\n");
1197 syslog(LOG_INFO, "sending 500 REJECT invalid Query: %s\n", internet_addr);
1201 void check_get_greeting(void) {
1202 /* dummy function, we have no greeting in this verry simple protocol. */
1207 * We don't know if the Contacts room exists so we just create it at login
1209 void vcard_CtdlCreateRoom(void)
1214 /* Create the calendar room if it doesn't already exist */
1215 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1217 /* Set expiration policy to manual; otherwise objects will be lost! */
1218 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1219 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!\n");
1222 qr.QRep.expire_mode = EXPIRE_MANUAL;
1223 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1224 CtdlPutRoomLock(&qr);
1226 /* Set the view to a calendar view */
1227 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1228 vbuf.v_view = 2; /* 2 = address book view */
1229 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1238 * When a user logs in...
1240 void vcard_session_login_hook(void) {
1241 struct vCard *v = NULL;
1242 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1246 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1247 * into the user's vCard.
1249 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1250 v = vcard_get_user(&CCC->user);
1252 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1253 vcard_write_user(&CCC->user, v);
1260 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1261 * These are inserted into the session data for various message entry commands to use.
1263 v = vcard_get_user(&CCC->user);
1265 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1266 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1269 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1274 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1276 vcard_CtdlCreateRoom();
1281 * Turn an arbitrary RFC822 address into a struct vCard for possible
1282 * inclusion into an address book.
1284 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1286 char user[256], node[256], name[256], email[256], n[256], uid[256];
1290 if (v == NULL) return(NULL);
1292 process_rfc822_addr(addr, user, node, name);
1293 vcard_set_prop(v, "fn", name, 0);
1295 vcard_fn_to_n(n, name, sizeof n);
1296 vcard_set_prop(v, "n", n, 0);
1298 snprintf(email, sizeof email, "%s@%s", user, node);
1299 vcard_set_prop(v, "email;internet", email, 0);
1301 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1302 for (i=0; uid[i]; ++i) {
1303 if (isspace(uid[i])) uid[i] = '_';
1304 uid[i] = tolower(uid[i]);
1306 vcard_set_prop(v, "UID", uid, 0);
1314 * This is called by store_harvested_addresses() to remove from the
1315 * list any addresses we already have in our address book.
1317 void strip_addresses_already_have(long msgnum, void *userdata) {
1318 char *collected_addresses;
1319 struct CtdlMessage *msg = NULL;
1323 char addr[256], user[256], node[256], name[256];
1325 collected_addresses = (char *)userdata;
1327 msg = CtdlFetchMessage(msgnum, 1);
1328 if (msg == NULL) return;
1329 v = vcard_load(msg->cm_fields['M']);
1330 CtdlFreeMessage(msg);
1333 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1335 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1336 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1338 /* Remove the address if we already have it! */
1339 process_rfc822_addr(addr, user, node, name);
1340 snprintf(addr, sizeof addr, "%s@%s", user, node);
1341 if (!strcasecmp(value, addr)) {
1342 remove_token(collected_addresses, j, ',');
1354 * Back end function for store_harvested_addresses()
1356 void store_this_ha(struct addresses_to_be_filed *aptr) {
1357 struct CtdlMessage *vmsg = NULL;
1359 struct vCard *v = NULL;
1360 char recipient[256];
1363 /* First remove any addresses we already have in the address book */
1364 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
1365 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1366 strip_addresses_already_have, aptr->collected_addresses);
1368 if (!IsEmptyStr(aptr->collected_addresses))
1369 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1371 /* Make a vCard out of each address */
1372 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1374 v = vcard_new_from_rfc822_addr(recipient);
1376 vmsg = malloc(sizeof(struct CtdlMessage));
1377 memset(vmsg, 0, sizeof(struct CtdlMessage));
1378 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1379 vmsg->cm_anon_type = MES_NORMAL;
1380 vmsg->cm_format_type = FMT_RFC822;
1381 vmsg->cm_fields['A'] = strdup("Citadel");
1382 vmsg->cm_fields['E'] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1383 ser = vcard_serialize(v);
1385 vmsg->cm_fields['M'] = malloc(strlen(ser) + 1024);
1386 sprintf(vmsg->cm_fields['M'],
1387 "Content-type: " VCARD_MIME_TYPE
1388 "\r\n\r\n%s\r\n", ser);
1393 syslog(LOG_DEBUG, "Adding contact: %s\n", recipient);
1394 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1395 CtdlFreeMessage(vmsg);
1399 free(aptr->roomname);
1400 free(aptr->collected_addresses);
1406 * When a user sends a message, we may harvest one or more email addresses
1407 * from the recipient list to be added to the user's address book. But we
1408 * want to do this asynchronously so it doesn't keep the user waiting.
1410 void store_harvested_addresses(void) {
1412 struct addresses_to_be_filed *aptr = NULL;
1414 if (atbf == NULL) return;
1416 begin_critical_section(S_ATBF);
1417 while (atbf != NULL) {
1420 end_critical_section(S_ATBF);
1421 store_this_ha(aptr);
1422 begin_critical_section(S_ATBF);
1424 end_critical_section(S_ATBF);
1429 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1430 * really this is just so we expose the vCard data to the full text indexer.
1432 void vcard_fixed_output(char *ptr, int len) {
1433 char *serialized_vcard;
1438 serialized_vcard = malloc(len + 1);
1439 safestrncpy(serialized_vcard, ptr, len+1);
1440 v = vcard_load(serialized_vcard);
1441 free(serialized_vcard);
1444 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1445 value = vcard_get_prop(v, "", 0, i++, 0);
1446 cprintf("%s\n", value);
1453 const char *CitadelServiceDICT_TCP="DICT_TCP";
1455 CTDL_MODULE_INIT(vcard)
1464 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN);
1465 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1466 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1467 CtdlRegisterDeleteHook(vcard_delete_remove);
1468 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1469 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1470 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1471 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1472 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1473 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1474 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1475 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1476 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1477 CtdlRegisterNetprocHook(vcard_extract_from_network);
1478 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER);
1479 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1480 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1482 /* Create the Global ADdress Book room if necessary */
1483 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1485 /* Set expiration policy to manual; otherwise objects will be lost! */
1486 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1487 qr.QRep.expire_mode = EXPIRE_MANUAL;
1488 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1489 CtdlPutRoomLock(&qr);
1492 * Also make sure it has a netconfig file, so the networker runs
1493 * on this room even if we don't share it with any other nodes.
1494 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1497 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1498 fp = fopen(filename, "a");
1499 if (fp != NULL) fclose(fp);
1500 rv = chown(filename, CTDLUID, (-1));
1502 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
1503 filename, strerror(errno));
1506 /* for postfix tcpdict */
1507 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1512 CitadelServiceDICT_TCP);
1515 /* return our module name for the log */