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 as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <sys/types.h>
32 #include <libcitadel.h>
35 #include "serv_extensions.h"
36 #include "sysdep_decls.h"
40 #include "modules/crypto/serv_crypto.h" /* Needed until a universal crypto startup hook is implimented for CtdlStartTLS */
42 #include "ctdl_module.h"
52 * Structure defentitions for hook tables
55 typedef struct __LogDebugEntry {
61 HashList *LogDebugEntryTable = NULL;
63 typedef struct LogFunctionHook LogFunctionHook;
64 struct LogFunctionHook {
65 LogFunctionHook *next;
67 void (*h_function_pointer) (char *);
69 extern LogFunctionHook *LogHookTable;
71 typedef struct FixedOutputHook FixedOutputHook;
72 struct FixedOutputHook {
73 FixedOutputHook *next;
74 char content_type[64];
75 void (*h_function_pointer) (char *, int);
77 extern FixedOutputHook *FixedOutputTable;
82 * SessionFunctionHook extensions are used for any type of hook for which
83 * the context in which it's being called (which is determined by the event
84 * type) will make it obvious for the hook function to know where to look for
87 typedef struct SessionFunctionHook SessionFunctionHook;
88 struct SessionFunctionHook {
89 SessionFunctionHook *next;
90 void (*h_function_pointer) (void);
93 extern SessionFunctionHook *SessionHookTable;
97 * UserFunctionHook extensions are used for any type of hook which implements
98 * an operation on a user or username (potentially) other than the one
99 * operating the current session.
101 typedef struct UserFunctionHook UserFunctionHook;
102 struct UserFunctionHook {
103 UserFunctionHook *next;
104 void (*h_function_pointer) (struct ctdluser *usbuf);
107 extern UserFunctionHook *UserHookTable;
110 * MessageFunctionHook extensions are used for hooks which implement handlers
111 * for various types of message operations (save, read, etc.)
113 typedef struct MessageFunctionHook MessageFunctionHook;
114 struct MessageFunctionHook {
115 MessageFunctionHook *next;
116 int (*h_function_pointer) (struct CtdlMessage *msg);
119 extern MessageFunctionHook *MessageHookTable;
123 * NetprocFunctionHook extensions are used for hooks which implement handlers
124 * for incoming network messages.
126 typedef struct NetprocFunctionHook NetprocFunctionHook;
127 struct NetprocFunctionHook {
128 NetprocFunctionHook *next;
129 int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
131 extern NetprocFunctionHook *NetprocHookTable;
135 * DeleteFunctionHook extensions are used for hooks which get called when a
136 * message is about to be deleted.
138 typedef struct DeleteFunctionHook DeleteFunctionHook;
139 struct DeleteFunctionHook {
140 DeleteFunctionHook *next;
141 void (*h_function_pointer) (char *target_room, long msgnum);
143 extern DeleteFunctionHook *DeleteHookTable;
147 * ExpressMessageFunctionHook extensions are used for hooks which implement
148 * the sending of an instant message through various channels. Any function
149 * registered should return the number of recipients to whom the message was
150 * successfully transmitted.
152 typedef struct XmsgFunctionHook XmsgFunctionHook;
153 struct XmsgFunctionHook {
154 XmsgFunctionHook *next;
155 int (*h_function_pointer) (char *, char *, char *, char *);
158 extern XmsgFunctionHook *XmsgHookTable;
164 * RoomFunctionHook extensions are used for hooks which impliment room
165 * processing functions when new messages are added EG. SIEVE.
167 typedef struct RoomFunctionHook RoomFunctionHook;
168 struct RoomFunctionHook {
169 RoomFunctionHook *next;
170 int (*fcn_ptr) (struct ctdlroom *);
172 extern RoomFunctionHook *RoomHookTable;
176 typedef struct SearchFunctionHook SearchFunctionHook;
177 struct SearchFunctionHook {
178 SearchFunctionHook *next;
179 void (*fcn_ptr) (int *, long **, const char *);
182 extern SearchFunctionHook *SearchFunctionHookTable;
185 CleanupFunctionHook *CleanupHookTable = NULL;
186 CleanupFunctionHook *EVCleanupHookTable = NULL;
187 SessionFunctionHook *SessionHookTable = NULL;
188 UserFunctionHook *UserHookTable = NULL;
189 XmsgFunctionHook *XmsgHookTable = NULL;
190 MessageFunctionHook *MessageHookTable = NULL;
191 NetprocFunctionHook *NetprocHookTable = NULL;
192 DeleteFunctionHook *DeleteHookTable = NULL;
193 ServiceFunctionHook *ServiceHookTable = NULL;
194 FixedOutputHook *FixedOutputTable = NULL;
195 RoomFunctionHook *RoomHookTable = NULL;
196 SearchFunctionHook *SearchFunctionHookTable = NULL;
198 typedef struct ProtoFunctionHook ProtoFunctionHook;
199 struct ProtoFunctionHook {
200 void (*handler) (char *cmdbuf);
205 HashList *ProtoHookList = NULL;
208 #define ERR_PORT (1 << 1)
211 static StrBuf *portlist = NULL;
213 static StrBuf *errormessages = NULL;
216 long DetailErrorFlags;
217 ConstStr Empty = {HKEY("")};
218 char *ErrSubject = "Startup Problems";
219 ConstStr ErrGeneral[] = {
220 {HKEY("Citadel had trouble on starting up. ")},
221 {HKEY(" This means, citadel won't be the service provider for a specific service you configured it to.\n\n"
222 "If you don't want citadel to provide these services, turn them off in WebCit via: ")},
223 {HKEY("To make both ways actualy take place restart the citserver with \"sendcommand down\"\n\n"
224 "The errors returned by the system were:\n")},
225 {HKEY("You can recheck the above if you follow this faq item:\n"
226 "http://www.citadel.org/doku.php?id=faq:mastering_your_os:net#netstat")}
229 ConstStr ErrPortShort = { HKEY("We couldn't bind all ports you configured to be provided by citadel server.\n")};
230 ConstStr ErrPortWhere = { HKEY("\"Admin->System Preferences->Network\".\n\nThe failed ports and sockets are: ")};
231 ConstStr ErrPortHint = { HKEY("If you want citadel to provide you with that functionality, "
232 "check the output of \"netstat -lnp\" on linux Servers or \"netstat -na\" on *BSD"
233 " and stop the program that binds these ports.\n You should eventually remove "
234 " their initscripts in /etc/init.d so that you won't get this trouble once more.\n"
235 " After that goto \"Administration -> Shutdown Citadel\" to make Citadel restart & retry to bind this port.\n")};
238 void LogPrintMessages(long err)
241 StrBuf *List, *DetailList;
242 ConstStr *Short, *Where, *Hint;
245 Message = NewStrBufPlain(NULL,
246 StrLength(portlist) + StrLength(errormessages));
248 DetailErrorFlags = DetailErrorFlags & ~err;
253 Short = &ErrPortShort;
254 Where = &ErrPortWhere;
257 DetailList = errormessages;
267 StrBufAppendBufPlain(Message, CKEY(ErrGeneral[0]), 0);
268 StrBufAppendBufPlain(Message, CKEY(*Short), 0);
269 StrBufAppendBufPlain(Message, CKEY(ErrGeneral[1]), 0);
270 StrBufAppendBufPlain(Message, CKEY(*Where), 0);
271 StrBufAppendBuf(Message, List, 0);
272 StrBufAppendBufPlain(Message, HKEY("\n\n"), 0);
273 StrBufAppendBufPlain(Message, CKEY(*Hint), 0);
274 StrBufAppendBufPlain(Message, HKEY("\n\n"), 0);
275 StrBufAppendBufPlain(Message, CKEY(ErrGeneral[2]), 0);
276 StrBufAppendBuf(Message, DetailList, 0);
277 StrBufAppendBufPlain(Message, HKEY("\n\n"), 0);
278 StrBufAppendBufPlain(Message, CKEY(ErrGeneral[3]), 0);
280 MOD_syslog(LOG_EMERG, "%s", ChrPtr(Message));
281 MOD_syslog(LOG_EMERG, "%s", ErrSubject);
282 quickie_message("Citadel", NULL, NULL, AIDEROOM, ChrPtr(Message), FMT_FIXED, ErrSubject);
284 FreeStrBuf(&Message);
286 FreeStrBuf(&DetailList);
290 void AddPortError(char *Port, char *ErrorMessage)
294 DetailErrorFlags |= ERR_PORT;
296 len = StrLength(errormessages);
297 if (len > 0) StrBufAppendBufPlain(errormessages, HKEY("; "), 0);
298 else errormessages = NewStrBuf();
299 StrBufAppendBufPlain(errormessages, ErrorMessage, -1, 0);
302 len = StrLength(portlist);
303 if (len > 0) StrBufAppendBufPlain(portlist, HKEY(";"), 0);
304 else portlist = NewStrBuf();
305 StrBufAppendBufPlain(portlist, Port, -1, 0);
309 int DLoader_Exec_Cmd(char *cmdbuf)
312 ProtoFunctionHook *p;
314 if (GetHash(ProtoHookList, cmdbuf, 4, &vP) && (vP != NULL)) {
315 p = (ProtoFunctionHook*) vP;
316 p->handler(&cmdbuf[5]);
322 long FourHash(const char *key, long length)
326 const unsigned char *ptr = (const unsigned char*)key;
328 for (i = 0; i < 4; i++, ptr ++)
338 void CtdlRegisterDebugFlagHook(const char *Name, long Len, CtdlDbgFunction F, const int *LogP)
341 if (LogDebugEntryTable == NULL)
342 LogDebugEntryTable = NewHash(1, NULL);
343 E = (LogDebugEntry*) malloc(sizeof(LogDebugEntry));
348 Put(LogDebugEntryTable, Name, Len, E, NULL);
351 void CtdlSetDebugLogFacilities(const char **Str, long n)
353 StrBuf *Token = NULL;
360 for (i=0; i < n; i++){
361 if ((Str[i] != NULL) && !IsEmptyStr(Str[i])) {
362 if (strcmp(Str[i], "all") == 0) {
366 Buf = NewStrBufPlain(Str[i], -1);
369 Token = NewStrBufPlain(NULL, StrLength(Buf));
370 while ((ch != StrBufNOTNULL) &&
371 StrBufExtract_NextToken(Token, Buf, &ch, ',')) {
372 if (GetHash(LogDebugEntryTable, SKEY(Token), &vptr) &&
375 LogDebugEntry *E = (LogDebugEntry*)vptr;
388 Pos = GetNewHashPos(LogDebugEntryTable, 0);
389 while (GetNextHashPos(LogDebugEntryTable, Pos, &HKLen, &ch, &vptr)) {
390 LogDebugEntry *E = (LogDebugEntry*)vptr;
397 void cmd_log_get(char *argbuf)
404 if (CtdlAccessCheck(ac_aide)) return;
406 cprintf("%d Log modules enabled:\n", LISTING_FOLLOWS);
408 Pos = GetNewHashPos(LogDebugEntryTable, 0);
410 while (GetNextHashPos(LogDebugEntryTable, Pos, &HKLen, &ch, &vptr)) {
411 LogDebugEntry *E = (LogDebugEntry*)vptr;
412 cprintf("%s|%d\n", ch, *E->LogP);
418 void cmd_log_set(char *argbuf)
423 char which[SIZ] = "";
425 if (CtdlAccessCheck(ac_aide)) return;
427 wlen = extract_token(which, argbuf, 0, '|', sizeof(which));
428 if (wlen < 0) wlen = 0;
429 lset = extract_int(argbuf, 1);
430 if (lset != 0) lset = 1;
431 if (GetHash(LogDebugEntryTable, which, wlen, &vptr) &&
434 LogDebugEntry *E = (LogDebugEntry*)vptr;
436 cprintf("%d %s|%d\n", CIT_OK, which, lset);
439 cprintf("%d Log setting %s not known\n",
443 void CtdlDestroyDebugTable(void)
446 DeleteHash(&LogDebugEntryTable);
449 void CtdlRegisterProtoHook(void (*handler) (char *), char *cmd, char *desc)
451 ProtoFunctionHook *p;
453 if (ProtoHookList == NULL)
454 ProtoHookList = NewHash (1, FourHash);
457 p = (ProtoFunctionHook *)
458 malloc(sizeof(ProtoFunctionHook));
461 fprintf(stderr, "can't malloc new ProtoFunctionHook\n");
464 p->handler = handler;
468 Put(ProtoHookList, cmd, 4, p, NULL);
469 MOD_syslog(LOG_DEBUG, "Registered server command %s (%s)\n", cmd, desc);
472 void CtdlDestroyProtoHooks(void)
475 DeleteHash(&ProtoHookList);
479 void CtdlRegisterCleanupHook(void (*fcn_ptr) (void))
482 CleanupFunctionHook *newfcn;
484 newfcn = (CleanupFunctionHook *)
485 malloc(sizeof(CleanupFunctionHook));
486 newfcn->next = CleanupHookTable;
487 newfcn->h_function_pointer = fcn_ptr;
488 CleanupHookTable = newfcn;
490 MODM_syslog(LOG_DEBUG, "Registered a new cleanup function\n");
494 void CtdlUnregisterCleanupHook(void (*fcn_ptr) (void))
496 CleanupFunctionHook *cur, *p;
498 for (cur = CleanupHookTable; cur != NULL; cur = cur->next) {
499 /* This will also remove duplicates if any */
500 while (cur != NULL &&
501 fcn_ptr == cur->h_function_pointer) {
502 MODM_syslog(LOG_DEBUG, "Unregistered cleanup function\n");
504 if (cur == CleanupHookTable) {
505 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;
548 for (cur = EVCleanupHookTable; cur != NULL; cur = cur->next) {
549 /* This will also remove duplicates if any */
550 while (cur != NULL &&
551 fcn_ptr == cur->h_function_pointer) {
552 MODM_syslog(LOG_DEBUG, "Unregistered cleanup function\n");
554 if (cur == EVCleanupHookTable) {
555 EVCleanupHookTable = p;
564 void CtdlDestroyEVCleanupHooks(void)
566 CleanupFunctionHook *cur, *p;
568 cur = EVCleanupHookTable;
571 MODM_syslog(LOG_DEBUG, "Destroyed cleanup function\n");
576 EVCleanupHookTable = NULL;
580 void CtdlRegisterSessionHook(void (*fcn_ptr) (void), int EventType)
583 SessionFunctionHook *newfcn;
585 newfcn = (SessionFunctionHook *)
586 malloc(sizeof(SessionFunctionHook));
587 newfcn->next = SessionHookTable;
588 newfcn->h_function_pointer = fcn_ptr;
589 newfcn->eventtype = EventType;
590 SessionHookTable = newfcn;
592 MOD_syslog(LOG_DEBUG, "Registered a new session function (type %d)\n",
597 void CtdlUnregisterSessionHook(void (*fcn_ptr) (void), int EventType)
599 SessionFunctionHook *cur, *p;
601 for (cur = SessionHookTable; cur != NULL; cur = cur->next) {
602 /* This will also remove duplicates if any */
603 while (cur != NULL &&
604 fcn_ptr == cur->h_function_pointer &&
605 EventType == cur->eventtype) {
606 MOD_syslog(LOG_DEBUG, "Unregistered session function (type %d)\n",
609 if (cur == SessionHookTable) {
610 SessionHookTable = p;
618 void CtdlDestroySessionHooks(void)
620 SessionFunctionHook *cur, *p;
622 cur = SessionHookTable;
625 MODM_syslog(LOG_DEBUG, "Destroyed session function\n");
630 SessionHookTable = NULL;
634 void CtdlRegisterUserHook(void (*fcn_ptr) (ctdluser *), int EventType)
637 UserFunctionHook *newfcn;
639 newfcn = (UserFunctionHook *)
640 malloc(sizeof(UserFunctionHook));
641 newfcn->next = UserHookTable;
642 newfcn->h_function_pointer = fcn_ptr;
643 newfcn->eventtype = EventType;
644 UserHookTable = newfcn;
646 MOD_syslog(LOG_DEBUG, "Registered a new user function (type %d)\n",
651 void CtdlUnregisterUserHook(void (*fcn_ptr) (struct ctdluser *), int EventType)
653 UserFunctionHook *cur, *p;
655 for (cur = UserHookTable; cur != NULL; cur = cur->next) {
656 /* This will also remove duplicates if any */
657 while (cur != NULL &&
658 fcn_ptr == cur->h_function_pointer &&
659 EventType == cur->eventtype) {
660 MOD_syslog(LOG_DEBUG, "Unregistered user function (type %d)\n",
663 if (cur == UserHookTable) {
672 void CtdlDestroyUserHooks(void)
674 UserFunctionHook *cur, *p;
679 MODM_syslog(LOG_DEBUG, "Destroyed user function \n");
684 UserHookTable = NULL;
688 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
692 MessageFunctionHook *newfcn;
694 newfcn = (MessageFunctionHook *)
695 malloc(sizeof(MessageFunctionHook));
696 newfcn->next = MessageHookTable;
697 newfcn->h_function_pointer = handler;
698 newfcn->eventtype = EventType;
699 MessageHookTable = newfcn;
701 MOD_syslog(LOG_DEBUG, "Registered a new message function (type %d)\n",
706 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
709 MessageFunctionHook *cur, *p;
711 for (cur = MessageHookTable; cur != NULL; cur = cur->next) {
712 /* This will also remove duplicates if any */
713 while (cur != NULL &&
714 handler == cur->h_function_pointer &&
715 EventType == cur->eventtype) {
716 MOD_syslog(LOG_DEBUG, "Unregistered message function (type %d)\n",
719 if (cur == MessageHookTable) {
720 MessageHookTable = p;
728 void CtdlDestroyMessageHook(void)
730 MessageFunctionHook *cur, *p;
732 cur = MessageHookTable;
735 MOD_syslog(LOG_DEBUG, "Destroyed message function (type %d)\n", cur->eventtype);
740 MessageHookTable = NULL;
744 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
746 RoomFunctionHook *newfcn;
748 newfcn = (RoomFunctionHook *)
749 malloc(sizeof(RoomFunctionHook));
750 newfcn->next = RoomHookTable;
751 newfcn->fcn_ptr = fcn_ptr;
752 RoomHookTable = newfcn;
754 MODM_syslog(LOG_DEBUG, "Registered a new room function\n");
758 void CtdlUnregisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
760 RoomFunctionHook *cur, *p, *last;
762 for (last = NULL, cur = RoomHookTable;
766 if (fcn_ptr == cur->fcn_ptr) {
767 MODM_syslog(LOG_DEBUG, "Unregistered room function\n");
783 void CtdlDestroyRoomHooks(void)
785 RoomFunctionHook *cur, *p;
790 MODM_syslog(LOG_DEBUG, "Destroyed room function\n");
795 RoomHookTable = NULL;
798 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
800 NetprocFunctionHook *newfcn;
802 newfcn = (NetprocFunctionHook *)
803 malloc(sizeof(NetprocFunctionHook));
804 newfcn->next = NetprocHookTable;
805 newfcn->h_function_pointer = handler;
806 NetprocHookTable = newfcn;
808 MODM_syslog(LOG_DEBUG, "Registered a new netproc function\n");
812 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
814 NetprocFunctionHook *cur, *p;
816 for (cur = NetprocHookTable; cur != NULL; cur = cur->next) {
817 /* This will also remove duplicates if any */
818 while (cur != NULL &&
819 handler == cur->h_function_pointer ) {
820 MODM_syslog(LOG_DEBUG, "Unregistered netproc function\n");
822 if (cur == NetprocHookTable) {
823 NetprocHookTable = p;
831 void CtdlDestroyNetprocHooks(void)
833 NetprocFunctionHook *cur, *p;
835 cur = NetprocHookTable;
838 MODM_syslog(LOG_DEBUG, "Destroyed netproc function\n");
843 NetprocHookTable = NULL;
847 void CtdlRegisterDeleteHook(void (*handler)(char *, long) )
849 DeleteFunctionHook *newfcn;
851 newfcn = (DeleteFunctionHook *)
852 malloc(sizeof(DeleteFunctionHook));
853 newfcn->next = DeleteHookTable;
854 newfcn->h_function_pointer = handler;
855 DeleteHookTable = newfcn;
857 MODM_syslog(LOG_DEBUG, "Registered a new delete function\n");
861 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) )
863 DeleteFunctionHook *cur, *p;
865 for (cur = DeleteHookTable; cur != NULL; cur = cur->next) {
866 /* This will also remove duplicates if any */
867 while (cur != NULL &&
868 handler == cur->h_function_pointer ) {
869 MODM_syslog(LOG_DEBUG, "Unregistered delete function\n");
871 if (cur == DeleteHookTable) {
879 void CtdlDestroyDeleteHooks(void)
881 DeleteFunctionHook *cur, *p;
883 cur = DeleteHookTable;
886 MODM_syslog(LOG_DEBUG, "Destroyed delete function\n");
891 DeleteHookTable = NULL;
897 void CtdlRegisterFixedOutputHook(char *content_type, void (*handler)(char *, int) )
899 FixedOutputHook *newfcn;
901 newfcn = (FixedOutputHook *)
902 malloc(sizeof(FixedOutputHook));
903 newfcn->next = FixedOutputTable;
904 newfcn->h_function_pointer = handler;
905 safestrncpy(newfcn->content_type, content_type, sizeof newfcn->content_type);
906 FixedOutputTable = newfcn;
908 MOD_syslog(LOG_DEBUG, "Registered a new fixed output function for %s\n", newfcn->content_type);
912 void CtdlUnregisterFixedOutputHook(char *content_type)
914 FixedOutputHook *cur, *p;
916 for (cur = FixedOutputTable; cur != NULL; cur = cur->next) {
917 /* This will also remove duplicates if any */
918 while (cur != NULL && (!strcasecmp(content_type, cur->content_type))) {
919 MOD_syslog(LOG_DEBUG, "Unregistered fixed output function for %s\n", content_type);
921 if (cur == FixedOutputTable) {
922 FixedOutputTable = p;
930 void CtdlDestroyFixedOutputHooks(void)
932 FixedOutputHook *cur, *p;
934 cur = FixedOutputTable;
937 MOD_syslog(LOG_DEBUG, "Destroyed fixed output function for %s\n", cur->content_type);
943 FixedOutputTable = NULL;
946 /* returns nonzero if we found a hook and used it */
947 int PerformFixedOutputHooks(char *content_type, char *content, int content_length)
949 FixedOutputHook *fcn;
951 for (fcn = FixedOutputTable; fcn != NULL; fcn = fcn->next) {
952 if (!strcasecmp(content_type, fcn->content_type)) {
953 (*fcn->h_function_pointer) (content, content_length);
964 void CtdlRegisterXmsgHook(int (*fcn_ptr) (char *, char *, char *, char *), int order)
967 XmsgFunctionHook *newfcn;
969 newfcn = (XmsgFunctionHook *) malloc(sizeof(XmsgFunctionHook));
970 newfcn->next = XmsgHookTable;
971 newfcn->order = order;
972 newfcn->h_function_pointer = fcn_ptr;
973 XmsgHookTable = newfcn;
974 MOD_syslog(LOG_DEBUG, "Registered a new x-msg function (priority %d)\n", order);
978 void CtdlUnregisterXmsgHook(int (*fcn_ptr) (char *, char *, char *, char *), int order)
980 XmsgFunctionHook *cur, *p;
982 for (cur = XmsgHookTable; cur != NULL; cur = cur->next) {
983 /* This will also remove duplicates if any */
984 while (cur != NULL &&
985 fcn_ptr == cur->h_function_pointer &&
986 order == cur->order) {
987 MOD_syslog(LOG_DEBUG, "Unregistered x-msg function "
988 "(priority %d)\n", order);
990 if (cur == XmsgHookTable) {
999 void CtdlDestroyXmsgHooks(void)
1001 XmsgFunctionHook *cur, *p;
1003 cur = XmsgHookTable;
1006 MOD_syslog(LOG_DEBUG, "Destroyed x-msg function "
1007 "(priority %d)\n", cur->order);
1013 XmsgHookTable = NULL;
1017 void CtdlRegisterServiceHook(int tcp_port,
1019 void (*h_greeting_function) (void),
1020 void (*h_command_function) (void),
1021 void (*h_async_function) (void),
1022 const char *ServiceName)
1024 ServiceFunctionHook *newfcn;
1029 newfcn = (ServiceFunctionHook *) malloc(sizeof(ServiceFunctionHook));
1030 message = (char*) malloc (SIZ + SIZ);
1032 newfcn->next = ServiceHookTable;
1033 newfcn->tcp_port = tcp_port;
1034 newfcn->sockpath = sockpath;
1035 newfcn->h_greeting_function = h_greeting_function;
1036 newfcn->h_command_function = h_command_function;
1037 newfcn->h_async_function = h_async_function;
1038 newfcn->ServiceName = ServiceName;
1040 if (sockpath != NULL) {
1041 newfcn->msock = ctdl_uds_server(sockpath, config.c_maxsessions, error);
1042 snprintf(message, SIZ, "Unix domain socket '%s': ", sockpath);
1044 else if (tcp_port <= 0) { /* port -1 to disable */
1045 MOD_syslog(LOG_INFO, "Service %s has been manually disabled, skipping\n", ServiceName);
1051 newfcn->msock = ctdl_tcp_server(config.c_ip_addr,
1053 config.c_maxsessions,
1055 snprintf(message, SIZ, "TCP port %s:%d: (%s) ",
1056 config.c_ip_addr, tcp_port, ServiceName);
1059 if (newfcn->msock > 0) {
1060 ServiceHookTable = newfcn;
1061 strcat(message, "registered.");
1062 MOD_syslog(LOG_INFO, "%s\n", message);
1065 AddPortError(message, error);
1066 strcat(message, "FAILED.");
1067 MOD_syslog(LOG_CRIT, "%s\n", message);
1074 void CtdlUnregisterServiceHook(int tcp_port, char *sockpath,
1075 void (*h_greeting_function) (void),
1076 void (*h_command_function) (void),
1077 void (*h_async_function) (void)
1080 ServiceFunctionHook *cur, *p;
1082 cur = ServiceHookTable;
1083 while (cur != NULL) {
1084 /* This will also remove duplicates if any */
1085 while (cur != NULL &&
1086 !(sockpath && cur->sockpath &&
1087 strcmp(sockpath, cur->sockpath)) &&
1088 h_greeting_function == cur->h_greeting_function &&
1089 h_command_function == cur->h_command_function &&
1090 h_async_function == cur->h_async_function &&
1091 tcp_port == cur->tcp_port) {
1094 MOD_syslog(LOG_INFO, "Closed UNIX domain socket %s\n",
1097 } else if (tcp_port) {
1098 MOD_syslog(LOG_INFO, "Closed TCP port %d\n", tcp_port);
1100 MOD_syslog(LOG_INFO, "Unregistered service \"%s\"\n", cur->ServiceName);
1103 if (cur == ServiceHookTable) {
1104 ServiceHookTable = p;
1113 void CtdlShutdownServiceHooks(void)
1115 /* sort of a duplicate of close_masters() but called earlier */
1116 ServiceFunctionHook *cur;
1118 cur = ServiceHookTable;
1121 if (cur->msock != -1)
1125 if (cur->sockpath != NULL){
1126 MOD_syslog(LOG_INFO, "[%s] Closed UNIX domain socket %s\n",
1129 unlink(cur->sockpath);
1131 MOD_syslog(LOG_INFO, "[%s] closing service\n",
1139 void CtdlDestroyServiceHook(void)
1141 ServiceFunctionHook *cur, *p;
1143 cur = ServiceHookTable;
1147 if (cur->sockpath) {
1148 MOD_syslog(LOG_INFO, "Closed UNIX domain socket %s\n",
1150 unlink(cur->sockpath);
1151 } else if (cur->tcp_port) {
1152 MOD_syslog(LOG_INFO, "Closed TCP port %d\n", cur->tcp_port);
1154 MOD_syslog(LOG_INFO, "Destroyed service \"%s\"\n", cur->ServiceName);
1160 ServiceHookTable = NULL;
1163 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name)
1165 SearchFunctionHook *newfcn;
1167 if (!name || !fcn_ptr) {
1171 newfcn = (SearchFunctionHook *)
1172 malloc(sizeof(SearchFunctionHook));
1173 newfcn->next = SearchFunctionHookTable;
1174 newfcn->name = name;
1175 newfcn->fcn_ptr = fcn_ptr;
1176 SearchFunctionHookTable = newfcn;
1178 MOD_syslog(LOG_DEBUG, "Registered a new search function (%s)\n", name);
1181 void CtdlUnregisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name)
1183 SearchFunctionHook *cur, *p;
1185 for (cur = SearchFunctionHookTable; cur != NULL; cur = cur->next) {
1186 while (fcn_ptr && (cur->fcn_ptr == fcn_ptr) && name && !strcmp(name, cur->name)) {
1187 MOD_syslog(LOG_DEBUG, "Unregistered search function(%s)\n", name);
1189 if (cur == SearchFunctionHookTable) {
1190 SearchFunctionHookTable = p;
1198 void CtdlDestroySearchHooks(void)
1200 SearchFunctionHook *cur, *p;
1202 cur = SearchFunctionHookTable;
1203 SearchFunctionHookTable = NULL;
1204 while (cur != NULL) {
1211 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name)
1213 SearchFunctionHook *fcn = NULL;
1215 for (fcn = SearchFunctionHookTable; fcn != NULL; fcn = fcn->next) {
1216 if (!func_name || !strcmp(func_name, fcn->name)) {
1217 (*fcn->fcn_ptr) (num_msgs, search_msgs, search_string);
1225 void PerformSessionHooks(int EventType)
1227 SessionFunctionHook *fcn = NULL;
1229 for (fcn = SessionHookTable; fcn != NULL; fcn = fcn->next) {
1230 if (fcn->eventtype == EventType) {
1231 if (EventType == EVT_TIMER) {
1232 pthread_setspecific(MyConKey, NULL); /* for every hook */
1234 (*fcn->h_function_pointer) ();
1239 void PerformUserHooks(ctdluser *usbuf, int EventType)
1241 UserFunctionHook *fcn = NULL;
1243 for (fcn = UserHookTable; fcn != NULL; fcn = fcn->next) {
1244 if (fcn->eventtype == EventType) {
1245 (*fcn->h_function_pointer) (usbuf);
1250 int PerformMessageHooks(struct CtdlMessage *msg, int EventType)
1252 MessageFunctionHook *fcn = NULL;
1253 int total_retval = 0;
1255 /* Other code may elect to protect this message from server-side
1256 * handlers; if this is the case, don't do anything.
1257 MOD_syslog(LOG_DEBUG, "** Event type is %d, flags are %d\n", EventType, msg->cm_flags);
1259 if (msg->cm_flags & CM_SKIP_HOOKS) {
1260 MODM_syslog(LOG_DEBUG, "Skipping hooks\n");
1264 /* Otherwise, run all the hooks appropriate to this event type.
1266 for (fcn = MessageHookTable; fcn != NULL; fcn = fcn->next) {
1267 if (fcn->eventtype == EventType) {
1268 total_retval = total_retval + (*fcn->h_function_pointer) (msg);
1272 /* Return the sum of the return codes from the hook functions. If
1273 * this is an EVT_BEFORESAVE event, a nonzero return code will cause
1274 * the save operation to abort.
1276 return total_retval;
1280 int PerformRoomHooks(struct ctdlroom *target_room)
1282 RoomFunctionHook *fcn;
1283 int total_retval = 0;
1285 MOD_syslog(LOG_DEBUG, "Performing room hooks for <%s>\n", target_room->QRname);
1287 for (fcn = RoomHookTable; fcn != NULL; fcn = fcn->next) {
1288 total_retval = total_retval + (*fcn->fcn_ptr) (target_room);
1291 /* Return the sum of the return codes from the hook functions.
1293 return total_retval;
1297 int PerformNetprocHooks(struct CtdlMessage *msg, char *target_room)
1299 NetprocFunctionHook *fcn;
1300 int total_retval = 0;
1302 for (fcn = NetprocHookTable; fcn != NULL; fcn = fcn->next) {
1303 total_retval = total_retval +
1304 (*fcn->h_function_pointer) (msg, target_room);
1307 /* Return the sum of the return codes from the hook functions.
1308 * A nonzero return code will cause the message to *not* be imported.
1310 return total_retval;
1314 void PerformDeleteHooks(char *room, long msgnum)
1316 DeleteFunctionHook *fcn;
1318 for (fcn = DeleteHookTable; fcn != NULL; fcn = fcn->next) {
1319 (*fcn->h_function_pointer) (room, msgnum);
1327 int PerformXmsgHooks(char *sender, char *sender_email, char *recp, char *msg)
1329 XmsgFunctionHook *fcn;
1333 for (p=0; p<MAX_XMSG_PRI; ++p) {
1334 for (fcn = XmsgHookTable; fcn != NULL; fcn = fcn->next) {
1335 if (fcn->order == p) {
1337 (*fcn->h_function_pointer)
1338 (sender, sender_email, recp, msg);
1341 /* Break out of the loop if a higher-priority function
1342 * successfully delivered the message. This prevents duplicate
1343 * deliveries to local users simultaneously signed onto
1346 if (total_sent) break;
1353 * Dirty hack until we impliment a hook mechanism for this
1355 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response)
1358 CtdlStartTLS (ok_response, nosup_response, error_response);
1362 void DebugModulesEnable(const int n)
1366 CTDL_MODULE_INIT(modules)
1369 CtdlRegisterDebugFlagHook(HKEY("modules"), DebugModulesEnable, &DebugModules);
1371 CtdlRegisterProtoHook(cmd_log_get, "LOGP", "Print Log-parameters");
1372 CtdlRegisterProtoHook(cmd_log_set, "LOGS", "Set Log-parameters");