2 * A server-side module for Citadel which supports address book information
3 * using the standard vCard format.
5 * Copyright (c) 1999-2015 by the citadel.org team
7 * This program is open source software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 3.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 * Format of the "Exclusive ID" field of the message containing a user's
18 * vCard. Doesn't matter what it really looks like as long as it's both
19 * unique and consistent (because we use it for replication checking to
20 * delete the old vCard network-wide when the user enters a new one).
22 #define VCARD_EXT_FORMAT "Citadel vCard: personal card for %s at %s"
25 * Citadel will accept either text/vcard or text/x-vcard as the MIME type
26 * for a vCard. The following definition determines which one it *generates*
29 #define VCARD_MIME_TYPE "text/x-vcard"
40 #include <sys/types.h>
42 #if TIME_WITH_SYS_TIME
43 # include <sys/time.h>
47 # include <sys/time.h>
56 #include <libcitadel.h>
59 #include "citserver.h"
67 #include "internet_addressing.h"
68 #include "serv_vcard.h"
69 #include "citadel_ldap.h"
70 #include "ctdl_module.h"
73 * set global flag calling for an aide to validate new users
75 void set_mm_valid(void) {
78 begin_critical_section(S_CONTROL);
79 flags = CtdlGetConfigInt("MMflags");
80 flags = flags | MM_VALID ;
81 CtdlSetConfigInt("MMflags", flags);
82 end_critical_section(S_CONTROL);
88 * Extract Internet e-mail addresses from a message containing a vCard, and
89 * perform a callback for any found.
91 void vcard_extract_internet_addresses(struct CtdlMessage *msg, int (*callback)(char *, char *) ) {
96 char citadel_address[SIZ];
98 int found_something = 0;
100 if (CM_IsEmpty(msg, eAuthor)) return;
101 if (CM_IsEmpty(msg, eNodeName)) return;
102 snprintf(citadel_address, sizeof citadel_address, "%s @ %s",
103 msg->cm_fields[eAuthor], msg->cm_fields[eNodeName]);
105 v = vcard_load(msg->cm_fields[eMesageText]);
106 if (v == NULL) return;
108 /* Go through the vCard searching for *all* instances of
109 * the "email;internet" key
112 s = vcard_get_prop(v, "email", 1, instance, 0); /* get any 'email' field */
113 k = vcard_get_prop(v, "email", 1, instance++, 1); /* but also learn it with attrs */
114 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
117 if (!IsEmptyStr(addr)) {
118 if (callback != NULL) {
119 callback(addr, citadel_address);
128 } while(found_something);
135 * Callback for vcard_add_to_directory()
136 * (Lotsa ugly nested callbacks. Oh well.)
138 int vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
139 struct CitContext *CCC = CC;
142 /* We have to validate that we're not stepping on someone else's
143 * email address ... but only if we're logged in. Otherwise it's
144 * probably just the networker or something.
146 if (CCC->logged_in) {
147 syslog(LOG_DEBUG, "Checking for <%s>...", internet_addr);
148 if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
149 if (strcasecmp(buf, citadel_addr)) {
150 /* This address belongs to someone else.
151 * Bail out silently without saving.
153 syslog(LOG_DEBUG, "DOOP!");
155 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ALREADY_EXISTS);
156 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
157 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
158 StrBufAppendBufPlain(CCC->StatusMessage, _("Unable to add this email address again."), -1, 0);
159 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("\n"), 0);
164 syslog(LOG_INFO, "Adding %s (%s) to directory", citadel_addr, internet_addr);
165 if (CtdlDirectoryAddUser(internet_addr, citadel_addr))
167 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", CIT_OK);
168 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
169 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
170 StrBufAppendBufPlain(CCC->StatusMessage, _("Successfully added email address."), -1, 0);
175 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
176 StrBufAppendBufPlain(CCC->StatusMessage, internet_addr, -1, 0);
177 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
178 StrBufAppendBufPlain(CCC->StatusMessage, _("Unable to add this email address. It does not match any local domain."), -1, 0);
185 * Back end function for cmd_igab()
187 void vcard_add_to_directory(long msgnum, void *data) {
188 struct CtdlMessage *msg;
190 msg = CtdlFetchMessage(msgnum, 1, 1);
192 vcard_extract_internet_addresses(msg, vcard_directory_add_user);
200 * Initialize Global Adress Book
202 void cmd_igab(char *argbuf) {
203 char hold_rm[ROOMNAMELEN];
205 if (CtdlAccessCheck(ac_aide)) return;
207 strcpy(hold_rm, CC->room.QRname); /* save current room */
209 if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
210 CtdlGetRoom(&CC->room, hold_rm);
211 cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
215 /* Empty the existing database first.
219 /* We want *all* vCards in this room */
220 NewStrBufDupAppendFlush(&CC->StatusMessage, NULL, NULL, 0);
221 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
222 NULL, vcard_add_to_directory, NULL);
224 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
225 cprintf("%d Directory has been rebuilt.\n", CIT_OK);
232 * See if there is a valid Internet address in a vCard to use for outbound
233 * Internet messages. If there is, stick it in the buffer.
235 void extract_inet_email_addrs(char *emailaddrbuf, size_t emailaddrbuf_len,
236 char *secemailaddrbuf, size_t secemailaddrbuf_len,
238 int local_addrs_only)
240 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
243 int IsDirectoryAddress;
244 int saved_instance = 0;
246 /* Go through the vCard searching for *all* Internet email addresses
248 while (s = vcard_get_prop(v, "email", 1, instance, 0), s != NULL) {
249 k = vcard_get_prop(v, "email", 1, instance, 1);
250 if ( (s != NULL) && (k != NULL) && (bmstrcasestr(k, "internet")) ) {
253 if (!IsEmptyStr(addr)) {
254 IsDirectoryAddress = IsDirectory(addr, 1);
255 if ( IsDirectoryAddress || !local_addrs_only)
258 if ((saved_instance == 1) && (emailaddrbuf != NULL)) {
259 safestrncpy(emailaddrbuf, addr, emailaddrbuf_len);
261 else if ((saved_instance == 2) && (secemailaddrbuf != NULL)) {
262 safestrncpy(secemailaddrbuf, addr, secemailaddrbuf_len);
264 else if ((saved_instance > 2) && (secemailaddrbuf != NULL)) {
265 if ( (strlen(addr) + strlen(secemailaddrbuf) + 2)
266 < secemailaddrbuf_len ) {
267 strcat(secemailaddrbuf, "|");
268 strcat(secemailaddrbuf, addr);
272 if (!IsDirectoryAddress && local_addrs_only)
274 StrBufAppendPrintf(CCC->StatusMessage, "\n%d|", ERROR+ ILLEGAL_VALUE);
275 StrBufAppendBufPlain(CCC->StatusMessage, addr, -1, 0);
276 StrBufAppendBufPlain(CCC->StatusMessage, HKEY("|"), 0);
277 StrBufAppendBufPlain(CCC->StatusMessage, _("unable to add this emailaddress; its not matching our domain."), -1, 0);
289 * See if there is a name / screen name / friendly name in a vCard to use for outbound
290 * Internet messages. If there is, stick it in the buffer.
292 void extract_friendly_name(char *namebuf, size_t namebuf_len, struct vCard *v)
296 s = vcard_get_prop(v, "fn", 1, 0, 0);
298 s = vcard_get_prop(v, "n", 1, 0, 0);
302 safestrncpy(namebuf, s, namebuf_len);
308 * Callback function for vcard_upload_beforesave() hunts for the real vcard in the MIME structure
310 void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
311 void *content, char *cbtype, char *cbcharset, size_t length,
312 char *encoding, char *cbid, void *cbuserdata)
314 struct vCard **v = (struct vCard **) cbuserdata;
316 if ( (!strcasecmp(cbtype, "text/x-vcard"))
317 || (!strcasecmp(cbtype, "text/vcard")) ) {
319 syslog(LOG_DEBUG, "Part %s contains a vCard! Loading...", partnum);
323 *v = vcard_load(content);
329 * This handler detects whether the user is attempting to save a new
330 * vCard as part of his/her personal configuration, and handles the replace
331 * function accordingly (delete the user's existing vCard in the config room
332 * and in the global address book).
334 int vcard_upload_beforesave(struct CtdlMessage *msg, recptypes *recp) {
335 struct CitContext *CCC = CC;
338 struct ctdluser usbuf;
340 struct vCard *v = NULL;
343 int yes_my_citadel_config = 0;
344 int yes_any_vcard_room = 0;
346 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
348 /* Is this some user's "My Citadel Config" room? */
349 if (((CCC->room.QRflags & QR_MAILBOX) != 0) &&
350 (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
351 /* Yes, we want to do this */
352 yes_my_citadel_config = 1;
353 #ifdef VCARD_SAVES_BY_AIDES_ONLY
354 /* Prevent non-aides from performing registration changes, but ldap is ok. */
355 if ((CCC->user.axlevel < AxAideU) && (CCC->vcard_updated_by_ldap==0)) {
362 /* Is this a room with an address book in it? */
363 if (CCC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
364 yes_any_vcard_room = 1;
367 /* If neither condition exists, don't run this hook. */
368 if ( (!yes_my_citadel_config) && (!yes_any_vcard_room) ) {
372 /* If this isn't a MIME message, don't bother. */
373 if (msg->cm_format_type != 4) return(0);
375 /* Ok, if we got this far, look into the situation further... */
377 if (CM_IsEmpty(msg, eMesageText)) return(0);
379 mime_parser(CM_RANGE(msg, eMesageText),
380 *vcard_extract_vcard,
382 &v, /* user data ptr - put the vcard here */
386 if (v == NULL) return(0); /* no vCards were found in this message */
388 /* If users cannot create their own accounts, they cannot re-register either. */
389 if ( (yes_my_citadel_config) &&
390 (CtdlGetConfigInt("c_disable_newu")) &&
391 (CCC->user.axlevel < AxAideU) &&
392 (CCC->vcard_updated_by_ldap==0) )
397 vcard_get_prop(v, "fn", 1, 0, 0);
400 if (yes_my_citadel_config) {
401 /* Bingo! The user is uploading a new vCard, so
402 * delete the old one. First, figure out which user
403 * is being re-registered...
405 what_user = atol(CCC->room.QRname);
407 if (what_user == CCC->user.usernum) {
408 /* It's the logged in user. That was easy. */
409 memcpy(&usbuf, &CCC->user, sizeof(struct ctdluser));
412 else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
413 /* We fetched a valid user record */
417 /* somebody set up us the bomb! */
418 yes_my_citadel_config = 0;
422 if (yes_my_citadel_config) {
423 /* Delete the user's old vCard. This would probably
424 * get taken care of by the replication check, but we
425 * want to make sure there is absolutely only one
426 * vCard in the user's config room at all times.
429 CtdlDeleteMessages(CCC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
431 /* Make the author of the message the name of the user. */
432 CM_SetField(msg, eAuthor, usbuf.fullname, strlen(usbuf.fullname));
435 /* Insert or replace RFC2739-compliant free/busy URL */
436 if (yes_my_citadel_config) {
437 sprintf(buf, "http://%s/%s.vfb",
438 CtdlGetConfigStr("c_fqdn"),
440 for (i=0; buf[i]; ++i) {
441 if (buf[i] == ' ') buf[i] = '_';
443 vcard_set_prop(v, "FBURL;PREF", buf, 0);
447 s = vcard_get_prop(v, "UID", 1, 0, 0);
448 if (s == NULL) { /* Note LDAP auth sets UID from the LDAP UUID, use that if it exists. */
449 /* Enforce local UID policy if applicable */
450 if (yes_my_citadel_config) {
451 snprintf(buf, sizeof buf, VCARD_EXT_FORMAT, msg->cm_fields[eAuthor], NODENAME);
453 /* If the vCard has no UID, then give it one. */
456 vcard_set_prop(v, "UID", buf, 0);
461 * Set the EUID of the message to the UID of the vCard.
463 CM_FlushField(msg, eExclusiveID);
465 s = vcard_get_prop(v, "UID", 1, 0, 0);
467 CM_SetField(msg, eExclusiveID, s, strlen(s));
468 if (CM_IsEmpty(msg, eMsgSubject)) {
469 CM_CopyField(msg, eMsgSubject, eExclusiveID);
474 * Set the Subject to the name in the vCard.
476 s = vcard_get_prop(v, "FN", 1, 0, 0);
478 s = vcard_get_prop(v, "N", 1, 0, 0);
481 CM_SetField(msg, eMsgSubject, s, strlen(s));
484 /* Re-serialize it back into the msg body */
485 ser = vcard_serialize(v);
490 serlen = strlen(ser);
491 buf = NewStrBufPlain(NULL, serlen + 1024);
493 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
494 StrBufAppendBufPlain(buf, ser, serlen, 0);
495 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
496 CM_SetAsFieldSB(msg, eMesageText, &buf);
500 /* Now allow the save to complete. */
508 * This handler detects whether the user is attempting to save a new
509 * vCard as part of his/her personal configuration, and handles the replace
510 * function accordingly (copy the vCard from the config room to the global
513 int vcard_upload_aftersave(struct CtdlMessage *msg, recptypes *recp) {
514 struct CitContext *CCC = CC;
520 int is_MY_UserConf=0;
522 char roomname[ROOMNAMELEN];
524 if (msg->cm_format_type != 4) return(0);
525 if ((!CCC->logged_in) && (CCC->vcard_updated_by_ldap==0)) return(0); /* Only do this if logged in, or if ldap changed the vcard. */
527 /* We're interested in user config rooms only. */
529 if ( (strlen(CCC->room.QRname) >= 12) && (!strcasecmp(&CCC->room.QRname[11], USERCONFIGROOM)) ) {
530 is_UserConf = 1; /* It's someone's config room */
532 CtdlMailboxName(roomname, sizeof roomname, &CCC->user, USERCONFIGROOM);
533 if (!strcasecmp(CCC->room.QRname, roomname)) {
535 is_MY_UserConf = 1; /* It's MY config room */
537 if (!strcasecmp(CCC->room.QRname, ADDRESS_BOOK_ROOM)) {
538 is_GAB = 1; /* It's the Global Address Book */
541 if (!is_UserConf && !is_GAB) return(0);
543 if (CM_IsEmpty(msg, eMesageText))
546 ptr = msg->cm_fields[eMesageText];
548 CCC->vcard_updated_by_ldap=0; /* As this will write LDAP's previous changes, disallow LDAP change auth until next LDAP change. */
550 NewStrBufDupAppendFlush(&CCC->StatusMessage, NULL, NULL, 0);
552 StrBufPrintf(CCC->StatusMessage, "%d\n", LISTING_FOLLOWS);
554 while (ptr != NULL) {
556 linelen = strcspn(ptr, "\n");
557 if (linelen == 0) return(0); /* end of headers */
559 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
560 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
562 * Bingo! The user is uploading a new vCard, so
563 * copy it to the Global Address Book room.
566 I = atol(msg->cm_fields[eVltMsgNum]);
567 if (I <= 0L) return(0);
569 /* Store our Internet return address in memory */
570 if (is_MY_UserConf) {
571 v = vcard_load(msg->cm_fields[eMesageText]);
572 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
573 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
575 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
580 { // This is not the GAB
581 /* Put it in the Global Address Book room... */
582 CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
585 /* ...and also in the directory database. */
586 vcard_add_to_directory(I, NULL);
588 /* Some sites want an Aide to be notified when a
589 * user registers or re-registers
590 * But if the user was an Aide or was edited by an Aide then we can
591 * Assume they don't need validating.
593 if (CCC->user.axlevel >= AxAideU) {
594 CtdlLockGetCurrentUser();
595 CCC->user.flags |= US_REGIS;
596 CtdlPutCurrentUserLock();
602 /* ...which also means we need to flag the user */
603 CtdlLockGetCurrentUser();
604 CCC->user.flags |= (US_REGIS|US_NEEDVALID);
605 CtdlPutCurrentUserLock();
610 ptr = strchr((char *)ptr, '\n');
611 if (ptr != NULL) ++ptr;
620 * back end function used for callbacks
622 void vcard_gu_backend(long supplied_msgnum, void *userdata) {
625 msgnum = (long *) userdata;
626 *msgnum = supplied_msgnum;
631 * If this user has a vcard on disk, read it into memory, otherwise allocate
632 * and return an empty vCard.
634 struct vCard *vcard_get_user(struct ctdluser *u) {
635 struct CitContext *CCC = CC;
636 char hold_rm[ROOMNAMELEN];
637 char config_rm[ROOMNAMELEN];
638 struct CtdlMessage *msg = NULL;
642 strcpy(hold_rm, CCC->room.QRname); /* save current room */
643 CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
645 if (CtdlGetRoom(&CCC->room, config_rm) != 0) {
646 CtdlGetRoom(&CCC->room, hold_rm);
650 /* We want the last (and probably only) vcard in this room */
652 CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
653 NULL, vcard_gu_backend, (void *)&VCmsgnum );
654 CtdlGetRoom(&CCC->room, hold_rm); /* return to saved room */
656 if (VCmsgnum < 0L) return vcard_new();
658 msg = CtdlFetchMessage(VCmsgnum, 1, 1);
659 if (msg == NULL) return vcard_new();
661 v = vcard_load(msg->cm_fields[eMesageText]);
668 * Store this user's vCard in the appropriate place
671 * Write our config to disk
673 void vcard_write_user(struct ctdluser *u, struct vCard *v) {
676 ser = vcard_serialize(v);
678 ser = strdup("begin:vcard\r\nend:vcard\r\n");
682 /* This handy API function does all the work for us.
683 * NOTE: normally we would want to set that last argument to 1, to
684 * force the system to delete the user's old vCard. But it doesn't
685 * have to, because the vcard_upload_beforesave() hook above
686 * is going to notice what we're trying to do, and delete the old vCard.
688 CtdlWriteObject(USERCONFIGROOM, /* which room */
689 VCARD_MIME_TYPE, /* MIME type */
691 strlen(ser)+1, /* length */
694 0, /* don't delete others of this type */
703 * Old style "enter registration info" command. This function simply honors
704 * the REGI protocol command, translates the entered parameters into a vCard,
705 * and enters the vCard into the user's configuration.
707 void cmd_regi(char *argbuf) {
708 struct CitContext *CCC = CC;
711 struct vCard *my_vcard;
717 char tmpaddress[SIZ];
718 char tmpcountry[SIZ];
722 if (!(CCC->logged_in)) {
723 cprintf("%d Not logged in.\n",ERROR + NOT_LOGGED_IN);
727 /* If users cannot create their own accounts, they cannot re-register either. */
728 if ( (CtdlGetConfigInt("c_disable_newu")) && (CCC->user.axlevel < AxAideU) ) {
729 cprintf("%d Self-service registration is not allowed here.\n",
730 ERROR + HIGHER_ACCESS_REQUIRED);
733 my_vcard = vcard_get_user(&CCC->user);
736 strcpy(tmpstate, "");
738 strcpy(tmpcountry, "USA");
740 cprintf("%d Send registration...\n", SEND_LISTING);
742 while (client_getln(buf, sizeof buf), strcmp(buf,"000")) {
743 if (a==0) vcard_set_prop(my_vcard, "n", buf, 0);
744 if (a==1) strcpy(tmpaddr, buf);
745 if (a==2) strcpy(tmpcity, buf);
746 if (a==3) strcpy(tmpstate, buf);
748 for (c=0; buf[c]; ++c) {
749 if ((buf[c]>='0') && (buf[c]<='9')) {
756 if (a==5) vcard_set_prop(my_vcard, "tel", buf, 0);
757 if (a==6) vcard_set_prop(my_vcard, "email;internet", buf, 0);
758 if (a==7) strcpy(tmpcountry, buf);
762 snprintf(tmpaddress, sizeof tmpaddress, ";;%s;%s;%s;%s;%s",
763 tmpaddr, tmpcity, tmpstate, tmpzip, tmpcountry);
764 vcard_set_prop(my_vcard, "adr", tmpaddress, 0);
765 vcard_write_user(&CCC->user, my_vcard);
766 vcard_free(my_vcard);
771 * Protocol command to fetch registration info for a user
773 void cmd_greg(char *argbuf)
775 struct CitContext *CCC = CC;
776 struct ctdluser usbuf;
779 char who[USERNAME_SIZE];
783 extract_token(who, argbuf, 0, '|', sizeof who);
785 if (!(CCC->logged_in)) {
786 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
790 if (!strcasecmp(who,"_SELF_")) strcpy(who,CCC->curr_user);
792 if ((CCC->user.axlevel < AxAideU) && (strcasecmp(who,CCC->curr_user))) {
793 cprintf("%d Higher access required.\n",
794 ERROR + HIGHER_ACCESS_REQUIRED);
798 if (CtdlGetUser(&usbuf, who) != 0) {
799 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
803 v = vcard_get_user(&usbuf);
805 cprintf("%d %s\n", LISTING_FOLLOWS, usbuf.fullname);
806 cprintf("%ld\n", usbuf.usernum);
807 cprintf("%s\n", usbuf.password);
808 s = vcard_get_prop(v, "n", 1, 0, 0);
809 cprintf("%s\n", s ? s : " "); /* name */
811 s = vcard_get_prop(v, "adr", 1, 0, 0);
812 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
814 extract_token(buf, adr, 2, ';', sizeof buf);
815 cprintf("%s\n", buf); /* street */
816 extract_token(buf, adr, 3, ';', sizeof buf);
817 cprintf("%s\n", buf); /* city */
818 extract_token(buf, adr, 4, ';', sizeof buf);
819 cprintf("%s\n", buf); /* state */
820 extract_token(buf, adr, 5, ';', sizeof buf);
821 cprintf("%s\n", buf); /* zip */
823 s = vcard_get_prop(v, "tel", 1, 0, 0);
824 if (s == NULL) s = vcard_get_prop(v, "tel", 1, 0, 0);
832 cprintf("%d\n", usbuf.axlevel);
834 s = vcard_get_prop(v, "email;internet", 0, 0, 0);
835 cprintf("%s\n", s ? s : " ");
836 s = vcard_get_prop(v, "adr", 0, 0, 0);
837 snprintf(adr, sizeof adr, "%s", s ? s : " ");/* address... */
839 extract_token(buf, adr, 6, ';', sizeof buf);
840 cprintf("%s\n", buf); /* country */
848 * When a user is being created, create his/her vCard.
850 void vcard_newuser(struct ctdluser *usbuf) {
855 int need_default_vcard;
857 need_default_vcard =1;
858 vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
859 syslog(LOG_DEBUG, "Converted <%s> to <%s>", usbuf->fullname, vname);
861 /* Create and save the vCard */
863 if (v == NULL) return;
864 vcard_add_prop(v, "fn", usbuf->fullname);
865 vcard_add_prop(v, "n", vname);
866 vcard_add_prop(v, "adr", "adr:;;_;_;_;00000;__");
868 #ifdef HAVE_GETPWUID_R
869 /* If using host auth mode, we add an email address based on the login */
870 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
872 char pwd_buffer[SIZ];
874 #ifdef SOLARIS_GETPWUID
875 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
876 #else // SOLARIS_GETPWUID
877 struct passwd *result = NULL;
878 syslog(LOG_DEBUG, "Searching for uid %d", usbuf->uid);
879 if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
880 #endif // HAVE_GETPWUID_R
881 snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, CtdlGetConfigStr("c_fqdn"));
882 vcard_add_prop(v, "email;internet", buf);
883 need_default_vcard = 0;
891 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
892 * into the user's vCard.
894 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
899 found_user = CtdlTryUserLDAP(usbuf->fullname, ldap_dn, sizeof ldap_dn, ldap_cn, sizeof ldap_cn, &usbuf->uid,1);
900 if (found_user == 0) {
901 if (Ctdl_LDAP_to_vCard(ldap_dn, v)) {
902 /* Allow global address book and internet directory update without login long enough to write this. */
903 CC->vcard_updated_by_ldap++; /* Otherwise we'll only update the user config. */
904 need_default_vcard = 0;
905 syslog(LOG_DEBUG, "LDAP Created Initial Vcard for %s\n",usbuf->fullname);
910 if (need_default_vcard!=0) {
911 /* Everyone gets an email address based on their display name */
912 snprintf(buf, sizeof buf, "%s@%s", usbuf->fullname, CtdlGetConfigStr("c_fqdn"));
913 for (i=0; buf[i]; ++i) {
914 if (buf[i] == ' ') buf[i] = '_';
916 vcard_add_prop(v, "email;internet", buf);
919 vcard_write_user(usbuf, v);
925 * When a user is being deleted, we have to remove his/her vCard.
926 * This is accomplished by issuing a message with 'CANCEL' in the S (special)
927 * field, and the same Exclusive ID as the existing card.
929 void vcard_purge(struct ctdluser *usbuf) {
930 struct CtdlMessage *msg;
934 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
935 if (msg == NULL) return;
936 memset(msg, 0, sizeof(struct CtdlMessage));
938 msg->cm_magic = CTDLMESSAGE_MAGIC;
939 msg->cm_anon_type = MES_NORMAL;
940 msg->cm_format_type = 0;
941 CM_SetField(msg, eAuthor, usbuf->fullname, strlen(usbuf->fullname));
942 CM_SetField(msg, eOriginalRoom, HKEY(ADDRESS_BOOK_ROOM));
943 CM_SetField(msg, eNodeName, CtdlGetConfigStr("c_nodename"), strlen(CtdlGetConfigStr("c_nodename")));
944 CM_SetField(msg, eMesageText, HKEY("Purge this vCard\n"));
946 len = snprintf(buf, sizeof buf, VCARD_EXT_FORMAT,
947 msg->cm_fields[eAuthor], NODENAME);
948 CM_SetField(msg, eExclusiveID, buf, len);
950 CM_SetField(msg, eSpecialField, HKEY("CANCEL"));
952 CtdlSubmitMsg(msg, NULL, ADDRESS_BOOK_ROOM, QP_EADDR);
958 * Grab vCard directory stuff out of incoming network messages
960 int vcard_extract_from_network(struct CtdlMessage *msg, char *target_room) {
964 if (msg == NULL) return(0);
966 if (strcasecmp(target_room, ADDRESS_BOOK_ROOM)) {
970 if (msg->cm_format_type != 4) return(0);
972 if (CM_IsEmpty(msg, eMesageText))
975 ptr = msg->cm_fields[eMesageText];
977 while (ptr != NULL) {
979 linelen = strcspn(ptr, "\n");
980 if (linelen == 0) return(0); /* end of headers */
982 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
983 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
984 /* It's a vCard. Add it to the directory. */
985 vcard_extract_internet_addresses(msg, CtdlDirectoryAddUser);
989 ptr = strchr((char *)ptr, '\n');
990 if (ptr != NULL) ++ptr;
999 * When a vCard is being removed from the Global Address Book room, remove it
1000 * from the directory as well.
1002 void vcard_delete_remove(char *room, long msgnum) {
1003 struct CtdlMessage *msg;
1007 if (msgnum <= 0L) return;
1009 if (room == NULL) return;
1011 if (strcasecmp(room, ADDRESS_BOOK_ROOM)) {
1015 msg = CtdlFetchMessage(msgnum, 1, 1);
1016 if (msg == NULL) return;
1018 if (CM_IsEmpty(msg, eMesageText))
1021 ptr = msg->cm_fields[eMesageText];
1023 while (ptr != NULL) {
1024 linelen = strcspn(ptr, "\n");
1025 if (linelen == 0) goto EOH;
1027 if ( (!strncasecmp(ptr, "Content-type: text/x-vcard", 26))
1028 || (!strncasecmp(ptr, "Content-type: text/vcard", 24)) ) {
1029 /* Bingo! A vCard is being deleted. */
1030 vcard_extract_internet_addresses(msg, CtdlDirectoryDelUser);
1032 ptr = strchr((char *)ptr, '\n');
1033 if (ptr != NULL) ++ptr;
1042 * Get Valid Screen Names
1044 void cmd_gvsn(char *argbuf)
1046 struct CitContext *CCC = CC;
1048 if (CtdlAccessCheck(ac_logged_in)) return;
1050 cprintf("%d valid screen names:\n", LISTING_FOLLOWS);
1051 cprintf("%s\n", CCC->user.fullname);
1052 if ( (!IsEmptyStr(CCC->cs_inet_fn)) && (strcasecmp(CCC->user.fullname, CCC->cs_inet_fn)) ) {
1053 cprintf("%s\n", CCC->cs_inet_fn);
1060 * Get Valid Email Addresses
1062 void cmd_gvea(char *argbuf)
1064 struct CitContext *CCC = CC;
1065 int num_secondary_emails = 0;
1069 if (CtdlAccessCheck(ac_logged_in)) return;
1071 cprintf("%d valid email addresses:\n", LISTING_FOLLOWS);
1072 if (!IsEmptyStr(CCC->cs_inet_email)) {
1073 cprintf("%s\n", CCC->cs_inet_email);
1075 if (!IsEmptyStr(CCC->cs_inet_other_emails)) {
1076 num_secondary_emails = num_tokens(CCC->cs_inet_other_emails, '|');
1077 for (i=0; i<num_secondary_emails; ++i) {
1078 extract_token(buf, CCC->cs_inet_other_emails,i,'|',sizeof CCC->cs_inet_other_emails);
1079 cprintf("%s\n", buf);
1089 * Callback function for cmd_dvca() that hunts for vCard content types
1090 * and outputs any email addresses found within.
1092 void dvca_mime_callback(char *name, char *filename, char *partnum, char *disp,
1093 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1094 char *cbid, void *cbuserdata) {
1097 char displayname[256] = "";
1098 int displayname_len;
1099 char emailaddr[256] = "";
1103 if ( (strcasecmp(cbtype, "text/vcard")) && (strcasecmp(cbtype, "text/x-vcard")) ) {
1107 v = vcard_load(content);
1108 if (v == NULL) return;
1110 extract_friendly_name(displayname, sizeof displayname, v);
1111 extract_inet_email_addrs(emailaddr, sizeof emailaddr, NULL, 0, v, 0);
1113 displayname_len = strlen(displayname);
1114 for (i=0; i<displayname_len; ++i) {
1115 if (displayname[i] == '\"') displayname[i] = ' ';
1116 if (displayname[i] == ';') displayname[i] = ',';
1117 if (displayname[i] == ',') has_commas = 1;
1119 striplt(displayname);
1121 cprintf("%s%s%s <%s>\n",
1122 (has_commas ? "\"" : ""),
1124 (has_commas ? "\"" : ""),
1133 * Back end callback function for cmd_dvca()
1135 * It's basically just passed a list of message numbers, which we're going
1136 * to fetch off the disk and then pass along to the MIME parser via another
1137 * layer of callback...
1139 void dvca_callback(long msgnum, void *userdata) {
1140 struct CtdlMessage *msg = NULL;
1142 msg = CtdlFetchMessage(msgnum, 1, 1);
1143 if (msg == NULL) return;
1144 mime_parser(CM_RANGE(msg, eMesageText),
1145 *dvca_mime_callback, /* callback function */
1147 NULL, /* user data */
1155 * Dump VCard Addresses
1157 void cmd_dvca(char *argbuf)
1159 if (CtdlAccessCheck(ac_logged_in)) return;
1161 cprintf("%d addresses:\n", LISTING_FOLLOWS);
1162 CtdlForEachMessage(MSGS_ALL, 0, NULL, NULL, NULL, dvca_callback, NULL);
1170 void cmd_qdir(char *argbuf) {
1171 char citadel_addr[256];
1172 char internet_addr[256];
1174 if (CtdlAccessCheck(ac_logged_in)) return;
1176 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1178 if (CtdlDirectoryLookup(citadel_addr, internet_addr, sizeof citadel_addr) != 0) {
1179 cprintf("%d %s was not found.\n",
1180 ERROR + NO_SUCH_USER, internet_addr);
1184 cprintf("%d %s\n", CIT_OK, citadel_addr);
1188 * Query Directory, in fact an alias to match postfix tcp auth.
1190 void check_get(void) {
1191 char internet_addr[256];
1196 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1197 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1198 syslog(LOG_CRIT, "vcard client disconnected: ending session.");
1199 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1202 syslog(LOG_INFO, ": %s", cmdbuf);
1203 while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
1204 syslog(LOG_INFO, "[ %s]", cmdbuf);
1206 if (strncasecmp(cmdbuf, "GET ", 4)==0)
1209 char *argbuf = &cmdbuf[4];
1211 extract_token(internet_addr, argbuf, 0, '|', sizeof internet_addr);
1212 rcpt = validate_recipients(internet_addr, NULL, CHECK_EXISTANCE);
1213 if ((rcpt != NULL)&&
1215 (*rcpt->recp_local != '\0')||
1216 (*rcpt->recp_room != '\0')||
1217 (*rcpt->recp_ignet != '\0')))
1220 cprintf("200 OK %s\n", internet_addr);
1221 syslog(LOG_INFO, "sending 200 OK for the room %s", rcpt->display_recp);
1225 cprintf("500 REJECT noone here by that name.\n");
1227 syslog(LOG_INFO, "sending 500 REJECT no one here by that name: %s", internet_addr);
1230 free_recipients(rcpt);
1233 cprintf("500 REJECT invalid Query.\n");
1234 syslog(LOG_INFO, "sending 500 REJECT invalid query: %s", internet_addr);
1238 void check_get_greeting(void) {
1239 /* dummy function, we have no greeting in this verry simple protocol. */
1244 * We don't know if the Contacts room exists so we just create it at login
1246 void vcard_CtdlCreateRoom(void)
1251 /* Create the calendar room if it doesn't already exist */
1252 CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1254 /* Set expiration policy to manual; otherwise objects will be lost! */
1255 if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
1256 syslog(LOG_ERR, "Couldn't get the user CONTACTS room!");
1259 qr.QRep.expire_mode = EXPIRE_MANUAL;
1260 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1261 CtdlPutRoomLock(&qr);
1263 /* Set the view to a calendar view */
1264 CtdlGetRelationship(&vbuf, &CC->user, &qr);
1265 vbuf.v_view = 2; /* 2 = address book view */
1266 CtdlSetRelationship(&vbuf, &CC->user, &qr);
1275 * When a user logs in...
1277 void vcard_session_login_hook(void) {
1278 struct vCard *v = NULL;
1279 struct CitContext *CCC = CC; /* put this on the stack, just for speed */
1283 * Is this an LDAP session? If so, copy various LDAP attributes from the directory entry
1284 * into the user's vCard.
1286 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
1287 v = vcard_get_user(&CCC->user);
1289 if (Ctdl_LDAP_to_vCard(CCC->ldap_dn, v)) {
1290 CCC->vcard_updated_by_ldap++; /* Make sure changes make it to the global address book and internet directory, not just the user config. */
1291 syslog(LOG_DEBUG, "LDAP Detected vcard change.\n");
1292 vcard_write_user(&CCC->user, v);
1299 * Extract from the user's vCard, any Internet email addresses and the user's real name.
1300 * These are inserted into the session data for various message entry commands to use.
1302 v = vcard_get_user(&CCC->user);
1304 extract_inet_email_addrs(CCC->cs_inet_email, sizeof CCC->cs_inet_email,
1305 CCC->cs_inet_other_emails, sizeof CCC->cs_inet_other_emails,
1308 extract_friendly_name(CCC->cs_inet_fn, sizeof CCC->cs_inet_fn, v);
1313 * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
1315 vcard_CtdlCreateRoom();
1320 * Turn an arbitrary RFC822 address into a struct vCard for possible
1321 * inclusion into an address book.
1323 struct vCard *vcard_new_from_rfc822_addr(char *addr) {
1325 char user[256], node[256], name[256], email[256], n[256], uid[256];
1329 if (v == NULL) return(NULL);
1331 process_rfc822_addr(addr, user, node, name);
1332 vcard_set_prop(v, "fn", name, 0);
1334 vcard_fn_to_n(n, name, sizeof n);
1335 vcard_set_prop(v, "n", n, 0);
1337 snprintf(email, sizeof email, "%s@%s", user, node);
1338 vcard_set_prop(v, "email;internet", email, 0);
1340 snprintf(uid, sizeof uid, "collected: %s %s@%s", name, user, node);
1341 for (i=0; uid[i]; ++i) {
1342 if (isspace(uid[i])) uid[i] = '_';
1343 uid[i] = tolower(uid[i]);
1345 vcard_set_prop(v, "UID", uid, 0);
1353 * This is called by store_harvested_addresses() to remove from the
1354 * list any addresses we already have in our address book.
1356 void strip_addresses_already_have(long msgnum, void *userdata) {
1357 char *collected_addresses;
1358 struct CtdlMessage *msg = NULL;
1362 char addr[256], user[256], node[256], name[256];
1364 collected_addresses = (char *)userdata;
1366 msg = CtdlFetchMessage(msgnum, 1, 1);
1367 if (msg == NULL) return;
1368 v = vcard_load(msg->cm_fields[eMesageText]);
1372 while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
1374 for (j=0; j<num_tokens(collected_addresses, ','); ++j) {
1375 extract_token(addr, collected_addresses, j, ',', sizeof addr);
1377 /* Remove the address if we already have it! */
1378 process_rfc822_addr(addr, user, node, name);
1379 snprintf(addr, sizeof addr, "%s@%s", user, node);
1380 if (!strcasecmp(value, addr)) {
1381 remove_token(collected_addresses, j, ',');
1393 * Back end function for store_harvested_addresses()
1395 void store_this_ha(struct addresses_to_be_filed *aptr) {
1396 struct CtdlMessage *vmsg = NULL;
1398 struct vCard *v = NULL;
1399 char recipient[256];
1402 /* First remove any addresses we already have in the address book */
1403 CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL, NULL, NULL);
1404 CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
1405 strip_addresses_already_have, aptr->collected_addresses);
1407 if (!IsEmptyStr(aptr->collected_addresses))
1408 for (i=0; i<num_tokens(aptr->collected_addresses, ','); ++i) {
1410 /* Make a vCard out of each address */
1411 extract_token(recipient, aptr->collected_addresses, i, ',', sizeof recipient);
1413 v = vcard_new_from_rfc822_addr(recipient);
1416 vmsg = malloc(sizeof(struct CtdlMessage));
1417 memset(vmsg, 0, sizeof(struct CtdlMessage));
1418 vmsg->cm_magic = CTDLMESSAGE_MAGIC;
1419 vmsg->cm_anon_type = MES_NORMAL;
1420 vmsg->cm_format_type = FMT_RFC822;
1421 CM_SetField(vmsg, eAuthor, HKEY("Citadel"));
1422 s = vcard_get_prop(v, "UID", 1, 0, 0);
1423 CM_SetField(vmsg, eExclusiveID, s, strlen(s));
1424 ser = vcard_serialize(v);
1429 serlen = strlen(ser);
1430 buf = NewStrBufPlain(NULL, serlen + 1024);
1432 StrBufAppendBufPlain(buf, HKEY("Content-type: " VCARD_MIME_TYPE "\r\n\r\n"), 0);
1433 StrBufAppendBufPlain(buf, ser, serlen, 0);
1434 StrBufAppendBufPlain(buf, HKEY("\r\n"), 0);
1435 CM_SetAsFieldSB(vmsg, eMesageText, &buf);
1440 syslog(LOG_DEBUG, "Adding contact: %s", recipient);
1441 CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
1446 free(aptr->roomname);
1447 free(aptr->collected_addresses);
1453 * When a user sends a message, we may harvest one or more email addresses
1454 * from the recipient list to be added to the user's address book. But we
1455 * want to do this asynchronously so it doesn't keep the user waiting.
1457 void store_harvested_addresses(void) {
1459 struct addresses_to_be_filed *aptr = NULL;
1461 if (atbf == NULL) return;
1463 begin_critical_section(S_ATBF);
1464 while (atbf != NULL) {
1467 end_critical_section(S_ATBF);
1468 store_this_ha(aptr);
1469 begin_critical_section(S_ATBF);
1471 end_critical_section(S_ATBF);
1476 * Function to output vCard data as plain text. Nobody uses MSG0 anymore, so
1477 * really this is just so we expose the vCard data to the full text indexer.
1479 void vcard_fixed_output(char *ptr, int len) {
1480 char *serialized_vcard;
1485 serialized_vcard = malloc(len + 1);
1486 safestrncpy(serialized_vcard, ptr, len+1);
1487 v = vcard_load(serialized_vcard);
1488 free(serialized_vcard);
1491 while (key = vcard_get_prop(v, "", 0, i, 1), key != NULL) {
1492 value = vcard_get_prop(v, "", 0, i++, 0);
1493 cprintf("%s\n", value);
1500 const char *CitadelServiceDICT_TCP="DICT_TCP";
1502 CTDL_MODULE_INIT(vcard)
1511 CtdlRegisterSessionHook(vcard_session_login_hook, EVT_LOGIN, PRIO_LOGIN + 70);
1512 CtdlRegisterMessageHook(vcard_upload_beforesave, EVT_BEFORESAVE);
1513 CtdlRegisterMessageHook(vcard_upload_aftersave, EVT_AFTERSAVE);
1514 CtdlRegisterDeleteHook(vcard_delete_remove);
1515 CtdlRegisterProtoHook(cmd_regi, "REGI", "Enter registration info");
1516 CtdlRegisterProtoHook(cmd_greg, "GREG", "Get registration info");
1517 CtdlRegisterProtoHook(cmd_igab, "IGAB", "Initialize Global Address Book");
1518 CtdlRegisterProtoHook(cmd_qdir, "QDIR", "Query Directory");
1519 CtdlRegisterProtoHook(cmd_gvsn, "GVSN", "Get Valid Screen Names");
1520 CtdlRegisterProtoHook(cmd_gvea, "GVEA", "Get Valid Email Addresses");
1521 CtdlRegisterProtoHook(cmd_dvca, "DVCA", "Dump VCard Addresses");
1522 CtdlRegisterUserHook(vcard_newuser, EVT_NEWUSER);
1523 CtdlRegisterUserHook(vcard_purge, EVT_PURGEUSER);
1524 CtdlRegisterNetprocHook(vcard_extract_from_network);
1525 CtdlRegisterSessionHook(store_harvested_addresses, EVT_TIMER, PRIO_CLEANUP + 470);
1526 CtdlRegisterFixedOutputHook("text/x-vcard", vcard_fixed_output);
1527 CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
1529 /* Create the Global ADdress Book room if necessary */
1530 CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
1532 /* Set expiration policy to manual; otherwise objects will be lost! */
1533 if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
1534 qr.QRep.expire_mode = EXPIRE_MANUAL;
1535 qr.QRdefaultview = VIEW_ADDRESSBOOK; /* 2 = address book view */
1536 CtdlPutRoomLock(&qr);
1539 * Also make sure it has a netconfig file, so the networker runs
1540 * on this room even if we don't share it with any other nodes.
1541 * This allows the CANCEL messages (i.e. "Purge this vCard") to be
1544 assoc_file_name(filename, sizeof filename, &qr, ctdl_netcfg_dir);
1545 fp = fopen(filename, "a");
1546 if (fp != NULL) fclose(fp);
1547 rv = chown(filename, CTDLUID, (-1));
1549 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]",
1550 filename, strerror(errno));
1551 rv = chmod(filename, 0600);
1553 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]",
1554 filename, strerror(errno));
1557 /* for postfix tcpdict */
1558 CtdlRegisterServiceHook(CtdlGetConfigInt("c_pftcpdict_port"), /* Postfix */
1563 CitadelServiceDICT_TCP);
1566 /* return our module name for the log */