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