* modules registering serverports now need to specify a plaintext name.
[citadel.git] / citadel / serv_extensions.c
index cb0618a61cdee24d3affd39ed8a2b499c30ce3af..e9461489e68a8fb60cda010f4b0a4f5af9affe64 100644 (file)
@@ -23,6 +23,8 @@
 #include "tools.h"
 #include "config.h"
 
+#include "modules/crypto/serv_crypto.h"        /* Needed until a universal crypto startup hook is implimented for CtdlStartTLS */
+
 #ifndef HAVE_SNPRINTF
 #include <stdarg.h>
 #include "snprintf.h"
@@ -37,6 +39,9 @@ struct NetprocFunctionHook *NetprocHookTable = NULL;
 struct DeleteFunctionHook *DeleteHookTable = NULL;
 struct ServiceFunctionHook *ServiceHookTable = NULL;
 struct FixedOutputHook *FixedOutputTable = NULL;
+struct RoomFunctionHook *RoomHookTable = NULL;
+struct MaintenanceThreadHook *MaintenanceThreadHookTable = NULL;
+struct SearchFunctionHook *SearchFunctionHookTable = NULL;
 
 struct ProtoFunctionHook {
        void (*handler) (char *cmdbuf);
@@ -45,6 +50,128 @@ struct ProtoFunctionHook {
        struct ProtoFunctionHook *next;
 } *ProtoHookList = NULL;
 
+
+#define ERR_PORT (1 << 1)
+
+
+static char *portlist = NULL;
+static size_t nSizPort = 0;
+
+static char *errormessages = NULL;
+static size_t nSizErrmsg = 0;
+
+
+static long   DetailErrorFlags;
+
+char *ErrSubject = "Startup Problems";
+char *ErrGeneral = "Citadel had trouble on starting up. %s This means, citadel won't be the service provider for a specific service you configured it to.\n\n"
+"If you don't want citadel to provide these services, turn them off in WebCit via %s%s\n\n%s\n\n"
+"To make both ways actualy take place restart the citserver with \"sendcommand down\"\n\n"
+"The errors returned by the system were:\n%s\n"
+"You can recheck the above if you follow this faq item:\n"
+"http://www.citadel.org/doku.php/faq:mastering_your_os:net#netstat";
+
+
+char *ErrPortShort = "We couldn't bind all ports you configured to be provided by citadel server.";
+char *ErrPortWhere = "Admin->System Preferences->Network.\n\nThe failed ports and sockets are: ";
+char *ErrPortHint = "If you want citadel to provide you with that functionality, "
+"check the output of \"netstat -lnp\" on linux Servers or \"netstat -na\" on *BSD"
+" and stop the programm, that binds these ports. You should eventually remove "
+" their initscripts in /etc/init.d so that you won't get this trouble once more.\n";
+
+
+void LogPrintMessages(long err)
+{
+       char *List, *DetailList, *Short, *Where, *Hint, *Message; 
+       int n = nSizPort + nSizErrmsg + 5;
+
+       Message = (char*) malloc(n * SIZ);
+
+       switch (err)
+       {
+       case ERR_PORT:
+               Short = ErrPortShort;
+               Where = ErrPortWhere;
+               Hint  = ErrPortHint;
+               List  = portlist;
+               DetailList = errormessages;
+               break;
+       default:
+               Short = "";
+               Where = "";
+               Hint  = "";
+               List  = "";
+               DetailList = "";
+       }
+
+
+       snprintf(Message, n * SIZ, ErrGeneral, Short, Where, List, Hint, DetailList);
+
+       quickie_message("Citadel", NULL, NULL, AIDEROOM, Message, FMT_FIXED, ErrSubject);
+       if (errormessages!=NULL) free (errormessages);
+       errormessages = NULL;
+       if (portlist!=NULL) free (portlist);
+       portlist = NULL;
+       free(Message);
+}
+
+
+
+void AppendString(char **target, char *append, size_t *len, size_t rate)
+{
+       size_t oLen = 0;
+       long AddLen;
+       long RelPtr = 0;
+
+       AddLen = strlen(append);
+
+       if (*len == 0)
+       {
+               *len = rate;
+
+               *target = (char*)malloc (*len * SIZ);
+       }
+       else 
+       {
+               oLen = strlen(*target);
+               RelPtr = strlen(*target);
+               if (oLen + AddLen + 2 > *len * SIZ)
+               {
+                       char *Buff = *target;
+                       size_t NewSiz = *len + 10;
+                       *target = malloc (NewSiz * SIZ);
+                       memcpy (*target, Buff, NewSiz * SIZ);
+                       *len = NewSiz;
+               }
+       }
+       memcpy (*target + oLen, append, AddLen);
+       (*target)[oLen + AddLen + 1] = '\n';
+       (*target)[oLen + AddLen + 2] = '\0';
+}
+
+void AddPortError(char *Port, char *ErrorMessage)
+{
+       char *pos;
+       long len;
+
+       DetailErrorFlags |= ERR_PORT;
+
+       AppendString(&errormessages, ErrorMessage, &nSizErrmsg, 10);
+       AppendString(&portlist, Port, &nSizPort, 2);
+
+       pos = strchr (portlist, ':');
+       if (pos != NULL) *pos = ';';
+       
+       len = strlen (errormessages);
+       if (nSizErrmsg * SIZ > len + 3)
+       {
+               errormessages[len] = ';';
+               errormessages[len+1] = ' ';
+               errormessages[len+2] = '\0';
+       }       
+}
+
+
 void CtdlRegisterProtoHook(void (*handler) (char *), char *cmd, char *desc)
 {
        struct ProtoFunctionHook *p;
@@ -67,9 +194,13 @@ void CtdlRegisterProtoHook(void (*handler) (char *), char *cmd, char *desc)
 
 void CtdlUnregisterProtoHook(void (*handler) (char *), char *cmd)
 {
-       struct ProtoFunctionHook *cur, *p;
+       struct ProtoFunctionHook *cur = NULL;
+       struct ProtoFunctionHook *p = NULL;
+       struct ProtoFunctionHook *lastcur = NULL;
 
-       for (cur = ProtoHookList; cur != NULL; cur = cur->next) {
+       for (cur = ProtoHookList; 
+            cur != NULL; 
+            cur = (cur != NULL)? cur->next: NULL) {
                /* This will also remove duplicates if any */
                while (cur != NULL &&
                                handler == cur->handler &&
@@ -80,10 +211,31 @@ void CtdlUnregisterProtoHook(void (*handler) (char *), char *cmd)
                        if (cur == ProtoHookList) {
                                ProtoHookList = p;
                        }
+                       else if (lastcur != NULL)
+                       {
+                               lastcur->next = p;
+                       }
                        free(cur);
                        cur = p;
                }
+               lastcur = cur;
+       }
+}
+
+void CtdlDestroyProtoHooks(void)
+{
+       struct ProtoFunctionHook *cur, *p;
+
+       cur = ProtoHookList; 
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Destroyed server command %s (%s)\n",
+                       cur->cmd, cur->desc);
+               p = cur->next;
+               free(cur);
+               cur = p;
        }
+       ProtoHookList = NULL;
 }
 
 
@@ -100,9 +252,14 @@ int DLoader_Exec_Cmd(char *cmdbuf)
        return 0;
 }
 
+#if 0
 void initialize_server_extensions(void)
 {
-       lprintf(CTDL_INFO, "%s\n", serv_bio_init());
+       long filter;
+
+       nSizErrmsg = 0;
+
+       /*lprintf(CTDL_INFO, "%s\n", serv_bio_init());
        lprintf(CTDL_INFO, "%s\n", serv_calendar_init());
        lprintf(CTDL_INFO, "%s\n", serv_notes_init());
        lprintf(CTDL_INFO, "%s\n", serv_ldap_init());
@@ -117,20 +274,25 @@ void initialize_server_extensions(void)
        lprintf(CTDL_INFO, "%s\n", serv_network_init());
        lprintf(CTDL_INFO, "%s\n", serv_newuser_init());
        lprintf(CTDL_INFO, "%s\n", serv_pas2_init());
+       lprintf(CTDL_INFO, "%s\n", serv_smtp_init());
        lprintf(CTDL_INFO, "%s\n", serv_pop3_init());
        lprintf(CTDL_INFO, "%s\n", serv_rwho_init());
-       lprintf(CTDL_INFO, "%s\n", serv_smtp_init());
-       lprintf(CTDL_INFO, "%s\n", serv_spam_init());
+       lprintf(CTDL_INFO, "%s\n", serv_spam_init());*/
        /* lprintf(CTDL_INFO, "%s\n", serv_test_init()); */
-       lprintf(CTDL_INFO, "%s\n", serv_vandelay_init());
+       /*lprintf(CTDL_INFO, "%s\n", serv_vandelay_init());
        lprintf(CTDL_INFO, "%s\n", serv_vcard_init());
        lprintf(CTDL_INFO, "%s\n", serv_fulltext_init());
        lprintf(CTDL_INFO, "%s\n", serv_autocompletion_init());
        lprintf(CTDL_INFO, "%s\n", serv_postfix_tcpdict());
+       lprintf(CTDL_INFO, "%s\n", serv_sieve_init());
        lprintf(CTDL_INFO, "%s\n", serv_managesieve_init());
+       lprintf(CTDL_INFO, "%s\n", serv_funambol_init());*/
+       for (filter = 1; filter != 0; filter = filter << 1)
+               if ((filter & DetailErrorFlags) != 0)
+                       LogPrintMessages(filter);
 }
 
-
+#endif
 
 void CtdlRegisterCleanupHook(void (*fcn_ptr) (void))
 {
@@ -166,6 +328,21 @@ void CtdlUnregisterCleanupHook(void (*fcn_ptr) (void))
        }
 }
 
+void CtdlDestroyCleanupHooks(void)
+{
+       struct CleanupFunctionHook *cur, *p;
+
+       cur = CleanupHookTable;
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Destroyed cleanup function\n");
+               p = cur->next;
+               free(cur);
+               cur = p;
+       }
+       CleanupHookTable = NULL;
+}
+
 
 void CtdlRegisterSessionHook(void (*fcn_ptr) (void), int EventType)
 {
@@ -205,6 +382,21 @@ void CtdlUnregisterSessionHook(void (*fcn_ptr) (void), int EventType)
        }
 }
 
+void CtdlDestroySessionHooks(void)
+{
+       struct SessionFunctionHook *cur, *p;
+
+       cur = SessionHookTable;
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Destroyed session function\n");
+               p = cur->next;
+               free(cur);
+               cur = p;
+       }
+       SessionHookTable = NULL;
+}
+
 
 void CtdlRegisterUserHook(void (*fcn_ptr) (struct ctdluser *), int EventType)
 {
@@ -244,6 +436,21 @@ void CtdlUnregisterUserHook(void (*fcn_ptr) (struct ctdluser *), int EventType)
        }
 }
 
+void CtdlDestroyUserHooks(void)
+{
+       struct UserFunctionHook *cur, *p;
+
+       cur = UserHookTable;
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Destroyed user function \n");
+               p = cur->next;
+               free(cur);
+               cur = p;
+       }
+       UserHookTable = NULL;
+}
+
 
 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
                                int EventType)
@@ -285,6 +492,68 @@ void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
        }
 }
 
+void CtdlDestroyMessageHook(void)
+{
+       struct MessageFunctionHook *cur, *p;
+
+       cur = MessageHookTable; 
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Destroyed message function \n");
+               p = cur->next;
+               free(cur);
+               cur = p;
+       }
+       MessageHookTable = NULL;
+}
+
+
+void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
+{
+       struct RoomFunctionHook *newfcn;
+
+       newfcn = (struct RoomFunctionHook *)
+           malloc(sizeof(struct RoomFunctionHook));
+       newfcn->next = RoomHookTable;
+       newfcn->fcn_ptr = fcn_ptr;
+       RoomHookTable = newfcn;
+
+       lprintf(CTDL_INFO, "Registered a new room function\n");
+}
+
+
+void CtdlUnregisterRoomHook(int (*fcn_ptr)(struct ctdlroom *))
+{
+       struct RoomFunctionHook *cur, *p;
+
+       for (cur = RoomHookTable; cur != NULL; cur = cur->next) {
+               while (cur != NULL && fcn_ptr == cur->fcn_ptr) {
+                       lprintf(CTDL_INFO, "Unregistered room function\n");
+                       p = cur->next;
+                       if (cur == RoomHookTable) {
+                               RoomHookTable = p;
+                       }
+                       free(cur);
+                       cur = p;
+               }
+       }
+}
+
+
+void CtdlDestroyRoomHooks(void)
+{
+       struct RoomFunctionHook *cur, *p;
+
+       cur = RoomHookTable;
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Unregistered room function\n");
+               p = cur->next;
+               free(cur);
+               cur = p;
+       }
+       RoomHookTable = NULL;
+}
 
 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
 {
@@ -319,6 +588,21 @@ void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) )
        }
 }
 
+void CtdlDestroyNetprocHooks(void)
+{
+       struct NetprocFunctionHook *cur, *p;
+
+       cur = NetprocHookTable;
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Unregistered netproc function\n");
+               p = cur->next;
+               free(cur);
+               cur = p;
+       }
+       NetprocHookTable = NULL;
+}
+
 
 void CtdlRegisterDeleteHook(void (*handler)(char *, long) )
 {
@@ -352,6 +636,20 @@ void CtdlUnregisterDeleteHook(void (*handler)(char *, long) )
                }
        }
 }
+void CtdlDestroyDeleteHooks(void)
+{
+       struct DeleteFunctionHook *cur, *p;
+
+       cur = DeleteHookTable;
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Destroyed netproc function\n");
+               p = cur->next;
+               free(cur);
+               cur = p;                
+       }
+       DeleteHookTable = NULL;
+}
 
 
 
@@ -389,6 +687,22 @@ void CtdlUnregisterFixedOutputHook(char *content_type)
        }
 }
 
+void CtdlDestroyFixedOutputHooks(void)
+{
+       struct FixedOutputHook *cur, *p;
+
+       cur = FixedOutputTable; 
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Destroyed fixed output function for %s\n", cur->content_type);
+               p = cur->next;
+               free(cur);
+               cur = p;
+               
+       }
+       FixedOutputTable = NULL;
+}
+
 /* returns nonzero if we found a hook and used it */
 int PerformFixedOutputHooks(char *content_type, char *content, int content_length)
 {
@@ -443,40 +757,65 @@ void CtdlUnregisterXmsgHook(int (*fcn_ptr) (char *, char *, char *), int order)
        }
 }
 
+void CtdlDestroyXmsgHooks(void)
+{
+       struct XmsgFunctionHook *cur, *p;
+
+       cur = XmsgHookTable;
+       while (cur != NULL)
+       {
+               lprintf(CTDL_INFO, "Destroyed x-msg function "
+                       "(priority %d)\n", cur->order);
+               p = cur->next;
+                       
+               free(cur);
+               cur = p;
+       }
+       XmsgHookTable = NULL;
+}
+
 
 void CtdlRegisterServiceHook(int tcp_port,
-                       char *sockpath,
-                       void (*h_greeting_function) (void),
-                       void (*h_command_function) (void),
-                       void (*h_async_function) (void)
-                       )
+                            char *sockpath,
+                            void (*h_greeting_function) (void),
+                            void (*h_command_function) (void),
+                            void (*h_async_function) (void),
+                            const char *ServiceName)
 {
        struct ServiceFunctionHook *newfcn;
-       char message[SIZ];
+       char *message;
+       char *error;
 
+       error = NULL;
        newfcn = (struct ServiceFunctionHook *)
            malloc(sizeof(struct ServiceFunctionHook));
+       message = (char*) malloc (SIZ);
+       
        newfcn->next = ServiceHookTable;
        newfcn->tcp_port = tcp_port;
        newfcn->sockpath = sockpath;
        newfcn->h_greeting_function = h_greeting_function;
        newfcn->h_command_function = h_command_function;
        newfcn->h_async_function = h_async_function;
+       newfcn->ServiceName = ServiceName;
 
        if (sockpath != NULL) {
-               newfcn->msock = ig_uds_server(sockpath, config.c_maxsessions);
-               snprintf(message, sizeof message, "Unix domain socket '%s': ", sockpath);
+               newfcn->msock = ig_uds_server(sockpath, config.c_maxsessions, &error);
+               snprintf(message, SIZ, "Unix domain socket '%s': ", sockpath);
        }
        else if (tcp_port <= 0) {       /* port -1 to disable */
-               lprintf(CTDL_INFO, "Service has been manually disabled, skipping\n");
+               lprintf(CTDL_INFO, "Service %s has been manually disabled, skipping\n", ServiceName);
+               free (message);
                free(newfcn);
                return;
        }
        else {
                newfcn->msock = ig_tcp_server(config.c_ip_addr,
-                                       tcp_port,
-                                       config.c_maxsessions);
-               snprintf(message, sizeof message, "TCP port %d: ", tcp_port);
+                                             tcp_port,
+                                             config.c_maxsessions, 
+                                             &error);
+               snprintf(message, SIZ, "TCP port %s:%d: (%s) ", 
+                        config.c_ip_addr, tcp_port, ServiceName);
        }
 
        if (newfcn->msock > 0) {
@@ -485,10 +824,13 @@ void CtdlRegisterServiceHook(int tcp_port,
                lprintf(CTDL_INFO, "%s\n", message);
        }
        else {
+               AddPortError(message, error);
                strcat(message, "FAILED.");
                lprintf(CTDL_CRIT, "%s\n", message);
+               free(error);
                free(newfcn);
        }
+       free(message);
 }
 
 
@@ -528,10 +870,81 @@ void CtdlUnregisterServiceHook(int tcp_port, char *sockpath,
        }
 }
 
+void CtdlDestroyServiceHook(void)
+{
+       struct ServiceFunctionHook *cur, *p;
+
+       cur = ServiceHookTable;
+       while (cur != NULL)
+       {
+               close(cur->msock);
+               if (cur->sockpath) {
+                       lprintf(CTDL_INFO, "Closed UNIX domain socket %s\n",
+                               cur->sockpath);
+               } else if (cur->tcp_port) {
+                       lprintf(CTDL_INFO, "Closed TCP port %d\n", cur->tcp_port);
+               } else {
+                       lprintf(CTDL_INFO, "Unregistered unknown service\n");
+               }
+               p = cur->next;
+               free(cur);
+               cur = p;
+       }
+       ServiceHookTable = NULL;
+}
+
+void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, char *), char *name)
+{
+       struct SearchFunctionHook *newfcn;
+
+       if (!name || !fcn_ptr) {
+               return;
+       }
+       
+       newfcn = (struct SearchFunctionHook *)
+           malloc(sizeof(struct SearchFunctionHook));
+       newfcn->next = SearchFunctionHookTable;
+       newfcn->name = name;
+       newfcn->fcn_ptr = fcn_ptr;
+       SearchFunctionHookTable = newfcn;
+
+       lprintf(CTDL_INFO, "Registered a new search function (%s)\n", name);
+}
+
+void CtdlUnregisterSearchFuncHook(void (*fcn_ptr)(int *, long **, char *), char *name)
+{
+       struct SearchFunctionHook *cur, *p;
+       
+       for (cur = SearchFunctionHookTable; cur != NULL; cur = cur->next) {
+               while (fcn_ptr && (cur->fcn_ptr == fcn_ptr) && name && !strcmp(name, cur->name)) {
+                       lprintf(CTDL_INFO, "Unregistered search function(%s)\n", name);
+                       p = cur->next;
+                       if (cur == SearchFunctionHookTable) {
+                               SearchFunctionHookTable = p;
+                       }
+                       free (cur);
+                       cur = p;
+               }
+       }
+}
+
+void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, char *search_string, char *func_name)
+{
+       struct SearchFunctionHook *fcn = NULL;
+
+       for (fcn = SearchFunctionHookTable; fcn != NULL; fcn = fcn->next) {
+               if (!func_name || !strcmp(func_name, fcn->name)) {
+                       (*fcn->fcn_ptr) (num_msgs, search_msgs, search_string);
+                       return;
+               }
+       }
+       *num_msgs = 0;
+}
+
 
 void PerformSessionHooks(int EventType)
 {
-       struct SessionFunctionHook *fcn;
+       struct SessionFunctionHook *fcn = NULL;
 
        for (fcn = SessionHookTable; fcn != NULL; fcn = fcn->next) {
                if (fcn->eventtype == EventType) {
@@ -542,7 +955,7 @@ void PerformSessionHooks(int EventType)
 
 void PerformUserHooks(struct ctdluser *usbuf, int EventType)
 {
-       struct UserFunctionHook *fcn;
+       struct UserFunctionHook *fcn = NULL;
 
        for (fcn = UserHookTable; fcn != NULL; fcn = fcn->next) {
                if (fcn->eventtype == EventType) {
@@ -553,7 +966,7 @@ void PerformUserHooks(struct ctdluser *usbuf, int EventType)
 
 int PerformMessageHooks(struct CtdlMessage *msg, int EventType)
 {
-       struct MessageFunctionHook *fcn;
+       struct MessageFunctionHook *fcn = NULL;
        int total_retval = 0;
 
        /* Other code may elect to protect this message from server-side
@@ -583,6 +996,22 @@ int PerformMessageHooks(struct CtdlMessage *msg, int EventType)
 }
 
 
+int PerformRoomHooks(struct ctdlroom *target_room)
+{
+       struct RoomFunctionHook *fcn;
+       int total_retval = 0;
+
+       lprintf(CTDL_DEBUG, "Performing room hooks for <%s>\n", target_room->QRname);
+
+       for (fcn = RoomHookTable; fcn != NULL; fcn = fcn->next) {
+               total_retval = total_retval + (*fcn->fcn_ptr) (target_room);
+       }
+
+       /* Return the sum of the return codes from the hook functions.
+        */
+       return total_retval;
+}
+
 
 int PerformNetprocHooks(struct CtdlMessage *msg, char *target_room)
 {
@@ -637,3 +1066,28 @@ int PerformXmsgHooks(char *sender, char *recp, char *msg)
        }
        return total_sent;
 }
+
+void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc)(void *arg))
+{
+       struct MaintenanceThreadHook *newfcn;
+
+       newfcn = (struct MaintenanceThreadHook *)
+           malloc(sizeof(struct MaintenanceThreadHook));
+       newfcn->name = name;
+       newfcn->next = MaintenanceThreadHookTable;
+       newfcn->fcn_ptr = thread_proc;
+       MaintenanceThreadHookTable = newfcn;
+
+       lprintf(CTDL_INFO, "Registered a new maintenance thread function\n");
+}
+
+
+/*
+ * Dirty hack until we impliment a hook mechanism for this
+ */
+void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response)
+{
+#ifdef HAVE_OPENSSL
+       CtdlStartTLS (ok_response, nosup_response, error_response);
+#endif
+}