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
 440
 441 /*
 442  * client_write()   ...    Send binary data to the client.
 443  */
 444 int client_write(const char *buf, int nbytes)
 445 {
 446         int bytes_written = 0;
 447         int retval;
 448 #ifndef HAVE_TCP_BUFFERING
 449         int old_buffer_len = 0;
 450 #endif
 451         fd_set wset;
 452         CitContext *Ctx;
 453         int fdflags;
 454
 455         Ctx = CC;
 456         if (Ctx->redirect_buffer != NULL) {
 457                 if ((Ctx->redirect_len + nbytes + 2) >= Ctx->redirect_alloc) {
 458                         Ctx->redirect_alloc = (Ctx->redirect_alloc * 2) + nbytes;
 459                         Ctx->redirect_buffer = realloc(Ctx->redirect_buffer,
 460                                                 Ctx->redirect_alloc);
 461                 }
 462                 memcpy(&Ctx->redirect_buffer[Ctx->redirect_len], buf, nbytes);
 463                 Ctx->redirect_len += nbytes;
 464                 Ctx->redirect_buffer[Ctx->redirect_len] = 0;
 465                 return 0;
 466         }
 467
 468 #ifdef HAVE_OPENSSL
 469         if (Ctx->redirect_ssl) {
 470                 client_write_ssl(buf, nbytes);
 471                 return 0;
 472         }
 473 #endif
 474
 475         fdflags = fcntl(Ctx->client_socket, F_GETFL);
 476
 477         while (bytes_written < nbytes) {
 478                 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
 479                         FD_ZERO(&wset);
 480                         FD_SET(Ctx->client_socket, &wset);
 481                         if (select(1, NULL, &wset, NULL, NULL) == -1) {
 482                                 if (errno == EINTR)
 483                                 {
 484                                         CtdlLogPrintf(CTDL_DEBUG, "client_write(%d bytes) select() interrupted.\n", nbytes-bytes_written);
 485                                         if (CtdlThreadCheckStop()) {
 486                                                 CC->kill_me = 1;
 487                                                 return (-1);
 488                                         } else {
 489                                                 /* can't trust fd's and stuff so we need to re-create them */
 490                                                 continue;
 491                                         }
 492                                 } else {
 493                                         CtdlLogPrintf(CTDL_ERR,
 494                                                 "client_write(%d bytes) select failed: %s (%d)\n",
 495                                                 nbytes - bytes_written,
 496                                                 strerror(errno), errno);
 497                                         cit_backtrace();
 498                                         Ctx->kill_me = 1;
 499                                         return -1;
 500                                 }
 501                         }
 502                 }
 503
 504                 retval = write(Ctx->client_socket, &buf[bytes_written],
 505                         nbytes - bytes_written);
 506                 if (retval < 1) {
 507                         CtdlLogPrintf(CTDL_ERR,
 508                                 "client_write(%d bytes) failed: %s (%d)\n",
 509                                 nbytes - bytes_written,
 510                                 strerror(errno), errno);
 511                         cit_backtrace();
 512                         // CtdlLogPrintf(CTDL_DEBUG, "Tried to send: %s",  &buf[bytes_written]);
 513                         Ctx->kill_me = 1;
 514                         return -1;
 515                 }
 516                 bytes_written = bytes_written + retval;
 517         }
 518         return 0;
 519 }
 520
 521 void cputbuf(const StrBuf *Buf) {
 522         client_write(ChrPtr(Buf), StrLength(Buf));
 523 }
 524
 525
 526 /*
 527  * cprintf()    Send formatted printable data to the client.
 528  *              Implemented in terms of client_write() so it's technically not sysdep...
 529  */
 530 void cprintf(const char *format, ...) {
 531         va_list arg_ptr;
 532         char buf[1024];
 533
 534         va_start(arg_ptr, format);
 535         if (vsnprintf(buf, sizeof buf, format, arg_ptr) == -1)
 536                 buf[sizeof buf - 2] = '\n';
 537         client_write(buf, strlen(buf));
 538         va_end(arg_ptr);
 539 }
 540
 541
 542 /*
 543  * Read data from the client socket.
 544  * Return values are:
 545  *      1       Requested number of bytes has been read.
 546  *      0       Request timed out.
 547  *      -1      The socket is broken.
 548  * If the socket breaks, the session will be terminated.
 549  */
 550 int client_read_to(char *buf, int bytes, int timeout)
 551 {
 552         int len,rlen;
 553         fd_set rfds;
 554         int fd;
 555         struct timeval tv;
 556         int retval;
 557
 558 #ifdef HAVE_OPENSSL
 559         if (CC->redirect_ssl) {
 560                 return (client_read_ssl(buf, bytes, timeout));
 561         }
 562 #endif
 563         len = 0;
 564         fd = CC->client_socket;
 565         while(len<bytes) {
 566                 FD_ZERO(&rfds);
 567                 FD_SET(fd, &rfds);
 568                 tv.tv_sec = timeout;
 569                 tv.tv_usec = 0;
 570
 571                 retval = select( (fd)+1,
 572                                  &rfds, NULL, NULL, &tv);
 573                 if (retval < 0)
 574                 {
 575                         if (errno == EINTR)
 576                         {
 577                                 CtdlLogPrintf(CTDL_DEBUG, "Interrupted select() in client_read_to().\n");
 578                                 if (CtdlThreadCheckStop()) {
 579                                         CC->kill_me = 1;
 580                                         return (-1);
 581                                 } else {
 582                                         /* can't trust fd's and stuff so we need to re-create them */
 583                                         continue;
 584                                 }
 585                         }
 586                         else {
 587                                 CtdlLogPrintf(CTDL_DEBUG, "Failed select() in client_read_to().\n");
 588                                 CC->kill_me = 1;
 589                                 return (-1);
 590                         }
 591                 }
 592
 593                 if (FD_ISSET(fd, &rfds) == 0) {
 594                         return(0);
 595                 }
 596
 597                 rlen = read(fd, &buf[len], bytes-len);
 598                 if (rlen<1) {
 599                         /* The socket has been disconnected! */
 600                         CC->kill_me = 1;
 601                         return(-1);
 602                 }
 603                 len = len + rlen;
 604         }
 605         return(1);
 606 }
 607
 608 /*
 609  * Read data from the client socket with default timeout.
 610  * (This is implemented in terms of client_read_to() and could be
 611  * justifiably moved out of sysdep.c)
 612  */
 613 INLINE int client_read(char *buf, int bytes)
 614 {
 615         return(client_read_to(buf, bytes, config.c_sleeping));
 616 }
 617
 618
 619 /*
 620  * client_getln()   ...   Get a LF-terminated line of text from the client.
 621  * (This is implemented in terms of client_read() and could be
 622  * justifiably moved out of sysdep.c)
 623  */
 624 int client_getln(char *buf, int bufsize)
 625 {
 626         int i, retval;
 627
 628         /* Read one character at a time.
 629          */
 630         for (i = 0;;i++) {
 631                 retval = client_read(&buf[i], 1);
 632                 if (retval != 1 || buf[i] == '\n' || i == (bufsize-1))
 633                         break;
 634         }
 635
 636         /* If we got a long line, discard characters until the newline.
 637          */
 638         if (i == (bufsize-1))
 639                 while (buf[i] != '\n' && retval == 1)
 640                         retval = client_read(&buf[i], 1);
 641
 642         /* Strip the trailing LF, and the trailing CR if present.
 643          */
 644         buf[i] = 0;
 645         while ( (i > 0)
 646                 && ( (buf[i - 1]==13)
 647                      || ( buf[i - 1]==10)) ) {
 648                 i--;
 649                 buf[i] = 0;
 650         }
 651         if (retval < 0) safestrncpy(&buf[i], "000", bufsize - i);
 652         return(retval);
 653 }
 654
 655
 656 /*
 657  * Cleanup any contexts that are left lying around
 658  */
 659
 660
 661 void close_masters (void)
 662 {
 663         struct ServiceFunctionHook *serviceptr;
 664
 665         /*
 666          * close all protocol master sockets
 667          */
 668         for (serviceptr = ServiceHookTable; serviceptr != NULL;
 669             serviceptr = serviceptr->next ) {
 670
 671                 if (serviceptr->tcp_port > 0)
 672                 {
 673                         CtdlLogPrintf(CTDL_INFO, "Closing listener on port %d\n",
 674                                 serviceptr->tcp_port);
 675                         serviceptr->tcp_port = 0;
 676                 }
 677
 678                 if (serviceptr->sockpath != NULL)
 679                         CtdlLogPrintf(CTDL_INFO, "Closing listener on '%s'\n",
 680                                 serviceptr->sockpath);
 681
 682                 close(serviceptr->msock);
 683                 /* If it's a Unix domain socket, remove the file. */
 684                 if (serviceptr->sockpath != NULL) {
 685                         unlink(serviceptr->sockpath);
 686                         serviceptr->sockpath = NULL;
 687                 }
 688         }
 689 }
 690
 691
 692 /*
 693  * The system-dependent part of master_cleanup() - close the master socket.
 694  */
 695 void sysdep_master_cleanup(void) {
 696
 697         close_masters();
 698
 699         context_cleanup();
 700
 701 #ifdef HAVE_OPENSSL
 702         destruct_ssl();
 703 #endif
 704         CtdlDestroyProtoHooks();
 705         CtdlDestroyDeleteHooks();
 706         CtdlDestroyXmsgHooks();
 707         CtdlDestroyNetprocHooks();
 708         CtdlDestroyUserHooks();
 709         CtdlDestroyMessageHook();
 710         CtdlDestroyCleanupHooks();
 711         CtdlDestroyFixedOutputHooks();
 712         CtdlDestroySessionHooks();
 713         CtdlDestroyServiceHook();
 714         CtdlDestroyRoomHooks();
 715         #ifdef HAVE_BACKTRACE
 716         eCrash_Uninit();
 717         #endif
 718 }
 719
 720
 721
 722 pid_t current_child;
 723 void graceful_shutdown(int signum) {
 724         kill(current_child, signum);
 725         unlink(file_pid_file);
 726         exit(0);
 727 }
 728
 729 int nFireUps = 0;
 730 int nFireUpsNonRestart = 0;
 731 pid_t ForkedPid = 1;
 732
 733 /*
 734  * Start running as a daemon.
 735  */
 736 void start_daemon(int unused) {
 737         int status = 0;
 738         pid_t child = 0;
 739         FILE *fp;
 740         int do_restart = 0;
 741
 742         current_child = 0;
 743
 744         /* Close stdin/stdout/stderr and replace them with /dev/null.
 745          * We don't just call close() because we don't want these fd's
 746          * to be reused for other files.
 747          */
 748         if (chdir(ctdl_run_dir) != 0)
 749                 CtdlLogPrintf(CTDL_EMERG,
 750                               "unable to change into directory [%s]: %s",
 751                               ctdl_run_dir, strerror(errno));
 752
 753         child = fork();
 754         if (child != 0) {
 755                 exit(0);
 756         }
 757
 758         signal(SIGHUP, SIG_IGN);
 759         signal(SIGINT, SIG_IGN);
 760         signal(SIGQUIT, SIG_IGN);
 761
 762         setsid();
 763         umask(0);
 764         if ((freopen("/dev/null", "r", stdin) != stdin) ||
 765             (freopen("/dev/null", "w", stdout) != stdout) ||
 766             (freopen("/dev/null", "w", stderr) != stderr))
 767                 CtdlLogPrintf(CTDL_EMERG,
 768                               "unable to reopen stdin/out/err %s",
 769                               strerror(errno));
 770
 771
 772         do {
 773                 current_child = fork();
 774
 775                 signal(SIGTERM, graceful_shutdown);
 776
 777                 if (current_child < 0) {
 778                         perror("fork");
 779                         exit(errno);
 780                 }
 781
 782                 else if (current_child == 0) {
 783                         return; /* continue starting citadel. */
 784                 }
 785
 786                 else {
 787                         fp = fopen(file_pid_file, "w");
 788                         if (fp != NULL) {
 789                                 fprintf(fp, ""F_PID_T"\n", getpid());
 790                                 fclose(fp);
 791                         }
 792                         waitpid(current_child, &status, 0);
 793                 }
 794                 do_restart = 0;
 795                 nFireUpsNonRestart = nFireUps;
 796
 797                 /* Exit code 0 means the watcher should exit */
 798                 if (WIFEXITED(status) && (WEXITSTATUS(status) == CTDLEXIT_SHUTDOWN)) {
 799                         do_restart = 0;
 800                 }
 801
 802                 /* Exit code 101-109 means the watcher should exit */
 803                 else if (WIFEXITED(status) && (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109)) {
 804                         do_restart = 0;
 805                 }
 806
 807                 /* Any other exit code, or no exit code, means we should restart. */
 808                 else {
 809                         do_restart = 1;
 810                         nFireUps++;
 811                         ForkedPid = current_child;
 812                 }
 813
 814         } while (do_restart);
 815
 816         unlink(file_pid_file);
 817         exit(WEXITSTATUS(status));
 818 }
 819
 820
 821
 822 void checkcrash(void)
 823 {
 824         if (nFireUpsNonRestart != nFireUps)
 825         {
 826                 StrBuf *CrashMail;
 827
 828                 CrashMail = NewStrBuf();
 829                 CtdlLogPrintf(CTDL_ALERT, "Posting crash message\n");
 830                 StrBufPrintf(CrashMail,
 831                         " \n"
 832                         " The Citadel server process (citserver) terminated unexpectedly."
 833                         "\n \n"
 834                         " This could be the result of a bug in the server program, or some external "
 835                         "factor.\n \n"
 836                         " You can obtain more information about this by enabling core dumps.\n \n"
 837                         " For more information, please see:\n \n"
 838                         " http://citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files"
 839                         "\n \n"
 840 "http://www.4players.de/4players.php/walkthrough/Wii/9298/24733/Die_Chroniken_von_Narnia_Prinz_Kaspian_von_Narnia.html"
 841
 842                         " If you have already done this, the core dump is likely to be found at %score.%d\n"
 843                         ,
 844                         ctdl_run_dir, ForkedPid);
 845                 CtdlAideMessage(ChrPtr(CrashMail), "Citadel server process terminated unexpectedly");
 846                 FreeStrBuf(&CrashMail);
 847         }
 848 }
 849
 850
 851 /*
 852  * Generic routine to convert a login name to a full name (gecos)
 853  * Returns nonzero if a conversion took place
 854  */
 855 int convert_login(char NameToConvert[]) {
 856         struct passwd *pw;
 857         int a;
 858
 859         pw = getpwnam(NameToConvert);
 860         if (pw == NULL) {
 861                 return(0);
 862         }
 863         else {
 864                 strcpy(NameToConvert, pw->pw_gecos);
 865                 for (a=0; a<strlen(NameToConvert); ++a) {
 866                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
 867                 }
 868                 return(1);
 869         }
 870 }
 871
 872
 873
 874 /*
 875  * This loop just keeps going and going and going...
 876  */
 877 /*
 878  * FIXME:
 879  * This current implimentation of worker_thread creates a bottle neck in several situations
 880  * The first thing to remember is that a single thread can handle more than one connection at a time.
 881  * More threads mean less memory for the system to run in.
 882  * So for efficiency we want every thread to be doing something useful or waiting in the main loop for
 883  * something to happen anywhere.
 884  * This current implimentation requires worker threads to wait in other locations, after it has
 885  * been committed to a single connection which is very wasteful.
 886  * As an extreme case consider this:
 887  * A slow client connects and this slow client sends only one character each second.
 888  * With this current implimentation a single worker thread is dispatched to handle that connection
 889  * until such times as the client timeout expires, an error occurs on the socket or the client
 890  * completes its transmission.
 891  * THIS IS VERY BAD since that thread could have handled a read from many more clients in each one
 892  * second interval between chars.
 893  *
 894  * It is my intention to re-write this code and the associated client_getln, client_read functions
 895  * to allow any thread to read data on behalf of any connection (context).
 896  * To do this I intend to have this main loop read chars into a buffer stored in the context.
 897  * Once the correct criteria for a full buffer is met then we will dispatch a thread to
 898  * process it.
 899  * This worker thread loop also needs to be able to handle binary data.
 900  */
 901
 902 void *worker_thread(void *arg) {
 903         int highest;
 904         CitContext *ptr;
 905         CitContext *bind_me = NULL;
 906         fd_set readfds;
 907         int retval = 0;
 908         struct timeval tv;
 909         int force_purge = 0;
 910
 911
 912         while (!CtdlThreadCheckStop()) {
 913
 914                 /* make doubly sure we're not holding any stale db handles
 915                  * which might cause a deadlock.
 916                  */
 917                 cdb_check_handles();
 918 do_select:      force_purge = 0;
 919                 bind_me = NULL;         /* Which session shall we handle? */
 920
 921                 /* Initialize the fdset. */
 922                 FD_ZERO(&readfds);
 923                 highest = 0;
 924
 925                 begin_critical_section(S_SESSION_TABLE);
 926                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 927                         /* Dont select on dead sessions only truly idle ones */
 928                         if ((ptr->state == CON_IDLE)) {
 929                                 FD_SET(ptr->client_socket, &readfds);
 930                                 if (ptr->client_socket > highest)
 931                                         highest = ptr->client_socket;
 932                         }
 933                         if ((bind_me == NULL) && (ptr->state == CON_READY)) {
 934                                 bind_me = ptr;
 935                                 ptr->state = CON_EXECUTING;
 936                                 break;
 937                         }
 938                         if ((bind_me == NULL) && (ptr->state == CON_STARTING)) {
 939                                 bind_me = ptr;
 940                                 break;
 941                         }
 942                 }
 943                 end_critical_section(S_SESSION_TABLE);
 944
 945                 if (bind_me) {
 946                         goto SKIP_SELECT;
 947                 }
 948
 949                 /* If we got this far, it means that there are no sessions
 950                  * which a previous thread marked for attention, so we go
 951                  * ahead and get ready to select().
 952                  */
 953
 954                 if (!CtdlThreadCheckStop()) {
 955                         tv.tv_sec = 1;          /* wake up every second if no input */
 956                         tv.tv_usec = 0;
 957                         retval = CtdlThreadSelect(highest + 1, &readfds, NULL, NULL, &tv);
 958                 }
 959                 else
 960                         return NULL;
 961
 962                 /* Now figure out who made this select() unblock.
 963                  * First, check for an error or exit condition.
 964                  */
 965                 if (retval < 0) {
 966                         if (errno == EBADF) {
 967                                 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
 968                                         strerror(errno));
 969                                 goto do_select;
 970                         }
 971                         if (errno != EINTR) {
 972                                 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
 973                                 CtdlThreadStopAll();
 974                                 continue;
 975                         } else {
 976                                 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
 977                                 if (CtdlThreadCheckStop()) return(NULL);
 978                                 goto do_select;
 979                         }
 980                 }
 981                 else if(retval == 0) {
 982                         if (CtdlThreadCheckStop()) return(NULL);
 983                 }
 984
 985                 /* It must be a client socket.  Find a context that has data
 986                  * waiting on its socket *and* is in the CON_IDLE state.  Any
 987                  * active sockets other than our chosen one are marked as
 988                  * CON_READY so the next thread that comes around can just bind
 989                  * to one without having to select() again.
 990                  */
 991                 begin_critical_section(S_SESSION_TABLE);
 992                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 993                         if ( (FD_ISSET(ptr->client_socket, &readfds))
 994                            && (ptr->state != CON_EXECUTING) ) {
 995                                 ptr->input_waiting = 1;
 996                                 if (!bind_me) {
 997                                         bind_me = ptr;  /* I choose you! */
 998                                         bind_me->state = CON_EXECUTING;
 999                                 }
1000                                 else {
1001                                         ptr->state = CON_READY;
1002                                 }
1003                         }
1004                 }
1005                 end_critical_section(S_SESSION_TABLE);
1006
1007 SKIP_SELECT:
1008                 /* We're bound to a session */
1009                 if (bind_me != NULL) {
1010                         become_session(bind_me);
1011
1012                         if (bind_me->state == CON_STARTING) {
1013                                 bind_me->state = CON_EXECUTING;
1014                                 begin_session(bind_me);
1015                                 bind_me->h_greeting_function();
1016                         }
1017                         /* If the client has sent a command, execute it. */
1018                         if (CC->input_waiting) {
1019                                 CC->h_command_function();
1020                                 CC->input_waiting = 0;
1021                         }
1022
1023                         /* If there are asynchronous messages waiting and the
1024                          * client supports it, do those now */
1025                         if ((CC->is_async) && (CC->async_waiting)
1026                            && (CC->h_async_function != NULL)) {
1027                                 CC->h_async_function();
1028                                 CC->async_waiting = 0;
1029                         }
1030
1031                         force_purge = CC->kill_me;
1032                         become_session(NULL);
1033                         bind_me->state = CON_IDLE;
1034                 }
1035
1036                 dead_session_purge(force_purge);
1037                 do_housekeeping();
1038         }
1039         /* If control reaches this point, the server is shutting down */
1040         return(NULL);
1041 }
1042
1043
1044
1045
1046 /*
1047  * A function to handle selecting on master sockets.
1048  * In other words it handles new connections.
1049  * It is a thread.
1050  */
1051 void *select_on_master (void *arg)
1052 {
1053         struct ServiceFunctionHook *serviceptr;
1054         fd_set master_fds;
1055         int highest;
1056         struct timeval tv;
1057         int ssock;                      /* Descriptor for client socket */
1058         CitContext *con= NULL;  /* Temporary context pointer */
1059         int m;
1060         int i;
1061         int retval;
1062
1063         while (!CtdlThreadCheckStop()) {
1064                 /* Initialize the fdset. */
1065                 FD_ZERO(&master_fds);
1066                 highest = 0;
1067
1068                 /* First, add the various master sockets to the fdset. */
1069                 for (serviceptr = ServiceHookTable; serviceptr != NULL;
1070                 serviceptr = serviceptr->next ) {
1071                         m = serviceptr->msock;
1072                         FD_SET(m, &master_fds);
1073                         if (m > highest) {
1074                                 highest = m;
1075                         }
1076                 }
1077
1078                 if (!CtdlThreadCheckStop()) {
1079                         tv.tv_sec = 60;         /* wake up every second if no input */
1080                         tv.tv_usec = 0;
1081                         retval = CtdlThreadSelect(highest + 1, &master_fds, NULL, NULL, &tv);
1082                 }
1083                 else
1084                         return NULL;
1085
1086                 /* Now figure out who made this select() unblock.
1087                  * First, check for an error or exit condition.
1088                  */
1089                 if (retval < 0) {
1090                         if (errno == EBADF) {
1091                                 CtdlLogPrintf(CTDL_NOTICE, "select() failed: (%s)\n",
1092                                         strerror(errno));
1093                                 continue;
1094                         }
1095                         if (errno != EINTR) {
1096                                 CtdlLogPrintf(CTDL_EMERG, "Exiting (%s)\n", strerror(errno));
1097                                 CtdlThreadStopAll();
1098                         } else {
1099                                 CtdlLogPrintf(CTDL_DEBUG, "Interrupted CtdlThreadSelect.\n");
1100                                 if (CtdlThreadCheckStop()) return(NULL);
1101                                 continue;
1102                         }
1103                 }
1104                 else if(retval == 0) {
1105                         if (CtdlThreadCheckStop()) return(NULL);
1106                         continue;
1107                 }
1108                 /* Next, check to see if it's a new client connecting
1109                  * on a master socket.
1110                  */
1111                 else for (serviceptr = ServiceHookTable; serviceptr != NULL;
1112                      serviceptr = serviceptr->next ) {
1113
1114                         if (FD_ISSET(serviceptr->msock, &master_fds)) {
1115                                 ssock = accept(serviceptr->msock, NULL, 0);
1116                                 if (ssock >= 0) {
1117                                         CtdlLogPrintf(CTDL_DEBUG,
1118                                                 "New client socket %d\n",
1119                                                 ssock);
1120
1121                                         /* The master socket is non-blocking but the client
1122                                          * sockets need to be blocking, otherwise certain
1123                                          * operations barf on FreeBSD.  Not a fatal error.
1124                                          */
1125                                         if (fcntl(ssock, F_SETFL, 0) < 0) {
1126                                                 CtdlLogPrintf(CTDL_EMERG,
1127                                                         "citserver: Can't set socket to blocking: %s\n",
1128                                                         strerror(errno));
1129                                         }
1130
1131                                         /* New context will be created already
1132                                          * set up in the CON_EXECUTING state.
1133                                          */
1134                                         con = CreateNewContext();
1135
1136                                         /* Assign our new socket number to it. */
1137                                         con->client_socket = ssock;
1138                                         con->h_command_function =
1139                                                 serviceptr->h_command_function;
1140                                         con->h_async_function =
1141                                                 serviceptr->h_async_function;
1142                                         con->h_greeting_function = serviceptr->h_greeting_function;
1143                                         con->ServiceName =
1144                                                 serviceptr->ServiceName;
1145
1146                                         /* Determine whether it's a local socket */
1147                                         if (serviceptr->sockpath != NULL)
1148                                                 con->is_local_socket = 1;
1149
1150                                         /* Set the SO_REUSEADDR socket option */
1151                                         i = 1;
1152                                         setsockopt(ssock, SOL_SOCKET,
1153                                                 SO_REUSEADDR,
1154                                                 &i, sizeof(i));
1155
1156                                         con->state = CON_STARTING;
1157
1158                                         retval--;
1159                                         if (retval == 0)
1160                                                 break;
1161                                 }
1162                         }
1163                 }
1164         }
1165         return NULL;
1166 }
1167
1168
1169
1170 /*
1171  * SyslogFacility()
1172  * Translate text facility name to syslog.h defined value.
1173  */
1174 int SyslogFacility(char *name)
1175 {
1176         int i;
1177         struct
1178         {
1179                 int facility;
1180                 char *name;
1181         }   facTbl[] =
1182         {
1183                 {   LOG_KERN,   "kern"          },
1184                 {   LOG_USER,   "user"          },
1185                 {   LOG_MAIL,   "mail"          },
1186                 {   LOG_DAEMON, "daemon"        },
1187                 {   LOG_AUTH,   "auth"          },
1188                 {   LOG_SYSLOG, "syslog"        },
1189                 {   LOG_LPR,    "lpr"           },
1190                 {   LOG_NEWS,   "news"          },
1191                 {   LOG_UUCP,   "uucp"          },
1192                 {   LOG_LOCAL0, "local0"        },
1193                 {   LOG_LOCAL1, "local1"        },
1194                 {   LOG_LOCAL2, "local2"        },
1195                 {   LOG_LOCAL3, "local3"        },
1196                 {   LOG_LOCAL4, "local4"        },
1197                 {   LOG_LOCAL5, "local5"        },
1198                 {   LOG_LOCAL6, "local6"        },
1199                 {   LOG_LOCAL7, "local7"        },
1200                 {   0,            NULL          }
1201         };
1202         for(i = 0; facTbl[i].name != NULL; i++) {
1203                 if(!strcasecmp(name, facTbl[i].name))
1204                         return facTbl[i].facility;
1205         }
1206         enable_syslog = 0;
1207         return LOG_DAEMON;
1208 }
1209
1210
1211 /********** MEM CHEQQER ***********/
1212
1213 #ifdef DEBUG_MEMORY_LEAKS
1214
1215 #undef malloc
1216 #undef realloc
1217 #undef strdup
1218 #undef free
1219
1220 void *tracked_malloc(size_t size, char *file, int line) {
1221         struct igheap *thisheap;
1222         void *block;
1223
1224         block = malloc(size);
1225         if (block == NULL) return(block);
1226
1227         thisheap = malloc(sizeof(struct igheap));
1228         if (thisheap == NULL) {
1229                 free(block);
1230                 return(NULL);
1231         }
1232
1233         thisheap->block = block;
1234         strcpy(thisheap->file, file);
1235         thisheap->line = line;
1236
1237         begin_critical_section(S_DEBUGMEMLEAKS);
1238         thisheap->next = igheap;
1239         igheap = thisheap;
1240         end_critical_section(S_DEBUGMEMLEAKS);
1241
1242         return(block);
1243 }
1244
1245
1246 void *tracked_realloc(void *ptr, size_t size, char *file, int line) {
1247         struct igheap *thisheap;
1248         void *block;
1249
1250         block = realloc(ptr, size);
1251         if (block == NULL) return(block);
1252
1253         thisheap = malloc(sizeof(struct igheap));
1254         if (thisheap == NULL) {
1255                 free(block);
1256                 return(NULL);
1257         }
1258
1259         thisheap->block = block;
1260         strcpy(thisheap->file, file);
1261         thisheap->line = line;
1262
1263         begin_critical_section(S_DEBUGMEMLEAKS);
1264         thisheap->next = igheap;
1265         igheap = thisheap;
1266         end_critical_section(S_DEBUGMEMLEAKS);
1267
1268         return(block);
1269 }
1270
1271
1272
1273 void tracked_free(void *ptr) {
1274         struct igheap *thisheap;
1275         struct igheap *trash;
1276
1277         free(ptr);
1278
1279         if (igheap == NULL) return;
1280         begin_critical_section(S_DEBUGMEMLEAKS);
1281         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1282                 if (thisheap->next != NULL) {
1283                         if (thisheap->next->block == ptr) {
1284                                 trash = thisheap->next;
1285                                 thisheap->next = thisheap->next->next;
1286                                 free(trash);
1287                         }
1288                 }
1289         }
1290         if (igheap->block == ptr) {
1291                 trash = igheap;
1292                 igheap = igheap->next;
1293                 free(trash);
1294         }
1295         end_critical_section(S_DEBUGMEMLEAKS);
1296 }
1297
1298 char *tracked_strdup(const char *s, char *file, int line) {
1299         char *ptr;
1300
1301         if (s == NULL) return(NULL);
1302         ptr = tracked_malloc(strlen(s) + 1, file, line);
1303         if (ptr == NULL) return(NULL);
1304         strncpy(ptr, s, strlen(s));
1305         return(ptr);
1306 }
1307
1308 void dump_heap(void) {
1309         struct igheap *thisheap;
1310
1311         for (thisheap = igheap; thisheap != NULL; thisheap = thisheap->next) {
1312                 CtdlLogPrintf(CTDL_CRIT, "UNFREED: %30s : %d\n",
1313                         thisheap->file, thisheap->line);
1314         }
1315 }
1316
1317 #endif /*  DEBUG_MEMORY_LEAKS */