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