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");
157 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress again."), -1, 0);
158 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
159 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
160 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
165 syslog(LOG_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
166 if (CtdlDirectoryAddUser(internet_addr, citadel_addr))
168 StrBufAppendBufPlain(CCC->StatusMessage, _("successfully addded emailaddress."), -1, 0);
169 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
170 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
171 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
176 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
177 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
178 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
179 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
186 * Back end function for cmd_igab()
188 void vcard_add_to_directory(long msgnum, void *data) {
189 struct CtdlMessage *msg;
191 msg = CtdlFetchMessage(msgnum, 1);
193 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
196 CtdlFreeMessage(msg);
201 * Initialize Global Adress Book
203 void cmd_igab(char *argbuf) {
204 char hold_rm[ROOMNAMELEN];
206 if (CtdlAccessCheck(ac_aide)) return;
208 strcpy(hold_rm, CC->room.QRname); /* save current room */
210 if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
211 CtdlGetRoom(&CC->room, hold_rm);
212 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
216 /* Empty the existing database first.
220 /* We want *all* vCards in this room */
221 NewStrBufDupAppendFlush(&CC->StatusMessage, NULL, NULL, 0);
222 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
223 NULL, vcard_add_to_directory, NULL);
225 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
226 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
233 * See if there is a valid Internet address in a vCard to use for outbound
234 * Internet messages. If there is, stick it in the buffer.
236 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
237 char *secemailaddrbuf, size_t secemailaddrbuf_len,
239 int local_addrs_only)
241 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
244 int IsDirectoryAddress;
245 int saved_instance = 0;
247 /* Go through the vCard searching for *all* Internet email addresses
249 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
250 k = vcard_get_prop(v, "email", 1, instance, 1);
251 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
254 if (!IsEmptyStr(addr)) {
255 IsDirectoryAddress = IsDirectory(addr, 1);
256 if ( IsDirectoryAddress || !local_addrs_only)
259 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
260 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
262 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
263 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
265 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
266 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
267 < secemailaddrbuf_len ) {
268 strcat(secemailaddrbuf, "|");
269 strcat(secemailaddrbuf, addr);
273 if (!IsDirectoryAddress && local_addrs_only)
275 StrBufAppendBufPlain(CCC->StatusMessage,
276 _("unable to add this emailaddress; its not matching our domain."), -1, 0);
277 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
278 StrBufAppendBufPlain(CCC->StatusMessage, addr, -1, 0);
279 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
291 * See if there is a name / screen name / friendly name in a vCard to use for outbound
292 * Internet messages. If there is, stick it in the buffer.
294 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
298 s = vcard_get_prop(v, "fn", 1, 0, 0);
300 s = vcard_get_prop(v, "n", 1, 0, 0);
304 safestrncpy(namebuf, s, namebuf_len);
310 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
312 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
313 void *content, char *cbtype, char *cbcharset, size_t length,
314 char *encoding, char *cbid, void *cbuserdata)
316 struct vCard **v = (struct vCard **) cbuserdata;
318 if ( (!strcasecmp(cbtype, "text/x-vcard"))
319 || (!strcasecmp(cbtype, "text/vcard")) ) {
321 syslog(LOG_DEBUG, "Part %s contains a vCard! Loading...\n", partnum);
325 *v = vcard_load(content);
331 * This handler detects whether the user is attempting to save a new
332 * vCard as part of his/her personal configuration, and handles the replace
333 * function accordingly (delete the user's existing vCard in the config room
334 * and in the global address book).
336 int vcard_upload_beforesave(struct CtdlMessage *msg) {
340 struct ctdluser usbuf;
342 struct vCard *v = NULL;
345 int yes_my_citadel_config = 0;
346 int yes_any_vcard_room = 0;
348 if (!CC->logged_in) return(0); /* Only do this if logged in. */
350 /* Is this some user's "My Citadel Config" room? */
351 if ( (CC->room.QRflags && QR_MAILBOX)
352 && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
353 /* Yes, we want to do this */
354 yes_my_citadel_config = 1;
356 #ifdef VCARD_SAVES_BY_AIDES_ONLY
357 /* Prevent non-aides from performing registration changes */
358 if (CC->user.axlevel < AxAideU) {
365 /* Is this a room with an address book in it? */
366 if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
367 yes_any_vcard_room = 1;
370 /* If neither condition exists, don't run this hook. */
371 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
375 /* If this isn't a MIME message, don't bother. */
376 if (msg->cm_format_type != 4) return(0);
378 /* Ok, if we got this far, look into the situation further... */
380 ptr = msg->cm_fields['M'];
381 if (ptr == NULL) return(0);
383 mime_parser(msg->cm_fields['M'],
385 *vcard_extract_vcard,
387 &v, /* user data ptr - put the vcard here */
391 if (v == NULL) return(0); /* no vCards were found in this message */
393 /* If users cannot create their own accounts, they cannot re-register either. */
394 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
398 s = vcard_get_prop(v, "fn", 1, 0, 0);
399 if (s) syslog(LOG_DEBUG, "vCard beforesave hook running for <%s>\n", s);
401 if (yes_my_citadel_config) {
402 /* Bingo! The user is uploading a new vCard, so
403 * delete the old one. First, figure out which user
404 * is being re-registered...
406 what_user = atol(CC->room.QRname);
408 if (what_user == CC->user.usernum) {
409 /* It's the logged in user. That was easy. */
410 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
413 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
414 /* We fetched a valid user record */
418 /* somebody set up us the bomb! */
419 yes_my_citadel_config = 0;
423 if (yes_my_citadel_config) {
424 /* Delete the user's old vCard. This would probably
425 * get taken care of by the replication check, but we
426 * want to make sure there is absolutely only one
427 * vCard in the user's config room at all times.
430 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
432 /* Make the author of the message the name of the user. */
433 if (msg->cm_fields['A'] != NULL) {
434 free(msg->cm_fields['A']);
436 msg->cm_fields['A'] = strdup(usbuf.fullname);
439 /* Insert or replace RFC2739-compliant free/busy URL */
440 if (yes_my_citadel_config) {
441 sprintf(buf, "http://%s/%s.vfb",
444 for (i=0; buf[i]; ++i) {
445 if (buf[i] == ' ') buf[i] = '_';
447 vcard_set_prop(v, "FBURL;PREF", buf, 0);
450 /* If the vCard has no UID, then give it one. */
451 s = vcard_get_prop(v, "UID", 1, 0, 0);
454 vcard_set_prop(v, "UID", buf, 0);
457 /* Enforce local UID policy if applicable */
458 if (yes_my_citadel_config) {
459 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
460 vcard_set_prop(v, "UID", buf, 0);
464 * Set the EUID of the message to the UID of the vCard.
466 if (msg->cm_fields['E'] != NULL)
468 free(msg->cm_fields['E']);
469 msg->cm_fields['E'] = NULL;
471 s = vcard_get_prop(v, "UID", 1, 0, 0);
473 msg->cm_fields['E'] = strdup(s);
474 if (msg->cm_fields['U'] == NULL) {
475 msg->cm_fields['U'] = strdup(s);
480 * Set the Subject to the name in the vCard.
482 s = vcard_get_prop(v, "FN", 1, 0, 0);
484 s = vcard_get_prop(v, "N", 1, 0, 0);
487 if (msg->cm_fields['U'] != NULL) {
488 free(msg->cm_fields['U']);
490 msg->cm_fields['U'] = strdup(s);
493 /* Re-serialize it back into the msg body */
494 ser = vcard_serialize(v);
496 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], strlen(ser) + 1024);
497 sprintf(msg->cm_fields['M'],
498 "Content-type: " VCARD_MIME_TYPE
499 "\r\n\r\n%s\r\n", ser);
503 /* Now allow the save to complete. */
511 * This handler detects whether the user is attempting to save a new
512 * vCard as part of his/her personal configuration, and handles the replace
513 * function accordingly (copy the vCard from the config room to the global
516 int vcard_upload_aftersave(struct CtdlMessage *msg) {
522 int is_MY_UserConf=0;
524 char roomname[ROOMNAMELEN];
526 if (msg->cm_format_type != 4) return(0);
527 if (!CC->logged_in) return(0); /* Only do this if logged in. */
529 /* We're interested in user config rooms only. */
531 if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
532 is_UserConf = 1; /* It's someone's config room */
534 CtdlMailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
535 if (!strcasecmp(CC->room.QRname, roomname)) {
537 is_MY_UserConf = 1; /* It's MY config room */
539 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
540 is_GAB = 1; /* It's the Global Address Book */
543 if (!is_UserConf && !is_GAB) return(0);
545 ptr = msg->cm_fields['M'];
546 if (ptr == NULL) return(0);
548 NewStrBufDupAppendFlush(&CC->StatusMessage, NULL, NULL, 0);
550 while (ptr != NULL) {
552 linelen = strcspn(ptr, "\n");
553 if (linelen == 0) return(0); /* end of headers */
555 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
556 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
558 * Bingo! The user is uploading a new vCard, so
559 * copy it to the Global Address Book room.
562 I = atol(msg->cm_fields['I']);
563 if (I < 0L) return(0);
565 /* Store our Internet return address in memory */
566 if (is_MY_UserConf) {
567 v = vcard_load(msg->cm_fields['M']);
568 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
569 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
571 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
576 { // This is not the GAB
577 /* Put it in the Global Address Book room... */
578 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
581 /* ...and also in the directory database. */
582 vcard_add_to_directory(I, NULL);
584 /* Some sites want an Aide to be notified when a
585 * user registers or re-registers
586 * But if the user was an Aide or was edited by an Aide then we can
587 * Assume they don't need validating.
589 if (CC->user.axlevel >= AxAideU) {
590 CtdlGetUserLock(&CC->user, CC->curr_user);
591 CC->user.flags |= US_REGIS;
592 CtdlPutUserLock(&CC->user);
598 /* ...which also means we need to flag the user */
599 CtdlGetUserLock(&CC->user, CC->curr_user);
600 CC->user.flags |= (US_REGIS|US_NEEDVALID);
601 CtdlPutUserLock(&CC->user);
606 ptr = strchr((char *)ptr, '\n');
607 if (ptr != NULL) ++ptr;
616 * back end function used for callbacks
618 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
621 msgnum = (long *) userdata;
622 *msgnum = supplied_msgnum;
627 * If this user has a vcard on disk, read it into memory, otherwise allocate
628 * and return an empty vCard.
630 struct vCard *vcard_get_user(struct ctdluser *u) {
631 char hold_rm[ROOMNAMELEN];
632 char config_rm[ROOMNAMELEN];
633 struct CtdlMessage *msg = NULL;
637 strcpy(hold_rm, CC->room.QRname); /* save current room */
638 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
640 if (CtdlGetRoom(&CC->room, config_rm) != 0) {
641 CtdlGetRoom(&CC->room, hold_rm);
645 /* We want the last (and probably only) vcard in this room */
647 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
648 NULL, vcard_gu_backend, (void *)&VCmsgnum );
649 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
651 if (VCmsgnum < 0L) return vcard_new();
653 msg = CtdlFetchMessage(VCmsgnum, 1);
654 if (msg == NULL) return vcard_new();
656 v = vcard_load(msg->cm_fields['M']);
657 CtdlFreeMessage(msg);
663 * Store this user's vCard in the appropriate place
666 * Write our config to disk
668 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
671 ser = vcard_serialize(v);
673 ser = strdup("begin:vcard\r\nend:vcard\r\n");
677 /* This handy API function does all the work for us.
678 * NOTE: normally we would want to set that last argument to 1, to
679 * force the system to delete the user's old vCard. But it doesn't
680 * have to, because the vcard_upload_beforesave() hook above
681 * is going to notice what we're trying to do, and delete the old vCard.
683 CtdlWriteObject(USERCONFIGROOM, /* which room */
684 VCARD_MIME_TYPE, /* MIME type */
686 strlen(ser)+1, /* length */
689 0, /* don't delete others of this type */
698 * Old style "enter registration info" command. This function simply honors
699 * the REGI protocol command, translates the entered parameters into a vCard,
700 * and enters the vCard into the user's configuration.
702 void cmd_regi(char *argbuf) {
705 struct vCard *my_vcard;
711 char tmpaddress[SIZ];
712 char tmpcountry[SIZ];
716 if (!(CC->logged_in)) {
717 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
721 /* If users cannot create their own accounts, they cannot re-register either. */
722 if ( (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
723 cprintf("%d Self-service registration is not allowed here.\n",
724 ERROR + HIGHER_ACCESS_REQUIRED);
727 my_vcard = vcard_get_user(&CC->user);
730 strcpy(tmpstate, "");
732 strcpy(tmpcountry, "USA");
734 cprintf("%d Send registration...\n", SEND_LISTING);
736 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
737 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
738 if (a==1) strcpy(tmpaddr, buf);
739 if (a==2) strcpy(tmpcity, buf);
740 if (a==3) strcpy(tmpstate, buf);
742 for (c=0; buf[c]; ++c) {
743 if ((buf[c]>='0') && (buf[c]<='9')) {
750 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
751 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
752 if (a==7) strcpy(tmpcountry, buf);
756 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
757 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
758 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
759 vcard_write_user(&CC->user, my_vcard);
760 vcard_free(my_vcard);
765 * Protocol command to fetch registration info for a user
767 void cmd_greg(char *argbuf)
769 struct ctdluser usbuf;
772 char who[USERNAME_SIZE];
776 extract_token(who, argbuf, 0, '|', sizeof who);
778 if (!(CC->logged_in)) {
779 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
783 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
785 if ((CC->user.axlevel < AxAideU) && (strcasecmp(who,CC->curr_user))) {
786 cprintf("%d Higher access required.\n",
787 ERROR + HIGHER_ACCESS_REQUIRED);
791 if (CtdlGetUser(&usbuf, who) != 0) {
792 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
796 v = vcard_get_user(&usbuf);
798 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
799 cprintf("%ld\n", usbuf.usernum);
800 cprintf("%s\n", usbuf.password);
801 s = vcard_get_prop(v, "n", 1, 0, 0);
802 cprintf("%s\n", s ? s : " "); /* name */
804 s = vcard_get_prop(v, "adr", 1, 0, 0);
805 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
807 extract_token(buf, adr, 2, ';', sizeof buf);
808 cprintf("%s\n", buf); /* street */
809 extract_token(buf, adr, 3, ';', sizeof buf);
810 cprintf("%s\n", buf); /* city */
811 extract_token(buf, adr, 4, ';', sizeof buf);
812 cprintf("%s\n", buf); /* state */
813 extract_token(buf, adr, 5, ';', sizeof buf);
814 cprintf("%s\n", buf); /* zip */
816 s = vcard_get_prop(v, "tel", 1, 0, 0);
817 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
825 cprintf("%d\n", usbuf.axlevel);
827 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
828 cprintf("%s\n", s ? s : " ");
829 s = vcard_get_prop(v, "adr", 0, 0, 0);
830 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
832 extract_token(buf, adr, 6, ';', sizeof buf);
833 cprintf("%s\n", buf); /* country */
841 * When a user is being created, create his/her vCard.
843 void vcard_newuser(struct ctdluser *usbuf) {
849 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
850 syslog(LOG_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
852 /* Create and save the vCard */
854 if (v == NULL) return;
855 vcard_add_prop(v, "fn", usbuf->fullname);
856 vcard_add_prop(v, "n", vname);
857 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
859 #ifdef HAVE_GETPWUID_R
860 /* If using host auth mode, we add an email address based on the login */
861 if (config.c_auth_mode == AUTHMODE_HOST) {
863 char pwd_buffer[SIZ];
865 #ifdef SOLARIS_GETPWUID
866 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
867 #else // SOLARIS_GETPWUID
868 struct passwd *result = NULL;
869 syslog(LOG_DEBUG, "Searching for uid %d\n", usbuf->uid);
870 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
871 #endif // HAVE_GETPWUID_R
872 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
873 vcard_add_prop(v, "email;internet", buf);
878 /* Everyone gets an email address based on their display name */
879 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
880 for (i=0; buf[i]; ++i) {
881 if (buf[i] == ' ') buf[i] = '_';
883 vcard_add_prop(v, "email;internet", buf);
886 vcard_write_user(usbuf, v);
892 * When a user is being deleted, we have to remove his/her vCard.
893 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
894 * field, and the same Exclusive ID as the existing card.
896 void vcard_purge(struct ctdluser *usbuf) {
897 struct CtdlMessage *msg;
900 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
901 if (msg == NULL) return;
902 memset(msg, 0, sizeof(struct CtdlMessage));
904 msg->cm_magic = CTDLMESSAGE_MAGIC;
905 msg->cm_anon_type = MES_NORMAL;
906 msg->cm_format_type = 0;
907 msg->cm_fields['A'] = strdup(usbuf->fullname);
908 msg->cm_fields['O'] = strdup(ADDRESS_BOOK_ROOM);
909 msg->cm_fields['N'] = strdup(NODENAME);
910 msg->cm_fields['M'] = strdup("Purge this vCard\n");
912 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
913 msg->cm_fields['A'], NODENAME);
914 msg->cm_fields['E'] = strdup(buf);
916 msg->cm_fields['S'] = strdup("CANCEL");
918 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
919 CtdlFreeMessage(msg);
924 * Grab vCard directory stuff out of incoming network messages
926 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
930 if (msg == NULL) return(0);
932 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
936 if (msg->cm_format_type != 4) return(0);
938 ptr = msg->cm_fields['M'];
939 if (ptr == NULL) return(0);
940 while (ptr != NULL) {
942 linelen = strcspn(ptr, "\n");
943 if (linelen == 0) return(0); /* end of headers */
945 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
946 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
947 /* It's a vCard. Add it to the directory. */
948 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
952 ptr = strchr((char *)ptr, '\n');
953 if (ptr != NULL) ++ptr;
962 * When a vCard is being removed from the Global Address Book room, remove it
963 * from the directory as well.
965 void vcard_delete_remove(char *room, long msgnum) {
966 struct CtdlMessage *msg;
970 if (msgnum <= 0L) return;
972 if (room == NULL) return;
974 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
978 msg = CtdlFetchMessage(msgnum, 1);
979 if (msg == NULL) return;
981 ptr = msg->cm_fields['M'];
982 if (ptr == NULL) goto EOH;
983 while (ptr != NULL) {
984 linelen = strcspn(ptr, "\n");
985 if (linelen == 0) goto EOH;
987 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
988 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
989 /* Bingo! A vCard is being deleted. */
990 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
992 ptr = strchr((char *)ptr, '\n');
993 if (ptr != NULL) ++ptr;
996 EOH: CtdlFreeMessage(msg);
1002 * Get Valid Screen Names
1004 void cmd_gvsn(char *argbuf)
1006 if (CtdlAccessCheck(ac_logged_in)) return;
1008 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
1009 cprintf("%s\n", CC->user.fullname);
1010 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
1011 cprintf("%s\n", CC->cs_inet_fn);
1018 * Get Valid Email Addresses
1020 void cmd_gvea(char *argbuf)
1022 int num_secondary_emails = 0;
1026 if (CtdlAccessCheck(ac_logged_in)) return;
1028 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
1029 if (!IsEmptyStr(CC->cs_inet_email)) {
1030 cprintf("%s\n", CC->cs_inet_email);
1032 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
1033 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
1034 for (i=0; i<num_secondary_emails; ++i) {
1035 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
1036 cprintf("%s\n", buf);
1046 * Callback function for cmd_dvca() that hunts for vCard content types
1047 * and outputs any email addresses found within.
1049 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1050 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1051 char *cbid, void *cbuserdata) {
1054 char displayname[256];
1055 int displayname_len;
1056 char emailaddr[256];
1060 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1064 v = vcard_load(content);
1065 if (v == NULL) return;
1067 extract_friendly_name(displayname, sizeof displayname, v);
1068 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1070 displayname_len = strlen(displayname);
1071 for (i=0; i<displayname_len; ++i) {
1072 if (displayname[i] == '\"') displayname[i] = ' ';
1073 if (displayname[i] == ';') displayname[i] = ',';
1074 if (displayname[i] == ',') has_commas = 1;
1076 striplt(displayname);
1078 cprintf("%s%s%s <%s>\n",
1079 (has_commas ? "\"" : ""),
1081 (has_commas ? "\"" : ""),
1090 * Back end callback function for cmd_dvca()
1092 * It's basically just passed a list of message numbers, which we're going
1093 * to fetch off the disk and then pass along to the MIME parser via another
1094 * layer of callback...
1096 void dvca_callback(long msgnum, void *userdata) {
1097 struct CtdlMessage *msg = NULL;
1099 msg = CtdlFetchMessage(msgnum, 1);
1100 if (msg == NULL) return;
1101 mime_parser(msg->cm_fields['M'],
1103 *dvca_mime_callback, /* callback function */
1105 NULL, /* user data */
1108 CtdlFreeMessage(msg);
1113 * Dump VCard Addresses
1115 void cmd_dvca(char *argbuf)
1117 if (CtdlAccessCheck(ac_logged_in)) return;
1119 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1120 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1128 void cmd_qdir(char *argbuf) {
1129 char citadel_addr[256];
1130 char internet_addr[256];
1132 if (CtdlAccessCheck(ac_logged_in)) return;
1134 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1136 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1137 cprintf("%d %s was not found.\n",
1138 ERROR + NO_SUCH_USER, internet_addr);
1142 cprintf("%d %s\n", CIT_OK, citadel_addr);
1146 * Query Directory, in fact an alias to match postfix tcp auth.
1148 void check_get(void) {
1149 char internet_addr[256];
1154 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1155 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1156 syslog(LOG_CRIT, "vcard client disconnected: ending session.\n");
1157 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1160 syslog(LOG_INFO, ": %s\n", cmdbuf);
1161 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1162 syslog(LOG_INFO, "[ %s]\n", cmdbuf);
1164 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1166 struct recptypes *rcpt;
1167 char *argbuf = &cmdbuf[4];
1169 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1170 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1171 if ((rcpt != NULL)&&
1173 (*rcpt->recp_local != '\0')||
1174 (*rcpt->recp_room != '\0')||
1175 (*rcpt->recp_ignet != '\0')))
1178 cprintf("200 OK %s\n", internet_addr);
1179 syslog(LOG_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
1183 cprintf("500 REJECT noone here by that name.\n");
1185 syslog(LOG_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
1188 free_recipients(rcpt);
1192 cprintf("500 REJECT invalid Query.\n");
1194 syslog(LOG_INFO, "sending 500 REJECT invalid Query: %s\n", internet_addr);
1198 void check_get_greeting(void) {
1199 /* dummy function, we have no greeting in this verry simple protocol. */
1204 * We don't know if the Contacts room exists so we just create it at login
1206 void vcard_CtdlCreateRoom(void)
1211 /* Create the calendar room if it doesn't already exist */
1212 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1214 /* Set expiration policy to manual; otherwise objects will be lost! */
1215 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1216 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!\n");
1219 qr.QRep.expire_mode = EXPIRE_MANUAL;
1220 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1221 CtdlPutRoomLock(&qr);
1223 /* Set the view to a calendar view */
1224 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1225 vbuf.v_view = 2; /* 2 = address book view */
1226 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1235 * When a user logs in...
1237 void vcard_session_login_hook(void) {
1238 struct vCard *v = NULL;
1239 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1243 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1244 * into the user's vCard.
1246 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1247 v = vcard_get_user(&CCC->user);
1249 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1250 vcard_write_user(&CCC->user, v);
1257 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1258 * These are inserted into the session data for various message entry commands to use.
1260 v = vcard_get_user(&CCC->user);
1262 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1263 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1266 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1271 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1273 vcard_CtdlCreateRoom();
1278 * Turn an arbitrary RFC822 address into a struct vCard for possible
1279 * inclusion into an address book.
1281 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1283 char user[256], node[256], name[256], email[256], n[256], uid[256];
1287 if (v == NULL) return(NULL);
1289 process_rfc822_addr(addr, user, node, name);
1290 vcard_set_prop(v, "fn", name, 0);
1292 vcard_fn_to_n(n, name, sizeof n);
1293 vcard_set_prop(v, "n", n, 0);
1295 snprintf(email, sizeof email, "%s@%s", user, node);
1296 vcard_set_prop(v, "email;internet", email, 0);
1298 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1299 for (i=0; uid[i]; ++i) {
1300 if (isspace(uid[i])) uid[i] = '_';
1301 uid[i] = tolower(uid[i]);
1303 vcard_set_prop(v, "UID", uid, 0);
1311 * This is called by store_harvested_addresses() to remove from the
1312 * list any addresses we already have in our address book.
1314 void strip_addresses_already_have(long msgnum, void *userdata) {
1315 char *collected_addresses;
1316 struct CtdlMessage *msg = NULL;
1320 char addr[256], user[256], node[256], name[256];
1322 collected_addresses = (char *)userdata;
1324 msg = CtdlFetchMessage(msgnum, 1);
1325 if (msg == NULL) return;
1326 v = vcard_load(msg->cm_fields['M']);
1327 CtdlFreeMessage(msg);
1330 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1332 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1333 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1335 /* Remove the address if we already have it! */
1336 process_rfc822_addr(addr, user, node, name);
1337 snprintf(addr, sizeof addr, "%s@%s", user, node);
1338 if (!strcasecmp(value, addr)) {
1339 remove_token(collected_addresses, j, ',');
1351 * Back end function for store_harvested_addresses()
1353 void store_this_ha(struct addresses_to_be_filed *aptr) {
1354 struct CtdlMessage *vmsg = NULL;
1356 struct vCard *v = NULL;
1357 char recipient[256];
1360 /* First remove any addresses we already have in the address book */
1361 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
1362 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1363 strip_addresses_already_have, aptr->collected_addresses);
1365 if (!IsEmptyStr(aptr->collected_addresses))
1366 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1368 /* Make a vCard out of each address */
1369 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1371 v = vcard_new_from_rfc822_addr(recipient);
1373 vmsg = malloc(sizeof(struct CtdlMessage));
1374 memset(vmsg, 0, sizeof(struct CtdlMessage));
1375 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1376 vmsg->cm_anon_type = MES_NORMAL;
1377 vmsg->cm_format_type = FMT_RFC822;
1378 vmsg->cm_fields['A'] = strdup("Citadel");
1379 vmsg->cm_fields['E'] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1380 ser = vcard_serialize(v);
1382 vmsg->cm_fields['M'] = malloc(strlen(ser) + 1024);
1383 sprintf(vmsg->cm_fields['M'],
1384 "Content-type: " VCARD_MIME_TYPE
1385 "\r\n\r\n%s\r\n", ser);
1390 syslog(LOG_DEBUG, "Adding contact: %s\n", recipient);
1391 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1392 CtdlFreeMessage(vmsg);
1396 free(aptr->roomname);
1397 free(aptr->collected_addresses);
1403 * When a user sends a message, we may harvest one or more email addresses
1404 * from the recipient list to be added to the user's address book. But we
1405 * want to do this asynchronously so it doesn't keep the user waiting.
1407 void store_harvested_addresses(void) {
1409 struct addresses_to_be_filed *aptr = NULL;
1411 if (atbf == NULL) return;
1413 begin_critical_section(S_ATBF);
1414 while (atbf != NULL) {
1417 end_critical_section(S_ATBF);
1418 store_this_ha(aptr);
1419 begin_critical_section(S_ATBF);
1421 end_critical_section(S_ATBF);
1426 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1427 * really this is just so we expose the vCard data to the full text indexer.
1429 void vcard_fixed_output(char *ptr, int len) {
1430 char *serialized_vcard;
1435 serialized_vcard = malloc(len + 1);
1436 safestrncpy(serialized_vcard, ptr, len+1);
1437 v = vcard_load(serialized_vcard);
1438 free(serialized_vcard);
1441 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1442 value = vcard_get_prop(v, "", 0, i++, 0);
1443 cprintf("%s\n", value);
1450 const char *CitadelServiceDICT_TCP="DICT_TCP";
1452 CTDL_MODULE_INIT(vcard)
1461 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN);
1462 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1463 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1464 CtdlRegisterDeleteHook(vcard_delete_remove);
1465 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1466 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1467 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1468 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1469 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1470 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1471 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1472 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1473 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1474 CtdlRegisterNetprocHook(vcard_extract_from_network);
1475 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER);
1476 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1477 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1479 /* Create the Global ADdress Book room if necessary */
1480 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1482 /* Set expiration policy to manual; otherwise objects will be lost! */
1483 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1484 qr.QRep.expire_mode = EXPIRE_MANUAL;
1485 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1486 CtdlPutRoomLock(&qr);
1489 * Also make sure it has a netconfig file, so the networker runs
1490 * on this room even if we don't share it with any other nodes.
1491 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1494 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1495 fp = fopen(filename, "a");
1496 if (fp != NULL) fclose(fp);
1497 rv = chown(filename, CTDLUID, (-1));
1499 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
1500 filename, strerror(errno));
1503 /* for postfix tcpdict */
1504 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1509 CitadelServiceDICT_TCP);
1512 /* return our module name for the log */