12ef309cc88531231e0c7acc2e53044d44491477
[citadel.git] / citadel / sysdep.c
1 /*
2  * $Id$
3  *
4  * Citadel "system dependent" stuff.
5  * See copyright.txt for copyright information.
6  *
7  * Here's where we (hopefully) have most parts of the Citadel server that
8  * would need to be altered to run the server in a non-POSIX environment.
9  * 
10  * If we ever port to a different platform and either have multiple
11  * variants of this file or simply load it up with #ifdefs.
12  *
13  */
14
15 #include "sysdep.h"
16 #include <stdlib.h>
17 #include <unistd.h>
18 #include <stdio.h>
19 #include <fcntl.h>
20 #include <ctype.h>
21 #include <signal.h>
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/wait.h>
25 #include <sys/socket.h>
26 #include <syslog.h>
27 #include <sys/syslog.h>
28
29 #if TIME_WITH_SYS_TIME
30 # include <sys/time.h>
31 # include <time.h>
32 #else
33 # if HAVE_SYS_TIME_H
34 #  include <sys/time.h>
35 # else
36 #  include <time.h>
37 # endif
38 #endif
39
40 #include <limits.h>
41 #include <sys/resource.h>
42 #include <netinet/in.h>
43 #include <netinet/tcp.h>
44 #include <arpa/inet.h>
45 #include <netdb.h>
46 #include <sys/un.h>
47 #include <string.h>
48 #include <pwd.h>
49 #include <errno.h>
50 #include <stdarg.h>
51 #include <grp.h>
52 #include <libcitadel.h>
53 #include "citadel.h"
54 #include "server.h"
55 #include "sysdep_decls.h"
56 #include "citserver.h"
57 #include "support.h"
58 #include "config.h"
59 #include "database.h"
60 #include "housekeeping.h"
61 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
62 #include "ecrash.h"
63
64 #ifdef HAVE_SYS_SELECT_H
65 #include <sys/select.h>
66 #endif
67
68 #ifndef HAVE_SNPRINTF
69 #include "snprintf.h"
70 #endif
71
72 #include "ctdl_module.h"
73 #include "threads.h"
74
75 #ifdef DEBUG_MEMORY_LEAKS
76 struct igheap {
77         struct igheap *next;
78         char file[32];
79         int line;
80         void *block;
81 };
82
83 struct igheap *igheap = NULL;
84 #endif
85
86
87 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
88
89 int verbosity = DEFAULT_VERBOSITY;              /* Logging level */
90
91 struct CitContext masterCC;
92 time_t last_purge = 0;                          /* Last dead session purge */
93 int num_sessions = 0;                           /* Current number of sessions */
94
95 int syslog_facility = LOG_DAEMON;
96 int enable_syslog = 0;
97
98
99 /*
100  * Create an interface to lprintf that follows the coding convention.
101  * This is here until such time as we have replaced all calls to lprintf with CtdlLogPrintf
102  */
103  
104 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...)
105 {
106         va_list arg_ptr;
107         va_start(arg_ptr, format);
108         vlprintf(loglevel, format, arg_ptr);
109         va_end(arg_ptr);
110 }
111
112
113 /*
114  * lprintf()  ...   Write logging information
115  */
116 void lprintf(enum LogLevel loglevel, const char *format, ...) {   
117         va_list arg_ptr;
118         va_start(arg_ptr, format);
119         vlprintf(loglevel, format, arg_ptr);
120         va_end(arg_ptr);
121 }
122
123 void vlprintf(enum LogLevel loglevel, const char *format, va_list arg_ptr)
124 {
125         char buf[SIZ], buf2[SIZ];
126
127         if (enable_syslog) {
128                 vsyslog((syslog_facility | loglevel), format, arg_ptr);
129         }
130
131         /* stderr output code */
132         if (enable_syslog || running_as_daemon) return;
133
134         /* if we run in forground and syslog is disabled, log to terminal */
135         if (loglevel <= verbosity) { 
136                 struct timeval tv;
137                 struct tm tim;
138                 time_t unixtime;
139
140                 gettimeofday(&tv, NULL);
141                 /* Promote to time_t; types differ on some OSes (like darwin) */
142                 unixtime = tv.tv_sec;
143                 localtime_r(&unixtime, &tim);
144                 if (CC->cs_pid != 0) {
145                         sprintf(buf,
146                                 "%04d/%02d/%02d %2d:%02d:%02d.%06ld [%3d] ",
147                                 tim.tm_year + 1900, tim.tm_mon + 1,
148                                 tim.tm_mday, tim.tm_hour, tim.tm_min,
149                                 tim.tm_sec, (long)tv.tv_usec,
150                                 CC->cs_pid);
151                 } else {
152                         sprintf(buf,
153                                 "%04d/%02d/%02d %2d:%02d:%02d.%06ld ",
154                                 tim.tm_year + 1900, tim.tm_mon + 1,
155                                 tim.tm_mday, tim.tm_hour, tim.tm_min,
156                                 tim.tm_sec, (long)tv.tv_usec);
157                 }
158                 vsprintf(buf2, format, arg_ptr);   
159
160                 fprintf(stderr, "%s%s", buf, buf2);
161                 fflush(stderr);
162         }
163 }   
164
165
166
167 /*
168  * Signal handler to shut down the server.
169  */
170
171 volatile int exit_signal = 0;
172 volatile int shutdown_and_halt = 0;
173 volatile int restart_server = 0;
174 volatile int running_as_daemon = 0;
175
176 static RETSIGTYPE signal_cleanup(int signum) {
177         CtdlLogPrintf(CTDL_DEBUG, "Caught signal %d; shutting down.\n", signum);
178 #ifdef THREADS_USESIGNALS
179         if (CT)
180         {
181                 CtdlLogPrintf(CTDL_DEBUG, "Thread \"%s\" caught signal %d.\n", CT->name, signum);
182                 CT->signal = signum;
183         }
184         else
185 #endif
186                 exit_signal = signum;
187 }
188
189
190
191 /*
192  * Some initialization stuff...
193  */
194 void init_sysdep(void) {
195         sigset_t set;
196
197         /* Avoid vulnerabilities related to FD_SETSIZE if we can. */
198 #ifdef FD_SETSIZE
199 #ifdef RLIMIT_NOFILE
200         struct rlimit rl;
201         getrlimit(RLIMIT_NOFILE, &rl);
202         rl.rlim_cur = FD_SETSIZE;
203         rl.rlim_max = FD_SETSIZE;
204         setrlimit(RLIMIT_NOFILE, &rl);
205 #endif
206 #endif
207
208         /* If we've got OpenSSL, we're going to use it. */
209 #ifdef HAVE_OPENSSL
210         init_ssl();
211 #endif
212
213         /*
214          * Set up a place to put thread-specific data.
215          * We only need a single pointer per thread - it points to the
216          * CitContext structure (in the ContextList linked list) of the
217          * session to which the calling thread is currently bound.
218          */
219         if (pthread_key_create(&MyConKey, NULL) != 0) {
220                 CtdlLogPrintf(CTDL_CRIT, "Can't create TSD key: %s\n",
221                         strerror(errno));
222         }
223
224         /*
225          * The action for unexpected signals and exceptions should be to
226          * call signal_cleanup() to gracefully shut down the server.
227          */
228         sigemptyset(&set);
229         sigaddset(&set, SIGINT);
230         sigaddset(&set, SIGQUIT);
231         sigaddset(&set, SIGHUP);
232         sigaddset(&set, SIGTERM);
233         // sigaddset(&set, SIGSEGV);    commented out because
234         // sigaddset(&set, SIGILL);     we want core dumps
235         // sigaddset(&set, SIGBUS);
236         sigprocmask(SIG_UNBLOCK, &set, NULL);
237
238         signal(SIGINT, signal_cleanup);
239         signal(SIGQUIT, signal_cleanup);
240         signal(SIGHUP, signal_cleanup);
241         signal(SIGTERM, signal_cleanup);
242         // signal(SIGSEGV, signal_cleanup);     commented out because
243         // signal(SIGILL, signal_cleanup);      we want core dumps
244         // signal(SIGBUS, signal_cleanup);
245
246         /*
247          * Do not shut down the server on broken pipe signals, otherwise the
248          * whole Citadel service would come down whenever a single client
249          * socket breaks.
250          */
251         signal(SIGPIPE, SIG_IGN);
252 }
253
254
255
256
257 /*
258  * This is a generic function to set up a master socket for listening on
259  * a TCP port.  The server shuts down if the bind fails.
260  *
261  */
262 int ig_tcp_server(char *ip_addr, int port_number, int queue_len, char **errormessage)
263 {
264         struct sockaddr_in sin;
265         int s, i;
266         int actual_queue_len;
267
268         actual_queue_len = queue_len;
269         if (actual_queue_len < 5) actual_queue_len = 5;
270
271         memset(&sin, 0, sizeof(sin));
272         sin.sin_family = AF_INET;
273         sin.sin_port = htons((u_short)port_number);
274         if (ip_addr == NULL) {
275                 sin.sin_addr.s_addr = INADDR_ANY;
276         }
277         else {
278                 sin.sin_addr.s_addr = inet_addr(ip_addr);
279         }
280                                                                                 
281         if (sin.sin_addr.s_addr == !INADDR_ANY) {
282                 sin.sin_addr.s_addr = INADDR_ANY;
283         }
284
285         s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
286
287         if (s < 0) {
288                 *errormessage = (char*) malloc(SIZ + 1);
289                 snprintf(*errormessage, SIZ, 
290                                  "citserver: Can't create a socket: %s",
291                                  strerror(errno));
292                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
293                 return(-1);
294         }
295
296         i = 1;
297         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
298
299         if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
300                 *errormessage = (char*) malloc(SIZ + 1);
301                 snprintf(*errormessage, SIZ, 
302                                  "citserver: Can't bind: %s",
303                                  strerror(errno));
304                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
305                 close(s);
306                 return(-1);
307         }
308
309         /* set to nonblock - we need this for some obscure situations */
310         if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
311                 *errormessage = (char*) malloc(SIZ + 1);
312                 snprintf(*errormessage, SIZ, 
313                                  "citserver: Can't set socket to non-blocking: %s",
314                                  strerror(errno));
315                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
316                 close(s);
317                 return(-1);
318         }
319
320         if (listen(s, actual_queue_len) < 0) {
321                 *errormessage = (char*) malloc(SIZ + 1);
322                 snprintf(*errormessage, SIZ, 
323                                  "citserver: Can't listen: %s",
324                                  strerror(errno));
325                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
326                 close(s);
327                 return(-1);
328         }
329
330         return(s);
331 }
332
333
334
335 /*
336  * Create a Unix domain socket and listen on it
337  */
338 int ig_uds_server(char *sockpath, int queue_len, char **errormessage)
339 {
340         struct sockaddr_un addr;
341         int s;
342         int i;
343         int actual_queue_len;
344
345         actual_queue_len = queue_len;
346         if (actual_queue_len < 5) actual_queue_len = 5;
347
348         i = unlink(sockpath);
349         if (i != 0) if (errno != ENOENT) {
350                 *errormessage = (char*) malloc(SIZ + 1);
351                 snprintf(*errormessage, SIZ, "citserver: can't unlink %s: %s",
352                         sockpath, strerror(errno));
353                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
354                 return(-1);
355         }
356
357         memset(&addr, 0, sizeof(addr));
358         addr.sun_family = AF_UNIX;
359         safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
360
361         s = socket(AF_UNIX, SOCK_STREAM, 0);
362         if (s < 0) {
363                 *errormessage = (char*) malloc(SIZ + 1);
364                 snprintf(*errormessage, SIZ, 
365                          "citserver: Can't create a socket: %s",
366                          strerror(errno));
367                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
368                 return(-1);
369         }
370
371         if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
372                 *errormessage = (char*) malloc(SIZ + 1);
373                 snprintf(*errormessage, SIZ, 
374                          "citserver: Can't bind: %s",
375                          strerror(errno));
376                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
377                 return(-1);
378         }
379
380         /* set to nonblock - we need this for some obscure situations */
381         if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
382                 *errormessage = (char*) malloc(SIZ + 1);
383                 snprintf(*errormessage, SIZ, 
384                          "citserver: Can't set socket to non-blocking: %s",
385                          strerror(errno));
386                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
387                 close(s);
388                 return(-1);
389         }
390
391         if (listen(s, actual_queue_len) < 0) {
392                 *errormessage = (char*) malloc(SIZ + 1);
393                 snprintf(*errormessage, SIZ, 
394                          "citserver: Can't listen: %s",
395                          strerror(errno));
396                 CtdlLogPrintf(CTDL_EMERG, "%s\n", *errormessage);
397                 return(-1);
398         }
399
400         chmod(sockpath, S_ISGID|S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
401         return(s);
402 }
403
404
405
406 /*
407  * Return a pointer to the CitContext structure bound to the thread which
408  * called this function.  If there's no such binding (for example, if it's
409  * called by the housekeeper thread) then a generic 'master' CC is returned.
410  *
411  * This function is used *VERY* frequently and must be kept small.
412  */
413 struct CitContext *MyContext(void) {
414
415         register struct CitContext *c;
416
417         return ((c = (struct CitContext *) pthread_getspecific(MyConKey),
418                 c == NULL) ? &masterCC : c
419         );
420 }
421
422
423 /*
424  * Initialize a new context and place it in the list.  The session number
425  * used to be the PID (which is why it's called cs_pid), but that was when we
426  * had one process per session.  Now we just assign them sequentially, starting
427  * at 1 (don't change it to 0 because masterCC uses 0).
428  */
429 struct CitContext *CreateNewContext(void) {
430         struct CitContext *me;
431         static int next_pid = 0;
432
433         me = (struct CitContext *) malloc(sizeof(struct CitContext));
434         if (me == NULL) {
435                 CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
436                 return NULL;
437         }
438         memset(me, 0, sizeof(struct CitContext));
439
440         /* The new context will be created already in the CON_EXECUTING state
441          * in order to prevent another thread from grabbing it while it's
442          * being set up.
443          */
444         me->state = CON_EXECUTING;
445         /*
446          * Generate a unique session number and insert this context into
447          * the list.
448          */
449         begin_critical_section(S_SESSION_TABLE);
450         me->cs_pid = ++next_pid;
451         me->prev = NULL;
452         me->next = ContextList;
453         ContextList = me;
454         if (me->next != NULL) {
455                 me->next->prev = me;
456         }
457         ++num_sessions;
458         end_critical_section(S_SESSION_TABLE);
459         return (me);
460 }
461
462
463 /*
464  * The following functions implement output buffering. If the kernel supplies
465  * native TCP buffering (Linux & *BSD), use that; otherwise, emulate it with
466  * user-space buffering.
467  */
468 #ifndef HAVE_DARWIN
469 #ifdef TCP_CORK
470 #       define HAVE_TCP_BUFFERING
471 #else
472 #       ifdef TCP_NOPUSH
473 #               define HAVE_TCP_BUFFERING
474 #               define TCP_CORK TCP_NOPUSH
475 #       endif
476 #endif /* TCP_CORK */
477 #endif /* HAVE_DARWIN */
478
479 #ifdef HAVE_TCP_BUFFERING
480 static unsigned on = 1, off = 0;
481 void buffer_output(void) {
482         struct CitContext *ctx = MyContext();
483         setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
484         ctx->buffering = 1;
485 }
486
487 void unbuffer_output(void) {
488         struct CitContext *ctx = MyContext();
489         setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
490         ctx->buffering = 0;
491 }
492
493 void flush_output(void) {
494         struct CitContext *ctx = MyContext();
495         setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &off, 4);
496         setsockopt(ctx->client_socket, IPPROTO_TCP, TCP_CORK, &on, 4);
497 }
498 #else 
499 #ifdef HAVE_DARWIN
500 /* Stub functions for Darwin/OS X where TCP buffering isn't liked at all */
501 void buffer_output(void) {
502         CC->buffering = 0;
503 }
504 void unbuffer_output(void) {
505         CC->buffering = 0;
506 }
507 void flush_output(void) {
508 }
509 #else
510 void buffer_output(void) {
511         if (CC->buffering == 0) {
512                 CC->buffering = 1;
513                 CC->buffer_len = 0;
514                 CC->output_buffer = malloc(SIZ);
515         }
516 }
517
518 void flush_output(void) {
519         if (CC->buffering == 1) {
520                 client_write(CC->output_buffer, CC->buffer_len);
521                 CC->buffer_len = 0;
522         }
523 }
524
525 void unbuffer_output(void) {
526         if (CC->buffering == 1) {
527                 CC->buffering = 0;
528                 /* We don't call flush_output because we can't. */
529                 client_write(CC->output_buffer, CC->buffer_len);
530                 CC->buffer_len = 0;
531                 free(CC->output_buffer);
532                 CC->output_buffer = NULL;
533         }
534 }
535 #endif /* HAVE_DARWIN */
536 #endif /* HAVE_TCP_BUFFERING */
537
538
539
540 /*
541  * client_write()   ...    Send binary data to the client.
542  */
543 void client_write(char *buf, int nbytes)
544 {
545         int bytes_written = 0;
546         int retval;
547 #ifndef HAVE_TCP_BUFFERING
548         int old_buffer_len = 0;
549 #endif
550         t_context *Ctx;
551
552         Ctx = CC;
553         if (Ctx->redirect_buffer != NULL) {
554                 if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
555                         Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
556                         Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
557                                                 Ctx->redirect_alloc);
558                 }
559                 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
560                 Ctx->redirect_len += nbytes;
561                 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
562                 return;
563         }
564
565 #ifndef HAVE_TCP_BUFFERING
566         /* If we're buffering for later, do that now. */
567         if (Ctx->buffering) {
568                 old_buffer_len = Ctx->buffer_len;
569                 Ctx->buffer_len += nbytes;
570                 Ctx->output_buffer = realloc(Ctx->output_buffer, Ctx->buffer_len);
571                 memcpy(&Ctx->output_buffer[old_buffer_len], buf, nbytes);
572                 return;
573         }
574 #endif
575
576         /* Ok, at this point we're not buffering.  Go ahead and write. */
577
578 #ifdef HAVE_OPENSSL
579         if (Ctx->redirect_ssl) {
580                 client_write_ssl(buf, nbytes);
581                 return;
582         }
583 #endif
584
585         while (bytes_written < nbytes) {
586                 retval = write(Ctx->client_socket, &buf[bytes_written],
587                         nbytes - bytes_written);
588                 if (retval < 1) {
589                         CtdlLogPrintf(CTDL_ERR,
590                                 "client_write(%d bytes) failed: %s (%d)\n",
591                                 nbytes - bytes_written,
592                                 strerror(errno), errno);
593                         cit_backtrace();
594                         // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s",  &buf[bytes_written]);
595                         Ctx->kill_me = 1;
596                         return;
597                 }
598                 bytes_written = bytes_written + retval;
599         }
600 }
601
602
603 /*
604  * cprintf()  ...   Send formatted printable data to the client.   It is
605  *                implemented in terms of client_write() but remains in
606  *                sysdep.c in case we port to somewhere without va_args...
607  */
608 void cprintf(const char *format, ...) {   
609         va_list arg_ptr;   
610         char buf[1024];   
611    
612         va_start(arg_ptr, format);   
613         if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
614                 buf[sizeof buf - 2] = '\n';
615         client_write(buf, strlen(buf)); 
616         va_end(arg_ptr);
617 }   
618
619
620 /*
621  * Read data from the client socket.
622  * Return values are:
623  *      1       Requested number of bytes has been read.
624  *      0       Request timed out.
625  *      -1      The socket is broken.
626  * If the socket breaks, the session will be terminated.
627  */
628 int client_read_to(char *buf, int bytes, int timeout)
629 {
630         int len,rlen;
631         fd_set rfds;
632         int fd;
633         struct timeval tv;
634         int retval;
635
636 #ifdef HAVE_OPENSSL
637         if (CC->redirect_ssl) {
638                 return (client_read_ssl(buf, bytes, timeout));
639         }
640 #endif
641         len = 0;
642         fd = CC->client_socket;
643         while(len<bytes) {
644                 FD_ZERO(&rfds);
645                 FD_SET(fd, &rfds);
646                 tv.tv_sec = timeout;
647                 tv.tv_usec = 0;
648
649                 retval = select( (fd)+1, 
650                                  &rfds, NULL, NULL, &tv);
651
652                 if (FD_ISSET(fd, &rfds) == 0) {
653                         return(0);
654                 }
655
656                 rlen = read(fd, &buf[len], bytes-len);
657                 if (rlen<1) {
658                         /* The socket has been disconnected! */
659                         CC->kill_me = 1;
660                         return(-1);
661                 }
662                 len = len + rlen;
663         }
664         return(1);
665 }
666
667 /*
668  * Read data from the client socket with default timeout.
669  * (This is implemented in terms of client_read_to() and could be
670  * justifiably moved out of sysdep.c)
671  */
672 INLINE int client_read(char *buf, int bytes)
673 {
674         return(client_read_to(buf, bytes, config.c_sleeping));
675 }
676
677
678 /*
679  * client_getln()   ...   Get a LF-terminated line of text from the client.
680  * (This is implemented in terms of client_read() and could be
681  * justifiably moved out of sysdep.c)
682  */
683 int client_getln(char *buf, int bufsize)
684 {
685         int i, retval;
686
687         /* Read one character at a time.
688          */
689         for (i = 0;;i++) {
690                 retval = client_read(&buf[i], 1);
691                 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
692                         break;
693         }
694
695         /* If we got a long line, discard characters until the newline.
696          */
697         if (i == (bufsize-1))
698                 while (buf[i] != '\n' && retval == 1)
699                         retval = client_read(&buf[i], 1);
700
701         /* Strip the trailing LF, and the trailing CR if present.
702          */
703         buf[i] = 0;
704         while ( (i > 0)
705                 && ( (buf[i - 1]==13)
706                      || ( buf[i - 1]==10)) ) {
707                 i--;
708                 buf[i] = 0;
709         }
710         if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
711         return(retval);
712 }
713
714
715 /*
716  * Cleanup any contexts that are left lying around
717  */
718 void context_cleanup(void)
719 {
720         struct CitContext *ptr = NULL;
721         struct CitContext *rem = NULL;
722
723         /*
724          * Clean up the contexts.
725          * There are no threads so no critical_section stuff is needed.
726          */
727         ptr = ContextList;
728         
729         /* We need to update the ContextList because some modules may want to itterate it
730          * Question is should we NULL it before iterating here or should we just keep updating it
731          * as we remove items?
732          *
733          * Answer is to NULL it first to prevent modules from doing any actions on the list at all
734          */
735         ContextList=NULL;
736         while (ptr != NULL){
737                 /* Remove the session from the active list */
738                 rem = ptr->next;
739                 --num_sessions;
740                 
741                 lprintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
742                 RemoveContext(ptr);
743                 free (ptr);
744                 ptr = rem;
745         }
746 }
747
748
749
750 void close_masters (void)
751 {
752         struct ServiceFunctionHook *serviceptr;
753         
754         /*
755          * close all protocol master sockets
756          */
757         for (serviceptr = ServiceHookTable; serviceptr != NULL;
758             serviceptr = serviceptr->next ) {
759
760                 if (serviceptr->tcp_port > 0)
761                 {
762                         CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
763                                 serviceptr->tcp_port);
764                         serviceptr->tcp_port = 0;
765                 }
766                 
767                 if (serviceptr->sockpath != NULL)
768                         CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
769                                 serviceptr->sockpath);
770
771                 close(serviceptr->msock);
772                 /* If it's a Unix domain socket, remove the file. */
773                 if (serviceptr->sockpath != NULL) {
774                         unlink(serviceptr->sockpath);
775                         serviceptr->sockpath = NULL;
776                 }
777         }
778 }
779
780
781 /*
782  * The system-dependent part of master_cleanup() - close the master socket.
783  */
784 void sysdep_master_cleanup(void) {
785         
786         close_masters();
787         
788         context_cleanup();
789         
790 #ifdef HAVE_OPENSSL
791         destruct_ssl();
792 #endif
793         CtdlDestroyProtoHooks();
794         CtdlDestroyDeleteHooks();
795         CtdlDestroyXmsgHooks();
796         CtdlDestroyNetprocHooks();
797         CtdlDestroyUserHooks();
798         CtdlDestroyMessageHook();
799         CtdlDestroyCleanupHooks();
800         CtdlDestroyFixedOutputHooks();  
801         CtdlDestroySessionHooks();
802         CtdlDestroyServiceHook();
803         CtdlDestroyRoomHooks();
804         CtdlDestroyDirectoryServiceFuncs();
805         #ifdef HAVE_BACKTRACE
806         eCrash_Uninit();
807         #endif
808 }
809
810
811
812 /*
813  * Terminate another session.
814  * (This could justifiably be moved out of sysdep.c because it
815  * no longer does anything that is system-dependent.)
816  */
817 void kill_session(int session_to_kill) {
818         struct CitContext *ptr;
819
820         begin_critical_section(S_SESSION_TABLE);
821         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
822                 if (ptr->cs_pid == session_to_kill) {
823                         ptr->kill_me = 1;
824                 }
825         }
826         end_critical_section(S_SESSION_TABLE);
827 }
828
829 pid_t current_child;
830 void graceful_shutdown(int signum) {
831         kill(current_child, signum);
832         unlink(file_pid_file);
833         exit(0);
834 }
835
836
837 /*
838  * Start running as a daemon.
839  */
840 void start_daemon(int unused) {
841         int status = 0;
842         pid_t child = 0;
843         FILE *fp;
844         int do_restart = 0;
845
846         current_child = 0;
847
848         /* Close stdin/stdout/stderr and replace them with /dev/null.
849          * We don't just call close() because we don't want these fd's
850          * to be reused for other files.
851          */
852         chdir(ctdl_run_dir);
853
854         child = fork();
855         if (child != 0) {
856                 exit(0);
857         }
858         
859         signal(SIGHUP, SIG_IGN);
860         signal(SIGINT, SIG_IGN);
861         signal(SIGQUIT, SIG_IGN);
862
863         setsid();
864         umask(0);
865         freopen("/dev/null", "r", stdin);
866         freopen("/dev/null", "w", stdout);
867         freopen("/dev/null", "w", stderr);
868
869         do {
870                 current_child = fork();
871
872                 signal(SIGTERM, graceful_shutdown);
873         
874                 if (current_child < 0) {
875                         perror("fork");
876                         exit(errno);
877                 }
878         
879                 else if (current_child == 0) {
880                         return; /* continue starting citadel. */
881                 }
882         
883                 else {
884                         fp = fopen(file_pid_file, "w");
885                         if (fp != NULL) {
886                 /*
887                  * NB.. The pid file contains the pid of the actual server.
888                  * This is not the pid of the watcher process
889                  */
890                                 fprintf(fp, ""F_PID_T"\n", current_child);
891                                 fclose(fp);
892                         }
893                         waitpid(current_child, &status, 0);
894                 }
895
896                 do_restart = 0;
897
898                 /* Did the main process exit with an actual exit code? */
899                 if (WIFEXITED(status)) {
900
901                         /* Exit code 0 means the watcher should exit */
902                         if (WEXITSTATUS(status) == 0) {
903                                 do_restart = 0;
904                         }
905
906                         /* Exit code 101-109 means the watcher should exit */
907                         else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
908                                 do_restart = 0;
909                         }
910
911                         /* Any other exit code means we should restart. */
912                         else {
913                                 do_restart = 1;
914                         }
915                 }
916
917                 /* Any other type of termination (signals, etc.) should also restart. */
918                 else {
919                         do_restart = 1;
920                 }
921
922         } while (do_restart);
923
924         unlink(file_pid_file);
925         exit(WEXITSTATUS(status));
926 }
927
928
929
930 /*
931  * Generic routine to convert a login name to a full name (gecos)
932  * Returns nonzero if a conversion took place
933  */
934 int convert_login(char NameToConvert[]) {
935         struct passwd *pw;
936         int a;
937
938         pw = getpwnam(NameToConvert);
939         if (pw == NULL) {
940                 return(0);
941         }
942         else {
943                 strcpy(NameToConvert, pw->pw_gecos);
944                 for (a=0; a<strlen(NameToConvert); ++a) {
945                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
946                 }
947                 return(1);
948         }
949 }
950
951 /*
952  * Purge all sessions which have the 'kill_me' flag set.
953  * This function has code to prevent it from running more than once every
954  * few seconds, because running it after every single unbind would waste a lot
955  * of CPU time and keep the context list locked too much.  To force it to run
956  * anyway, set "force" to nonzero.
957  */
958 void dead_session_purge(int force) {
959         struct CitContext *ptr, *ptr2;          /* general-purpose utility pointer */
960         struct CitContext *rem = NULL;  /* list of sessions to be destroyed */
961         
962         if (force == 0) {
963                 if ( (time(NULL) - last_purge) < 5 ) {
964                         return; /* Too soon, go away */
965                 }
966         }
967         time(&last_purge);
968
969         if (try_critical_section(S_SESSION_TABLE))
970                 return;
971                 
972         ptr = ContextList;
973         while (ptr) {
974                 ptr2 = ptr;
975                 ptr = ptr->next;
976                 
977                 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
978                         /* Remove the session from the active list */
979                         if (ptr2->prev) {
980                                 ptr2->prev->next = ptr2->next;
981                         }
982                         else {
983                                 ContextList = ptr2->next;
984                         }
985                         if (ptr2->next) {
986                                 ptr2->next->prev = ptr2->prev;
987                         }
988
989                         --num_sessions;
990                         /* And put it on our to-be-destroyed list */
991                         ptr2->next = rem;
992                         rem = ptr2;
993                 }
994         }
995         end_critical_section(S_SESSION_TABLE);
996
997         /* Now that we no longer have the session list locked, we can take
998          * our time and destroy any sessions on the to-be-killed list, which
999          * is allocated privately on this thread's stack.
1000          */
1001         while (rem != NULL) {
1002                 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
1003                 RemoveContext(rem);
1004                 ptr = rem;
1005                 rem = rem->next;
1006                 free(ptr);
1007         }
1008 }
1009
1010
1011
1012
1013
1014 /*
1015  * masterCC is the context we use when not attached to a session.  This
1016  * function initializes it.
1017  */
1018 void InitializeMasterCC(void) {
1019         memset(&masterCC, 0, sizeof(struct CitContext));
1020         masterCC.internal_pgm = 1;
1021         masterCC.cs_pid = 0;
1022 }
1023
1024
1025
1026
1027
1028
1029 /*
1030  * Bind a thread to a context.  (It's inline merely to speed things up.)
1031  */
1032 INLINE void become_session(struct CitContext *which_con) {
1033         pthread_setspecific(MyConKey, (void *)which_con );
1034 }
1035
1036
1037
1038 /* 
1039  * This loop just keeps going and going and going...
1040  */
1041 /*
1042  * FIXME:
1043  * This current implimentation of worker_thread creates a bottle neck in several situations
1044  * The first thing to remember is that a single thread can handle more than one connection at a time.
1045  * More threads mean less memory for the system to run in.
1046  * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
1047  * something to happen anywhere.
1048  * This current implimentation requires worker threads to wait in other locations, after it has
1049  * been committed to a single connection which is very wasteful.
1050  * As an extreme case consider this:
1051  * A slow client connects and this slow client sends only one character each second.
1052  * With this current implimentation a single worker thread is dispatched to handle that connection
1053  * until such times as the client timeout expires, an error occurs on the socket or the client
1054  * completes its transmission.
1055  * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
1056  * second interval between chars.
1057  *
1058  * It is my intention to re-write this code and the associated client_getln, client_read functions
1059  * to allow any thread to read data on behalf of any connection (context).
1060  * To do this I intend to have this main loop read chars into a buffer stored in the context.
1061  * Once the correct criteria for a full buffer is met then we will dispatch a thread to 
1062  * process it.
1063  * This worker thread loop also needs to be able to handle binary data.
1064  */
1065  
1066 void *worker_thread(void *arg) {
1067         int i;
1068         int highest;
1069         struct CitContext *ptr;
1070         struct CitContext *bind_me = NULL;
1071         fd_set readfds;
1072         int retval = 0;
1073         struct CitContext *con= NULL;   /* Temporary context pointer */
1074         struct ServiceFunctionHook *serviceptr;
1075         int ssock;                      /* Descriptor for client socket */
1076         struct timeval tv;
1077         int force_purge = 0;
1078         int m;
1079         
1080
1081         while (!CtdlThreadCheckStop()) {
1082
1083                 /* make doubly sure we're not holding any stale db handles
1084                  * which might cause a deadlock.
1085                  */
1086                 cdb_check_handles();
1087 do_select:      force_purge = 0;
1088                 bind_me = NULL;         /* Which session shall we handle? */
1089
1090                 /* Initialize the fdset. */
1091                 FD_ZERO(&readfds);
1092                 highest = 0;
1093
1094                 begin_critical_section(S_SESSION_TABLE);
1095                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1096                         if (ptr->state == CON_IDLE) {
1097                                 FD_SET(ptr->client_socket, &readfds);
1098                                 if (ptr->client_socket > highest)
1099                                         highest = ptr->client_socket;
1100                         }
1101                         if ((bind_me == NULL) && (ptr->state == CON_READY)) {
1102                                 bind_me = ptr;
1103                                 ptr->state = CON_EXECUTING;
1104                         }
1105                 }
1106                 end_critical_section(S_SESSION_TABLE);
1107
1108                 if (bind_me) {
1109                         goto SKIP_SELECT;
1110                 }
1111
1112                 /* If we got this far, it means that there are no sessions
1113                  * which a previous thread marked for attention, so we go
1114                  * ahead and get ready to select().
1115                  */
1116
1117                 /* First, add the various master sockets to the fdset. */
1118                 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1119                 serviceptr = serviceptr->next ) {
1120                         m = serviceptr->msock;
1121                         FD_SET(m, &readfds);
1122                         if (m > highest) {
1123                                 highest = m;
1124                         }
1125                 }
1126
1127                 if (!CtdlThreadCheckStop()) {
1128                         tv.tv_sec = 1;          /* wake up every second if no input */
1129                         tv.tv_usec = 0;
1130                         retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
1131                 }
1132
1133                 if (CtdlThreadCheckStop()) return(NULL);
1134
1135                 /* Now figure out who made this select() unblock.
1136                  * First, check for an error or exit condition.
1137                  */
1138                 if (retval < 0) {
1139                         if (errno == EBADF) {
1140                                 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1141                                         strerror(errno));
1142                                 goto do_select;
1143                         }
1144                         if (errno != EINTR) {
1145                                 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1146                                 CtdlThreadStopAll();
1147                         } else if (!CtdlThreadCheckStop()) {
1148                                 CtdlLogPrintf(CTDL_DEBUG, "Un handled select failure.\n");
1149                                 goto do_select;
1150                         }
1151                 }
1152                 else if(retval == 0) {
1153                         goto SKIP_SELECT;
1154                 }
1155                 /* Next, check to see if it's a new client connecting
1156                  * on a master socket.
1157                  */
1158                 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1159                      serviceptr = serviceptr->next ) {
1160
1161                         if (FD_ISSET(serviceptr->msock, &readfds)) {
1162                                 ssock = accept(serviceptr->msock, NULL, 0);
1163                                 if (ssock >= 0) {
1164                                         CtdlLogPrintf(CTDL_DEBUG,
1165                                                 "New client socket %d\n",
1166                                                 ssock);
1167
1168                                         /* The master socket is non-blocking but the client
1169                                          * sockets need to be blocking, otherwise certain
1170                                          * operations barf on FreeBSD.  Not a fatal error.
1171                                          */
1172                                         if (fcntl(ssock, F_SETFL, 0) < 0) {
1173                                                 CtdlLogPrintf(CTDL_EMERG,
1174                                                         "citserver: Can't set socket to blocking: %s\n",
1175                                                         strerror(errno));
1176                                         }
1177
1178                                         /* New context will be created already
1179                                          * set up in the CON_EXECUTING state.
1180                                          */
1181                                         con = CreateNewContext();
1182
1183                                         /* Assign our new socket number to it. */
1184                                         con->client_socket = ssock;
1185                                         con->h_command_function =
1186                                                 serviceptr->h_command_function;
1187                                         con->h_async_function =
1188                                                 serviceptr->h_async_function;
1189                                         con->ServiceName =
1190                                                 serviceptr->ServiceName;
1191                                         
1192                                         /* Determine whether it's a local socket */
1193                                         if (serviceptr->sockpath != NULL)
1194                                                 con->is_local_socket = 1;
1195         
1196                                         /* Set the SO_REUSEADDR socket option */
1197                                         i = 1;
1198                                         setsockopt(ssock, SOL_SOCKET,
1199                                                 SO_REUSEADDR,
1200                                                 &i, sizeof(i));
1201
1202                                         become_session(con);
1203                                         begin_session(con);
1204                                         serviceptr->h_greeting_function();
1205                                         become_session(NULL);
1206                                         con->state = CON_IDLE;
1207                                         goto do_select;
1208                                 }
1209                         }
1210                 }
1211
1212                 /* It must be a client socket.  Find a context that has data
1213                  * waiting on its socket *and* is in the CON_IDLE state.  Any
1214                  * active sockets other than our chosen one are marked as
1215                  * CON_READY so the next thread that comes around can just bind
1216                  * to one without having to select() again.
1217                  */
1218                 begin_critical_section(S_SESSION_TABLE);
1219                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1220                         if ( (FD_ISSET(ptr->client_socket, &readfds))
1221                            && (ptr->state != CON_EXECUTING) ) {
1222                                 ptr->input_waiting = 1;
1223                                 if (!bind_me) {
1224                                         bind_me = ptr;  /* I choose you! */
1225                                         bind_me->state = CON_EXECUTING;
1226                                 }
1227                                 else {
1228                                         ptr->state = CON_READY;
1229                                 }
1230                         }
1231                 }
1232                 end_critical_section(S_SESSION_TABLE);
1233
1234 SKIP_SELECT:
1235                 /* We're bound to a session */
1236                 if (bind_me != NULL) {
1237                         become_session(bind_me);
1238
1239                         /* If the client has sent a command, execute it. */
1240                         if (CC->input_waiting) {
1241                                 CC->h_command_function();
1242                                 CC->input_waiting = 0;
1243                         }
1244
1245                         /* If there are asynchronous messages waiting and the
1246                          * client supports it, do those now */
1247                         if ((CC->is_async) && (CC->async_waiting)
1248                            && (CC->h_async_function != NULL)) {
1249                                 CC->h_async_function();
1250                                 CC->async_waiting = 0;
1251                         }
1252                         
1253                         force_purge = CC->kill_me;
1254                         become_session(NULL);
1255                         bind_me->state = CON_IDLE;
1256                 }
1257
1258                 dead_session_purge(force_purge);
1259                 do_housekeeping();
1260         }
1261         /* If control reaches this point, the server is shutting down */        
1262         return(NULL);
1263 }
1264
1265
1266
1267
1268 /*
1269  * SyslogFacility()
1270  * Translate text facility name to syslog.h defined value.
1271  */
1272 int SyslogFacility(char *name)
1273 {
1274         int i;
1275         struct
1276         {
1277                 int facility;
1278                 char *name;
1279         }   facTbl[] =
1280         {
1281                 {   LOG_KERN,   "kern"          },
1282                 {   LOG_USER,   "user"          },
1283                 {   LOG_MAIL,   "mail"          },
1284                 {   LOG_DAEMON, "daemon"        },
1285                 {   LOG_AUTH,   "auth"          },
1286                 {   LOG_SYSLOG, "syslog"        },
1287                 {   LOG_LPR,    "lpr"           },
1288                 {   LOG_NEWS,   "news"          },
1289                 {   LOG_UUCP,   "uucp"          },
1290                 {   LOG_LOCAL0, "local0"        },
1291                 {   LOG_LOCAL1, "local1"        },
1292                 {   LOG_LOCAL2, "local2"        },
1293                 {   LOG_LOCAL3, "local3"        },
1294                 {   LOG_LOCAL4, "local4"        },
1295                 {   LOG_LOCAL5, "local5"        },
1296                 {   LOG_LOCAL6, "local6"        },
1297                 {   LOG_LOCAL7, "local7"        },
1298                 {   0,            NULL          }
1299         };
1300         for(i = 0; facTbl[i].name != NULL; i++) {
1301                 if(!strcasecmp(name, facTbl[i].name))
1302                         return facTbl[i].facility;
1303         }
1304         enable_syslog = 0;
1305         return LOG_DAEMON;
1306 }
1307
1308
1309 /********** MEM CHEQQER ***********/
1310
1311 #ifdef DEBUG_MEMORY_LEAKS
1312
1313 #undef malloc
1314 #undef realloc
1315 #undef strdup
1316 #undef free
1317
1318 void *tracked_malloc(size_t size, char *file, int line) {
1319         struct igheap *thisheap;
1320         void *block;
1321
1322         block = malloc(size);
1323         if (block == NULL) return(block);
1324
1325         thisheap = malloc(sizeof(struct igheap));
1326         if (thisheap == NULL) {
1327                 free(block);
1328                 return(NULL);
1329         }
1330
1331         thisheap->block = block;
1332         strcpy(thisheap->file, file);
1333         thisheap->line = line;
1334         
1335         begin_critical_section(S_DEBUGMEMLEAKS);
1336         thisheap->next = igheap;
1337         igheap = thisheap;
1338         end_critical_section(S_DEBUGMEMLEAKS);
1339
1340         return(block);
1341 }
1342
1343
1344 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1345         struct igheap *thisheap;
1346         void *block;
1347
1348         block = realloc(ptr, size);
1349         if (block == NULL) return(block);
1350
1351         thisheap = malloc(sizeof(struct igheap));
1352         if (thisheap == NULL) {
1353                 free(block);
1354                 return(NULL);
1355         }
1356
1357         thisheap->block = block;
1358         strcpy(thisheap->file, file);
1359         thisheap->line = line;
1360         
1361         begin_critical_section(S_DEBUGMEMLEAKS);
1362         thisheap->next = igheap;
1363         igheap = thisheap;
1364         end_critical_section(S_DEBUGMEMLEAKS);
1365
1366         return(block);
1367 }
1368
1369
1370
1371 void tracked_free(void *ptr) {
1372         struct igheap *thisheap;
1373         struct igheap *trash;
1374
1375         free(ptr);
1376
1377         if (igheap == NULL) return;
1378         begin_critical_section(S_DEBUGMEMLEAKS);
1379         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1380                 if (thisheap->next != NULL) {
1381                         if (thisheap->next->block == ptr) {
1382                                 trash = thisheap->next;
1383                                 thisheap->next = thisheap->next->next;
1384                                 free(trash);
1385                         }
1386                 }
1387         }
1388         if (igheap->block == ptr) {
1389                 trash = igheap;
1390                 igheap = igheap->next;
1391                 free(trash);
1392         }
1393         end_critical_section(S_DEBUGMEMLEAKS);
1394 }
1395
1396 char *tracked_strdup(const char *s, char *file, int line) {
1397         char *ptr;
1398
1399         if (s == NULL) return(NULL);
1400         ptr = tracked_malloc(strlen(s) + 1, file, line);
1401         if (ptr == NULL) return(NULL);
1402         strncpy(ptr, s, strlen(s));
1403         return(ptr);
1404 }
1405
1406 void dump_heap(void) {
1407         struct igheap *thisheap;
1408
1409         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1410                 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1411                         thisheap->file, thisheap->line);
1412         }
1413 }
1414
1415 #endif /*  DEBUG_MEMORY_LEAKS */