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