citadel/sysdep.c

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