fix the rest of the unregister functions
[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, *last;
497         last = NULL;
498         cur = CleanupHookTable;
499         while (cur != NULL)
500         {
501                 if (fcn_ptr == cur->h_function_pointer)
502                 {
503                         MODM_syslog(LOG_DEBUG, "Unregistered cleanup function\n");
504                         p = cur->next;
505
506                         free(cur);
507                         cur = NULL;
508
509                         if (last != NULL)
510                                 last->next = p;
511                         else 
512                                 CleanupHookTable = p;
513                         cur = p;
514                 }
515                 else {
516                         last = cur;
517                         cur = cur->next;
518                 }
519         }
520 }
521
522
523 void CtdlDestroyCleanupHooks(void)
524 {
525         CleanupFunctionHook *cur, *p;
526
527         cur = CleanupHookTable;
528         while (cur != NULL)
529         {
530                 MODM_syslog(LOG_DEBUG, "Destroyed cleanup function\n");
531                 p = cur->next;
532                 free(cur);
533                 cur = p;
534         }
535         CleanupHookTable = NULL;
536 }
537
538 void CtdlRegisterEVCleanupHook(void (*fcn_ptr) (void))
539 {
540
541         CleanupFunctionHook *newfcn;
542
543         newfcn = (CleanupFunctionHook *)
544             malloc(sizeof(CleanupFunctionHook));
545         newfcn->next = EVCleanupHookTable;
546         newfcn->h_function_pointer = fcn_ptr;
547         EVCleanupHookTable = newfcn;
548
549         MODM_syslog(LOG_DEBUG, "Registered a new cleanup function\n");
550 }
551
552
553 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr) (void))
554 {
555         CleanupFunctionHook *cur, *p, *last;
556         last = NULL;
557         cur = EVCleanupHookTable;
558         while (cur != NULL)
559         {
560                 if (fcn_ptr == cur->h_function_pointer)
561                 {
562                         MODM_syslog(LOG_DEBUG, "Unregistered cleanup function\n");
563                         p = cur->next;
564
565                         free(cur);
566                         cur = NULL;
567
568                         if (last != NULL)
569                                 last->next = p;
570                         else 
571                                 EVCleanupHookTable = p;
572                         cur = p;
573                 }
574                 else {
575                         last = cur;
576                         cur = cur->next;
577                 }
578         }
579 }
580
581
582 void CtdlDestroyEVCleanupHooks(void)
583 {
584         CleanupFunctionHook *cur, *p;
585
586         cur = EVCleanupHookTable;
587         while (cur != NULL)
588         {
589                 MODM_syslog(LOG_DEBUG, "Destroyed cleanup function\n");
590                 p = cur->next;
591                 free(cur);
592                 cur = p;
593         }
594         EVCleanupHookTable = NULL;
595 }
596
597
598 void CtdlRegisterSessionHook(void (*fcn_ptr) (void), int EventType)
599 {
600
601         SessionFunctionHook *newfcn;
602
603         newfcn = (SessionFunctionHook *)
604             malloc(sizeof(SessionFunctionHook));
605         newfcn->next = SessionHookTable;
606         newfcn->h_function_pointer = fcn_ptr;
607         newfcn->eventtype = EventType;
608         SessionHookTable = newfcn;
609
610         MOD_syslog(LOG_DEBUG, "Registered a new session function (type %d)\n",
611                    EventType);
612 }
613
614
615 void CtdlUnregisterSessionHook(void (*fcn_ptr) (void), int EventType)
616 {
617         SessionFunctionHook *cur, *p, *last;
618         last = NULL;
619         cur = SessionHookTable;
620         while  (cur != NULL) {
621                 if ((fcn_ptr == cur->h_function_pointer) &&
622                     (EventType == cur->eventtype))
623                 {
624                         MOD_syslog(LOG_DEBUG, "Unregistered session function (type %d)\n",
625                                    EventType);
626                         p = cur->next;
627
628                         free(cur);
629                         cur = NULL;
630
631                         if (last != NULL)
632                                 last->next = p;
633                         else 
634                                 SessionHookTable = p;
635                         cur = p;
636                 }
637                 else {
638                         last = cur;
639                         cur = cur->next;
640                 }
641         }
642 }
643
644 void CtdlDestroySessionHooks(void)
645 {
646         SessionFunctionHook *cur, *p;
647
648         cur = SessionHookTable;
649         while (cur != NULL)
650         {
651                 MODM_syslog(LOG_DEBUG, "Destroyed session function\n");
652                 p = cur->next;
653                 free(cur);
654                 cur = p;
655         }
656         SessionHookTable = NULL;
657 }
658
659
660 void CtdlRegisterUserHook(void (*fcn_ptr) (ctdluser *), int EventType)
661 {
662
663         UserFunctionHook *newfcn;
664
665         newfcn = (UserFunctionHook *)
666             malloc(sizeof(UserFunctionHook));
667         newfcn->next = UserHookTable;
668         newfcn->h_function_pointer = fcn_ptr;
669         newfcn->eventtype = EventType;
670         UserHookTable = newfcn;
671
672         MOD_syslog(LOG_DEBUG, "Registered a new user function (type %d)\n",
673                    EventType);
674 }
675
676
677 void CtdlUnregisterUserHook(void (*fcn_ptr) (struct ctdluser *), int EventType)
678 {
679         UserFunctionHook *cur, *p, *last;
680         last = NULL;
681         cur = UserHookTable;
682         while (cur != NULL) {
683                 if ((fcn_ptr == cur->h_function_pointer) &&
684                     (EventType == cur->eventtype))
685                 {
686                         MOD_syslog(LOG_DEBUG, "Unregistered user function (type %d)\n",
687                                    EventType);
688                         p = cur->next;
689
690                         free(cur);
691                         cur = NULL;
692
693                         if (last != NULL)
694                                 last->next = p;
695                         else 
696                                 UserHookTable = p;
697                         cur = p;
698                 }
699                 else {
700                         last = cur;
701                         cur = cur->next;
702                 }
703         }
704 }
705
706 void CtdlDestroyUserHooks(void)
707 {
708         UserFunctionHook *cur, *p;
709
710         cur = UserHookTable;
711         while (cur != NULL)
712         {
713                 MODM_syslog(LOG_DEBUG, "Destroyed user function \n");
714                 p = cur->next;
715                 free(cur);
716                 cur = p;
717         }
718         UserHookTable = NULL;
719 }
720
721
722 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
723                                 int EventType)
724 {
725
726         MessageFunctionHook *newfcn;
727
728         newfcn = (MessageFunctionHook *)
729             malloc(sizeof(MessageFunctionHook));
730         newfcn->next = MessageHookTable;
731         newfcn->h_function_pointer = handler;
732         newfcn->eventtype = EventType;
733         MessageHookTable = newfcn;
734
735         MOD_syslog(LOG_DEBUG, "Registered a new message function (type %d)\n",
736                    EventType);
737 }
738
739
740 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
741                 int EventType)
742 {
743         MessageFunctionHook *cur, *p, *last;
744         last = NULL;
745         cur = MessageHookTable;
746         while (cur != NULL) {
747                 if ((handler == cur->h_function_pointer) &&
748                     (EventType == cur->eventtype))
749                 {
750                         MOD_syslog(LOG_DEBUG, "Unregistered message function (type %d)\n",
751                                    EventType);
752                         p = cur->next;
753                         free(cur);
754                         cur = NULL;
755
756                         if (last != NULL)
757                                 last->next = p;
758                         else 
759                                 MessageHookTable = p;
760                         cur = p;
761                 }
762                 else {
763                         last = cur;
764                         cur = cur->next;
765                 }
766         }
767 }
768
769 void CtdlDestroyMessageHook(void)
770 {
771         MessageFunctionHook *cur, *p;
772
773         cur = MessageHookTable; 
774         while (cur != NULL)
775         {
776                 MOD_syslog(LOG_DEBUG, "Destroyed message function (type %d)\n", cur->eventtype);
777                 p = cur->next;
778                 free(cur);
779                 cur = p;
780         }
781         MessageHookTable = NULL;
782 }
783
784
785 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
786 {
787         RoomFunctionHook *newfcn;
788
789         newfcn = (RoomFunctionHook *)
790             malloc(sizeof(RoomFunctionHook));
791         newfcn->next = RoomHookTable;
792         newfcn->fcn_ptr = fcn_ptr;
793         RoomHookTable = newfcn;
794
795         MODM_syslog(LOG_DEBUG, "Registered a new room function\n");
796 }
797
798
799 void CtdlUnregisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
800 {
801         RoomFunctionHook *cur, *p, *last;
802         last = NULL;
803         cur = RoomHookTable;
804         while (cur != NULL)
805         {
806                 if (fcn_ptr == cur->fcn_ptr) {
807                         MODM_syslog(LOG_DEBUG, "Unregistered room function\n");
808                         p = cur->next;
809
810                         free(cur);
811                         cur = NULL;
812
813                         if (last != NULL)
814                                 last->next = p;
815                         else 
816                                 RoomHookTable = p;
817                         cur = p;
818                 }
819                 else {
820                         last = cur;
821                         cur = cur->next;
822                 }
823         }
824 }
825
826
827 void CtdlDestroyRoomHooks(void)
828 {
829         RoomFunctionHook *cur, *p;
830
831         cur = RoomHookTable;
832         while (cur != NULL)
833         {
834                 MODM_syslog(LOG_DEBUG, "Destroyed room function\n");
835                 p = cur->next;
836                 free(cur);
837                 cur = p;
838         }
839         RoomHookTable = NULL;
840 }
841
842 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
843 {
844         NetprocFunctionHook *newfcn;
845
846         newfcn = (NetprocFunctionHook *)
847             malloc(sizeof(NetprocFunctionHook));
848         newfcn->next = NetprocHookTable;
849         newfcn->h_function_pointer = handler;
850         NetprocHookTable = newfcn;
851
852         MODM_syslog(LOG_DEBUG, "Registered a new netproc function\n");
853 }
854
855
856 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
857 {
858         NetprocFunctionHook *cur, *p, *last;
859
860         cur = NetprocHookTable;
861         last = NULL;
862
863         while (cur != NULL) {
864                 if (handler == cur->h_function_pointer)
865                 {
866                         MODM_syslog(LOG_DEBUG, "Unregistered netproc function\n");
867                         p = cur->next;
868                         free(cur);
869                         if (last != NULL) {
870                                 last->next = p;
871                         }
872                         else {
873                                 NetprocHookTable = p;
874                         }
875                         cur = p;
876                 }
877                 else {
878                         last = cur;
879                         cur = cur->next;
880                 }
881         }
882 }
883
884 void CtdlDestroyNetprocHooks(void)
885 {
886         NetprocFunctionHook *cur, *p;
887
888         cur = NetprocHookTable;
889         while (cur != NULL)
890         {
891                 MODM_syslog(LOG_DEBUG, "Destroyed netproc function\n");
892                 p = cur->next;
893                 free(cur);
894                 cur = p;
895         }
896         NetprocHookTable = NULL;
897 }
898
899
900 void CtdlRegisterDeleteHook(void (*handler)(char *, long) )
901 {
902         DeleteFunctionHook *newfcn;
903
904         newfcn = (DeleteFunctionHook *)
905             malloc(sizeof(DeleteFunctionHook));
906         newfcn->next = DeleteHookTable;
907         newfcn->h_function_pointer = handler;
908         DeleteHookTable = newfcn;
909
910         MODM_syslog(LOG_DEBUG, "Registered a new delete function\n");
911 }
912
913
914 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) )
915 {
916         DeleteFunctionHook *cur, *p, *last;
917
918         last = NULL;
919         cur = DeleteHookTable;
920         while (cur != NULL) {
921                 if (handler == cur->h_function_pointer )
922                 {
923                         MODM_syslog(LOG_DEBUG, "Unregistered delete function\n");
924                         p = cur->next;
925                         free(cur);
926
927                         if (last != NULL)
928                                 last->next = p;
929                         else
930                                 DeleteHookTable = p;
931
932                         cur = p;
933                 }
934                 else {
935                         last = cur;
936                         cur = cur->next;
937                 }
938         }
939 }
940 void CtdlDestroyDeleteHooks(void)
941 {
942         DeleteFunctionHook *cur, *p;
943
944         cur = DeleteHookTable;
945         while (cur != NULL)
946         {
947                 MODM_syslog(LOG_DEBUG, "Destroyed delete function\n");
948                 p = cur->next;
949                 free(cur);
950                 cur = p;                
951         }
952         DeleteHookTable = NULL;
953 }
954
955
956
957
958 void CtdlRegisterFixedOutputHook(char *content_type, void (*handler)(char *, int) )
959 {
960         FixedOutputHook *newfcn;
961
962         newfcn = (FixedOutputHook *)
963             malloc(sizeof(FixedOutputHook));
964         newfcn->next = FixedOutputTable;
965         newfcn->h_function_pointer = handler;
966         safestrncpy(newfcn->content_type, content_type, sizeof newfcn->content_type);
967         FixedOutputTable = newfcn;
968
969         MOD_syslog(LOG_DEBUG, "Registered a new fixed output function for %s\n", newfcn->content_type);
970 }
971
972
973 void CtdlUnregisterFixedOutputHook(char *content_type)
974 {
975         FixedOutputHook *cur, *p, *last;
976
977         last = NULL;
978         cur = FixedOutputTable;
979         while (cur != NULL) {
980                 /* This will also remove duplicates if any */
981                 if (!strcasecmp(content_type, cur->content_type)) {
982                         MOD_syslog(LOG_DEBUG,
983                                    "Unregistered fixed output function for %s\n",
984                                    content_type);
985
986                         p = cur->next;
987                         free(cur);
988
989                         if (last != NULL)
990                                 last->next = p;
991                         else
992                                 FixedOutputTable = p;
993                         
994                         cur = p;
995                 }
996                 else
997                 {
998                         last = cur;
999                         cur = cur->next;
1000                 }
1001         }
1002 }
1003
1004 void CtdlDestroyFixedOutputHooks(void)
1005 {
1006         FixedOutputHook *cur, *p;
1007
1008         cur = FixedOutputTable; 
1009         while (cur != NULL)
1010         {
1011                 MOD_syslog(LOG_DEBUG, "Destroyed fixed output function for %s\n", cur->content_type);
1012                 p = cur->next;
1013                 free(cur);
1014                 cur = p;
1015                 
1016         }
1017         FixedOutputTable = NULL;
1018 }
1019
1020 /* returns nonzero if we found a hook and used it */
1021 int PerformFixedOutputHooks(char *content_type, char *content, int content_length)
1022 {
1023         FixedOutputHook *fcn;
1024
1025         for (fcn = FixedOutputTable; fcn != NULL; fcn = fcn->next) {
1026                 if (!strcasecmp(content_type, fcn->content_type)) {
1027                         (*fcn->h_function_pointer) (content, content_length);
1028                         return(1);
1029                 }
1030         }
1031         return(0);
1032 }
1033
1034
1035
1036
1037
1038 void CtdlRegisterXmsgHook(int (*fcn_ptr) (char *, char *, char *, char *), int order)
1039 {
1040
1041         XmsgFunctionHook *newfcn;
1042
1043         newfcn = (XmsgFunctionHook *) malloc(sizeof(XmsgFunctionHook));
1044         newfcn->next = XmsgHookTable;
1045         newfcn->order = order;
1046         newfcn->h_function_pointer = fcn_ptr;
1047         XmsgHookTable = newfcn;
1048         MOD_syslog(LOG_DEBUG, "Registered a new x-msg function (priority %d)\n", order);
1049 }
1050
1051
1052 void CtdlUnregisterXmsgHook(int (*fcn_ptr) (char *, char *, char *, char *), int order)
1053 {
1054         XmsgFunctionHook *cur, *p, *last;
1055
1056         last = NULL;
1057         cur = XmsgHookTable;
1058         while (cur != NULL) {
1059                 /* This will also remove duplicates if any */
1060                 if (fcn_ptr == cur->h_function_pointer &&
1061                     order == cur->order) {
1062                         MOD_syslog(LOG_DEBUG, "Unregistered x-msg function "
1063                                    "(priority %d)\n", order);
1064                         p = cur->next;
1065                         free(cur);
1066
1067                         if (last != NULL)
1068                                 last->next = p;
1069                         else
1070                                 XmsgHookTable = p;
1071                         
1072                         cur = p;
1073                 }
1074                 else {
1075                         last = cur;
1076                         cur = cur->next;
1077                 }
1078         }
1079 }
1080
1081 void CtdlDestroyXmsgHooks(void)
1082 {
1083         XmsgFunctionHook *cur, *p;
1084
1085         cur = XmsgHookTable;
1086         while (cur != NULL)
1087         {
1088                 MOD_syslog(LOG_DEBUG, "Destroyed x-msg function "
1089                         "(priority %d)\n", cur->order);
1090                 p = cur->next;
1091                         
1092                 free(cur);
1093                 cur = p;
1094         }
1095         XmsgHookTable = NULL;
1096 }
1097
1098
1099 void CtdlRegisterServiceHook(int tcp_port,
1100                              char *sockpath,
1101                              void (*h_greeting_function) (void),
1102                              void (*h_command_function) (void),
1103                              void (*h_async_function) (void),
1104                              const char *ServiceName)
1105 {
1106         ServiceFunctionHook *newfcn;
1107         char *message;
1108         char error[SIZ];
1109
1110         strcpy(error, "");
1111         newfcn = (ServiceFunctionHook *) malloc(sizeof(ServiceFunctionHook));
1112         message = (char*) malloc (SIZ + SIZ);
1113         
1114         newfcn->next = ServiceHookTable;
1115         newfcn->tcp_port = tcp_port;
1116         newfcn->sockpath = sockpath;
1117         newfcn->h_greeting_function = h_greeting_function;
1118         newfcn->h_command_function = h_command_function;
1119         newfcn->h_async_function = h_async_function;
1120         newfcn->ServiceName = ServiceName;
1121
1122         if (sockpath != NULL) {
1123                 newfcn->msock = ctdl_uds_server(sockpath, config.c_maxsessions, error);
1124                 snprintf(message, SIZ, "Unix domain socket '%s': ", sockpath);
1125         }
1126         else if (tcp_port <= 0) {       /* port -1 to disable */
1127                 MOD_syslog(LOG_INFO, "Service %s has been manually disabled, skipping\n", ServiceName);
1128                 free (message);
1129                 free(newfcn);
1130                 return;
1131         }
1132         else {
1133                 newfcn->msock = ctdl_tcp_server(config.c_ip_addr,
1134                                               tcp_port,
1135                                               config.c_maxsessions, 
1136                                               error);
1137                 snprintf(message, SIZ, "TCP port %s:%d: (%s) ", 
1138                          config.c_ip_addr, tcp_port, ServiceName);
1139         }
1140
1141         if (newfcn->msock > 0) {
1142                 ServiceHookTable = newfcn;
1143                 strcat(message, "registered.");
1144                 MOD_syslog(LOG_INFO, "%s\n", message);
1145         }
1146         else {
1147                 AddPortError(message, error);
1148                 strcat(message, "FAILED.");
1149                 MOD_syslog(LOG_CRIT, "%s\n", message);
1150                 free(newfcn);
1151         }
1152         free(message);
1153 }
1154
1155
1156 void CtdlUnregisterServiceHook(int tcp_port, char *sockpath,
1157                         void (*h_greeting_function) (void),
1158                         void (*h_command_function) (void),
1159                         void (*h_async_function) (void)
1160                         )
1161 {
1162         ServiceFunctionHook *cur, *p, *last;
1163
1164         last = NULL;
1165         cur = ServiceHookTable;
1166         while (cur != NULL) {
1167                 /* This will also remove duplicates if any */
1168                 if (h_greeting_function == cur->h_greeting_function &&
1169                     h_command_function == cur->h_command_function &&
1170                     h_async_function == cur->h_async_function &&
1171                     tcp_port == cur->tcp_port && 
1172                     !(sockpath && cur->sockpath && strcmp(sockpath, cur->sockpath)) )
1173                 {
1174                         if (cur->msock > 0)
1175                                 close(cur->msock);
1176                         if (sockpath) {
1177                                 MOD_syslog(LOG_INFO, "Closed UNIX domain socket %s\n",
1178                                            sockpath);
1179                                 unlink(sockpath);
1180                         } else if (tcp_port) {
1181                                 MOD_syslog(LOG_INFO, "Closed TCP port %d\n", tcp_port);
1182                         } else {
1183                                 MOD_syslog(LOG_INFO, "Unregistered service \"%s\"\n", cur->ServiceName);
1184                         }
1185                         p = cur->next;
1186                         free(cur);
1187                         if (last != NULL)
1188                                 last->next = p;
1189                         else
1190                                 ServiceHookTable = p;
1191                         cur = p;
1192                 }
1193                 else {
1194                         last = cur;
1195                         cur = cur->next;
1196                 }
1197         }
1198 }
1199
1200
1201 void CtdlShutdownServiceHooks(void)
1202 {
1203         /* sort of a duplicate of close_masters() but called earlier */
1204         ServiceFunctionHook *cur;
1205
1206         cur = ServiceHookTable;
1207         while (cur != NULL) 
1208         {
1209                 if (cur->msock != -1)
1210                 {
1211                         close(cur->msock);
1212                         cur->msock = -1;
1213                         if (cur->sockpath != NULL){
1214                                 MOD_syslog(LOG_INFO, "[%s] Closed UNIX domain socket %s\n",
1215                                            cur->ServiceName,
1216                                            cur->sockpath);
1217                                 unlink(cur->sockpath);
1218                         } else {
1219                                 MOD_syslog(LOG_INFO, "[%s] closing service\n", 
1220                                            cur->ServiceName);
1221                         }
1222                 }
1223                 cur = cur->next;
1224         }
1225 }
1226
1227 void CtdlDestroyServiceHook(void)
1228 {
1229         ServiceFunctionHook *cur, *p;
1230
1231         cur = ServiceHookTable;
1232         while (cur != NULL)
1233         {
1234                 close(cur->msock);
1235                 if (cur->sockpath) {
1236                         MOD_syslog(LOG_INFO, "Closed UNIX domain socket %s\n",
1237                                    cur->sockpath);
1238                         unlink(cur->sockpath);
1239                 } else if (cur->tcp_port) {
1240                         MOD_syslog(LOG_INFO, "Closed TCP port %d\n", cur->tcp_port);
1241                 } else {
1242                         MOD_syslog(LOG_INFO, "Destroyed service \"%s\"\n", cur->ServiceName);
1243                 }
1244                 p = cur->next;
1245                 free(cur);
1246                 cur = p;
1247         }
1248         ServiceHookTable = NULL;
1249 }
1250
1251 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name)
1252 {
1253         SearchFunctionHook *newfcn;
1254
1255         if (!name || !fcn_ptr) {
1256                 return;
1257         }
1258         
1259         newfcn = (SearchFunctionHook *)
1260             malloc(sizeof(SearchFunctionHook));
1261         newfcn->next = SearchFunctionHookTable;
1262         newfcn->name = name;
1263         newfcn->fcn_ptr = fcn_ptr;
1264         SearchFunctionHookTable = newfcn;
1265
1266         MOD_syslog(LOG_DEBUG, "Registered a new search function (%s)\n", name);
1267 }
1268
1269 void CtdlUnregisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name)
1270 {
1271         SearchFunctionHook *cur, *p, *last;
1272         
1273         last = NULL;
1274         cur = SearchFunctionHookTable;
1275         while (cur != NULL) {
1276                 if (fcn_ptr &&
1277                     (cur->fcn_ptr == fcn_ptr) &&
1278                     name && !strcmp(name, cur->name))
1279                 {
1280                         MOD_syslog(LOG_DEBUG, "Unregistered search function(%s)\n", name);
1281                         p = cur->next;
1282                         free (cur);
1283                         if (last != NULL)
1284                                 last->next = p;
1285                         else
1286                                 SearchFunctionHookTable = p;
1287                         cur = p;
1288                 }
1289                 else {
1290                         last = cur;
1291                         cur = cur->next;
1292                 }
1293         }
1294 }
1295
1296 void CtdlDestroySearchHooks(void)
1297 {
1298         SearchFunctionHook *cur, *p;
1299
1300         cur = SearchFunctionHookTable;
1301         SearchFunctionHookTable = NULL;
1302         while (cur != NULL) {
1303                 p = cur->next;
1304                 free(cur);
1305                 cur = p;
1306         }
1307 }
1308
1309 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name)
1310 {
1311         SearchFunctionHook *fcn = NULL;
1312
1313         for (fcn = SearchFunctionHookTable; fcn != NULL; fcn = fcn->next) {
1314                 if (!func_name || !strcmp(func_name, fcn->name)) {
1315                         (*fcn->fcn_ptr) (num_msgs, search_msgs, search_string);
1316                         return;
1317                 }
1318         }
1319         *num_msgs = 0;
1320 }
1321
1322
1323 void PerformSessionHooks(int EventType)
1324 {
1325         SessionFunctionHook *fcn = NULL;
1326
1327         for (fcn = SessionHookTable; fcn != NULL; fcn = fcn->next) {
1328                 if (fcn->eventtype == EventType) {
1329                         if (EventType == EVT_TIMER) {
1330                                 pthread_setspecific(MyConKey, NULL);    /* for every hook */
1331                         }
1332                         (*fcn->h_function_pointer) ();
1333                 }
1334         }
1335 }
1336
1337 void PerformUserHooks(ctdluser *usbuf, int EventType)
1338 {
1339         UserFunctionHook *fcn = NULL;
1340
1341         for (fcn = UserHookTable; fcn != NULL; fcn = fcn->next) {
1342                 if (fcn->eventtype == EventType) {
1343                         (*fcn->h_function_pointer) (usbuf);
1344                 }
1345         }
1346 }
1347
1348 int PerformMessageHooks(struct CtdlMessage *msg, int EventType)
1349 {
1350         MessageFunctionHook *fcn = NULL;
1351         int total_retval = 0;
1352
1353         /* Other code may elect to protect this message from server-side
1354          * handlers; if this is the case, don't do anything.
1355         MOD_syslog(LOG_DEBUG, "** Event type is %d, flags are %d\n", EventType, msg->cm_flags);
1356          */
1357         if (msg->cm_flags & CM_SKIP_HOOKS) {
1358                 MODM_syslog(LOG_DEBUG, "Skipping hooks\n");
1359                 return(0);
1360         }
1361
1362         /* Otherwise, run all the hooks appropriate to this event type.
1363          */
1364         for (fcn = MessageHookTable; fcn != NULL; fcn = fcn->next) {
1365                 if (fcn->eventtype == EventType) {
1366                         total_retval = total_retval + (*fcn->h_function_pointer) (msg);
1367                 }
1368         }
1369
1370         /* Return the sum of the return codes from the hook functions.  If
1371          * this is an EVT_BEFORESAVE event, a nonzero return code will cause
1372          * the save operation to abort.
1373          */
1374         return total_retval;
1375 }
1376
1377
1378 int PerformRoomHooks(struct ctdlroom *target_room)
1379 {
1380         RoomFunctionHook *fcn;
1381         int total_retval = 0;
1382
1383         MOD_syslog(LOG_DEBUG, "Performing room hooks for <%s>\n", target_room->QRname);
1384
1385         for (fcn = RoomHookTable; fcn != NULL; fcn = fcn->next) {
1386                 total_retval = total_retval + (*fcn->fcn_ptr) (target_room);
1387         }
1388
1389         /* Return the sum of the return codes from the hook functions.
1390          */
1391         return total_retval;
1392 }
1393
1394
1395 int PerformNetprocHooks(struct CtdlMessage *msg, char *target_room)
1396 {
1397         NetprocFunctionHook *fcn;
1398         int total_retval = 0;
1399
1400         for (fcn = NetprocHookTable; fcn != NULL; fcn = fcn->next) {
1401                 total_retval = total_retval +
1402                         (*fcn->h_function_pointer) (msg, target_room);
1403         }
1404
1405         /* Return the sum of the return codes from the hook functions.
1406          * A nonzero return code will cause the message to *not* be imported.
1407          */
1408         return total_retval;
1409 }
1410
1411
1412 void PerformDeleteHooks(char *room, long msgnum)
1413 {
1414         DeleteFunctionHook *fcn;
1415
1416         for (fcn = DeleteHookTable; fcn != NULL; fcn = fcn->next) {
1417                 (*fcn->h_function_pointer) (room, msgnum);
1418         }
1419 }
1420
1421
1422
1423
1424
1425 int PerformXmsgHooks(char *sender, char *sender_email, char *recp, char *msg)
1426 {
1427         XmsgFunctionHook *fcn;
1428         int total_sent = 0;
1429         int p;
1430
1431         for (p=0; p<MAX_XMSG_PRI; ++p) {
1432                 for (fcn = XmsgHookTable; fcn != NULL; fcn = fcn->next) {
1433                         if (fcn->order == p) {
1434                                 total_sent +=
1435                                         (*fcn->h_function_pointer)
1436                                                 (sender, sender_email, recp, msg);
1437                         }
1438                 }
1439                 /* Break out of the loop if a higher-priority function
1440                  * successfully delivered the message.  This prevents duplicate
1441                  * deliveries to local users simultaneously signed onto
1442                  * remote services.
1443                  */
1444                 if (total_sent) break;
1445         }
1446         return total_sent;
1447 }
1448
1449
1450 /*
1451  * Dirty hack until we impliment a hook mechanism for this
1452  */
1453 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response)
1454 {
1455 #ifdef HAVE_OPENSSL
1456         CtdlStartTLS (ok_response, nosup_response, error_response);
1457 #endif
1458 }
1459
1460 void DebugModulesEnable(const int n)
1461 {
1462         DebugModules = n;
1463 }
1464 CTDL_MODULE_INIT(modules)
1465 {
1466         if (!threading) {
1467                 CtdlRegisterDebugFlagHook(HKEY("modules"), DebugModulesEnable, &DebugModules);
1468
1469                 CtdlRegisterProtoHook(cmd_log_get, "LOGP", "Print Log-parameters");
1470                 CtdlRegisterProtoHook(cmd_log_set, "LOGS", "Set Log-parameters");
1471         }
1472         return "modules";
1473 }