4 * A server-side module for Citadel which supports address book information
5 * using the standard vCard format.
7 * Copyright (c) 1999-2009 by the citadel.org team
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * Format of the "Exclusive ID" field of the message containing a user's
26 * vCard. Doesn't matter what it really looks like as long as it's both
27 * unique and consistent (because we use it for replication checking to
28 * delete the old vCard network-wide when the user enters a new one).
30 #define VCARD_EXT_FORMAT "Citadel vCard: personal card for %s at %s"
33 * Citadel will accept either text/vcard or text/x-vcard as the MIME type
34 * for a vCard. The following definition determines which one it *generates*
37 #define VCARD_MIME_TYPE "text/x-vcard"
48 #include <sys/types.h>
50 #if TIME_WITH_SYS_TIME
51 # include <sys/time.h>
55 # include <sys/time.h>
64 #include <libcitadel.h>
67 #include "citserver.h"
74 #include "internet_addressing.h"
75 #include "serv_vcard.h"
76 #include "citadel_ldap.h"
77 #include "ctdl_module.h"
80 * set global flag calling for an aide to validate new users
82 void set_mm_valid(void) {
83 begin_critical_section(S_CONTROL);
85 CitControl.MMflags = CitControl.MMflags | MM_VALID ;
87 end_critical_section(S_CONTROL);
93 * Extract Internet e-mail addresses from a message containing a vCard, and
94 * perform a callback for any found.
96 void vcard_extract_internet_addresses(struct CtdlMessage *msg, void (*callback)(char *, char *) ) {
101 char citadel_address[SIZ];
103 int found_something = 0;
105 if (msg->cm_fields['A'] == NULL) return;
106 if (msg->cm_fields['N'] == NULL) return;
107 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
108 msg->cm_fields['A'], msg->cm_fields['N']);
110 v = vcard_load(msg->cm_fields['M']);
111 if (v == NULL) return;
113 /* Go through the vCard searching for *all* instances of
114 * the "email;internet" key
117 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
118 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
119 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
122 if (!IsEmptyStr(addr)) {
123 if (callback != NULL) {
124 callback(addr, citadel_address);
133 } while(found_something);
140 * Callback for vcard_add_to_directory()
141 * (Lotsa ugly nested callbacks. Oh well.)
143 void vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
146 /* We have to validate that we're not stepping on someone else's
147 * email address ... but only if we're logged in. Otherwise it's
148 * probably just the networker or something.
151 CtdlLogPrintf(CTDL_DEBUG, "Checking for <%s>...\n", internet_addr);
152 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
153 if (strcasecmp(buf, citadel_addr)) {
154 /* This address belongs to someone else.
155 * Bail out silently without saving.
157 CtdlLogPrintf(CTDL_DEBUG, "DOOP!\n");
162 CtdlLogPrintf(CTDL_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
163 CtdlDirectoryAddUser(internet_addr, citadel_addr);
168 * Back end function for cmd_igab()
170 void vcard_add_to_directory(long msgnum, void *data) {
171 struct CtdlMessage *msg;
173 msg = CtdlFetchMessage(msgnum, 1);
175 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
178 CtdlFreeMessage(msg);
183 * Initialize Global Adress Book
185 void cmd_igab(char *argbuf) {
186 char hold_rm[ROOMNAMELEN];
188 if (CtdlAccessCheck(ac_aide)) return;
190 strcpy(hold_rm, CC->room.QRname); /* save current room */
192 if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
193 CtdlGetRoom(&CC->room, hold_rm);
194 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
198 /* Empty the existing database first.
202 /* We want *all* vCards in this room */
203 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
204 NULL, vcard_add_to_directory, NULL);
206 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
207 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
214 * See if there is a valid Internet address in a vCard to use for outbound
215 * Internet messages. If there is, stick it in the buffer.
217 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
218 char *secemailaddrbuf, size_t secemailaddrbuf_len,
219 struct vCard *v, int local_addrs_only) {
222 int saved_instance = 0;
224 /* Go through the vCard searching for *all* Internet email addresses
226 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
227 k = vcard_get_prop(v, "email", 1, instance, 1);
228 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
231 if (!IsEmptyStr(addr)) {
232 if ( (IsDirectory(addr, 1)) ||
233 (!local_addrs_only) ) {
235 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
236 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
238 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
239 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
241 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
242 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
243 < secemailaddrbuf_len ) {
244 strcat(secemailaddrbuf, "|");
245 strcat(secemailaddrbuf, addr);
259 * See if there is a name / screen name / friendly name in a vCard to use for outbound
260 * Internet messages. If there is, stick it in the buffer.
262 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
266 s = vcard_get_prop(v, "fn", 1, 0, 0);
268 s = vcard_get_prop(v, "n", 1, 0, 0);
272 safestrncpy(namebuf, s, namebuf_len);
278 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
280 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
281 void *content, char *cbtype, char *cbcharset, size_t length,
282 char *encoding, char *cbid, void *cbuserdata)
284 struct vCard **v = (struct vCard **) cbuserdata;
286 if ( (!strcasecmp(cbtype, "text/x-vcard"))
287 || (!strcasecmp(cbtype, "text/vcard")) ) {
289 CtdlLogPrintf(CTDL_DEBUG, "Part %s contains a vCard! Loading...\n", partnum);
293 *v = vcard_load(content);
299 * This handler detects whether the user is attempting to save a new
300 * vCard as part of his/her personal configuration, and handles the replace
301 * function accordingly (delete the user's existing vCard in the config room
302 * and in the global address book).
304 int vcard_upload_beforesave(struct CtdlMessage *msg) {
308 struct ctdluser usbuf;
310 struct vCard *v = NULL;
313 int yes_my_citadel_config = 0;
314 int yes_any_vcard_room = 0;
316 if (!CC->logged_in) return(0); /* Only do this if logged in. */
318 /* Is this some user's "My Citadel Config" room? */
319 if ( (CC->room.QRflags && QR_MAILBOX)
320 && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
321 /* Yes, we want to do this */
322 yes_my_citadel_config = 1;
324 #ifdef VCARD_SAVES_BY_AIDES_ONLY
325 /* Prevent non-aides from performing registration changes */
326 if (CC->user.axlevel < AxAideU) {
333 /* Is this a room with an address book in it? */
334 if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
335 yes_any_vcard_room = 1;
338 /* If neither condition exists, don't run this hook. */
339 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
343 /* If this isn't a MIME message, don't bother. */
344 if (msg->cm_format_type != 4) return(0);
346 /* Ok, if we got this far, look into the situation further... */
348 ptr = msg->cm_fields['M'];
349 if (ptr == NULL) return(0);
351 mime_parser(msg->cm_fields['M'],
353 *vcard_extract_vcard,
355 &v, /* user data ptr - put the vcard here */
359 if (v == NULL) return(0); /* no vCards were found in this message */
361 /* If users cannot create their own accounts, they cannot re-register either. */
362 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
366 s = vcard_get_prop(v, "fn", 1, 0, 0);
367 if (s) CtdlLogPrintf(CTDL_DEBUG, "vCard beforesave hook running for <%s>\n", s);
369 if (yes_my_citadel_config) {
370 /* Bingo! The user is uploading a new vCard, so
371 * delete the old one. First, figure out which user
372 * is being re-registered...
374 what_user = atol(CC->room.QRname);
376 if (what_user == CC->user.usernum) {
377 /* It's the logged in user. That was easy. */
378 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
381 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
382 /* We fetched a valid user record */
386 /* somebody set up us the bomb! */
387 yes_my_citadel_config = 0;
391 if (yes_my_citadel_config) {
392 /* Delete the user's old vCard. This would probably
393 * get taken care of by the replication check, but we
394 * want to make sure there is absolutely only one
395 * vCard in the user's config room at all times.
398 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
400 /* Make the author of the message the name of the user. */
401 if (msg->cm_fields['A'] != NULL) {
402 free(msg->cm_fields['A']);
404 msg->cm_fields['A'] = strdup(usbuf.fullname);
407 /* Insert or replace RFC2739-compliant free/busy URL */
408 if (yes_my_citadel_config) {
409 sprintf(buf, "http://%s/%s.vfb",
412 for (i=0; buf[i]; ++i) {
413 if (buf[i] == ' ') buf[i] = '_';
415 vcard_set_prop(v, "FBURL;PREF", buf, 0);
418 /* If the vCard has no UID, then give it one. */
419 s = vcard_get_prop(v, "UID", 1, 0, 0);
422 vcard_set_prop(v, "UID", buf, 0);
425 /* Enforce local UID policy if applicable */
426 if (yes_my_citadel_config) {
427 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
428 vcard_set_prop(v, "UID", buf, 0);
432 * Set the EUID of the message to the UID of the vCard.
434 if (msg->cm_fields['E'] != NULL)
436 free(msg->cm_fields['E']);
437 msg->cm_fields['E'] = NULL;
439 s = vcard_get_prop(v, "UID", 1, 0, 0);
441 msg->cm_fields['E'] = strdup(s);
442 if (msg->cm_fields['U'] == NULL) {
443 msg->cm_fields['U'] = strdup(s);
448 * Set the Subject to the name in the vCard.
450 s = vcard_get_prop(v, "FN", 1, 0, 0);
452 s = vcard_get_prop(v, "N", 1, 0, 0);
455 if (msg->cm_fields['U'] != NULL) {
456 free(msg->cm_fields['U']);
458 msg->cm_fields['U'] = strdup(s);
461 /* Re-serialize it back into the msg body */
462 ser = vcard_serialize(v);
464 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], strlen(ser) + 1024);
465 sprintf(msg->cm_fields['M'],
466 "Content-type: " VCARD_MIME_TYPE
467 "\r\n\r\n%s\r\n", ser);
471 /* Now allow the save to complete. */
479 * This handler detects whether the user is attempting to save a new
480 * vCard as part of his/her personal configuration, and handles the replace
481 * function accordingly (copy the vCard from the config room to the global
484 int vcard_upload_aftersave(struct CtdlMessage *msg) {
490 int is_MY_UserConf=0;
492 char roomname[ROOMNAMELEN];
494 if (msg->cm_format_type != 4) return(0);
495 if (!CC->logged_in) return(0); /* Only do this if logged in. */
497 /* We're interested in user config rooms only. */
499 if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
500 is_UserConf = 1; /* It's someone's config room */
502 CtdlMailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
503 if (!strcasecmp(CC->room.QRname, roomname)) {
505 is_MY_UserConf = 1; /* It's MY config room */
507 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
508 is_GAB = 1; /* It's the Global Address Book */
511 if (!is_UserConf && !is_GAB) return(0);
513 ptr = msg->cm_fields['M'];
514 if (ptr == NULL) return(0);
515 while (ptr != NULL) {
517 linelen = strcspn(ptr, "\n");
518 if (linelen == 0) return(0); /* end of headers */
520 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
521 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
523 * Bingo! The user is uploading a new vCard, so
524 * copy it to the Global Address Book room.
527 I = atol(msg->cm_fields['I']);
528 if (I < 0L) return(0);
530 /* Store our Internet return address in memory */
531 if (is_MY_UserConf) {
532 v = vcard_load(msg->cm_fields['M']);
533 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
534 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
536 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
541 { // This is not the GAB
542 /* Put it in the Global Address Book room... */
543 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
546 /* ...and also in the directory database. */
547 vcard_add_to_directory(I, NULL);
549 /* Some sites want an Aide to be notified when a
550 * user registers or re-registers
551 * But if the user was an Aide or was edited by an Aide then we can
552 * Assume they don't need validating.
554 if (CC->user.axlevel >= AxAideU) {
555 CtdlGetUserLock(&CC->user, CC->curr_user);
556 CC->user.flags |= US_REGIS;
557 CtdlPutUserLock(&CC->user);
563 /* ...which also means we need to flag the user */
564 CtdlGetUserLock(&CC->user, CC->curr_user);
565 CC->user.flags |= (US_REGIS|US_NEEDVALID);
566 CtdlPutUserLock(&CC->user);
571 ptr = strchr((char *)ptr, '\n');
572 if (ptr != NULL) ++ptr;
581 * back end function used for callbacks
583 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
586 msgnum = (long *) userdata;
587 *msgnum = supplied_msgnum;
592 * If this user has a vcard on disk, read it into memory, otherwise allocate
593 * and return an empty vCard.
595 struct vCard *vcard_get_user(struct ctdluser *u) {
596 char hold_rm[ROOMNAMELEN];
597 char config_rm[ROOMNAMELEN];
598 struct CtdlMessage *msg = NULL;
602 strcpy(hold_rm, CC->room.QRname); /* save current room */
603 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
605 if (CtdlGetRoom(&CC->room, config_rm) != 0) {
606 CtdlGetRoom(&CC->room, hold_rm);
610 /* We want the last (and probably only) vcard in this room */
612 CtdlForEachMessage(MSGS_LAST, 1, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
613 NULL, vcard_gu_backend, (void *)&VCmsgnum );
614 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
616 if (VCmsgnum < 0L) return vcard_new();
618 msg = CtdlFetchMessage(VCmsgnum, 1);
619 if (msg == NULL) return vcard_new();
621 v = vcard_load(msg->cm_fields['M']);
622 CtdlFreeMessage(msg);
628 * Store this user's vCard in the appropriate place
631 * Write our config to disk
633 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
636 ser = vcard_serialize(v);
638 ser = strdup("begin:vcard\r\nend:vcard\r\n");
642 /* This handy API function does all the work for us.
643 * NOTE: normally we would want to set that last argument to 1, to
644 * force the system to delete the user's old vCard. But it doesn't
645 * have to, because the vcard_upload_beforesave() hook above
646 * is going to notice what we're trying to do, and delete the old vCard.
648 CtdlWriteObject(USERCONFIGROOM, /* which room */
649 VCARD_MIME_TYPE, /* MIME type */
651 strlen(ser)+1, /* length */
654 0, /* don't delete others of this type */
663 * Old style "enter registration info" command. This function simply honors
664 * the REGI protocol command, translates the entered parameters into a vCard,
665 * and enters the vCard into the user's configuration.
667 void cmd_regi(char *argbuf) {
670 struct vCard *my_vcard;
676 char tmpaddress[SIZ];
677 char tmpcountry[SIZ];
681 if (!(CC->logged_in)) {
682 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
686 /* If users cannot create their own accounts, they cannot re-register either. */
687 if ( (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
688 cprintf("%d Self-service registration is not allowed here.\n",
689 ERROR + HIGHER_ACCESS_REQUIRED);
692 my_vcard = vcard_get_user(&CC->user);
695 strcpy(tmpstate, "");
697 strcpy(tmpcountry, "USA");
699 cprintf("%d Send registration...\n", SEND_LISTING);
701 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
702 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
703 if (a==1) strcpy(tmpaddr, buf);
704 if (a==2) strcpy(tmpcity, buf);
705 if (a==3) strcpy(tmpstate, buf);
707 for (c=0; buf[c]; ++c) {
708 if ((buf[c]>='0') && (buf[c]<='9')) {
715 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
716 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
717 if (a==7) strcpy(tmpcountry, buf);
721 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
722 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
723 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
724 vcard_write_user(&CC->user, my_vcard);
725 vcard_free(my_vcard);
730 * Protocol command to fetch registration info for a user
732 void cmd_greg(char *argbuf)
734 struct ctdluser usbuf;
737 char who[USERNAME_SIZE];
741 extract_token(who, argbuf, 0, '|', sizeof who);
743 if (!(CC->logged_in)) {
744 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
748 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
750 if ((CC->user.axlevel < AxAideU) && (strcasecmp(who,CC->curr_user))) {
751 cprintf("%d Higher access required.\n",
752 ERROR + HIGHER_ACCESS_REQUIRED);
756 if (CtdlGetUser(&usbuf, who) != 0) {
757 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
761 v = vcard_get_user(&usbuf);
763 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
764 cprintf("%ld\n", usbuf.usernum);
765 cprintf("%s\n", usbuf.password);
766 s = vcard_get_prop(v, "n", 1, 0, 0);
767 cprintf("%s\n", s ? s : " "); /* name */
769 s = vcard_get_prop(v, "adr", 1, 0, 0);
770 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
772 extract_token(buf, adr, 2, ';', sizeof buf);
773 cprintf("%s\n", buf); /* street */
774 extract_token(buf, adr, 3, ';', sizeof buf);
775 cprintf("%s\n", buf); /* city */
776 extract_token(buf, adr, 4, ';', sizeof buf);
777 cprintf("%s\n", buf); /* state */
778 extract_token(buf, adr, 5, ';', sizeof buf);
779 cprintf("%s\n", buf); /* zip */
781 s = vcard_get_prop(v, "tel", 1, 0, 0);
782 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
790 cprintf("%d\n", usbuf.axlevel);
792 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
793 cprintf("%s\n", s ? s : " ");
794 s = vcard_get_prop(v, "adr", 0, 0, 0);
795 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
797 extract_token(buf, adr, 6, ';', sizeof buf);
798 cprintf("%s\n", buf); /* country */
806 * When a user is being created, create his/her vCard.
808 void vcard_newuser(struct ctdluser *usbuf) {
814 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
815 CtdlLogPrintf(CTDL_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
817 /* Create and save the vCard */
819 if (v == NULL) return;
820 vcard_add_prop(v, "fn", usbuf->fullname);
821 vcard_add_prop(v, "n", vname);
822 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
824 #ifdef HAVE_GETPWUID_R
825 /* If using host auth mode, we add an email address based on the login */
826 if (config.c_auth_mode == AUTHMODE_HOST) {
828 char pwd_buffer[SIZ];
830 #ifdef SOLARIS_GETPWUID
831 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
832 #else // SOLARIS_GETPWUID
833 struct passwd *result = NULL;
834 CtdlLogPrintf(CTDL_DEBUG, "Searching for uid %d\n", usbuf->uid);
835 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
836 #endif // HAVE_GETPWUID_R
837 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
838 vcard_add_prop(v, "email;internet", buf);
843 /* Everyone gets an email address based on their display name */
844 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
845 for (i=0; buf[i]; ++i) {
846 if (buf[i] == ' ') buf[i] = '_';
848 vcard_add_prop(v, "email;internet", buf);
851 vcard_write_user(usbuf, v);
857 * When a user is being deleted, we have to remove his/her vCard.
858 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
859 * field, and the same Exclusive ID as the existing card.
861 void vcard_purge(struct ctdluser *usbuf) {
862 struct CtdlMessage *msg;
865 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
866 if (msg == NULL) return;
867 memset(msg, 0, sizeof(struct CtdlMessage));
869 msg->cm_magic = CTDLMESSAGE_MAGIC;
870 msg->cm_anon_type = MES_NORMAL;
871 msg->cm_format_type = 0;
872 msg->cm_fields['A'] = strdup(usbuf->fullname);
873 msg->cm_fields['O'] = strdup(ADDRESS_BOOK_ROOM);
874 msg->cm_fields['N'] = strdup(NODENAME);
875 msg->cm_fields['M'] = strdup("Purge this vCard\n");
877 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
878 msg->cm_fields['A'], NODENAME);
879 msg->cm_fields['E'] = strdup(buf);
881 msg->cm_fields['S'] = strdup("CANCEL");
883 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
884 CtdlFreeMessage(msg);
889 * Grab vCard directory stuff out of incoming network messages
891 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
895 if (msg == NULL) return(0);
897 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
901 if (msg->cm_format_type != 4) return(0);
903 ptr = msg->cm_fields['M'];
904 if (ptr == NULL) return(0);
905 while (ptr != NULL) {
907 linelen = strcspn(ptr, "\n");
908 if (linelen == 0) return(0); /* end of headers */
910 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
911 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
912 /* It's a vCard. Add it to the directory. */
913 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
917 ptr = strchr((char *)ptr, '\n');
918 if (ptr != NULL) ++ptr;
927 * When a vCard is being removed from the Global Address Book room, remove it
928 * from the directory as well.
930 void vcard_delete_remove(char *room, long msgnum) {
931 struct CtdlMessage *msg;
935 if (msgnum <= 0L) return;
937 if (room == NULL) return;
939 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
943 msg = CtdlFetchMessage(msgnum, 1);
944 if (msg == NULL) return;
946 ptr = msg->cm_fields['M'];
947 if (ptr == NULL) goto EOH;
948 while (ptr != NULL) {
949 linelen = strcspn(ptr, "\n");
950 if (linelen == 0) goto EOH;
952 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
953 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
954 /* Bingo! A vCard is being deleted. */
955 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
957 ptr = strchr((char *)ptr, '\n');
958 if (ptr != NULL) ++ptr;
961 EOH: CtdlFreeMessage(msg);
967 * Get Valid Screen Names
969 void cmd_gvsn(char *argbuf)
971 if (CtdlAccessCheck(ac_logged_in)) return;
973 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
974 cprintf("%s\n", CC->user.fullname);
975 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
976 cprintf("%s\n", CC->cs_inet_fn);
983 * Get Valid Email Addresses
985 void cmd_gvea(char *argbuf)
987 int num_secondary_emails = 0;
991 if (CtdlAccessCheck(ac_logged_in)) return;
993 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
994 if (!IsEmptyStr(CC->cs_inet_email)) {
995 cprintf("%s\n", CC->cs_inet_email);
997 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
998 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
999 for (i=0; i<num_secondary_emails; ++i) {
1000 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
1001 cprintf("%s\n", buf);
1011 * Callback function for cmd_dvca() that hunts for vCard content types
1012 * and outputs any email addresses found within.
1014 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1015 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1016 char *cbid, void *cbuserdata) {
1019 char displayname[256];
1020 int displayname_len;
1021 char emailaddr[256];
1025 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1029 v = vcard_load(content);
1030 if (v == NULL) return;
1032 extract_friendly_name(displayname, sizeof displayname, v);
1033 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1035 displayname_len = strlen(displayname);
1036 for (i=0; i<displayname_len; ++i) {
1037 if (displayname[i] == '\"') displayname[i] = ' ';
1038 if (displayname[i] == ';') displayname[i] = ',';
1039 if (displayname[i] == ',') has_commas = 1;
1041 striplt(displayname);
1043 cprintf("%s%s%s <%s>\n",
1044 (has_commas ? "\"" : ""),
1046 (has_commas ? "\"" : ""),
1055 * Back end callback function for cmd_dvca()
1057 * It's basically just passed a list of message numbers, which we're going
1058 * to fetch off the disk and then pass along to the MIME parser via another
1059 * layer of callback...
1061 void dvca_callback(long msgnum, void *userdata) {
1062 struct CtdlMessage *msg = NULL;
1064 msg = CtdlFetchMessage(msgnum, 1);
1065 if (msg == NULL) return;
1066 mime_parser(msg->cm_fields['M'],
1068 *dvca_mime_callback, /* callback function */
1070 NULL, /* user data */
1073 CtdlFreeMessage(msg);
1078 * Dump VCard Addresses
1080 void cmd_dvca(char *argbuf)
1082 if (CtdlAccessCheck(ac_logged_in)) return;
1084 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1085 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1093 void cmd_qdir(char *argbuf) {
1094 char citadel_addr[256];
1095 char internet_addr[256];
1097 if (CtdlAccessCheck(ac_logged_in)) return;
1099 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1101 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1102 cprintf("%d %s was not found.\n",
1103 ERROR + NO_SUCH_USER, internet_addr);
1107 cprintf("%d %s\n", CIT_OK, citadel_addr);
1111 * Query Directory, in fact an alias to match postfix tcp auth.
1113 void check_get(void) {
1114 char internet_addr[256];
1119 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1120 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1121 CtdlLogPrintf(CTDL_CRIT, "Client disconnected: ending session.\n");
1125 CtdlLogPrintf(CTDL_INFO, ": %s\n", cmdbuf);
1126 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1127 CtdlLogPrintf(CTDL_INFO, "[ %s]\n", cmdbuf);
1129 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1131 struct recptypes *rcpt;
1132 char *argbuf = &cmdbuf[4];
1134 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1135 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1136 if ((rcpt != NULL)&&
1138 (*rcpt->recp_local != '\0')||
1139 (*rcpt->recp_room != '\0')||
1140 (*rcpt->recp_ignet != '\0')))
1143 cprintf("200 OK %s\n", internet_addr);
1144 CtdlLogPrintf(CTDL_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
1148 cprintf("500 REJECT noone here by that name.\n");
1150 CtdlLogPrintf(CTDL_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
1153 free_recipients(rcpt);
1157 cprintf("500 REJECT invalid Query.\n");
1159 CtdlLogPrintf(CTDL_INFO, "sending 500 REJECT invalid Query: %s\n", internet_addr);
1163 void check_get_greeting(void) {
1164 /* dummy function, we have no greeting in this verry simple protocol. */
1169 * We don't know if the Contacts room exists so we just create it at login
1171 void vcard_CtdlCreateRoom(void)
1176 /* Create the calendar room if it doesn't already exist */
1177 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1179 /* Set expiration policy to manual; otherwise objects will be lost! */
1180 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1181 CtdlLogPrintf(CTDL_ERR, "Couldn't get the user CONTACTS room!\n");
1184 qr.QRep.expire_mode = EXPIRE_MANUAL;
1185 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1186 CtdlPutRoomLock(&qr);
1188 /* Set the view to a calendar view */
1189 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1190 vbuf.v_view = 2; /* 2 = address book view */
1191 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1200 * When a user logs in...
1202 void vcard_session_login_hook(void) {
1203 struct vCard *v = NULL;
1204 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1208 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1209 * into the user's vCard.
1211 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1212 v = vcard_get_user(&CCC->user);
1214 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1215 vcard_write_user(&CCC->user, v);
1222 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1223 * These are inserted into the session data for various message entry commands to use.
1225 v = vcard_get_user(&CCC->user);
1227 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1228 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1231 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1236 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1238 vcard_CtdlCreateRoom();
1243 * Turn an arbitrary RFC822 address into a struct vCard for possible
1244 * inclusion into an address book.
1246 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1248 char user[256], node[256], name[256], email[256], n[256], uid[256];
1252 if (v == NULL) return(NULL);
1254 process_rfc822_addr(addr, user, node, name);
1255 vcard_set_prop(v, "fn", name, 0);
1257 vcard_fn_to_n(n, name, sizeof n);
1258 vcard_set_prop(v, "n", n, 0);
1260 snprintf(email, sizeof email, "%s@%s", user, node);
1261 vcard_set_prop(v, "email;internet", email, 0);
1263 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1264 for (i=0; uid[i]; ++i) {
1265 if (isspace(uid[i])) uid[i] = '_';
1266 uid[i] = tolower(uid[i]);
1268 vcard_set_prop(v, "UID", uid, 0);
1276 * This is called by store_harvested_addresses() to remove from the
1277 * list any addresses we already have in our address book.
1279 void strip_addresses_already_have(long msgnum, void *userdata) {
1280 char *collected_addresses;
1281 struct CtdlMessage *msg = NULL;
1285 char addr[256], user[256], node[256], name[256];
1287 collected_addresses = (char *)userdata;
1289 msg = CtdlFetchMessage(msgnum, 1);
1290 if (msg == NULL) return;
1291 v = vcard_load(msg->cm_fields['M']);
1292 CtdlFreeMessage(msg);
1295 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1297 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1298 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1300 /* Remove the address if we already have it! */
1301 process_rfc822_addr(addr, user, node, name);
1302 snprintf(addr, sizeof addr, "%s@%s", user, node);
1303 if (!strcasecmp(value, addr)) {
1304 remove_token(collected_addresses, j, ',');
1316 * Back end function for store_harvested_addresses()
1318 void store_this_ha(struct addresses_to_be_filed *aptr) {
1319 struct CtdlMessage *vmsg = NULL;
1320 long vmsgnum = (-1L);
1322 struct vCard *v = NULL;
1323 char recipient[256];
1326 /* First remove any addresses we already have in the address book */
1327 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
1328 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1329 strip_addresses_already_have, aptr->collected_addresses);
1331 if (!IsEmptyStr(aptr->collected_addresses))
1332 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1334 /* Make a vCard out of each address */
1335 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1337 v = vcard_new_from_rfc822_addr(recipient);
1339 vmsg = malloc(sizeof(struct CtdlMessage));
1340 memset(vmsg, 0, sizeof(struct CtdlMessage));
1341 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1342 vmsg->cm_anon_type = MES_NORMAL;
1343 vmsg->cm_format_type = FMT_RFC822;
1344 vmsg->cm_fields['A'] = strdup("Citadel");
1345 vmsg->cm_fields['E'] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1346 ser = vcard_serialize(v);
1348 vmsg->cm_fields['M'] = malloc(strlen(ser) + 1024);
1349 sprintf(vmsg->cm_fields['M'],
1350 "Content-type: " VCARD_MIME_TYPE
1351 "\r\n\r\n%s\r\n", ser);
1356 CtdlLogPrintf(CTDL_DEBUG, "Adding contact: %s\n", recipient);
1357 vmsgnum = CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1358 CtdlFreeMessage(vmsg);
1362 free(aptr->roomname);
1363 free(aptr->collected_addresses);
1369 * When a user sends a message, we may harvest one or more email addresses
1370 * from the recipient list to be added to the user's address book. But we
1371 * want to do this asynchronously so it doesn't keep the user waiting.
1373 void store_harvested_addresses(void) {
1375 struct addresses_to_be_filed *aptr = NULL;
1377 if (atbf == NULL) return;
1379 begin_critical_section(S_ATBF);
1380 while (atbf != NULL) {
1383 end_critical_section(S_ATBF);
1384 store_this_ha(aptr);
1385 begin_critical_section(S_ATBF);
1387 end_critical_section(S_ATBF);
1392 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1393 * really this is just so we expose the vCard data to the full text indexer.
1395 void vcard_fixed_output(char *ptr, int len) {
1396 char *serialized_vcard;
1401 serialized_vcard = malloc(len + 1);
1402 safestrncpy(serialized_vcard, ptr, len+1);
1403 v = vcard_load(serialized_vcard);
1404 free(serialized_vcard);
1407 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1408 value = vcard_get_prop(v, "", 0, i++, 0);
1409 cprintf("%s\n", value);
1416 const char *CitadelServiceDICT_TCP="DICT_TCP";
1418 CTDL_MODULE_INIT(vcard)
1427 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN);
1428 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1429 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1430 CtdlRegisterDeleteHook(vcard_delete_remove);
1431 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1432 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1433 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1434 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1435 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1436 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1437 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1438 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1439 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1440 CtdlRegisterNetprocHook(vcard_extract_from_network);
1441 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER);
1442 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1443 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1445 /* Create the Global ADdress Book room if necessary */
1446 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1448 /* Set expiration policy to manual; otherwise objects will be lost! */
1449 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1450 qr.QRep.expire_mode = EXPIRE_MANUAL;
1451 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1452 CtdlPutRoomLock(&qr);
1455 * Also make sure it has a netconfig file, so the networker runs
1456 * on this room even if we don't share it with any other nodes.
1457 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1460 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1461 fp = fopen(filename, "a");
1462 if (fp != NULL) fclose(fp);
1463 rv = chown(filename, CTDLUID, (-1));
1466 /* for postfix tcpdict */
1467 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1472 CitadelServiceDICT_TCP);
1475 /* return our Subversion id for the Log */