2 * Citadel Dynamic Loading Module
3 * Written by Brian Costello <btx@calyx.net>
5 * Copyright (c) 1987-2011 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.
20 #include <sys/types.h>
26 #include <libcitadel.h>
29 #include "serv_extensions.h"
30 #include "sysdep_decls.h"
34 #include "modules/crypto/serv_crypto.h" /* Needed until a universal crypto startup hook is implimented for CtdlStartTLS */
36 #include "ctdl_module.h"
42 * Structure defentitions for hook tables
45 typedef struct __LogDebugEntry {
51 HashList *LogDebugEntryTable = NULL;
53 typedef struct LogFunctionHook LogFunctionHook;
54 struct LogFunctionHook {
55 LogFunctionHook *next;
57 void (*h_function_pointer) (char *);
59 extern LogFunctionHook *LogHookTable;
61 typedef struct FixedOutputHook FixedOutputHook;
62 struct FixedOutputHook {
63 FixedOutputHook *next;
64 char content_type[64];
65 void (*h_function_pointer) (char *, int);
67 extern FixedOutputHook *FixedOutputTable;
72 * SessionFunctionHook extensions are used for any type of hook for which
73 * the context in which it's being called (which is determined by the event
74 * type) will make it obvious for the hook function to know where to look for
77 typedef struct SessionFunctionHook SessionFunctionHook;
78 struct SessionFunctionHook {
79 SessionFunctionHook *next;
81 void (*h_function_pointer) (void);
84 extern SessionFunctionHook *SessionHookTable;
88 * UserFunctionHook extensions are used for any type of hook which implements
89 * an operation on a user or username (potentially) other than the one
90 * operating the current session.
92 typedef struct UserFunctionHook UserFunctionHook;
93 struct UserFunctionHook {
94 UserFunctionHook *next;
95 void (*h_function_pointer) (struct ctdluser *usbuf);
98 extern UserFunctionHook *UserHookTable;
101 * MessageFunctionHook extensions are used for hooks which implement handlers
102 * for various types of message operations (save, read, etc.)
104 typedef struct MessageFunctionHook MessageFunctionHook;
105 struct MessageFunctionHook {
106 MessageFunctionHook *next;
107 int (*h_function_pointer) (struct CtdlMessage *msg);
110 extern MessageFunctionHook *MessageHookTable;
114 * NetprocFunctionHook extensions are used for hooks which implement handlers
115 * for incoming network messages.
117 typedef struct NetprocFunctionHook NetprocFunctionHook;
118 struct NetprocFunctionHook {
119 NetprocFunctionHook *next;
120 int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
122 extern NetprocFunctionHook *NetprocHookTable;
126 * DeleteFunctionHook extensions are used for hooks which get called when a
127 * message is about to be deleted.
129 typedef struct DeleteFunctionHook DeleteFunctionHook;
130 struct DeleteFunctionHook {
131 DeleteFunctionHook *next;
132 void (*h_function_pointer) (char *target_room, long msgnum);
134 extern DeleteFunctionHook *DeleteHookTable;
138 * ExpressMessageFunctionHook extensions are used for hooks which implement
139 * the sending of an instant message through various channels. Any function
140 * registered should return the number of recipients to whom the message was
141 * successfully transmitted.
143 typedef struct XmsgFunctionHook XmsgFunctionHook;
144 struct XmsgFunctionHook {
145 XmsgFunctionHook *next;
146 int (*h_function_pointer) (char *, char *, char *, char *);
149 extern XmsgFunctionHook *XmsgHookTable;
155 * RoomFunctionHook extensions are used for hooks which impliment room
156 * processing functions when new messages are added EG. SIEVE.
158 typedef struct RoomFunctionHook RoomFunctionHook;
159 struct RoomFunctionHook {
160 RoomFunctionHook *next;
161 int (*fcn_ptr) (struct ctdlroom *);
163 extern RoomFunctionHook *RoomHookTable;
167 typedef struct SearchFunctionHook SearchFunctionHook;
168 struct SearchFunctionHook {
169 SearchFunctionHook *next;
170 void (*fcn_ptr) (int *, long **, const char *);
173 extern SearchFunctionHook *SearchFunctionHookTable;
176 CleanupFunctionHook *CleanupHookTable = NULL;
177 CleanupFunctionHook *EVCleanupHookTable = NULL;
178 SessionFunctionHook *SessionHookTable = NULL;
179 UserFunctionHook *UserHookTable = NULL;
180 XmsgFunctionHook *XmsgHookTable = NULL;
181 MessageFunctionHook *MessageHookTable = NULL;
182 NetprocFunctionHook *NetprocHookTable = NULL;
183 DeleteFunctionHook *DeleteHookTable = NULL;
184 ServiceFunctionHook *ServiceHookTable = NULL;
185 FixedOutputHook *FixedOutputTable = NULL;
186 RoomFunctionHook *RoomHookTable = NULL;
187 SearchFunctionHook *SearchFunctionHookTable = NULL;
189 typedef struct ProtoFunctionHook ProtoFunctionHook;
190 struct ProtoFunctionHook {
191 void (*handler) (char *cmdbuf);
196 HashList *ProtoHookList = NULL;
199 #define ERR_PORT (1 << 1)
202 static StrBuf *portlist = NULL;
204 static StrBuf *errormessages = NULL;
207 long DetailErrorFlags;
208 ConstStr Empty = {HKEY("")};
209 char *ErrSubject = "Startup Problems";
210 ConstStr ErrGeneral[] = {
211 {HKEY("Citadel had trouble on starting up. ")},
212 {HKEY(" This means, citadel won't be the service provider for a specific service you configured it to.\n\n"
213 "If you don't want citadel to provide these services, turn them off in WebCit via: ")},
214 {HKEY("To make both ways actualy take place restart the citserver with \"sendcommand down\"\n\n"
215 "The errors returned by the system were:\n")},
216 {HKEY("You can recheck the above if you follow this faq item:\n"
217 "http://www.citadel.org/doku.php?id=faq:mastering_your_os:net#netstat")}
220 ConstStr ErrPortShort = { HKEY("We couldn't bind all ports you configured to be provided by citadel server.\n")};
221 ConstStr ErrPortWhere = { HKEY("\"Admin->System Preferences->Network\".\n\nThe failed ports and sockets are: ")};
222 ConstStr ErrPortHint = { HKEY("If you want citadel to provide you with that functionality, "
223 "check the output of \"netstat -lnp\" on linux Servers or \"netstat -na\" on *BSD"
224 " and stop the program that binds these ports.\n You should eventually remove "
225 " their initscripts in /etc/init.d so that you won't get this trouble once more.\n"
226 " After that goto \"Administration -> Shutdown Citadel\" to make Citadel restart & retry to bind this port.\n")};
229 void LogPrintMessages(long err)
232 StrBuf *List, *DetailList;
233 ConstStr *Short, *Where, *Hint;
236 Message = NewStrBufPlain(NULL,
237 StrLength(portlist) + StrLength(errormessages));
239 DetailErrorFlags = DetailErrorFlags & ~err;
244 Short = &ErrPortShort;
245 Where = &ErrPortWhere;
248 DetailList = errormessages;
258 StrBufAppendBufPlain(Message, CKEY(ErrGeneral[0]), 0);
259 StrBufAppendBufPlain(Message, CKEY(*Short), 0);
260 StrBufAppendBufPlain(Message, CKEY(ErrGeneral[1]), 0);
261 StrBufAppendBufPlain(Message, CKEY(*Where), 0);
262 StrBufAppendBuf(Message, List, 0);
263 StrBufAppendBufPlain(Message, HKEY("\n\n"), 0);
264 StrBufAppendBufPlain(Message, CKEY(*Hint), 0);
265 StrBufAppendBufPlain(Message, HKEY("\n\n"), 0);
266 StrBufAppendBufPlain(Message, CKEY(ErrGeneral[2]), 0);
267 StrBufAppendBuf(Message, DetailList, 0);
268 StrBufAppendBufPlain(Message, HKEY("\n\n"), 0);
269 StrBufAppendBufPlain(Message, CKEY(ErrGeneral[3]), 0);
271 MOD_syslog(LOG_EMERG, "%s", ChrPtr(Message));
272 MOD_syslog(LOG_EMERG, "%s", ErrSubject);
273 quickie_message("Citadel", NULL, NULL, AIDEROOM, ChrPtr(Message), FMT_FIXED, ErrSubject);
275 FreeStrBuf(&Message);
277 FreeStrBuf(&DetailList);
281 void AddPortError(char *Port, char *ErrorMessage)
285 DetailErrorFlags |= ERR_PORT;
287 len = StrLength(errormessages);
288 if (len > 0) StrBufAppendBufPlain(errormessages, HKEY("; "), 0);
289 else errormessages = NewStrBuf();
290 StrBufAppendBufPlain(errormessages, ErrorMessage, -1, 0);
293 len = StrLength(portlist);
294 if (len > 0) StrBufAppendBufPlain(portlist, HKEY(";"), 0);
295 else portlist = NewStrBuf();
296 StrBufAppendBufPlain(portlist, Port, -1, 0);
300 int DLoader_Exec_Cmd(char *cmdbuf)
303 ProtoFunctionHook *p;
305 if (GetHash(ProtoHookList, cmdbuf, 4, &vP) && (vP != NULL)) {
306 p = (ProtoFunctionHook*) vP;
307 p->handler(&cmdbuf[5]);
313 long FourHash(const char *key, long length)
317 const unsigned char *ptr = (const unsigned char*)key;
319 for (i = 0; i < 4; i++, ptr ++)
329 void CtdlRegisterDebugFlagHook(const char *Name, long Len, CtdlDbgFunction F, const int *LogP)
332 if (LogDebugEntryTable == NULL)
333 LogDebugEntryTable = NewHash(1, NULL);
334 E = (LogDebugEntry*) malloc(sizeof(LogDebugEntry));
339 Put(LogDebugEntryTable, Name, Len, E, NULL);
342 void CtdlSetDebugLogFacilities(const char **Str, long n)
344 StrBuf *Token = NULL;
351 for (i=0; i < n; i++){
352 if ((Str[i] != NULL) && !IsEmptyStr(Str[i])) {
353 if (strcmp(Str[i], "all") == 0) {
357 Buf = NewStrBufPlain(Str[i], -1);
360 Token = NewStrBufPlain(NULL, StrLength(Buf));
361 while ((ch != StrBufNOTNULL) &&
362 StrBufExtract_NextToken(Token, Buf, &ch, ',')) {
363 if (GetHash(LogDebugEntryTable, SKEY(Token), &vptr) &&
366 LogDebugEntry *E = (LogDebugEntry*)vptr;
379 Pos = GetNewHashPos(LogDebugEntryTable, 0);
380 while (GetNextHashPos(LogDebugEntryTable, Pos, &HKLen, &ch, &vptr)) {
381 LogDebugEntry *E = (LogDebugEntry*)vptr;
388 void cmd_log_get(char *argbuf)
395 if (CtdlAccessCheck(ac_aide)) return;
397 cprintf("%d Log modules enabled:\n", LISTING_FOLLOWS);
399 Pos = GetNewHashPos(LogDebugEntryTable, 0);
401 while (GetNextHashPos(LogDebugEntryTable, Pos, &HKLen, &ch, &vptr)) {
402 LogDebugEntry *E = (LogDebugEntry*)vptr;
403 cprintf("%s|%d\n", ch, *E->LogP);
409 void cmd_log_set(char *argbuf)
414 char which[SIZ] = "";
416 if (CtdlAccessCheck(ac_aide)) return;
418 wlen = extract_token(which, argbuf, 0, '|', sizeof(which));
419 if (wlen < 0) wlen = 0;
420 lset = extract_int(argbuf, 1);
421 if (lset != 0) lset = 1;
422 if (GetHash(LogDebugEntryTable, which, wlen, &vptr) &&
425 LogDebugEntry *E = (LogDebugEntry*)vptr;
427 cprintf("%d %s|%d\n", CIT_OK, which, lset);
430 cprintf("%d Log setting %s not known\n",
434 void CtdlDestroyDebugTable(void)
437 DeleteHash(&LogDebugEntryTable);
440 void CtdlRegisterProtoHook(void (*handler) (char *), char *cmd, char *desc)
442 ProtoFunctionHook *p;
444 if (ProtoHookList == NULL)
445 ProtoHookList = NewHash (1, FourHash);
448 p = (ProtoFunctionHook *)
449 malloc(sizeof(ProtoFunctionHook));
452 fprintf(stderr, "can't malloc new ProtoFunctionHook\n");
455 p->handler = handler;
459 Put(ProtoHookList, cmd, 4, p, NULL);
460 MOD_syslog(LOG_DEBUG, "Registered server command %s (%s)\n", cmd, desc);
463 void CtdlDestroyProtoHooks(void)
466 DeleteHash(&ProtoHookList);
470 void CtdlRegisterCleanupHook(void (*fcn_ptr) (void))
473 CleanupFunctionHook *newfcn;
475 newfcn = (CleanupFunctionHook *)
476 malloc(sizeof(CleanupFunctionHook));
477 newfcn->next = CleanupHookTable;
478 newfcn->h_function_pointer = fcn_ptr;
479 CleanupHookTable = newfcn;
481 MODM_syslog(LOG_DEBUG, "Registered a new cleanup function\n");
485 void CtdlUnregisterCleanupHook(void (*fcn_ptr) (void))
487 CleanupFunctionHook *cur, *p, *last;
489 cur = CleanupHookTable;
492 if (fcn_ptr == cur->h_function_pointer)
494 MODM_syslog(LOG_DEBUG, "Unregistered cleanup function\n");
503 CleanupHookTable = p;
514 void CtdlDestroyCleanupHooks(void)
516 CleanupFunctionHook *cur, *p;
518 cur = CleanupHookTable;
521 MODM_syslog(LOG_DEBUG, "Destroyed cleanup function\n");
526 CleanupHookTable = NULL;
529 void CtdlRegisterEVCleanupHook(void (*fcn_ptr) (void))
532 CleanupFunctionHook *newfcn;
534 newfcn = (CleanupFunctionHook *)
535 malloc(sizeof(CleanupFunctionHook));
536 newfcn->next = EVCleanupHookTable;
537 newfcn->h_function_pointer = fcn_ptr;
538 EVCleanupHookTable = newfcn;
540 MODM_syslog(LOG_DEBUG, "Registered a new cleanup function\n");
544 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr) (void))
546 CleanupFunctionHook *cur, *p, *last;
548 cur = EVCleanupHookTable;
551 if (fcn_ptr == cur->h_function_pointer)
553 MODM_syslog(LOG_DEBUG, "Unregistered cleanup function\n");
562 EVCleanupHookTable = p;
573 void CtdlDestroyEVCleanupHooks(void)
575 CleanupFunctionHook *cur, *p;
577 cur = EVCleanupHookTable;
580 MODM_syslog(LOG_DEBUG, "Destroyed cleanup function\n");
585 EVCleanupHookTable = NULL;
589 void CtdlRegisterSessionHook(void (*fcn_ptr) (void), int EventType, int Priority)
591 SessionFunctionHook *newfcn;
593 newfcn = (SessionFunctionHook *)
594 malloc(sizeof(SessionFunctionHook));
595 newfcn->Priority = Priority;
596 newfcn->h_function_pointer = fcn_ptr;
597 newfcn->eventtype = EventType;
599 SessionFunctionHook **pfcn;
600 pfcn = &SessionHookTable;
601 while ((*pfcn != NULL) &&
602 ((*pfcn)->Priority < newfcn->Priority) &&
603 ((*pfcn)->next != NULL))
604 pfcn = &(*pfcn)->next;
606 newfcn->next = *pfcn;
609 MOD_syslog(LOG_DEBUG, "Registered a new session function (type %d Priority %d)\n",
610 EventType, Priority);
614 void CtdlUnregisterSessionHook(void (*fcn_ptr) (void), int EventType)
616 SessionFunctionHook *cur, *p, *last;
618 cur = SessionHookTable;
619 while (cur != NULL) {
620 if ((fcn_ptr == cur->h_function_pointer) &&
621 (EventType == cur->eventtype))
623 MOD_syslog(LOG_DEBUG, "Unregistered session function (type %d)\n",
633 SessionHookTable = p;
643 void CtdlDestroySessionHooks(void)
645 SessionFunctionHook *cur, *p;
647 cur = SessionHookTable;
650 MODM_syslog(LOG_DEBUG, "Destroyed session function\n");
655 SessionHookTable = NULL;
659 void CtdlRegisterUserHook(void (*fcn_ptr) (ctdluser *), int EventType)
662 UserFunctionHook *newfcn;
664 newfcn = (UserFunctionHook *)
665 malloc(sizeof(UserFunctionHook));
666 newfcn->next = UserHookTable;
667 newfcn->h_function_pointer = fcn_ptr;
668 newfcn->eventtype = EventType;
669 UserHookTable = newfcn;
671 MOD_syslog(LOG_DEBUG, "Registered a new user function (type %d)\n",
676 void CtdlUnregisterUserHook(void (*fcn_ptr) (struct ctdluser *), int EventType)
678 UserFunctionHook *cur, *p, *last;
681 while (cur != NULL) {
682 if ((fcn_ptr == cur->h_function_pointer) &&
683 (EventType == cur->eventtype))
685 MOD_syslog(LOG_DEBUG, "Unregistered user function (type %d)\n",
705 void CtdlDestroyUserHooks(void)
707 UserFunctionHook *cur, *p;
712 MODM_syslog(LOG_DEBUG, "Destroyed user function \n");
717 UserHookTable = NULL;
721 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
725 MessageFunctionHook *newfcn;
727 newfcn = (MessageFunctionHook *)
728 malloc(sizeof(MessageFunctionHook));
729 newfcn->next = MessageHookTable;
730 newfcn->h_function_pointer = handler;
731 newfcn->eventtype = EventType;
732 MessageHookTable = newfcn;
734 MOD_syslog(LOG_DEBUG, "Registered a new message function (type %d)\n",
739 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
742 MessageFunctionHook *cur, *p, *last;
744 cur = MessageHookTable;
745 while (cur != NULL) {
746 if ((handler == cur->h_function_pointer) &&
747 (EventType == cur->eventtype))
749 MOD_syslog(LOG_DEBUG, "Unregistered message function (type %d)\n",
758 MessageHookTable = p;
768 void CtdlDestroyMessageHook(void)
770 MessageFunctionHook *cur, *p;
772 cur = MessageHookTable;
775 MOD_syslog(LOG_DEBUG, "Destroyed message function (type %d)\n", cur->eventtype);
780 MessageHookTable = NULL;
784 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
786 RoomFunctionHook *newfcn;
788 newfcn = (RoomFunctionHook *)
789 malloc(sizeof(RoomFunctionHook));
790 newfcn->next = RoomHookTable;
791 newfcn->fcn_ptr = fcn_ptr;
792 RoomHookTable = newfcn;
794 MODM_syslog(LOG_DEBUG, "Registered a new room function\n");
798 void CtdlUnregisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
800 RoomFunctionHook *cur, *p, *last;
805 if (fcn_ptr == cur->fcn_ptr) {
806 MODM_syslog(LOG_DEBUG, "Unregistered room function\n");
826 void CtdlDestroyRoomHooks(void)
828 RoomFunctionHook *cur, *p;
833 MODM_syslog(LOG_DEBUG, "Destroyed room function\n");
838 RoomHookTable = NULL;
841 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
843 NetprocFunctionHook *newfcn;
845 newfcn = (NetprocFunctionHook *)
846 malloc(sizeof(NetprocFunctionHook));
847 newfcn->next = NetprocHookTable;
848 newfcn->h_function_pointer = handler;
849 NetprocHookTable = newfcn;
851 MODM_syslog(LOG_DEBUG, "Registered a new netproc function\n");
855 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
857 NetprocFunctionHook *cur, *p, *last;
859 cur = NetprocHookTable;
862 while (cur != NULL) {
863 if (handler == cur->h_function_pointer)
865 MODM_syslog(LOG_DEBUG, "Unregistered netproc function\n");
872 NetprocHookTable = p;
883 void CtdlDestroyNetprocHooks(void)
885 NetprocFunctionHook *cur, *p;
887 cur = NetprocHookTable;
890 MODM_syslog(LOG_DEBUG, "Destroyed netproc function\n");
895 NetprocHookTable = NULL;
899 void CtdlRegisterDeleteHook(void (*handler)(char *, long) )
901 DeleteFunctionHook *newfcn;
903 newfcn = (DeleteFunctionHook *)
904 malloc(sizeof(DeleteFunctionHook));
905 newfcn->next = DeleteHookTable;
906 newfcn->h_function_pointer = handler;
907 DeleteHookTable = newfcn;
909 MODM_syslog(LOG_DEBUG, "Registered a new delete function\n");
913 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) )
915 DeleteFunctionHook *cur, *p, *last;
918 cur = DeleteHookTable;
919 while (cur != NULL) {
920 if (handler == cur->h_function_pointer )
922 MODM_syslog(LOG_DEBUG, "Unregistered delete function\n");
939 void CtdlDestroyDeleteHooks(void)
941 DeleteFunctionHook *cur, *p;
943 cur = DeleteHookTable;
946 MODM_syslog(LOG_DEBUG, "Destroyed delete function\n");
951 DeleteHookTable = NULL;
957 void CtdlRegisterFixedOutputHook(char *content_type, void (*handler)(char *, int) )
959 FixedOutputHook *newfcn;
961 newfcn = (FixedOutputHook *)
962 malloc(sizeof(FixedOutputHook));
963 newfcn->next = FixedOutputTable;
964 newfcn->h_function_pointer = handler;
965 safestrncpy(newfcn->content_type, content_type, sizeof newfcn->content_type);
966 FixedOutputTable = newfcn;
968 MOD_syslog(LOG_DEBUG, "Registered a new fixed output function for %s\n", newfcn->content_type);
972 void CtdlUnregisterFixedOutputHook(char *content_type)
974 FixedOutputHook *cur, *p, *last;
977 cur = FixedOutputTable;
978 while (cur != NULL) {
979 /* This will also remove duplicates if any */
980 if (!strcasecmp(content_type, cur->content_type)) {
981 MOD_syslog(LOG_DEBUG,
982 "Unregistered fixed output function for %s\n",
991 FixedOutputTable = p;
1003 void CtdlDestroyFixedOutputHooks(void)
1005 FixedOutputHook *cur, *p;
1007 cur = FixedOutputTable;
1010 MOD_syslog(LOG_DEBUG, "Destroyed fixed output function for %s\n", cur->content_type);
1016 FixedOutputTable = NULL;
1019 /* returns nonzero if we found a hook and used it */
1020 int PerformFixedOutputHooks(char *content_type, char *content, int content_length)
1022 FixedOutputHook *fcn;
1024 for (fcn = FixedOutputTable; fcn != NULL; fcn = fcn->next) {
1025 if (!strcasecmp(content_type, fcn->content_type)) {
1026 (*fcn->h_function_pointer) (content, content_length);
1037 void CtdlRegisterXmsgHook(int (*fcn_ptr) (char *, char *, char *, char *), int order)
1040 XmsgFunctionHook *newfcn;
1042 newfcn = (XmsgFunctionHook *) malloc(sizeof(XmsgFunctionHook));
1043 newfcn->next = XmsgHookTable;
1044 newfcn->order = order;
1045 newfcn->h_function_pointer = fcn_ptr;
1046 XmsgHookTable = newfcn;
1047 MOD_syslog(LOG_DEBUG, "Registered a new x-msg function (priority %d)\n", order);
1051 void CtdlUnregisterXmsgHook(int (*fcn_ptr) (char *, char *, char *, char *), int order)
1053 XmsgFunctionHook *cur, *p, *last;
1056 cur = XmsgHookTable;
1057 while (cur != NULL) {
1058 /* This will also remove duplicates if any */
1059 if (fcn_ptr == cur->h_function_pointer &&
1060 order == cur->order) {
1061 MOD_syslog(LOG_DEBUG, "Unregistered x-msg function "
1062 "(priority %d)\n", order);
1080 void CtdlDestroyXmsgHooks(void)
1082 XmsgFunctionHook *cur, *p;
1084 cur = XmsgHookTable;
1087 MOD_syslog(LOG_DEBUG, "Destroyed x-msg function "
1088 "(priority %d)\n", cur->order);
1094 XmsgHookTable = NULL;
1098 void CtdlRegisterServiceHook(int tcp_port,
1100 void (*h_greeting_function) (void),
1101 void (*h_command_function) (void),
1102 void (*h_async_function) (void),
1103 const char *ServiceName)
1105 ServiceFunctionHook *newfcn;
1110 newfcn = (ServiceFunctionHook *) malloc(sizeof(ServiceFunctionHook));
1111 message = (char*) malloc (SIZ + SIZ);
1113 newfcn->next = ServiceHookTable;
1114 newfcn->tcp_port = tcp_port;
1115 newfcn->sockpath = sockpath;
1116 newfcn->h_greeting_function = h_greeting_function;
1117 newfcn->h_command_function = h_command_function;
1118 newfcn->h_async_function = h_async_function;
1119 newfcn->ServiceName = ServiceName;
1121 if (sockpath != NULL) {
1122 newfcn->msock = ctdl_uds_server(sockpath, config.c_maxsessions, error);
1123 snprintf(message, SIZ, "Unix domain socket '%s': ", sockpath);
1125 else if (tcp_port <= 0) { /* port -1 to disable */
1126 MOD_syslog(LOG_INFO, "Service %s has been manually disabled, skipping\n", ServiceName);
1132 newfcn->msock = ctdl_tcp_server(config.c_ip_addr,
1134 config.c_maxsessions,
1136 snprintf(message, SIZ, "TCP port %s:%d: (%s) ",
1137 config.c_ip_addr, tcp_port, ServiceName);
1140 if (newfcn->msock > 0) {
1141 ServiceHookTable = newfcn;
1142 strcat(message, "registered.");
1143 MOD_syslog(LOG_INFO, "%s\n", message);
1146 AddPortError(message, error);
1147 strcat(message, "FAILED.");
1148 MOD_syslog(LOG_CRIT, "%s\n", message);
1155 void CtdlUnregisterServiceHook(int tcp_port, char *sockpath,
1156 void (*h_greeting_function) (void),
1157 void (*h_command_function) (void),
1158 void (*h_async_function) (void)
1161 ServiceFunctionHook *cur, *p, *last;
1164 cur = ServiceHookTable;
1165 while (cur != NULL) {
1166 /* This will also remove duplicates if any */
1167 if (h_greeting_function == cur->h_greeting_function &&
1168 h_command_function == cur->h_command_function &&
1169 h_async_function == cur->h_async_function &&
1170 tcp_port == cur->tcp_port &&
1171 !(sockpath && cur->sockpath && strcmp(sockpath, cur->sockpath)) )
1176 MOD_syslog(LOG_INFO, "Closed UNIX domain socket %s\n",
1179 } else if (tcp_port) {
1180 MOD_syslog(LOG_INFO, "Closed TCP port %d\n", tcp_port);
1182 MOD_syslog(LOG_INFO, "Unregistered service \"%s\"\n", cur->ServiceName);
1189 ServiceHookTable = p;
1200 void CtdlShutdownServiceHooks(void)
1202 /* sort of a duplicate of close_masters() but called earlier */
1203 ServiceFunctionHook *cur;
1205 cur = ServiceHookTable;
1208 if (cur->msock != -1)
1212 if (cur->sockpath != NULL){
1213 MOD_syslog(LOG_INFO, "[%s] Closed UNIX domain socket %s\n",
1216 unlink(cur->sockpath);
1218 MOD_syslog(LOG_INFO, "[%s] closing service\n",
1226 void CtdlDestroyServiceHook(void)
1228 ServiceFunctionHook *cur, *p;
1230 cur = ServiceHookTable;
1234 if (cur->sockpath) {
1235 MOD_syslog(LOG_INFO, "Closed UNIX domain socket %s\n",
1237 unlink(cur->sockpath);
1238 } else if (cur->tcp_port) {
1239 MOD_syslog(LOG_INFO, "Closed TCP port %d\n", cur->tcp_port);
1241 MOD_syslog(LOG_INFO, "Destroyed service \"%s\"\n", cur->ServiceName);
1247 ServiceHookTable = NULL;
1250 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name)
1252 SearchFunctionHook *newfcn;
1254 if (!name || !fcn_ptr) {
1258 newfcn = (SearchFunctionHook *)
1259 malloc(sizeof(SearchFunctionHook));
1260 newfcn->next = SearchFunctionHookTable;
1261 newfcn->name = name;
1262 newfcn->fcn_ptr = fcn_ptr;
1263 SearchFunctionHookTable = newfcn;
1265 MOD_syslog(LOG_DEBUG, "Registered a new search function (%s)\n", name);
1268 void CtdlUnregisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name)
1270 SearchFunctionHook *cur, *p, *last;
1273 cur = SearchFunctionHookTable;
1274 while (cur != NULL) {
1276 (cur->fcn_ptr == fcn_ptr) &&
1277 name && !strcmp(name, cur->name))
1279 MOD_syslog(LOG_DEBUG, "Unregistered search function(%s)\n", name);
1285 SearchFunctionHookTable = p;
1295 void CtdlDestroySearchHooks(void)
1297 SearchFunctionHook *cur, *p;
1299 cur = SearchFunctionHookTable;
1300 SearchFunctionHookTable = NULL;
1301 while (cur != NULL) {
1308 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name)
1310 SearchFunctionHook *fcn = NULL;
1312 for (fcn = SearchFunctionHookTable; fcn != NULL; fcn = fcn->next) {
1313 if (!func_name || !strcmp(func_name, fcn->name)) {
1314 (*fcn->fcn_ptr) (num_msgs, search_msgs, search_string);
1322 void PerformSessionHooks(int EventType)
1324 SessionFunctionHook *fcn = NULL;
1326 for (fcn = SessionHookTable; fcn != NULL; fcn = fcn->next) {
1327 if (fcn->eventtype == EventType) {
1328 if (EventType == EVT_TIMER) {
1329 pthread_setspecific(MyConKey, NULL); /* for every hook */
1331 (*fcn->h_function_pointer) ();
1336 void PerformUserHooks(ctdluser *usbuf, int EventType)
1338 UserFunctionHook *fcn = NULL;
1340 for (fcn = UserHookTable; fcn != NULL; fcn = fcn->next) {
1341 if (fcn->eventtype == EventType) {
1342 (*fcn->h_function_pointer) (usbuf);
1347 int PerformMessageHooks(struct CtdlMessage *msg, int EventType)
1349 MessageFunctionHook *fcn = NULL;
1350 int total_retval = 0;
1352 /* Other code may elect to protect this message from server-side
1353 * handlers; if this is the case, don't do anything.
1354 MOD_syslog(LOG_DEBUG, "** Event type is %d, flags are %d\n", EventType, msg->cm_flags);
1356 if (msg->cm_flags & CM_SKIP_HOOKS) {
1357 MODM_syslog(LOG_DEBUG, "Skipping hooks\n");
1361 /* Otherwise, run all the hooks appropriate to this event type.
1363 for (fcn = MessageHookTable; fcn != NULL; fcn = fcn->next) {
1364 if (fcn->eventtype == EventType) {
1365 total_retval = total_retval + (*fcn->h_function_pointer) (msg);
1369 /* Return the sum of the return codes from the hook functions. If
1370 * this is an EVT_BEFORESAVE event, a nonzero return code will cause
1371 * the save operation to abort.
1373 return total_retval;
1377 int PerformRoomHooks(struct ctdlroom *target_room)
1379 RoomFunctionHook *fcn;
1380 int total_retval = 0;
1382 MOD_syslog(LOG_DEBUG, "Performing room hooks for <%s>\n", target_room->QRname);
1384 for (fcn = RoomHookTable; fcn != NULL; fcn = fcn->next) {
1385 total_retval = total_retval + (*fcn->fcn_ptr) (target_room);
1388 /* Return the sum of the return codes from the hook functions.
1390 return total_retval;
1394 int PerformNetprocHooks(struct CtdlMessage *msg, char *target_room)
1396 NetprocFunctionHook *fcn;
1397 int total_retval = 0;
1399 for (fcn = NetprocHookTable; fcn != NULL; fcn = fcn->next) {
1400 total_retval = total_retval +
1401 (*fcn->h_function_pointer) (msg, target_room);
1404 /* Return the sum of the return codes from the hook functions.
1405 * A nonzero return code will cause the message to *not* be imported.
1407 return total_retval;
1411 void PerformDeleteHooks(char *room, long msgnum)
1413 DeleteFunctionHook *fcn;
1415 for (fcn = DeleteHookTable; fcn != NULL; fcn = fcn->next) {
1416 (*fcn->h_function_pointer) (room, msgnum);
1424 int PerformXmsgHooks(char *sender, char *sender_email, char *recp, char *msg)
1426 XmsgFunctionHook *fcn;
1430 for (p=0; p<MAX_XMSG_PRI; ++p) {
1431 for (fcn = XmsgHookTable; fcn != NULL; fcn = fcn->next) {
1432 if (fcn->order == p) {
1434 (*fcn->h_function_pointer)
1435 (sender, sender_email, recp, msg);
1438 /* Break out of the loop if a higher-priority function
1439 * successfully delivered the message. This prevents duplicate
1440 * deliveries to local users simultaneously signed onto
1443 if (total_sent) break;
1450 * Dirty hack until we impliment a hook mechanism for this
1452 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response)
1455 CtdlStartTLS (ok_response, nosup_response, error_response);
1459 void DebugModulesEnable(const int n)
1463 CTDL_MODULE_INIT(modules)
1466 CtdlRegisterDebugFlagHook(HKEY("modules"), DebugModulesEnable, &DebugModules);
1468 CtdlRegisterProtoHook(cmd_log_get, "LOGP", "Print Log-parameters");
1469 CtdlRegisterProtoHook(cmd_log_set, "LOGS", "Set Log-parameters");