* Written by Brian Costello
* btx@calyx.net
*
+ * $Id$
+ *
******************************************************/
+#include "sysdep.h"
#include <stdio.h>
#include <stdlib.h>
#include <dlfcn.h>
#include <dirent.h>
#include <strings.h>
#include <syslog.h>
-#include <pthread.h>
-#include "dynloader.h"
+#include <limits.h>
+#include <ctype.h>
#include "citadel.h"
#include "server.h"
+#include "dynloader.h"
#include "sysdep_decls.h"
+#include "msgbase.h"
+#include "tools.h"
+#include "config.h"
+
+#ifndef HAVE_SNPRINTF
+#include <stdarg.h>
+#include "snprintf.h"
+#endif
+
+struct LogFunctionHook *LogHookTable = NULL;
+struct CleanupFunctionHook *CleanupHookTable = NULL;
+struct SessionFunctionHook *SessionHookTable = NULL;
+struct UserFunctionHook *UserHookTable = NULL;
+struct XmsgFunctionHook *XmsgHookTable = NULL;
+struct MessageFunctionHook *MessageHookTable = NULL;
+struct ServiceFunctionHook *ServiceHookTable = NULL;
+
+struct ProtoFunctionHook {
+ void (*handler) (char *cmdbuf);
+ char *cmd;
+ char *desc;
+ struct ProtoFunctionHook *next;
+} *ProtoHookList = NULL;
-symtab *global_symtab;
+void CtdlRegisterProtoHook(void (*handler) (char *), char *cmd, char *desc)
+{
+ struct ProtoFunctionHook *p = mallok(sizeof *p);
-struct FunctionHook *HookTable = NULL;
+ if (p == NULL) {
+ fprintf(stderr, "can't malloc new ProtoFunctionHook\n");
+ exit(EXIT_FAILURE);
+ }
+ p->handler = handler;
+ p->cmd = cmd;
+ p->desc = desc;
+ p->next = ProtoHookList;
+ ProtoHookList = p;
+ lprintf(5, "Registered server command %s (%s)\n", cmd, desc);
+}
int DLoader_Exec_Cmd(char *cmdbuf)
{
- symtab *t_sym;
- void *fcn_handle;
- char *dl_error;
- void (*cmd_ptr)(void *);
-
- for (t_sym = global_symtab; ((t_sym) && (strncmp(t_sym->server_cmd, cmdbuf, strlen(t_sym->server_cmd))) ); t_sym=t_sym->next)
- ;
-
- if (t_sym)
- {
- if (!(fcn_handle = dlopen(t_sym->module_path, RTLD_NOW)))
- {
- dl_error = dlerror();
- syslog(LOG_NOTICE, "WARNING: module %s failed to load", t_sym->module_path);
- return(0);
- }
-
- cmd_ptr = dlsym(fcn_handle, t_sym->fcn_name);
- if ((dl_error = dlerror()) != NULL)
- {
- syslog(LOG_NOTICE, "dlsym error: %s - %s", dl_error, t_sym->module_path);
- return(0);
- }
- (*cmd_ptr)(&cmdbuf[5]);
- dlclose(fcn_handle);
- if ((dl_error = dlerror()) != NULL)
- {
- syslog(LOG_NOTICE, "dlclose error: %s", dl_error);
- return(0);
- }
- return(1);
- } /* If symbol found */
-
- return(0);
+ struct ProtoFunctionHook *p;
+
+ for (p = ProtoHookList; p; p = p->next) {
+ if (!strncasecmp(cmdbuf, p->cmd, 4)) {
+ p->handler(&cmdbuf[5]);
+ return 1;
+ }
+ }
+ return 0;
}
-void add_symbol(char *fcn_name, char *server_cmd, char *info_msg, symtab **first_symtab)
+void DLoader_Init(char *pathname)
{
- symtab *new_symtab, *t_sym, *last_sym;
-
- if (!(new_symtab = malloc(sizeof(symtab))))
- {
- perror("Malloc new symtab");
- exit(1);
- }
-
- new_symtab->fcn_name = strdup(fcn_name);
- new_symtab->server_cmd = strdup(server_cmd);
- new_symtab->info_msg = strdup(info_msg);
- new_symtab->next = NULL;
-
- if (!(*first_symtab))
- (*first_symtab) = new_symtab;
- else
- {
- last_sym = NULL;
- for (t_sym = (*first_symtab); (t_sym); t_sym = t_sym->next)
- last_sym = t_sym;
- last_sym->next = new_symtab;
- }
+ void *fcn_handle;
+ char dl_error[256];
+ DIR *dir;
+ int i;
+ struct dirent *dptr;
+ char *(*h_init_fcn) (void);
+ char *dl_info;
+
+ char pathbuf[PATH_MAX];
+
+ if ((dir = opendir(pathname)) == NULL) {
+ perror("opendir");
+ exit(1);
+ }
+ while ((dptr = readdir(dir)) != NULL) {
+ if (strlen(dptr->d_name) < 4)
+ continue;
+ if (strcasecmp(&dptr->d_name[strlen(dptr->d_name)-3], ".so"))
+ continue;
+
+ snprintf(pathbuf, PATH_MAX, "%s/%s", pathname, dptr->d_name);
+#ifdef RTLD_NOW
+ if (!(fcn_handle = dlopen(pathbuf, RTLD_NOW)))
+#else /* OpenBSD */
+ if (!(fcn_handle = dlopen(pathbuf, DL_LAZY)))
+#endif
+ {
+ safestrncpy(dl_error, dlerror(), sizeof dl_error);
+ for (i=0; i<strlen(dl_error); ++i)
+ if (!isprint(dl_error[i]))
+ dl_error[i]='.';
+ fprintf(stderr, "DLoader_Init dlopen failed: %s\n",
+ dl_error);
+ continue;
+ }
+ h_init_fcn = (char * (*)(void))
+#ifndef __OpenBSD__
+ dlsym(fcn_handle, "Dynamic_Module_Init");
+#else
+ dlsym(fcn_handle, "_Dynamic_Module_Init");
+#endif
+
+ if (dlerror() != NULL) {
+ fprintf(stderr, "DLoader_Init dlsym failed\n");
+ continue;
+ }
+ dl_info = h_init_fcn();
+
+ lprintf(3, "Loaded module: %s\n", dl_info);
+ } /* While */
+}
+
+
+
+void CtdlRegisterLogHook(void (*fcn_ptr) (char *), int loglevel)
+{
+
+ struct LogFunctionHook *newfcn;
+
+ newfcn = (struct LogFunctionHook *)
+ mallok(sizeof(struct LogFunctionHook));
+ newfcn->next = LogHookTable;
+ newfcn->h_function_pointer = fcn_ptr;
+ newfcn->loglevel = loglevel;
+ LogHookTable = newfcn;
+
+ lprintf(5, "Registered a new logging function\n");
}
-void DLoader_Init(char *pathname, symtab **my_symtab)
+
+void CtdlRegisterCleanupHook(void (*fcn_ptr) (void))
{
- void *fcn_handle;
- void (*h_init_fcn)(struct DLModule_Info *);
- void (*h_get_symtab)(symtab **);
- char *dl_error;
- char *filename;
- DIR *dir;
- struct dirent *dptr;
-
- char pathbuf[512];
- struct DLModule_Info dl_info;
- symtab *stab = NULL;
- symtab *t_sym;
-
- global_symtab = NULL; /* Global symbol table */
-
- if ((dir = opendir(pathname))==NULL)
- {
- perror("opendir");
- exit(1);
- }
-
- while ((dptr=readdir(dir))!= NULL)
- {
- if (dptr->d_name[0] == '.')
- continue;
-
- filename = strdup(dptr->d_name);
- snprintf(pathbuf, 512, "%s/%s", pathname, filename);
- if (!(fcn_handle = dlopen(pathbuf, RTLD_NOW)))
- {
- dl_error = dlerror();
- fprintf(stderr, "DLoader_Init dlopen failed (%s)", dl_error);
- continue;
- }
-
- h_init_fcn = dlsym(fcn_handle, "Dynamic_Module_Init");
- if ((dl_error = dlerror()) != NULL)
- {
- fprintf(stderr,"DLoader_Init dlsym failed (%s)", dl_error);
- continue;
- }
-
- (*h_init_fcn)(&dl_info);
-
- printf("Loaded module %s v%d.%d\nBy %s (%s)\n", dl_info.module_name,
- dl_info.major_version,
- dl_info.minor_version,
- dl_info.module_author,
- dl_info.module_author_email);
-
- h_get_symtab = dlsym(fcn_handle, "Get_Symtab");
- if ((dl_error = dlerror()) != NULL)
- {
- fprintf(stderr,"DLoader_Init dlsym failed for Get_Symtab (%s) on module %s", dl_error, dl_info.module_name);
- continue;
- }
-
-/* Get the symbol table for the current module and link it on */
-
- (*h_get_symtab)(&stab);
- if (!(*my_symtab))
- {
- (*my_symtab) = global_symtab = stab;
- }
- else
- {
- for (t_sym = (*my_symtab) ; t_sym->next; t_sym=t_sym->next);
- ;
- t_sym->next = stab;
- }
- for (t_sym = stab; t_sym; t_sym=t_sym->next)
- t_sym->module_path = (char *)strdup(pathbuf);
- dlclose(fcn_handle);
- if ((dl_error = dlerror()) != NULL)
- {
- fprintf(stderr,"DLoader_Init dlclose failed (%s)", dl_error);
- continue;
- }
-
- } /* While */
-
+
+ struct CleanupFunctionHook *newfcn;
+
+ newfcn = (struct CleanupFunctionHook *)
+ mallok(sizeof(struct CleanupFunctionHook));
+ newfcn->next = CleanupHookTable;
+ newfcn->h_function_pointer = fcn_ptr;
+ CleanupHookTable = newfcn;
+
+ lprintf(5, "Registered a new cleanup function\n");
}
+void CtdlRegisterSessionHook(void (*fcn_ptr) (void), int EventType)
+{
+
+ struct SessionFunctionHook *newfcn;
-void CtdlRegisterHook(void *fcn_ptr, int fcn_type) {
+ newfcn = (struct SessionFunctionHook *)
+ mallok(sizeof(struct SessionFunctionHook));
+ newfcn->next = SessionHookTable;
+ newfcn->h_function_pointer = fcn_ptr;
+ newfcn->eventtype = EventType;
+ SessionHookTable = newfcn;
- struct FunctionHook *newfcn;
+ lprintf(5, "Registered a new session function (type %d)\n",
+ EventType);
+}
- newfcn = (struct FunctionHook *) malloc(sizeof(struct FunctionHook));
- newfcn->next = HookTable;
+
+void CtdlRegisterUserHook(void (*fcn_ptr) (char *, long), int EventType)
+{
+
+ struct UserFunctionHook *newfcn;
+
+ newfcn = (struct UserFunctionHook *)
+ mallok(sizeof(struct UserFunctionHook));
+ newfcn->next = UserHookTable;
newfcn->h_function_pointer = fcn_ptr;
- newfcn->h_type = fcn_type;
+ newfcn->eventtype = EventType;
+ UserHookTable = newfcn;
+
+ lprintf(5, "Registered a new user function (type %d)\n",
+ EventType);
+}
- HookTable = newfcn;
- lprintf(5, "Registered a new function (type %d)\n", fcn_type);
+void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
+ int EventType)
+{
+
+ struct MessageFunctionHook *newfcn;
+
+ newfcn = (struct MessageFunctionHook *)
+ mallok(sizeof(struct MessageFunctionHook));
+ newfcn->next = MessageHookTable;
+ newfcn->h_function_pointer = handler;
+ newfcn->eventtype = EventType;
+ MessageHookTable = newfcn;
+
+ lprintf(5, "Registered a new message function (type %d)\n",
+ EventType);
+}
+
+
+void CtdlRegisterXmsgHook(int (*fcn_ptr) (char *, char *, char *), int order)
+{
+
+ struct XmsgFunctionHook *newfcn;
+
+ newfcn = (struct XmsgFunctionHook *)
+ mallok(sizeof(struct XmsgFunctionHook));
+ newfcn->next = XmsgHookTable;
+ newfcn->order = order;
+ newfcn->h_function_pointer = fcn_ptr;
+ XmsgHookTable = newfcn;
+ lprintf(5, "Registered a new x-msg function (priority %d)\n", order);
+}
+
+void CtdlRegisterServiceHook(int tcp_port,
+ void (*h_greeting_function) (void),
+ void (*h_command_function) (void) )
+{
+ struct ServiceFunctionHook *newfcn;
+
+ newfcn = (struct ServiceFunctionHook *)
+ mallok(sizeof(struct ServiceFunctionHook));
+ newfcn->next = ServiceHookTable;
+ newfcn->tcp_port = tcp_port;
+ newfcn->h_greeting_function = h_greeting_function;
+ newfcn->h_command_function = h_command_function;
+ newfcn->msock = ig_tcp_server(tcp_port, config.c_maxsessions);
+
+ if (newfcn->msock >= 0) {
+ ServiceHookTable = newfcn;
+ lprintf(5, "Registered a new service (TCP port %d)\n",
+ tcp_port);
+ }
+ else {
+ lprintf(2, "ERROR: could not bind to TCP port %d.\n",
+ tcp_port);
+ phree(newfcn);
}
+}
+
+
+
+void PerformSessionHooks(int EventType)
+{
+ struct SessionFunctionHook *fcn;
+
+ for (fcn = SessionHookTable; fcn != NULL; fcn = fcn->next) {
+ if (fcn->eventtype == EventType) {
+ (*fcn->h_function_pointer) ();
+ }
+ }
+}
+
+void PerformLogHooks(int loglevel, char *logmsg)
+{
+ struct LogFunctionHook *fcn;
+
+ for (fcn = LogHookTable; fcn != NULL; fcn = fcn->next) {
+ if (fcn->loglevel >= loglevel) {
+ (*fcn->h_function_pointer) (logmsg);
+ }
+ }
+}
+
+void PerformUserHooks(char *username, long usernum, int EventType)
+{
+ struct UserFunctionHook *fcn;
+
+ for (fcn = UserHookTable; fcn != NULL; fcn = fcn->next) {
+ if (fcn->eventtype == EventType) {
+ (*fcn->h_function_pointer) (username, usernum);
+ }
+ }
+}
+
+int PerformMessageHooks(struct CtdlMessage *msg, int EventType)
+{
+ struct MessageFunctionHook *fcn;
+ int total_retval = 0;
+
+ /* Other code may elect to protect this message from server-side
+ * handlers; if this is the case, don't do anything.
+ */
+ lprintf(9, "** Event type is %d, flags are %d\n",
+ EventType, msg->cm_flags);
+ if (msg->cm_flags & CM_SKIP_HOOKS) {
+ lprintf(9, "Skipping hooks\n");
+ return(0);
+ }
+
+ /* Otherwise, run all the hooks appropriate to this event type.
+ */
+ for (fcn = MessageHookTable; fcn != NULL; fcn = fcn->next) {
+ if (fcn->eventtype == EventType) {
+ total_retval = total_retval +
+ (*fcn->h_function_pointer) (msg);
+ }
+ }
+
+ /* Return the sum of the return codes from the hook functions. If
+ * this is an EVT_BEFORESAVE event, a nonzero return code will cause
+ * the save operation to abort.
+ */
+ return total_retval;
+}
+
+
+
+int PerformXmsgHooks(char *sender, char *recp, char *msg)
+{
+ struct XmsgFunctionHook *fcn;
+ int total_sent = 0;
+ int p;
+
+ for (p=0; p<MAX_XMSG_PRI; ++p) {
+ for (fcn = XmsgHookTable; fcn != NULL; fcn = fcn->next) {
+ if (fcn->order == p) {
+ total_sent +=
+ (*fcn->h_function_pointer)
+ (sender, recp, msg);
+ }
+ }
+ /* Break out of the loop if a higher-priority function
+ * successfully delivered the message. This prevents duplicate
+ * deliveries to local users simultaneously signed onto
+ * remote services.
+ */
+ if (total_sent) goto DONE;
+ }
+DONE: return total_sent;
+}