9100daea3509c914b2df4a8670de418b146b9bda
[citadel.git] / citadel / serv_extensions.c
1 /*
2  * Citadel Dynamic Loading Module
3  * Written by Brian Costello <btx@calyx.net>
4  *
5  * Copyright (c) 1987-2011 by the citadel.org team
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include "sysdep.h"
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <unistd.h>
26 #include <sys/types.h>
27 #include <dirent.h>
28 #include <string.h>
29 #include <limits.h>
30 #include <ctype.h>
31 #include <syslog.h>
32 #include <libcitadel.h>
33 #include "citadel.h"
34 #include "server.h"
35 #include "serv_extensions.h"
36 #include "sysdep_decls.h"
37 #include "msgbase.h"
38 #include "config.h"
39
40 #include "modules/crypto/serv_crypto.h" /* Needed until a universal crypto startup hook is implimented for CtdlStartTLS */
41
42 #include "ctdl_module.h"
43
44 #ifndef HAVE_SNPRINTF
45 #include <stdarg.h>
46 #include "snprintf.h"
47 #endif
48
49 int DebugModules = 0;
50  
51 /*
52  * Structure defentitions for hook tables
53  */
54
55 typedef struct __LogDebugEntry {
56         CtdlDbgFunction F;
57         const char *Name;
58         long Len;
59         const int *LogP;
60 } LogDebugEntry;
61 HashList *LogDebugEntryTable = NULL;
62
63 typedef struct LogFunctionHook LogFunctionHook;
64 struct LogFunctionHook {
65         LogFunctionHook *next;
66         int loglevel;
67         void (*h_function_pointer) (char *);
68 };
69 extern LogFunctionHook *LogHookTable;
70
71 typedef struct FixedOutputHook FixedOutputHook;
72 struct FixedOutputHook {
73         FixedOutputHook *next;
74         char content_type[64];
75         void (*h_function_pointer) (char *, int);
76 };
77 extern FixedOutputHook *FixedOutputTable;
78
79
80
81 /*
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
85  * pertinent data.
86  */
87 typedef struct SessionFunctionHook SessionFunctionHook;
88 struct SessionFunctionHook {
89         SessionFunctionHook *next;
90         void (*h_function_pointer) (void);
91         int eventtype;
92 };
93 extern SessionFunctionHook *SessionHookTable;
94
95
96 /*
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.
100  */
101 typedef struct UserFunctionHook UserFunctionHook;
102 struct UserFunctionHook {
103         UserFunctionHook *next;
104         void (*h_function_pointer) (struct ctdluser *usbuf);
105         int eventtype;
106 };
107 extern UserFunctionHook *UserHookTable;
108
109 /*
110  * MessageFunctionHook extensions are used for hooks which implement handlers
111  * for various types of message operations (save, read, etc.)
112  */
113 typedef struct MessageFunctionHook MessageFunctionHook;
114 struct MessageFunctionHook {
115         MessageFunctionHook *next;
116         int (*h_function_pointer) (struct CtdlMessage *msg);
117         int eventtype;
118 };
119 extern MessageFunctionHook *MessageHookTable;
120
121
122 /*
123  * NetprocFunctionHook extensions are used for hooks which implement handlers
124  * for incoming network messages.
125  */
126 typedef struct NetprocFunctionHook NetprocFunctionHook;
127 struct NetprocFunctionHook {
128         NetprocFunctionHook *next;
129         int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
130 };
131 extern NetprocFunctionHook *NetprocHookTable;
132
133
134 /*
135  * DeleteFunctionHook extensions are used for hooks which get called when a
136  * message is about to be deleted.
137  */
138 typedef struct DeleteFunctionHook DeleteFunctionHook;
139 struct DeleteFunctionHook {
140         DeleteFunctionHook *next;
141         void (*h_function_pointer) (char *target_room, long msgnum);
142 };
143 extern DeleteFunctionHook *DeleteHookTable;
144
145
146 /*
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.
151  */
152 typedef struct XmsgFunctionHook XmsgFunctionHook;
153 struct XmsgFunctionHook {
154         XmsgFunctionHook *next;
155         int (*h_function_pointer) (char *, char *, char *, char *);
156         int order;
157 };
158 extern XmsgFunctionHook *XmsgHookTable;
159
160
161
162
163 /*
164  * RoomFunctionHook extensions are used for hooks which impliment room
165  * processing functions when new messages are added EG. SIEVE.
166  */
167 typedef struct RoomFunctionHook RoomFunctionHook;
168 struct RoomFunctionHook {
169         RoomFunctionHook *next;
170         int (*fcn_ptr) (struct ctdlroom *);
171 };
172 extern RoomFunctionHook *RoomHookTable;
173
174
175
176 typedef struct SearchFunctionHook SearchFunctionHook;
177 struct SearchFunctionHook {
178         SearchFunctionHook *next;
179         void (*fcn_ptr) (int *, long **, const char *);
180         char *name;
181 };
182 extern SearchFunctionHook *SearchFunctionHookTable;
183
184
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;
197
198 typedef struct ProtoFunctionHook ProtoFunctionHook;
199 struct ProtoFunctionHook {
200         void (*handler) (char *cmdbuf);
201         const char *cmd;
202         const char *desc;
203 };
204
205 HashList *ProtoHookList = NULL;
206
207
208 #define ERR_PORT (1 << 1)
209
210
211 static StrBuf *portlist = NULL;
212
213 static StrBuf *errormessages = NULL;
214
215
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")}
227 };
228
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")};
236
237
238 void LogPrintMessages(long err)
239 {
240         StrBuf *Message;
241         StrBuf *List, *DetailList;
242         ConstStr *Short, *Where, *Hint; 
243
244         
245         Message = NewStrBufPlain(NULL, 
246                                  StrLength(portlist) + StrLength(errormessages));
247         
248         DetailErrorFlags = DetailErrorFlags & ~err;
249
250         switch (err)
251         {
252         case ERR_PORT:
253                 Short = &ErrPortShort;
254                 Where = &ErrPortWhere;
255                 Hint  = &ErrPortHint;
256                 List  = portlist;
257                 DetailList = errormessages;
258                 break;
259         default:
260                 Short = &Empty;
261                 Where = &Empty;
262                 Hint  = &Empty;
263                 List  = NULL;
264                 DetailList = NULL;
265         }
266
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);
279
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);
283
284         FreeStrBuf(&Message);
285         FreeStrBuf(&List);
286         FreeStrBuf(&DetailList);
287 }
288
289
290 void AddPortError(char *Port, char *ErrorMessage)
291 {
292         long len;
293
294         DetailErrorFlags |= ERR_PORT;
295
296         len = StrLength(errormessages);
297         if (len > 0) StrBufAppendBufPlain(errormessages, HKEY("; "), 0);
298         else errormessages = NewStrBuf();
299         StrBufAppendBufPlain(errormessages, ErrorMessage, -1, 0);
300
301
302         len = StrLength(portlist);
303         if (len > 0) StrBufAppendBufPlain(portlist, HKEY(";"), 0);
304         else portlist = NewStrBuf();
305         StrBufAppendBufPlain(portlist, Port, -1, 0);
306 }
307
308
309 int DLoader_Exec_Cmd(char *cmdbuf)
310 {
311         void *vP;
312         ProtoFunctionHook *p;
313
314         if (GetHash(ProtoHookList, cmdbuf, 4, &vP) && (vP != NULL)) {
315                 p = (ProtoFunctionHook*) vP;
316                 p->handler(&cmdbuf[5]);
317                 return 1;
318         }
319         return 0;
320 }
321
322 long FourHash(const char *key, long length) 
323 {
324         int i;
325         int ret = 0;
326         const unsigned char *ptr = (const unsigned char*)key;
327
328         for (i = 0; i < 4; i++, ptr ++) 
329                 ret = (ret << 8) | 
330                         ( ((*ptr >= 'a') &&
331                            (*ptr <= 'z'))? 
332                           *ptr - 'a' + 'A': 
333                           *ptr);
334
335         return ret;
336 }
337
338 void CtdlRegisterDebugFlagHook(const char *Name, long Len, CtdlDbgFunction F, const int *LogP)
339 {
340         LogDebugEntry *E;
341         if (LogDebugEntryTable == NULL)
342                 LogDebugEntryTable = NewHash(1, NULL);
343         E = (LogDebugEntry*) malloc(sizeof(LogDebugEntry));
344         E->F = F;
345         E->Name = Name;
346         E->Len = Len;
347         E->LogP = LogP;
348         Put(LogDebugEntryTable, Name, Len, E, NULL);
349         
350 }
351 void CtdlSetDebugLogFacilities(const char **Str, long n)
352 {
353         StrBuf *Token = NULL;
354         StrBuf *Buf = NULL;
355         const char *ch;
356         int i;
357         int DoAll = 0;
358         void *vptr;
359
360         for (i=0; i < n; i++){
361                 if ((Str[i] != NULL) && !IsEmptyStr(Str[i])) {
362                         if (strcmp(Str[i], "all") == 0) {
363                                 DoAll = 1;
364                                 continue;
365                         }
366                         Buf = NewStrBufPlain(Str[i], -1);
367                         ch = NULL;
368                         if (Token == NULL)
369                                 Token = NewStrBufPlain(NULL, StrLength(Buf));
370                         while ((ch != StrBufNOTNULL) &&
371                                StrBufExtract_NextToken(Token, Buf, &ch, ',')) {
372                                 if (GetHash(LogDebugEntryTable, SKEY(Token), &vptr) && 
373                                     (vptr != NULL))
374                                 {
375                                         LogDebugEntry *E = (LogDebugEntry*)vptr;
376                                         E->F(1);
377                                 }
378                         }
379                 }
380                 FreeStrBuf(&Buf);
381         }
382         FreeStrBuf(&Token);
383         if (DoAll) {
384                 long HKLen;
385                 const char *ch;
386                 HashPos *Pos;
387
388                 Pos = GetNewHashPos(LogDebugEntryTable, 0);
389                 while (GetNextHashPos(LogDebugEntryTable, Pos, &HKLen, &ch, &vptr)) {
390                         LogDebugEntry *E = (LogDebugEntry*)vptr;
391                         E->F(1);
392                 }
393
394                 DeleteHashPos(&Pos);
395         }
396 }
397 void cmd_log_get(char *argbuf)
398 {
399         long HKLen;
400         const char *ch;
401         HashPos *Pos;
402         void *vptr;
403
404         if (CtdlAccessCheck(ac_aide)) return;
405
406         cprintf("%d Log modules enabled:\n", LISTING_FOLLOWS);
407
408         Pos = GetNewHashPos(LogDebugEntryTable, 0);
409
410         while (GetNextHashPos(LogDebugEntryTable, Pos, &HKLen, &ch, &vptr)) {
411                 LogDebugEntry *E = (LogDebugEntry*)vptr;
412                 cprintf("%s: %d\n", ch, *E->LogP);
413         }
414         
415         DeleteHashPos(&Pos);
416         cprintf("000\n");
417 }
418 void cmd_log_set(char *argbuf)
419 {
420         void *vptr;
421         int lset;
422         int wlen;
423         char which[SIZ] = "";
424
425         if (CtdlAccessCheck(ac_aide)) return;
426
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) && 
432             (vptr != NULL))
433         {
434                 LogDebugEntry *E = (LogDebugEntry*)vptr;
435                 E->F(lset);
436                 cprintf("%d %s|%d\n", CIT_OK, which, lset);
437         }
438         else {
439                 cprintf("%d Log setting %s not known\n", 
440                         ERROR, which);
441         }
442 }
443 void CtdlDestroyDebugTable(void)
444 {
445
446         DeleteHash(&LogDebugEntryTable);
447 }
448
449 void CtdlRegisterProtoHook(void (*handler) (char *), char *cmd, char *desc)
450 {
451         ProtoFunctionHook *p;
452
453         if (ProtoHookList == NULL)
454                 ProtoHookList = NewHash (1, FourHash);
455
456
457         p = (ProtoFunctionHook *)
458                 malloc(sizeof(ProtoFunctionHook));
459
460         if (p == NULL) {
461                 fprintf(stderr, "can't malloc new ProtoFunctionHook\n");
462                 exit(EXIT_FAILURE);
463         }
464         p->handler = handler;
465         p->cmd = cmd;
466         p->desc = desc;
467
468         Put(ProtoHookList, cmd, 4, p, NULL);
469         MOD_syslog(LOG_DEBUG, "Registered server command %s (%s)\n", cmd, desc);
470 }
471
472 void CtdlDestroyProtoHooks(void)
473 {
474
475         DeleteHash(&ProtoHookList);
476 }
477
478
479 void CtdlRegisterCleanupHook(void (*fcn_ptr) (void))
480 {
481
482         CleanupFunctionHook *newfcn;
483
484         newfcn = (CleanupFunctionHook *)
485             malloc(sizeof(CleanupFunctionHook));
486         newfcn->next = CleanupHookTable;
487         newfcn->h_function_pointer = fcn_ptr;
488         CleanupHookTable = newfcn;
489
490         MODM_syslog(LOG_DEBUG, "Registered a new cleanup function\n");
491 }
492
493
494 void CtdlUnregisterCleanupHook(void (*fcn_ptr) (void))
495 {
496         CleanupFunctionHook *cur, *p;
497
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");
503                         p = cur->next;
504                         if (cur == CleanupHookTable) {
505                                 CleanupHookTable = p;
506                         }
507                         free(cur);
508                         cur = p;
509                 }
510         }
511 }
512
513
514 void CtdlDestroyCleanupHooks(void)
515 {
516         CleanupFunctionHook *cur, *p;
517
518         cur = CleanupHookTable;
519         while (cur != NULL)
520         {
521                 MODM_syslog(LOG_DEBUG, "Destroyed cleanup function\n");
522                 p = cur->next;
523                 free(cur);
524                 cur = p;
525         }
526         CleanupHookTable = NULL;
527 }
528
529 void CtdlRegisterEVCleanupHook(void (*fcn_ptr) (void))
530 {
531
532         CleanupFunctionHook *newfcn;
533
534         newfcn = (CleanupFunctionHook *)
535             malloc(sizeof(CleanupFunctionHook));
536         newfcn->next = EVCleanupHookTable;
537         newfcn->h_function_pointer = fcn_ptr;
538         EVCleanupHookTable = newfcn;
539
540         MODM_syslog(LOG_DEBUG, "Registered a new cleanup function\n");
541 }
542
543
544 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr) (void))
545 {
546         CleanupFunctionHook *cur, *p;
547
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");
553                         p = cur->next;
554                         if (cur == EVCleanupHookTable) {
555                                 EVCleanupHookTable = p;
556                         }
557                         free(cur);
558                         cur = p;
559                 }
560         }
561 }
562
563
564 void CtdlDestroyEVCleanupHooks(void)
565 {
566         CleanupFunctionHook *cur, *p;
567
568         cur = EVCleanupHookTable;
569         while (cur != NULL)
570         {
571                 MODM_syslog(LOG_DEBUG, "Destroyed cleanup function\n");
572                 p = cur->next;
573                 free(cur);
574                 cur = p;
575         }
576         EVCleanupHookTable = NULL;
577 }
578
579
580 void CtdlRegisterSessionHook(void (*fcn_ptr) (void), int EventType)
581 {
582
583         SessionFunctionHook *newfcn;
584
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;
591
592         MOD_syslog(LOG_DEBUG, "Registered a new session function (type %d)\n",
593                    EventType);
594 }
595
596
597 void CtdlUnregisterSessionHook(void (*fcn_ptr) (void), int EventType)
598 {
599         SessionFunctionHook *cur, *p;
600
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",
607                                    EventType);
608                         p = cur->next;
609                         if (cur == SessionHookTable) {
610                                 SessionHookTable = p;
611                         }
612                         free(cur);
613                         cur = p;
614                 }
615         }
616 }
617
618 void CtdlDestroySessionHooks(void)
619 {
620         SessionFunctionHook *cur, *p;
621
622         cur = SessionHookTable;
623         while (cur != NULL)
624         {
625                 MODM_syslog(LOG_DEBUG, "Destroyed session function\n");
626                 p = cur->next;
627                 free(cur);
628                 cur = p;
629         }
630         SessionHookTable = NULL;
631 }
632
633
634 void CtdlRegisterUserHook(void (*fcn_ptr) (ctdluser *), int EventType)
635 {
636
637         UserFunctionHook *newfcn;
638
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;
645
646         MOD_syslog(LOG_DEBUG, "Registered a new user function (type %d)\n",
647                    EventType);
648 }
649
650
651 void CtdlUnregisterUserHook(void (*fcn_ptr) (struct ctdluser *), int EventType)
652 {
653         UserFunctionHook *cur, *p;
654
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",
661                                    EventType);
662                         p = cur->next;
663                         if (cur == UserHookTable) {
664                                 UserHookTable = p;
665                         }
666                         free(cur);
667                         cur = p;
668                 }
669         }
670 }
671
672 void CtdlDestroyUserHooks(void)
673 {
674         UserFunctionHook *cur, *p;
675
676         cur = UserHookTable;
677         while (cur != NULL)
678         {
679                 MODM_syslog(LOG_DEBUG, "Destroyed user function \n");
680                 p = cur->next;
681                 free(cur);
682                 cur = p;
683         }
684         UserHookTable = NULL;
685 }
686
687
688 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
689                                 int EventType)
690 {
691
692         MessageFunctionHook *newfcn;
693
694         newfcn = (MessageFunctionHook *)
695             malloc(sizeof(MessageFunctionHook));
696         newfcn->next = MessageHookTable;
697         newfcn->h_function_pointer = handler;
698         newfcn->eventtype = EventType;
699         MessageHookTable = newfcn;
700
701         MOD_syslog(LOG_DEBUG, "Registered a new message function (type %d)\n",
702                    EventType);
703 }
704
705
706 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
707                 int EventType)
708 {
709         MessageFunctionHook *cur, *p;
710
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",
717                                    EventType);
718                         p = cur->next;
719                         if (cur == MessageHookTable) {
720                                 MessageHookTable = p;
721                         }
722                         free(cur);
723                         cur = p;
724                 }
725         }
726 }
727
728 void CtdlDestroyMessageHook(void)
729 {
730         MessageFunctionHook *cur, *p;
731
732         cur = MessageHookTable; 
733         while (cur != NULL)
734         {
735                 MOD_syslog(LOG_DEBUG, "Destroyed message function (type %d)\n", cur->eventtype);
736                 p = cur->next;
737                 free(cur);
738                 cur = p;
739         }
740         MessageHookTable = NULL;
741 }
742
743
744 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
745 {
746         RoomFunctionHook *newfcn;
747
748         newfcn = (RoomFunctionHook *)
749             malloc(sizeof(RoomFunctionHook));
750         newfcn->next = RoomHookTable;
751         newfcn->fcn_ptr = fcn_ptr;
752         RoomHookTable = newfcn;
753
754         MODM_syslog(LOG_DEBUG, "Registered a new room function\n");
755 }
756
757
758 void CtdlUnregisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
759 {
760         RoomFunctionHook *cur, *p;
761
762         for (cur = RoomHookTable; cur != NULL; cur = cur->next) {
763                 while (cur != NULL && fcn_ptr == cur->fcn_ptr) {
764                         MODM_syslog(LOG_DEBUG, "Unregistered room function\n");
765                         p = cur->next;
766                         if (cur == RoomHookTable) {
767                                 RoomHookTable = p;
768                         }
769                         free(cur);
770                         cur = p;
771                 }
772         }
773 }
774
775
776 void CtdlDestroyRoomHooks(void)
777 {
778         RoomFunctionHook *cur, *p;
779
780         cur = RoomHookTable;
781         while (cur != NULL)
782         {
783                 MODM_syslog(LOG_DEBUG, "Destroyed room function\n");
784                 p = cur->next;
785                 free(cur);
786                 cur = p;
787         }
788         RoomHookTable = NULL;
789 }
790
791 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
792 {
793         NetprocFunctionHook *newfcn;
794
795         newfcn = (NetprocFunctionHook *)
796             malloc(sizeof(NetprocFunctionHook));
797         newfcn->next = NetprocHookTable;
798         newfcn->h_function_pointer = handler;
799         NetprocHookTable = newfcn;
800
801         MODM_syslog(LOG_DEBUG, "Registered a new netproc function\n");
802 }
803
804
805 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
806 {
807         NetprocFunctionHook *cur, *p;
808
809         for (cur = NetprocHookTable; cur != NULL; cur = cur->next) {
810                 /* This will also remove duplicates if any */
811                 while (cur != NULL &&
812                                 handler == cur->h_function_pointer ) {
813                         MODM_syslog(LOG_DEBUG, "Unregistered netproc function\n");
814                         p = cur->next;
815                         if (cur == NetprocHookTable) {
816                                 NetprocHookTable = p;
817                         }
818                         free(cur);
819                         cur = p;
820                 }
821         }
822 }
823
824 void CtdlDestroyNetprocHooks(void)
825 {
826         NetprocFunctionHook *cur, *p;
827
828         cur = NetprocHookTable;
829         while (cur != NULL)
830         {
831                 MODM_syslog(LOG_DEBUG, "Destroyed netproc function\n");
832                 p = cur->next;
833                 free(cur);
834                 cur = p;
835         }
836         NetprocHookTable = NULL;
837 }
838
839
840 void CtdlRegisterDeleteHook(void (*handler)(char *, long) )
841 {
842         DeleteFunctionHook *newfcn;
843
844         newfcn = (DeleteFunctionHook *)
845             malloc(sizeof(DeleteFunctionHook));
846         newfcn->next = DeleteHookTable;
847         newfcn->h_function_pointer = handler;
848         DeleteHookTable = newfcn;
849
850         MODM_syslog(LOG_DEBUG, "Registered a new delete function\n");
851 }
852
853
854 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) )
855 {
856         DeleteFunctionHook *cur, *p;
857
858         for (cur = DeleteHookTable; cur != NULL; cur = cur->next) {
859                 /* This will also remove duplicates if any */
860                 while (cur != NULL &&
861                                 handler == cur->h_function_pointer ) {
862                         MODM_syslog(LOG_DEBUG, "Unregistered delete function\n");
863                         p = cur->next;
864                         if (cur == DeleteHookTable) {
865                                 DeleteHookTable = p;
866                         }
867                         free(cur);
868                         cur = p;
869                 }
870         }
871 }
872 void CtdlDestroyDeleteHooks(void)
873 {
874         DeleteFunctionHook *cur, *p;
875
876         cur = DeleteHookTable;
877         while (cur != NULL)
878         {
879                 MODM_syslog(LOG_DEBUG, "Destroyed delete function\n");
880                 p = cur->next;
881                 free(cur);
882                 cur = p;                
883         }
884         DeleteHookTable = NULL;
885 }
886
887
888
889
890 void CtdlRegisterFixedOutputHook(char *content_type, void (*handler)(char *, int) )
891 {
892         FixedOutputHook *newfcn;
893
894         newfcn = (FixedOutputHook *)
895             malloc(sizeof(FixedOutputHook));
896         newfcn->next = FixedOutputTable;
897         newfcn->h_function_pointer = handler;
898         safestrncpy(newfcn->content_type, content_type, sizeof newfcn->content_type);
899         FixedOutputTable = newfcn;
900
901         MOD_syslog(LOG_DEBUG, "Registered a new fixed output function for %s\n", newfcn->content_type);
902 }
903
904
905 void CtdlUnregisterFixedOutputHook(char *content_type)
906 {
907         FixedOutputHook *cur, *p;
908
909         for (cur = FixedOutputTable; cur != NULL; cur = cur->next) {
910                 /* This will also remove duplicates if any */
911                 while (cur != NULL && (!strcasecmp(content_type, cur->content_type))) {
912                         MOD_syslog(LOG_DEBUG, "Unregistered fixed output function for %s\n", content_type);
913                         p = cur->next;
914                         if (cur == FixedOutputTable) {
915                                 FixedOutputTable = p;
916                         }
917                         free(cur);
918                         cur = p;
919                 }
920         }
921 }
922
923 void CtdlDestroyFixedOutputHooks(void)
924 {
925         FixedOutputHook *cur, *p;
926
927         cur = FixedOutputTable; 
928         while (cur != NULL)
929         {
930                 MOD_syslog(LOG_DEBUG, "Destroyed fixed output function for %s\n", cur->content_type);
931                 p = cur->next;
932                 free(cur);
933                 cur = p;
934                 
935         }
936         FixedOutputTable = NULL;
937 }
938
939 /* returns nonzero if we found a hook and used it */
940 int PerformFixedOutputHooks(char *content_type, char *content, int content_length)
941 {
942         FixedOutputHook *fcn;
943
944         for (fcn = FixedOutputTable; fcn != NULL; fcn = fcn->next) {
945                 if (!strcasecmp(content_type, fcn->content_type)) {
946                         (*fcn->h_function_pointer) (content, content_length);
947                         return(1);
948                 }
949         }
950         return(0);
951 }
952
953
954
955
956
957 void CtdlRegisterXmsgHook(int (*fcn_ptr) (char *, char *, char *, char *), int order)
958 {
959
960         XmsgFunctionHook *newfcn;
961
962         newfcn = (XmsgFunctionHook *) malloc(sizeof(XmsgFunctionHook));
963         newfcn->next = XmsgHookTable;
964         newfcn->order = order;
965         newfcn->h_function_pointer = fcn_ptr;
966         XmsgHookTable = newfcn;
967         MOD_syslog(LOG_DEBUG, "Registered a new x-msg function (priority %d)\n", order);
968 }
969
970
971 void CtdlUnregisterXmsgHook(int (*fcn_ptr) (char *, char *, char *, char *), int order)
972 {
973         XmsgFunctionHook *cur, *p;
974
975         for (cur = XmsgHookTable; cur != NULL; cur = cur->next) {
976                 /* This will also remove duplicates if any */
977                 while (cur != NULL &&
978                                 fcn_ptr == cur->h_function_pointer &&
979                                 order == cur->order) {
980                         MOD_syslog(LOG_DEBUG, "Unregistered x-msg function "
981                                    "(priority %d)\n", order);
982                         p = cur->next;
983                         if (cur == XmsgHookTable) {
984                                 XmsgHookTable = p;
985                         }
986                         free(cur);
987                         cur = p;
988                 }
989         }
990 }
991
992 void CtdlDestroyXmsgHooks(void)
993 {
994         XmsgFunctionHook *cur, *p;
995
996         cur = XmsgHookTable;
997         while (cur != NULL)
998         {
999                 MOD_syslog(LOG_DEBUG, "Destroyed x-msg function "
1000                         "(priority %d)\n", cur->order);
1001                 p = cur->next;
1002                         
1003                 free(cur);
1004                 cur = p;
1005         }
1006         XmsgHookTable = NULL;
1007 }
1008
1009
1010 void CtdlRegisterServiceHook(int tcp_port,
1011                              char *sockpath,
1012                              void (*h_greeting_function) (void),
1013                              void (*h_command_function) (void),
1014                              void (*h_async_function) (void),
1015                              const char *ServiceName)
1016 {
1017         ServiceFunctionHook *newfcn;
1018         char *message;
1019         char error[SIZ];
1020
1021         strcpy(error, "");
1022         newfcn = (ServiceFunctionHook *) malloc(sizeof(ServiceFunctionHook));
1023         message = (char*) malloc (SIZ + SIZ);
1024         
1025         newfcn->next = ServiceHookTable;
1026         newfcn->tcp_port = tcp_port;
1027         newfcn->sockpath = sockpath;
1028         newfcn->h_greeting_function = h_greeting_function;
1029         newfcn->h_command_function = h_command_function;
1030         newfcn->h_async_function = h_async_function;
1031         newfcn->ServiceName = ServiceName;
1032
1033         if (sockpath != NULL) {
1034                 newfcn->msock = ctdl_uds_server(sockpath, config.c_maxsessions, error);
1035                 snprintf(message, SIZ, "Unix domain socket '%s': ", sockpath);
1036         }
1037         else if (tcp_port <= 0) {       /* port -1 to disable */
1038                 MOD_syslog(LOG_INFO, "Service %s has been manually disabled, skipping\n", ServiceName);
1039                 free (message);
1040                 free(newfcn);
1041                 return;
1042         }
1043         else {
1044                 newfcn->msock = ctdl_tcp_server(config.c_ip_addr,
1045                                               tcp_port,
1046                                               config.c_maxsessions, 
1047                                               error);
1048                 snprintf(message, SIZ, "TCP port %s:%d: (%s) ", 
1049                          config.c_ip_addr, tcp_port, ServiceName);
1050         }
1051
1052         if (newfcn->msock > 0) {
1053                 ServiceHookTable = newfcn;
1054                 strcat(message, "registered.");
1055                 MOD_syslog(LOG_INFO, "%s\n", message);
1056         }
1057         else {
1058                 AddPortError(message, error);
1059                 strcat(message, "FAILED.");
1060                 MOD_syslog(LOG_CRIT, "%s\n", message);
1061                 free(newfcn);
1062         }
1063         free(message);
1064 }
1065
1066
1067 void CtdlUnregisterServiceHook(int tcp_port, char *sockpath,
1068                         void (*h_greeting_function) (void),
1069                         void (*h_command_function) (void),
1070                         void (*h_async_function) (void)
1071                         )
1072 {
1073         ServiceFunctionHook *cur, *p;
1074
1075         cur = ServiceHookTable;
1076         while (cur != NULL) {
1077                 /* This will also remove duplicates if any */
1078                 while (cur != NULL &&
1079                                 !(sockpath && cur->sockpath &&
1080                                         strcmp(sockpath, cur->sockpath)) &&
1081                                 h_greeting_function == cur->h_greeting_function &&
1082                                 h_command_function == cur->h_command_function &&
1083                                 h_async_function == cur->h_async_function &&
1084                                 tcp_port == cur->tcp_port) {
1085                         close(cur->msock);
1086                         if (sockpath) {
1087                                 MOD_syslog(LOG_INFO, "Closed UNIX domain socket %s\n",
1088                                            sockpath);
1089                                 unlink(sockpath);
1090                         } else if (tcp_port) {
1091                                 MOD_syslog(LOG_INFO, "Closed TCP port %d\n", tcp_port);
1092                         } else {
1093                                 MOD_syslog(LOG_INFO, "Unregistered service \"%s\"\n", cur->ServiceName);
1094                         }
1095                         p = cur->next;
1096                         if (cur == ServiceHookTable) {
1097                                 ServiceHookTable = p;
1098                         }
1099                         free(cur);
1100                         cur = p;
1101                 }
1102         }
1103 }
1104
1105
1106 void CtdlShutdownServiceHooks(void)
1107 {
1108         /* sort of a duplicate of close_masters() but called earlier */
1109         ServiceFunctionHook *cur;
1110
1111         cur = ServiceHookTable;
1112         while (cur != NULL) 
1113         {
1114                 if (cur->msock != -1)
1115                 {
1116                         close(cur->msock);
1117                         cur->msock = -1;
1118                         if (cur->sockpath != NULL){
1119                                 MOD_syslog(LOG_INFO, "[%s] Closed UNIX domain socket %s\n",
1120                                            cur->ServiceName,
1121                                            cur->sockpath);
1122                                 unlink(cur->sockpath);
1123                         } else {
1124                                 MOD_syslog(LOG_INFO, "[%s] closing service\n", 
1125                                            cur->ServiceName);
1126                         }
1127                 }
1128                 cur = cur->next;
1129         }
1130 }
1131
1132 void CtdlDestroyServiceHook(void)
1133 {
1134         ServiceFunctionHook *cur, *p;
1135
1136         cur = ServiceHookTable;
1137         while (cur != NULL)
1138         {
1139                 close(cur->msock);
1140                 if (cur->sockpath) {
1141                         MOD_syslog(LOG_INFO, "Closed UNIX domain socket %s\n",
1142                                    cur->sockpath);
1143                         unlink(cur->sockpath);
1144                 } else if (cur->tcp_port) {
1145                         MOD_syslog(LOG_INFO, "Closed TCP port %d\n", cur->tcp_port);
1146                 } else {
1147                         MOD_syslog(LOG_INFO, "Destroyed service \"%s\"\n", cur->ServiceName);
1148                 }
1149                 p = cur->next;
1150                 free(cur);
1151                 cur = p;
1152         }
1153         ServiceHookTable = NULL;
1154 }
1155
1156 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name)
1157 {
1158         SearchFunctionHook *newfcn;
1159
1160         if (!name || !fcn_ptr) {
1161                 return;
1162         }
1163         
1164         newfcn = (SearchFunctionHook *)
1165             malloc(sizeof(SearchFunctionHook));
1166         newfcn->next = SearchFunctionHookTable;
1167         newfcn->name = name;
1168         newfcn->fcn_ptr = fcn_ptr;
1169         SearchFunctionHookTable = newfcn;
1170
1171         MOD_syslog(LOG_DEBUG, "Registered a new search function (%s)\n", name);
1172 }
1173
1174 void CtdlUnregisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name)
1175 {
1176         SearchFunctionHook *cur, *p;
1177         
1178         for (cur = SearchFunctionHookTable; cur != NULL; cur = cur->next) {
1179                 while (fcn_ptr && (cur->fcn_ptr == fcn_ptr) && name && !strcmp(name, cur->name)) {
1180                         MOD_syslog(LOG_DEBUG, "Unregistered search function(%s)\n", name);
1181                         p = cur->next;
1182                         if (cur == SearchFunctionHookTable) {
1183                                 SearchFunctionHookTable = p;
1184                         }
1185                         free (cur);
1186                         cur = p;
1187                 }
1188         }
1189 }
1190
1191 void CtdlDestroySearchHooks(void)
1192 {
1193         SearchFunctionHook *cur, *p;
1194
1195         cur = SearchFunctionHookTable;
1196         SearchFunctionHookTable = NULL;
1197         while (cur != NULL) {
1198                 p = cur->next;
1199                 free(cur);
1200                 cur = p;
1201         }
1202 }
1203
1204 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name)
1205 {
1206         SearchFunctionHook *fcn = NULL;
1207
1208         for (fcn = SearchFunctionHookTable; fcn != NULL; fcn = fcn->next) {
1209                 if (!func_name || !strcmp(func_name, fcn->name)) {
1210                         (*fcn->fcn_ptr) (num_msgs, search_msgs, search_string);
1211                         return;
1212                 }
1213         }
1214         *num_msgs = 0;
1215 }
1216
1217
1218 void PerformSessionHooks(int EventType)
1219 {
1220         SessionFunctionHook *fcn = NULL;
1221
1222         for (fcn = SessionHookTable; fcn != NULL; fcn = fcn->next) {
1223                 if (fcn->eventtype == EventType) {
1224                         if (EventType == EVT_TIMER) {
1225                                 pthread_setspecific(MyConKey, NULL);    /* for every hook */
1226                         }
1227                         (*fcn->h_function_pointer) ();
1228                 }
1229         }
1230 }
1231
1232 void PerformUserHooks(ctdluser *usbuf, int EventType)
1233 {
1234         UserFunctionHook *fcn = NULL;
1235
1236         for (fcn = UserHookTable; fcn != NULL; fcn = fcn->next) {
1237                 if (fcn->eventtype == EventType) {
1238                         (*fcn->h_function_pointer) (usbuf);
1239                 }
1240         }
1241 }
1242
1243 int PerformMessageHooks(struct CtdlMessage *msg, int EventType)
1244 {
1245         MessageFunctionHook *fcn = NULL;
1246         int total_retval = 0;
1247
1248         /* Other code may elect to protect this message from server-side
1249          * handlers; if this is the case, don't do anything.
1250         MOD_syslog(LOG_DEBUG, "** Event type is %d, flags are %d\n", EventType, msg->cm_flags);
1251          */
1252         if (msg->cm_flags & CM_SKIP_HOOKS) {
1253                 MODM_syslog(LOG_DEBUG, "Skipping hooks\n");
1254                 return(0);
1255         }
1256
1257         /* Otherwise, run all the hooks appropriate to this event type.
1258          */
1259         for (fcn = MessageHookTable; fcn != NULL; fcn = fcn->next) {
1260                 if (fcn->eventtype == EventType) {
1261                         total_retval = total_retval + (*fcn->h_function_pointer) (msg);
1262                 }
1263         }
1264
1265         /* Return the sum of the return codes from the hook functions.  If
1266          * this is an EVT_BEFORESAVE event, a nonzero return code will cause
1267          * the save operation to abort.
1268          */
1269         return total_retval;
1270 }
1271
1272
1273 int PerformRoomHooks(struct ctdlroom *target_room)
1274 {
1275         RoomFunctionHook *fcn;
1276         int total_retval = 0;
1277
1278         MOD_syslog(LOG_DEBUG, "Performing room hooks for <%s>\n", target_room->QRname);
1279
1280         for (fcn = RoomHookTable; fcn != NULL; fcn = fcn->next) {
1281                 total_retval = total_retval + (*fcn->fcn_ptr) (target_room);
1282         }
1283
1284         /* Return the sum of the return codes from the hook functions.
1285          */
1286         return total_retval;
1287 }
1288
1289
1290 int PerformNetprocHooks(struct CtdlMessage *msg, char *target_room)
1291 {
1292         NetprocFunctionHook *fcn;
1293         int total_retval = 0;
1294
1295         for (fcn = NetprocHookTable; fcn != NULL; fcn = fcn->next) {
1296                 total_retval = total_retval +
1297                         (*fcn->h_function_pointer) (msg, target_room);
1298         }
1299
1300         /* Return the sum of the return codes from the hook functions.
1301          * A nonzero return code will cause the message to *not* be imported.
1302          */
1303         return total_retval;
1304 }
1305
1306
1307 void PerformDeleteHooks(char *room, long msgnum)
1308 {
1309         DeleteFunctionHook *fcn;
1310
1311         for (fcn = DeleteHookTable; fcn != NULL; fcn = fcn->next) {
1312                 (*fcn->h_function_pointer) (room, msgnum);
1313         }
1314 }
1315
1316
1317
1318
1319
1320 int PerformXmsgHooks(char *sender, char *sender_email, char *recp, char *msg)
1321 {
1322         XmsgFunctionHook *fcn;
1323         int total_sent = 0;
1324         int p;
1325
1326         for (p=0; p<MAX_XMSG_PRI; ++p) {
1327                 for (fcn = XmsgHookTable; fcn != NULL; fcn = fcn->next) {
1328                         if (fcn->order == p) {
1329                                 total_sent +=
1330                                         (*fcn->h_function_pointer)
1331                                                 (sender, sender_email, recp, msg);
1332                         }
1333                 }
1334                 /* Break out of the loop if a higher-priority function
1335                  * successfully delivered the message.  This prevents duplicate
1336                  * deliveries to local users simultaneously signed onto
1337                  * remote services.
1338                  */
1339                 if (total_sent) break;
1340         }
1341         return total_sent;
1342 }
1343
1344
1345 /*
1346  * Dirty hack until we impliment a hook mechanism for this
1347  */
1348 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response)
1349 {
1350 #ifdef HAVE_OPENSSL
1351         CtdlStartTLS (ok_response, nosup_response, error_response);
1352 #endif
1353 }
1354
1355 void DebugModulesEnable(const int n)
1356 {
1357         DebugModules = n;
1358 }
1359 CTDL_MODULE_INIT(modules)
1360 {
1361         if (!threading) {
1362                 CtdlRegisterDebugFlagHook(HKEY("modules"), DebugModulesEnable, &DebugModules);
1363
1364                 CtdlRegisterProtoHook(cmd_log_get, "LOGP", "Print Log-parameters");
1365                 CtdlRegisterProtoHook(cmd_log_set, "LOGS", "Set Log-parameters");
1366         }
1367         return "modules";
1368 }