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"
75 #include "internet_addressing.h"
76 #include "serv_vcard.h"
77 #include "citadel_ldap.h"
78 #include "ctdl_module.h"
81 * set global flag calling for an aide to validate new users
83 void set_mm_valid(void) {
84 begin_critical_section(S_CONTROL);
86 CitControl.MMflags = CitControl.MMflags | MM_VALID ;
88 end_critical_section(S_CONTROL);
94 * Extract Internet e-mail addresses from a message containing a vCard, and
95 * perform a callback for any found.
97 void vcard_extract_internet_addresses(struct CtdlMessage *msg, void (*callback)(char *, char *) ) {
102 char citadel_address[SIZ];
104 int found_something = 0;
106 if (msg->cm_fields['A'] == NULL) return;
107 if (msg->cm_fields['N'] == NULL) return;
108 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
109 msg->cm_fields['A'], msg->cm_fields['N']);
111 v = vcard_load(msg->cm_fields['M']);
112 if (v == NULL) return;
114 /* Go through the vCard searching for *all* instances of
115 * the "email;internet" key
118 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
119 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
120 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
123 if (!IsEmptyStr(addr)) {
124 if (callback != NULL) {
125 callback(addr, citadel_address);
134 } while(found_something);
141 * Callback for vcard_add_to_directory()
142 * (Lotsa ugly nested callbacks. Oh well.)
144 void vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
147 /* We have to validate that we're not stepping on someone else's
148 * email address ... but only if we're logged in. Otherwise it's
149 * probably just the networker or something.
152 CtdlLogPrintf(CTDL_DEBUG, "Checking for <%s>...\n", internet_addr);
153 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
154 if (strcasecmp(buf, citadel_addr)) {
155 /* This address belongs to someone else.
156 * Bail out silently without saving.
158 CtdlLogPrintf(CTDL_DEBUG, "DOOP!\n");
163 CtdlLogPrintf(CTDL_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
164 CtdlDirectoryAddUser(internet_addr, citadel_addr);
169 * Back end function for cmd_igab()
171 void vcard_add_to_directory(long msgnum, void *data) {
172 struct CtdlMessage *msg;
174 msg = CtdlFetchMessage(msgnum, 1);
176 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
179 CtdlFreeMessage(msg);
184 * Initialize Global Adress Book
186 void cmd_igab(char *argbuf) {
187 char hold_rm[ROOMNAMELEN];
189 if (CtdlAccessCheck(ac_aide)) return;
191 strcpy(hold_rm, CC->room.QRname); /* save current room */
193 if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
194 CtdlGetRoom(&CC->room, hold_rm);
195 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
199 /* Empty the existing database first.
203 /* We want *all* vCards in this room */
204 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
205 NULL, vcard_add_to_directory, NULL);
207 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
208 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
215 * See if there is a valid Internet address in a vCard to use for outbound
216 * Internet messages. If there is, stick it in the buffer.
218 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
219 char *secemailaddrbuf, size_t secemailaddrbuf_len,
220 struct vCard *v, int local_addrs_only) {
223 int saved_instance = 0;
225 /* Go through the vCard searching for *all* Internet email addresses
227 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
228 k = vcard_get_prop(v, "email", 1, instance, 1);
229 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
232 if (!IsEmptyStr(addr)) {
233 if ( (IsDirectory(addr, 1)) ||
234 (!local_addrs_only) ) {
236 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
237 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
239 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
240 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
242 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
243 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
244 < secemailaddrbuf_len ) {
245 strcat(secemailaddrbuf, "|");
246 strcat(secemailaddrbuf, addr);
260 * See if there is a name / screen name / friendly name in a vCard to use for outbound
261 * Internet messages. If there is, stick it in the buffer.
263 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
267 s = vcard_get_prop(v, "fn", 1, 0, 0);
269 s = vcard_get_prop(v, "n", 1, 0, 0);
273 safestrncpy(namebuf, s, namebuf_len);
279 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
281 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
282 void *content, char *cbtype, char *cbcharset, size_t length,
283 char *encoding, char *cbid, void *cbuserdata)
285 struct vCard **v = (struct vCard **) cbuserdata;
287 if ( (!strcasecmp(cbtype, "text/x-vcard"))
288 || (!strcasecmp(cbtype, "text/vcard")) ) {
290 CtdlLogPrintf(CTDL_DEBUG, "Part %s contains a vCard! Loading...\n", partnum);
294 *v = vcard_load(content);
300 * This handler detects whether the user is attempting to save a new
301 * vCard as part of his/her personal configuration, and handles the replace
302 * function accordingly (delete the user's existing vCard in the config room
303 * and in the global address book).
305 int vcard_upload_beforesave(struct CtdlMessage *msg) {
309 struct ctdluser usbuf;
311 struct vCard *v = NULL;
314 int yes_my_citadel_config = 0;
315 int yes_any_vcard_room = 0;
317 if (!CC->logged_in) return(0); /* Only do this if logged in. */
319 /* Is this some user's "My Citadel Config" room? */
320 if ( (CC->room.QRflags && QR_MAILBOX)
321 && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
322 /* Yes, we want to do this */
323 yes_my_citadel_config = 1;
325 #ifdef VCARD_SAVES_BY_AIDES_ONLY
326 /* Prevent non-aides from performing registration changes */
327 if (CC->user.axlevel < AxAideU) {
334 /* Is this a room with an address book in it? */
335 if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
336 yes_any_vcard_room = 1;
339 /* If neither condition exists, don't run this hook. */
340 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
344 /* If this isn't a MIME message, don't bother. */
345 if (msg->cm_format_type != 4) return(0);
347 /* Ok, if we got this far, look into the situation further... */
349 ptr = msg->cm_fields['M'];
350 if (ptr == NULL) return(0);
352 mime_parser(msg->cm_fields['M'],
354 *vcard_extract_vcard,
356 &v, /* user data ptr - put the vcard here */
360 if (v == NULL) return(0); /* no vCards were found in this message */
362 /* If users cannot create their own accounts, they cannot re-register either. */
363 if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
367 s = vcard_get_prop(v, "fn", 1, 0, 0);
368 if (s) CtdlLogPrintf(CTDL_DEBUG, "vCard beforesave hook running for <%s>\n", s);
370 if (yes_my_citadel_config) {
371 /* Bingo! The user is uploading a new vCard, so
372 * delete the old one. First, figure out which user
373 * is being re-registered...
375 what_user = atol(CC->room.QRname);
377 if (what_user == CC->user.usernum) {
378 /* It's the logged in user. That was easy. */
379 memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
382 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
383 /* We fetched a valid user record */
387 /* somebody set up us the bomb! */
388 yes_my_citadel_config = 0;
392 if (yes_my_citadel_config) {
393 /* Delete the user's old vCard. This would probably
394 * get taken care of by the replication check, but we
395 * want to make sure there is absolutely only one
396 * vCard in the user's config room at all times.
399 CtdlDeleteMessages(CC->room.QRname, NULL, 0, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
401 /* Make the author of the message the name of the user. */
402 if (msg->cm_fields['A'] != NULL) {
403 free(msg->cm_fields['A']);
405 msg->cm_fields['A'] = strdup(usbuf.fullname);
408 /* Insert or replace RFC2739-compliant free/busy URL */
409 if (yes_my_citadel_config) {
410 sprintf(buf, "http://%s/%s.vfb",
413 for (i=0; buf[i]; ++i) {
414 if (buf[i] == ' ') buf[i] = '_';
416 vcard_set_prop(v, "FBURL;PREF", buf, 0);
419 /* If the vCard has no UID, then give it one. */
420 s = vcard_get_prop(v, "UID", 1, 0, 0);
423 vcard_set_prop(v, "UID", buf, 0);
426 /* Enforce local UID policy if applicable */
427 if (yes_my_citadel_config) {
428 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields['A'], NODENAME);
429 vcard_set_prop(v, "UID", buf, 0);
433 * Set the EUID of the message to the UID of the vCard.
435 if (msg->cm_fields['E'] != NULL)
437 free(msg->cm_fields['E']);
438 msg->cm_fields['E'] = NULL;
440 s = vcard_get_prop(v, "UID", 1, 0, 0);
442 msg->cm_fields['E'] = strdup(s);
443 if (msg->cm_fields['U'] == NULL) {
444 msg->cm_fields['U'] = strdup(s);
449 * Set the Subject to the name in the vCard.
451 s = vcard_get_prop(v, "FN", 1, 0, 0);
453 s = vcard_get_prop(v, "N", 1, 0, 0);
456 if (msg->cm_fields['U'] != NULL) {
457 free(msg->cm_fields['U']);
459 msg->cm_fields['U'] = strdup(s);
462 /* Re-serialize it back into the msg body */
463 ser = vcard_serialize(v);
465 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], strlen(ser) + 1024);
466 sprintf(msg->cm_fields['M'],
467 "Content-type: " VCARD_MIME_TYPE
468 "\r\n\r\n%s\r\n", ser);
472 /* Now allow the save to complete. */
480 * This handler detects whether the user is attempting to save a new
481 * vCard as part of his/her personal configuration, and handles the replace
482 * function accordingly (copy the vCard from the config room to the global
485 int vcard_upload_aftersave(struct CtdlMessage *msg) {
491 int is_MY_UserConf=0;
493 char roomname[ROOMNAMELEN];
495 if (msg->cm_format_type != 4) return(0);
496 if (!CC->logged_in) return(0); /* Only do this if logged in. */
498 /* We're interested in user config rooms only. */
500 if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
501 is_UserConf = 1; /* It's someone's config room */
503 CtdlMailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
504 if (!strcasecmp(CC->room.QRname, roomname)) {
506 is_MY_UserConf = 1; /* It's MY config room */
508 if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
509 is_GAB = 1; /* It's the Global Address Book */
512 if (!is_UserConf && !is_GAB) return(0);
514 ptr = msg->cm_fields['M'];
515 if (ptr == NULL) return(0);
516 while (ptr != NULL) {
518 linelen = strcspn(ptr, "\n");
519 if (linelen == 0) return(0); /* end of headers */
521 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
522 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
524 * Bingo! The user is uploading a new vCard, so
525 * copy it to the Global Address Book room.
528 I = atol(msg->cm_fields['I']);
529 if (I < 0L) return(0);
531 /* Store our Internet return address in memory */
532 if (is_MY_UserConf) {
533 v = vcard_load(msg->cm_fields['M']);
534 extract_inet_email_addrs(CC->cs_inet_email, sizeof CC->cs_inet_email,
535 CC->cs_inet_other_emails, sizeof CC->cs_inet_other_emails,
537 extract_friendly_name(CC->cs_inet_fn, sizeof CC->cs_inet_fn, v);
542 { // This is not the GAB
543 /* Put it in the Global Address Book room... */
544 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
547 /* ...and also in the directory database. */
548 vcard_add_to_directory(I, NULL);
550 /* Some sites want an Aide to be notified when a
551 * user registers or re-registers
552 * But if the user was an Aide or was edited by an Aide then we can
553 * Assume they don't need validating.
555 if (CC->user.axlevel >= AxAideU) {
556 CtdlGetUserLock(&CC->user, CC->curr_user);
557 CC->user.flags |= US_REGIS;
558 CtdlPutUserLock(&CC->user);
564 /* ...which also means we need to flag the user */
565 CtdlGetUserLock(&CC->user, CC->curr_user);
566 CC->user.flags |= (US_REGIS|US_NEEDVALID);
567 CtdlPutUserLock(&CC->user);
572 ptr = strchr((char *)ptr, '\n');
573 if (ptr != NULL) ++ptr;
582 * back end function used for callbacks
584 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
587 msgnum = (long *) userdata;
588 *msgnum = supplied_msgnum;
593 * If this user has a vcard on disk, read it into memory, otherwise allocate
594 * and return an empty vCard.
596 struct vCard *vcard_get_user(struct ctdluser *u) {
597 char hold_rm[ROOMNAMELEN];
598 char config_rm[ROOMNAMELEN];
599 struct CtdlMessage *msg = NULL;
603 strcpy(hold_rm, CC->room.QRname); /* save current room */
604 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
606 if (CtdlGetRoom(&CC->room, config_rm) != 0) {
607 CtdlGetRoom(&CC->room, hold_rm);
611 /* We want the last (and probably only) vcard in this room */
613 CtdlForEachMessage(MSGS_LAST, 1, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
614 NULL, vcard_gu_backend, (void *)&VCmsgnum );
615 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
617 if (VCmsgnum < 0L) return vcard_new();
619 msg = CtdlFetchMessage(VCmsgnum, 1);
620 if (msg == NULL) return vcard_new();
622 v = vcard_load(msg->cm_fields['M']);
623 CtdlFreeMessage(msg);
629 * Store this user's vCard in the appropriate place
632 * Write our config to disk
634 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
637 ser = vcard_serialize(v);
639 ser = strdup("begin:vcard\r\nend:vcard\r\n");
643 /* This handy API function does all the work for us.
644 * NOTE: normally we would want to set that last argument to 1, to
645 * force the system to delete the user's old vCard. But it doesn't
646 * have to, because the vcard_upload_beforesave() hook above
647 * is going to notice what we're trying to do, and delete the old vCard.
649 CtdlWriteObject(USERCONFIGROOM, /* which room */
650 VCARD_MIME_TYPE, /* MIME type */
652 strlen(ser)+1, /* length */
655 0, /* don't delete others of this type */
664 * Old style "enter registration info" command. This function simply honors
665 * the REGI protocol command, translates the entered parameters into a vCard,
666 * and enters the vCard into the user's configuration.
668 void cmd_regi(char *argbuf) {
671 struct vCard *my_vcard;
677 char tmpaddress[SIZ];
678 char tmpcountry[SIZ];
682 if (!(CC->logged_in)) {
683 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
687 /* If users cannot create their own accounts, they cannot re-register either. */
688 if ( (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
689 cprintf("%d Self-service registration is not allowed here.\n",
690 ERROR + HIGHER_ACCESS_REQUIRED);
693 my_vcard = vcard_get_user(&CC->user);
696 strcpy(tmpstate, "");
698 strcpy(tmpcountry, "USA");
700 cprintf("%d Send registration...\n", SEND_LISTING);
702 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
703 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
704 if (a==1) strcpy(tmpaddr, buf);
705 if (a==2) strcpy(tmpcity, buf);
706 if (a==3) strcpy(tmpstate, buf);
708 for (c=0; buf[c]; ++c) {
709 if ((buf[c]>='0') && (buf[c]<='9')) {
716 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
717 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
718 if (a==7) strcpy(tmpcountry, buf);
722 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
723 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
724 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
725 vcard_write_user(&CC->user, my_vcard);
726 vcard_free(my_vcard);
731 * Protocol command to fetch registration info for a user
733 void cmd_greg(char *argbuf)
735 struct ctdluser usbuf;
738 char who[USERNAME_SIZE];
742 extract_token(who, argbuf, 0, '|', sizeof who);
744 if (!(CC->logged_in)) {
745 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
749 if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
751 if ((CC->user.axlevel < AxAideU) && (strcasecmp(who,CC->curr_user))) {
752 cprintf("%d Higher access required.\n",
753 ERROR + HIGHER_ACCESS_REQUIRED);
757 if (CtdlGetUser(&usbuf, who) != 0) {
758 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
762 v = vcard_get_user(&usbuf);
764 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
765 cprintf("%ld\n", usbuf.usernum);
766 cprintf("%s\n", usbuf.password);
767 s = vcard_get_prop(v, "n", 1, 0, 0);
768 cprintf("%s\n", s ? s : " "); /* name */
770 s = vcard_get_prop(v, "adr", 1, 0, 0);
771 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
773 extract_token(buf, adr, 2, ';', sizeof buf);
774 cprintf("%s\n", buf); /* street */
775 extract_token(buf, adr, 3, ';', sizeof buf);
776 cprintf("%s\n", buf); /* city */
777 extract_token(buf, adr, 4, ';', sizeof buf);
778 cprintf("%s\n", buf); /* state */
779 extract_token(buf, adr, 5, ';', sizeof buf);
780 cprintf("%s\n", buf); /* zip */
782 s = vcard_get_prop(v, "tel", 1, 0, 0);
783 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
791 cprintf("%d\n", usbuf.axlevel);
793 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
794 cprintf("%s\n", s ? s : " ");
795 s = vcard_get_prop(v, "adr", 0, 0, 0);
796 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
798 extract_token(buf, adr, 6, ';', sizeof buf);
799 cprintf("%s\n", buf); /* country */
807 * When a user is being created, create his/her vCard.
809 void vcard_newuser(struct ctdluser *usbuf) {
815 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
816 CtdlLogPrintf(CTDL_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
818 /* Create and save the vCard */
820 if (v == NULL) return;
821 vcard_add_prop(v, "fn", usbuf->fullname);
822 vcard_add_prop(v, "n", vname);
823 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
825 #ifdef HAVE_GETPWUID_R
826 /* If using host auth mode, we add an email address based on the login */
827 if (config.c_auth_mode == AUTHMODE_HOST) {
829 char pwd_buffer[SIZ];
831 #ifdef SOLARIS_GETPWUID
832 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
833 #else // SOLARIS_GETPWUID
834 struct passwd *result = NULL;
835 CtdlLogPrintf(CTDL_DEBUG, "Searching for uid %d\n", usbuf->uid);
836 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
837 #endif // HAVE_GETPWUID_R
838 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
839 vcard_add_prop(v, "email;internet", buf);
844 /* Everyone gets an email address based on their display name */
845 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, config.c_fqdn);
846 for (i=0; buf[i]; ++i) {
847 if (buf[i] == ' ') buf[i] = '_';
849 vcard_add_prop(v, "email;internet", buf);
852 vcard_write_user(usbuf, v);
858 * When a user is being deleted, we have to remove his/her vCard.
859 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
860 * field, and the same Exclusive ID as the existing card.
862 void vcard_purge(struct ctdluser *usbuf) {
863 struct CtdlMessage *msg;
866 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
867 if (msg == NULL) return;
868 memset(msg, 0, sizeof(struct CtdlMessage));
870 msg->cm_magic = CTDLMESSAGE_MAGIC;
871 msg->cm_anon_type = MES_NORMAL;
872 msg->cm_format_type = 0;
873 msg->cm_fields['A'] = strdup(usbuf->fullname);
874 msg->cm_fields['O'] = strdup(ADDRESS_BOOK_ROOM);
875 msg->cm_fields['N'] = strdup(NODENAME);
876 msg->cm_fields['M'] = strdup("Purge this vCard\n");
878 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
879 msg->cm_fields['A'], NODENAME);
880 msg->cm_fields['E'] = strdup(buf);
882 msg->cm_fields['S'] = strdup("CANCEL");
884 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
885 CtdlFreeMessage(msg);
890 * Grab vCard directory stuff out of incoming network messages
892 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
896 if (msg == NULL) return(0);
898 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
902 if (msg->cm_format_type != 4) return(0);
904 ptr = msg->cm_fields['M'];
905 if (ptr == NULL) return(0);
906 while (ptr != NULL) {
908 linelen = strcspn(ptr, "\n");
909 if (linelen == 0) return(0); /* end of headers */
911 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
912 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
913 /* It's a vCard. Add it to the directory. */
914 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
918 ptr = strchr((char *)ptr, '\n');
919 if (ptr != NULL) ++ptr;
928 * When a vCard is being removed from the Global Address Book room, remove it
929 * from the directory as well.
931 void vcard_delete_remove(char *room, long msgnum) {
932 struct CtdlMessage *msg;
936 if (msgnum <= 0L) return;
938 if (room == NULL) return;
940 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
944 msg = CtdlFetchMessage(msgnum, 1);
945 if (msg == NULL) return;
947 ptr = msg->cm_fields['M'];
948 if (ptr == NULL) goto EOH;
949 while (ptr != NULL) {
950 linelen = strcspn(ptr, "\n");
951 if (linelen == 0) goto EOH;
953 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
954 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
955 /* Bingo! A vCard is being deleted. */
956 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
958 ptr = strchr((char *)ptr, '\n');
959 if (ptr != NULL) ++ptr;
962 EOH: CtdlFreeMessage(msg);
968 * Get Valid Screen Names
970 void cmd_gvsn(char *argbuf)
972 if (CtdlAccessCheck(ac_logged_in)) return;
974 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
975 cprintf("%s\n", CC->user.fullname);
976 if ( (!IsEmptyStr(CC->cs_inet_fn)) && (strcasecmp(CC->user.fullname, CC->cs_inet_fn)) ) {
977 cprintf("%s\n", CC->cs_inet_fn);
984 * Get Valid Email Addresses
986 void cmd_gvea(char *argbuf)
988 int num_secondary_emails = 0;
992 if (CtdlAccessCheck(ac_logged_in)) return;
994 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
995 if (!IsEmptyStr(CC->cs_inet_email)) {
996 cprintf("%s\n", CC->cs_inet_email);
998 if (!IsEmptyStr(CC->cs_inet_other_emails)) {
999 num_secondary_emails = num_tokens(CC->cs_inet_other_emails, '|');
1000 for (i=0; i<num_secondary_emails; ++i) {
1001 extract_token(buf, CC->cs_inet_other_emails,i,'|',sizeof CC->cs_inet_other_emails);
1002 cprintf("%s\n", buf);
1012 * Callback function for cmd_dvca() that hunts for vCard content types
1013 * and outputs any email addresses found within.
1015 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1016 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1017 char *cbid, void *cbuserdata) {
1020 char displayname[256];
1021 int displayname_len;
1022 char emailaddr[256];
1026 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1030 v = vcard_load(content);
1031 if (v == NULL) return;
1033 extract_friendly_name(displayname, sizeof displayname, v);
1034 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1036 displayname_len = strlen(displayname);
1037 for (i=0; i<displayname_len; ++i) {
1038 if (displayname[i] == '\"') displayname[i] = ' ';
1039 if (displayname[i] == ';') displayname[i] = ',';
1040 if (displayname[i] == ',') has_commas = 1;
1042 striplt(displayname);
1044 cprintf("%s%s%s <%s>\n",
1045 (has_commas ? "\"" : ""),
1047 (has_commas ? "\"" : ""),
1056 * Back end callback function for cmd_dvca()
1058 * It's basically just passed a list of message numbers, which we're going
1059 * to fetch off the disk and then pass along to the MIME parser via another
1060 * layer of callback...
1062 void dvca_callback(long msgnum, void *userdata) {
1063 struct CtdlMessage *msg = NULL;
1065 msg = CtdlFetchMessage(msgnum, 1);
1066 if (msg == NULL) return;
1067 mime_parser(msg->cm_fields['M'],
1069 *dvca_mime_callback, /* callback function */
1071 NULL, /* user data */
1074 CtdlFreeMessage(msg);
1079 * Dump VCard Addresses
1081 void cmd_dvca(char *argbuf)
1083 if (CtdlAccessCheck(ac_logged_in)) return;
1085 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1086 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1094 void cmd_qdir(char *argbuf) {
1095 char citadel_addr[256];
1096 char internet_addr[256];
1098 if (CtdlAccessCheck(ac_logged_in)) return;
1100 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1102 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1103 cprintf("%d %s was not found.\n",
1104 ERROR + NO_SUCH_USER, internet_addr);
1108 cprintf("%d %s\n", CIT_OK, citadel_addr);
1112 * Query Directory, in fact an alias to match postfix tcp auth.
1114 void check_get(void) {
1115 char internet_addr[256];
1120 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1121 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1122 CtdlLogPrintf(CTDL_CRIT, "Client disconnected: ending session.\n");
1126 CtdlLogPrintf(CTDL_INFO, ": %s\n", cmdbuf);
1127 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1129 if (strcasecmp(cmdbuf, "GET "));
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);
1152 if (rcpt != NULL) free_recipients(rcpt);
1156 void check_get_greeting(void) {
1157 /* dummy function, we have no greeting in this verry simple protocol. */
1162 * We don't know if the Contacts room exists so we just create it at login
1164 void vcard_CtdlCreateRoom(void)
1169 /* Create the calendar room if it doesn't already exist */
1170 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1172 /* Set expiration policy to manual; otherwise objects will be lost! */
1173 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1174 CtdlLogPrintf(CTDL_ERR, "Couldn't get the user CONTACTS room!\n");
1177 qr.QRep.expire_mode = EXPIRE_MANUAL;
1178 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1179 CtdlPutRoomLock(&qr);
1181 /* Set the view to a calendar view */
1182 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1183 vbuf.v_view = 2; /* 2 = address book view */
1184 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1193 * When a user logs in...
1195 void vcard_session_login_hook(void) {
1196 struct vCard *v = NULL;
1197 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1201 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1202 * into the user's vCard.
1204 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
1205 v = vcard_get_user(&CCC->user);
1207 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1208 vcard_write_user(&CCC->user, v);
1215 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1216 * These are inserted into the session data for various message entry commands to use.
1218 v = vcard_get_user(&CCC->user);
1220 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1221 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1224 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1229 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1231 vcard_CtdlCreateRoom();
1236 * Turn an arbitrary RFC822 address into a struct vCard for possible
1237 * inclusion into an address book.
1239 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1241 char user[256], node[256], name[256], email[256], n[256], uid[256];
1245 if (v == NULL) return(NULL);
1247 process_rfc822_addr(addr, user, node, name);
1248 vcard_set_prop(v, "fn", name, 0);
1250 vcard_fn_to_n(n, name, sizeof n);
1251 vcard_set_prop(v, "n", n, 0);
1253 snprintf(email, sizeof email, "%s@%s", user, node);
1254 vcard_set_prop(v, "email;internet", email, 0);
1256 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1257 for (i=0; uid[i]; ++i) {
1258 if (isspace(uid[i])) uid[i] = '_';
1259 uid[i] = tolower(uid[i]);
1261 vcard_set_prop(v, "UID", uid, 0);
1269 * This is called by store_harvested_addresses() to remove from the
1270 * list any addresses we already have in our address book.
1272 void strip_addresses_already_have(long msgnum, void *userdata) {
1273 char *collected_addresses;
1274 struct CtdlMessage *msg = NULL;
1278 char addr[256], user[256], node[256], name[256];
1280 collected_addresses = (char *)userdata;
1282 msg = CtdlFetchMessage(msgnum, 1);
1283 if (msg == NULL) return;
1284 v = vcard_load(msg->cm_fields['M']);
1285 CtdlFreeMessage(msg);
1288 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1290 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1291 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1293 /* Remove the address if we already have it! */
1294 process_rfc822_addr(addr, user, node, name);
1295 snprintf(addr, sizeof addr, "%s@%s", user, node);
1296 if (!strcasecmp(value, addr)) {
1297 remove_token(collected_addresses, j, ',');
1309 * Back end function for store_harvested_addresses()
1311 void store_this_ha(struct addresses_to_be_filed *aptr) {
1312 struct CtdlMessage *vmsg = NULL;
1313 long vmsgnum = (-1L);
1315 struct vCard *v = NULL;
1316 char recipient[256];
1319 /* First remove any addresses we already have in the address book */
1320 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
1321 CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1322 strip_addresses_already_have, aptr->collected_addresses);
1324 if (!IsEmptyStr(aptr->collected_addresses))
1325 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1327 /* Make a vCard out of each address */
1328 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1330 v = vcard_new_from_rfc822_addr(recipient);
1332 vmsg = malloc(sizeof(struct CtdlMessage));
1333 memset(vmsg, 0, sizeof(struct CtdlMessage));
1334 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1335 vmsg->cm_anon_type = MES_NORMAL;
1336 vmsg->cm_format_type = FMT_RFC822;
1337 vmsg->cm_fields['A'] = strdup("Citadel");
1338 vmsg->cm_fields['E'] = strdup(vcard_get_prop(v, "UID", 1, 0, 0));
1339 ser = vcard_serialize(v);
1341 vmsg->cm_fields['M'] = malloc(strlen(ser) + 1024);
1342 sprintf(vmsg->cm_fields['M'],
1343 "Content-type: " VCARD_MIME_TYPE
1344 "\r\n\r\n%s\r\n", ser);
1349 CtdlLogPrintf(CTDL_DEBUG, "Adding contact: %s\n", recipient);
1350 vmsgnum = CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1351 CtdlFreeMessage(vmsg);
1355 free(aptr->roomname);
1356 free(aptr->collected_addresses);
1362 * When a user sends a message, we may harvest one or more email addresses
1363 * from the recipient list to be added to the user's address book. But we
1364 * want to do this asynchronously so it doesn't keep the user waiting.
1366 void store_harvested_addresses(void) {
1368 struct addresses_to_be_filed *aptr = NULL;
1370 if (atbf == NULL) return;
1372 begin_critical_section(S_ATBF);
1373 while (atbf != NULL) {
1376 end_critical_section(S_ATBF);
1377 store_this_ha(aptr);
1378 begin_critical_section(S_ATBF);
1380 end_critical_section(S_ATBF);
1385 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1386 * really this is just so we expose the vCard data to the full text indexer.
1388 void vcard_fixed_output(char *ptr, int len) {
1389 char *serialized_vcard;
1394 serialized_vcard = malloc(len + 1);
1395 safestrncpy(serialized_vcard, ptr, len+1);
1396 v = vcard_load(serialized_vcard);
1397 free(serialized_vcard);
1400 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1401 value = vcard_get_prop(v, "", 0, i++, 0);
1402 cprintf("%s\n", value);
1409 const char *CitadelServiceDICT_TCP="DICT_TCP";
1411 CTDL_MODULE_INIT(vcard)
1420 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN);
1421 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1422 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1423 CtdlRegisterDeleteHook(vcard_delete_remove);
1424 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1425 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1426 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1427 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1428 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1429 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1430 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1431 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1432 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1433 CtdlRegisterNetprocHook(vcard_extract_from_network);
1434 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER);
1435 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1436 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1438 /* Create the Global ADdress Book room if necessary */
1439 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1441 /* Set expiration policy to manual; otherwise objects will be lost! */
1442 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1443 qr.QRep.expire_mode = EXPIRE_MANUAL;
1444 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1445 CtdlPutRoomLock(&qr);
1448 * Also make sure it has a netconfig file, so the networker runs
1449 * on this room even if we don't share it with any other nodes.
1450 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1453 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1454 fp = fopen(filename, "a");
1455 if (fp != NULL) fclose(fp);
1456 rv = chown(filename, CTDLUID, (-1));
1459 /* for postfix tcpdict */
1460 CtdlRegisterServiceHook(config.c_pftcpdict_port, /* Postfix */
1465 CitadelServiceDICT_TCP);
1468 /* return our Subversion id for the Log */