* Finished (mostly) the Sleepycat DB backend ... added transaction logging
[citadel.git] / citadel / sysdep.c
index 6bde9f3961d93b173dd2d96490dd4630a8f9f4a8..8a37d59339bd8021a41526565f5dd7083ecec0f4 100644 (file)
@@ -1,14 +1,15 @@
 /*
+ * $Id$
+ *
  * Citadel/UX "system dependent" stuff.
  * See copyright.txt for copyright information.
  *
- * $Id$
- *
- * Here's where we (hopefully) have all the parts of the Citadel server that
+ * Here's where we (hopefully) have most parts of the Citadel server that
  * would need to be altered to run the server in a non-POSIX environment.
  * 
- * Eventually we'll try porting to a different platform and either have
- * multiple variants of this file or simply load it up with #ifdefs.
+ * If we ever port to a different platform and either have multiple
+ * variants of this file or simply load it up with #ifdefs.
+ *
  */
 
 
 #include <ctype.h>
 #include <signal.h>
 #include <sys/types.h>
+#include <sys/stat.h>
 #include <sys/wait.h>
 #include <sys/socket.h>
 #include <sys/time.h>
 #include <limits.h>
 #include <netinet/in.h>
 #include <netdb.h>
+#include <sys/un.h>
 #include <string.h>
 #include <pwd.h>
 #include <errno.h>
@@ -75,6 +78,8 @@ int num_sessions = 0;                         /* Current number of sessions */
 fd_set masterfds;                              /* Master sockets etc. */
 int masterhighest;
 
+time_t last_timer = 0L;                                /* Last timer hook processing */
+
 
 /*
  * lprintf()  ...   Write logging information
@@ -90,10 +95,10 @@ void lprintf(int loglevel, const char *format, ...) {
        if (loglevel <= verbosity) { 
                fprintf(stderr, "%s", buf);
                fflush(stderr);
-               }
+       }
 
        PerformLogHooks(loglevel, buf);
-       }   
+}   
 
 
 
@@ -116,7 +121,7 @@ void *tracked_malloc(size_t tsize, char *tfile, int tline) {
        hptr->h_ptr = ptr;
        heap = hptr;
        return ptr;
-       }
+}
 
 char *tracked_strdup(const char *orig, char *tfile, int tline) {
        char *s;
@@ -135,19 +140,19 @@ void tracked_free(void *ptr) {
                hptr = heap->next;
                free(heap);
                heap = hptr;
-               }
+       }
        else {
                for (hptr=heap; hptr->next!=NULL; hptr=hptr->next) {
                        if (hptr->next->h_ptr == ptr) {
                                freeme = hptr->next;
                                hptr->next = hptr->next->next;
                                free(freeme);
-                               }
                        }
                }
+       }
 
        free(ptr);
-       }
+}
 
 void *tracked_realloc(void *ptr, size_t size) {
        void *newptr;
@@ -157,10 +162,10 @@ void *tracked_realloc(void *ptr, size_t size) {
 
        for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
                if (hptr->h_ptr == ptr) hptr->h_ptr = newptr;
-               }
+       }
 
        return newptr;
-       }
+}
 
 
 void dump_tracked() {
@@ -170,18 +175,18 @@ void dump_tracked() {
        for (hptr=heap; hptr!=NULL; hptr=hptr->next) {
                cprintf("%20s %5d\n",
                        hptr->h_file, hptr->h_line);
-               }
+       }
 #ifdef __GNUC__
         malloc_stats();
 #endif
 
        cprintf("000\n");
-       }
+}
 #endif
 
 
 /*
- * we used to use master_cleanup() as a signal handler to shut down the server.
+ * We used to use master_cleanup() as a signal handler to shut down the server.
  * however, master_cleanup() and the functions it calls do some things that
  * aren't such a good idea to do from a signal handler: acquiring mutexes,
  * playing with signal masks on BSDI systems, etc. so instead we install the
@@ -210,7 +215,8 @@ void init_sysdep(void) {
        /*
         * Set up a place to put thread-specific data.
         * We only need a single pointer per thread - it points to the
-        * thread's CitContext structure in the ContextList linked list.
+        * CitContext structure (in the ContextList linked list) of the
+        * session to which the calling thread is currently bound.
         */
        if (pthread_key_create(&MyConKey, NULL) != 0) {
                lprintf(1, "Can't create TSD key!!  %s\n", strerror(errno));
@@ -239,6 +245,7 @@ void init_sysdep(void) {
  */
 void begin_critical_section(int which_one)
 {
+       /* lprintf(9, "begin_critical_section(%d)\n", which_one); */
        pthread_mutex_lock(&Critters[which_one]);
 }
 
@@ -247,6 +254,7 @@ void begin_critical_section(int which_one)
  */
 void end_critical_section(int which_one)
 {
+       /* lprintf(9, "end_critical_section(%d)\n", which_one); */
        pthread_mutex_unlock(&Critters[which_one]);
 }
 
@@ -255,50 +263,44 @@ void end_critical_section(int which_one)
 /*
  * This is a generic function to set up a master socket for listening on
  * a TCP port.  The server shuts down if the bind fails.
+ *
  */
 int ig_tcp_server(int port_number, int queue_len)
 {
        struct sockaddr_in sin;
        int s, i;
+       int actual_queue_len;
+
+       actual_queue_len = queue_len;
+       if (actual_queue_len < 5) actual_queue_len = 5;
 
        memset(&sin, 0, sizeof(sin));
        sin.sin_family = AF_INET;
        sin.sin_addr.s_addr = INADDR_ANY;
-
-       if (port_number == 0) {
-               lprintf(1, "citserver: illegal port number specified\n");
-               return(-1);
-       }
-       
        sin.sin_port = htons((u_short)port_number);
 
-       s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
+       s = socket(PF_INET, SOCK_STREAM,
+               (getprotobyname("tcp")->p_proto));
+
        if (s < 0) {
                lprintf(1, "citserver: Can't create a socket: %s\n",
                        strerror(errno));
                return(-1);
        }
 
-       /* Set the SO_REUSEADDR socket option, because it makes sense. */
        i = 1;
        setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
 
        if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
-               lprintf(1, "citserver: Can't bind: %s\n", strerror(errno));
-               sin.sin_port = 0;
-               if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
-                       lprintf(1, "citserver: Can't bind: %s\n",
-                               strerror(errno));
-                       return(-1);
-               }
-               else {
-                       lprintf(1, "bind to alternate port %d ok\n",
-                               htons(sin.sin_port) );
-               }
+               lprintf(1, "citserver: Can't bind: %s\n",
+                       strerror(errno));
+               close(s);
+               return(-1);
        }
 
-       if (listen(s, queue_len) < 0) {
+       if (listen(s, actual_queue_len) < 0) {
                lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
+               close(s);
                return(-1);
        }
 
@@ -307,6 +309,54 @@ int ig_tcp_server(int port_number, int queue_len)
 
 
 
+/*
+ * Create a Unix domain socket and listen on it
+ */
+int ig_uds_server(char *sockpath, int queue_len)
+{
+       struct sockaddr_un addr;
+       int s;
+       int i;
+       int actual_queue_len;
+
+       actual_queue_len = queue_len;
+       if (actual_queue_len < 5) actual_queue_len = 5;
+
+       i = unlink(sockpath);
+       if (i != 0) if (errno != ENOENT) {
+               lprintf(1, "citserver: can't unlink %s: %s\n",
+                       sockpath, strerror(errno));
+               return(-1);
+       }
+
+       memset(&addr, 0, sizeof(addr));
+       addr.sun_family = AF_UNIX;
+       safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
+
+       s = socket(AF_UNIX, SOCK_STREAM, 0);
+       if (s < 0) {
+               lprintf(1, "citserver: Can't create a socket: %s\n",
+                       strerror(errno));
+               return(-1);
+       }
+
+       if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
+               lprintf(1, "citserver: Can't bind: %s\n",
+                       strerror(errno));
+               return(-1);
+       }
+
+       if (listen(s, actual_queue_len) < 0) {
+               lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
+               return(-1);
+       }
+
+       chmod(sockpath, 0777);
+       return(s);
+}
+
+
+
 /*
  * Return a pointer to the CitContext structure bound to the thread which
  * called this function.  If there's no such binding (for example, if it's
@@ -321,7 +371,11 @@ struct CitContext *MyContext(void) {
 
 
 /*
- * Initialize a new context and place it in the list.
+ * Initialize a new context and place it in the list.  The session number
+ * used to be the PID (which is why it's called cs_pid), but that was when we
+ * had one process per session.  Now we just assign them sequentially, starting
+ * at 1 (don't change it to 0 because masterCC uses 0) and re-using them when
+ * sessions terminate.
  */
 struct CitContext *CreateNewContext(void) {
        struct CitContext *me, *ptr;
@@ -372,13 +426,27 @@ void client_write(char *buf, int nbytes)
 {
        int bytes_written = 0;
        int retval;
+       int sock;
+
+       if (CC->redirect_fp != NULL) {
+               fwrite(buf, nbytes, 1, CC->redirect_fp);
+               return;
+       }
+
+       if (CC->redirect_sock > 0) {
+               sock = CC->redirect_sock;       /* and continue below... */
+       }
+       else {
+               sock = CC->client_socket;
+       }
+
        while (bytes_written < nbytes) {
-               retval = write(CC->client_socket, &buf[bytes_written],
+               retval = write(sock, &buf[bytes_written],
                        nbytes - bytes_written);
                if (retval < 1) {
                        lprintf(2, "client_write() failed: %s\n",
                                strerror(errno));
-                       CC->kill_me = 1;
+                       if (sock == CC->client_socket) CC->kill_me = 1;
                        return;
                }
                bytes_written = bytes_written + retval;
@@ -483,6 +551,7 @@ int client_gets(char *buf)
        buf[i] = 0;
        while ((strlen(buf)>0)&&(!isprint(buf[strlen(buf)-1])))
                buf[strlen(buf)-1] = 0;
+       if (retval < 0) strcpy(buf, "000");
        return(retval);
 }
 
@@ -492,7 +561,29 @@ int client_gets(char *buf)
  * The system-dependent part of master_cleanup() - close the master socket.
  */
 void sysdep_master_cleanup(void) {
-       /* FIX close all protocol master sockets here */
+       struct ServiceFunctionHook *serviceptr;
+
+       /*
+        * close all protocol master sockets
+        */
+       for (serviceptr = ServiceHookTable; serviceptr != NULL;
+           serviceptr = serviceptr->next ) {
+
+               if (serviceptr->tcp_port > 0)
+                       lprintf(3, "Closing listener on port %d\n",
+                               serviceptr->tcp_port);
+
+               if (serviceptr->sockpath != NULL)
+                       lprintf(3, "Closing listener on '%s'\n",
+                               serviceptr->sockpath);
+
+               close(serviceptr->msock);
+
+               /* If it's a Unix domain socket, remove the file. */
+               if (serviceptr->sockpath != NULL) {
+                       unlink(serviceptr->sockpath);
+               }
+       }
 }
 
 
@@ -687,7 +778,70 @@ void dead_session_purge(void) {
 }
 
 
-       
+
+
+
+/*
+ * Redirect a session's output to a file or socket.
+ * This function may be called with a file handle *or* a socket (but not
+ * both).  Call with neither to return output to its normal client socket.
+ */
+void CtdlRedirectOutput(FILE *fp, int sock) {
+
+       if (fp != NULL) CC->redirect_fp = fp;
+       else CC->redirect_fp = NULL;
+
+       if (sock > 0) CC->redirect_sock = sock;
+       else CC->redirect_sock = (-1);
+
+}
+
+
+/*
+ * masterCC is the context we use when not attached to a session.  This
+ * function initializes it.
+ */
+void InitializeMasterCC(void) {
+       memset(&masterCC, 0, sizeof(struct CitContext));
+       masterCC.internal_pgm = 1;
+       masterCC.cs_pid = 0;
+}
+
+
+
+/*
+ * Set up a fd_set containing all the master sockets to which we
+ * always listen.  It's computationally less expensive to just copy
+ * this to a local fd_set when starting a new select() and then add
+ * the client sockets than it is to initialize a new one and then
+ * figure out what to put there.
+ */
+void init_master_fdset(void) {
+       struct ServiceFunctionHook *serviceptr;
+       int m;
+
+       lprintf(9, "Initializing master fdset\n");
+
+       FD_ZERO(&masterfds);
+       masterhighest = 0;
+
+       lprintf(9, "Will listen on rescan pipe %d\n", rescan[0]);
+       FD_SET(rescan[0], &masterfds);
+       if (rescan[0] > masterhighest) masterhighest = rescan[0];
+
+       for (serviceptr = ServiceHookTable; serviceptr != NULL;
+           serviceptr = serviceptr->next ) {
+               m = serviceptr->msock;
+               lprintf(9, "Will listen on master socket %d\n", m);
+               FD_SET(m, &masterfds);
+               if (m > masterhighest) {
+                       masterhighest = m;
+               }
+       }
+       lprintf(9, "masterhighest = %d\n", masterhighest);
+}
+
+
 
 /*
  * Here's where it all begins.
@@ -701,11 +855,13 @@ int main(int argc, char **argv)
        struct passwd *pw;
        int drop_root_perms = 1;
        char *moddir;
-       struct ServiceFunctionHook *serviceptr;
         
        /* specify default port name and trace file */
        strcpy(tracefile, "");
 
+       /* initialize the master context */
+       InitializeMasterCC();
+
        /* parse command-line arguments */
        for (a=1; a<argc; ++a) {
 
@@ -757,7 +913,7 @@ int main(int argc, char **argv)
        /* Tell 'em who's in da house */
        lprintf(1,
 "\nMultithreaded message server for Citadel/UX\n"
-"Copyright (C) 1987-1999 by the Citadel/UX development team.\n"
+"Copyright (C) 1987-2000 by the Citadel/UX development team.\n"
 "Citadel/UX is free software, covered by the GNU General Public License, and\n"
 "you are welcome to change it and/or distribute copies of it under certain\n"
 "conditions.  There is absolutely no warranty for this software.  Please\n"
@@ -765,7 +921,7 @@ int main(int argc, char **argv)
 
        /* Initialize... */
        init_sysdep();
-       openlog("citserver",LOG_PID,LOG_USER);
+       openlog("citserver", LOG_PID, LOG_USER);
 
        /* Load site-specific parameters */
        lprintf(7, "Loading citadel.config\n");
@@ -777,9 +933,18 @@ int main(int argc, char **argv)
        master_startup();
 
        /*
-        * Bind the server to our favorite ports.
+        * Bind the server to a Unix-domain socket.
+        */
+       CtdlRegisterServiceHook(0,
+                               "citadel.socket",
+                               citproto_begin_session,
+                               do_command_loop);
+
+       /*
+        * Bind the server to our favorite TCP port (usually 504).
         */
        CtdlRegisterServiceHook(config.c_port_number,
+                               NULL,
                                citproto_begin_session,
                                do_command_loop);
 
@@ -804,36 +969,7 @@ int main(int argc, char **argv)
                exit(errno);
        }
 
-       /*
-        * Set up a fd_set containing all the master sockets to which we
-        * always listen.  It's computationally less expensive to just copy
-        * this to a local fd_set when starting a new select() and then add
-        * the client sockets than it is to initialize a new one and then
-        * figure out what to put there.
-        */
-       FD_ZERO(&masterfds);
-       masterhighest = 0;
-       FD_SET(rescan[0], &masterfds);
-       if (rescan[0] > masterhighest) masterhighest = rescan[0];
-
-       for (serviceptr = ServiceHookTable; serviceptr != NULL;
-           serviceptr = serviceptr->next ) {
-               serviceptr->msock = ig_tcp_server(
-                       serviceptr->tcp_port, config.c_maxsessions);
-               if (serviceptr->msock >= 0) {
-                       FD_SET(serviceptr->msock, &masterfds);
-                       if (serviceptr->msock > masterhighest)
-                               masterhighest = serviceptr->msock;
-                       lprintf(7, "Bound to port %-5d (socket %d)\n",
-                               serviceptr->tcp_port,
-                               serviceptr->msock);
-               }
-               else {
-                       lprintf(1, "Unable to bind to port %d\n",
-                               serviceptr->tcp_port);
-               }
-       }
-
+       init_master_fdset();
 
        /*
         * Now that we've bound the sockets, change to the BBS user id and its
@@ -890,7 +1026,7 @@ int main(int argc, char **argv)
 
 
 /*
- * Bind a thread to a context.
+ * Bind a thread to a context.  (It's inline merely to speed things up.)
  */
 inline void become_session(struct CitContext *which_con) {
        pthread_setspecific(MyConKey, (void *)which_con );
@@ -914,8 +1050,10 @@ void worker_thread(void) {
        struct sockaddr_in fsin;        /* Data for master socket */
        int alen;                       /* Data for master socket */
        int ssock;                      /* Descriptor for client socket */
+       struct timeval tv;
 
        ++num_threads;
+
        while (!time_to_die) {
 
                /* 
@@ -923,13 +1061,13 @@ void worker_thread(void) {
                 * calling select() and then they'd all wake up at once.  We
                 * solve this problem by putting the select() in a critical
                 * section, so only one thread has the opportunity to wake
-                * up.  If we wake up on the master socket, create a new
+                * up.  If we wake up on a master socket, create a new
                 * session context; otherwise, just bind the thread to the
                 * context we want and go on our merry way.
                 */
 
                begin_critical_section(S_I_WANNA_SELECT);
-SETUP_FD:      memcpy(&readfds, &masterfds, sizeof(fd_set) );
+SETUP_FD:      memcpy(&readfds, &masterfds, sizeof masterfds);
                highest = masterhighest;
                begin_critical_section(S_SESSION_TABLE);
                for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
@@ -941,7 +1079,9 @@ SETUP_FD:  memcpy(&readfds, &masterfds, sizeof(fd_set) );
                }
                end_critical_section(S_SESSION_TABLE);
 
-               retval = select(highest + 1, &readfds, NULL, NULL, NULL);
+               tv.tv_sec = 60;         /* wake up every minute if no input */
+               tv.tv_usec = 0;
+               retval = select(highest + 1, &readfds, NULL, NULL, &tv);
 
                /* Now figure out who made this select() unblock.
                 * First, check for an error or exit condition.
@@ -953,7 +1093,7 @@ SETUP_FD:  memcpy(&readfds, &masterfds, sizeof(fd_set) );
                }
 
                /* Next, check to see if it's a new client connecting
-                * on the master socket.
+                * on a master socket.
                 */
                else for (serviceptr = ServiceHookTable; serviceptr != NULL;
                     serviceptr = serviceptr->next ) {
@@ -980,6 +1120,10 @@ SETUP_FD: memcpy(&readfds, &masterfds, sizeof(fd_set) );
                                        con->client_socket = ssock;
                                        con->h_command_function =
                                                serviceptr->h_command_function;
+
+                                       /* Determine whether local socket */
+                                       if (serviceptr->sockpath != NULL)
+                                               con->is_local_socket = 1;
        
                                        /* Set the SO_REUSEADDR socket option */
                                        i = 1;
@@ -1001,7 +1145,10 @@ SETUP_FD:        memcpy(&readfds, &masterfds, sizeof(fd_set) );
                 * thread that the &readfds needs to be refreshed with more
                 * current data.
                 */
-               if (!time_to_die) if (FD_ISSET(rescan[0], &readfds)) {
+               if (time_to_die)
+                       break;
+
+               if (FD_ISSET(rescan[0], &readfds)) {
                        read(rescan[0], &junk, 1);
                        goto SETUP_FD;
                }
@@ -1033,7 +1180,9 @@ SETUP_FD: memcpy(&readfds, &masterfds, sizeof(fd_set) );
                        /* We're bound to a session, now do *one* command */
                        if (bind_me != NULL) {
                                become_session(bind_me);
+                               cdb_begin_transaction();
                                CC->h_command_function();
+                               cdb_end_transaction();
                                become_session(NULL);
                                bind_me->state = CON_IDLE;
                                if (bind_me->kill_me == 1) {
@@ -1041,12 +1190,13 @@ SETUP_FD:       memcpy(&readfds, &masterfds, sizeof(fd_set) );
                                } 
                                write(rescan[1], &junk, 1);
                        }
-                       else {
-                               lprintf(9, "Thread found nothing to do!\n");
-                       }
 
                }
                dead_session_purge();
+               if ((time(NULL) - last_timer) > 60L) {
+                       last_timer = time(NULL);
+                       PerformSessionHooks(EVT_TIMER);
+               }
        }
 
        /* If control reaches this point, the server is shutting down */