citadel/sysdep.c

   1 /*
   2  * Citadel/UX "system dependent" stuff.
   3  * See copyright.txt for copyright information.
   4  *
   5  * Here's where we (hopefully) have all the parts of the Citadel server that
   6  * would need to be altered to run the server in a non-POSIX environment.
   7  * Wherever possible, we use function wrappers and type definitions to create
   8  * abstractions that are platform-independent from the calling side.
   9  *
  10  * Eventually we'll try porting to a different platform and either have
  11  * multiple variants of this file or simply load it up with #ifdefs.
  12  */
  13
  14
  15 #include <stdlib.h>
  16 #include <unistd.h>
  17 #include <stdio.h>
  18 #include <fcntl.h>
  19 #include <signal.h>
  20 #include <sys/types.h>
  21 #include <sys/wait.h>
  22 #include <sys/socket.h>
  23 #include <sys/time.h>
  24 #include <netinet/in.h>
  25 #include <netdb.h>
  26 #include <string.h>
  27 #include <pwd.h>
  28 #include <errno.h>
  29 #include <stdarg.h>
  30 #include <syslog.h>
  31 #include <pthread.h>
  32 #include "citadel.h"
  33 #include "server.h"
  34 #include "proto.h"
  35
  36 #ifdef NEED_SELECT_H
  37 #include <sys/select.h>
  38 #endif
  39
  40 extern struct CitContext *ContextList;
  41 extern struct config config;
  42 extern char bbs_home_directory[];
  43 extern int home_specified;
  44
  45 pthread_mutex_t Critters[MAX_SEMAPHORES];       /* Things needing locking */
  46 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
  47
  48 int msock;                                      /* master listening socket */
  49 int verbosity = 3;                              /* Logging level */
  50
  51
  52 /*
  53  * lprintf()  ...   Write logging information
  54  */
  55 void lprintf(int loglevel, const char *format, ...) {
  56         va_list arg_ptr;
  57         char buf[256];
  58         int rc;
  59
  60         if (loglevel <= verbosity) {
  61                 va_start(arg_ptr, format);
  62                 rc = vsprintf(buf, format, arg_ptr);
  63                 va_end(arg_ptr);
  64
  65                 fprintf(stderr, "%s", buf);
  66                 fflush(stderr);
  67                 }
  68
  69         }
  70
  71
  72 /*
  73  * Some initialization stuff...
  74  */
  75 void init_sysdep(void) {
  76         int a;
  77
  78         /* Set up a bunch of semaphores to be used for critical sections */
  79         for (a=0; a<MAX_SEMAPHORES; ++a) {
  80                 pthread_mutex_init(&Critters[a], NULL);
  81                 }
  82
  83         /*
  84          * Set up a place to put thread-specific data.
  85          * We only need a single pointer per thread - it points to the
  86          * thread's CitContext structure in the ContextList linked list.
  87          */
  88         if (pthread_key_create(&MyConKey, NULL) != 0) {
  89                 lprintf(1, "Can't create TSD key!!  %s\n", strerror(errno));
  90                 }
  91
  92         /*
  93          * The action for unexpected signals and exceptions should be to
  94          * call master_cleanup() to gracefully shut down the server.
  95          */
  96         signal(SIGINT, master_cleanup);
  97         signal(SIGQUIT, master_cleanup);
  98         signal(SIGHUP, master_cleanup);
  99         signal(SIGTERM, master_cleanup);
 100         }
 101
 102
 103 /*
 104  * Obtain a semaphore lock to begin a critical section.
 105  */
 106 void begin_critical_section(int which_one)
 107 {
 108         int oldval;
 109
 110         lprintf(8, "begin_critical_section(%d)\n", which_one);
 111         if (CC != NULL) hook_crit_get(CC->cs_pid, which_one);
 112
 113         /* Don't get interrupted during the critical section */
 114         pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldval);
 115
 116         /* Obtain a semaphore */
 117         pthread_mutex_lock(&Critters[which_one]);
 118
 119         if (CC != NULL) hook_crit_got(CC->cs_pid, which_one);
 120         }
 121
 122 /*
 123  * Release a semaphore lock to end a critical section.
 124  */
 125 void end_critical_section(int which_one)
 126 {
 127         int oldval;
 128
 129         lprintf(8, "  end_critical_section(%d)\n", which_one);
 130         if (CC != NULL) hook_crit_end(CC->cs_pid, which_one);
 131
 132         /* Let go of the semaphore */
 133         pthread_mutex_unlock(&Critters[which_one]);
 134
 135         /* If a cancel was sent during the critical section, do it now.
 136          * Then re-enable thread cancellation.
 137          */
 138         pthread_testcancel();
 139         pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
 140         pthread_testcancel();
 141
 142         }
 143
 144
 145
 146 /*
 147  * This is a generic function to set up a master socket for listening on
 148  * a TCP port.  The server shuts down if the bind fails.
 149  */
 150 int ig_tcp_server(int port_number, int queue_len)
 151 {
 152         struct sockaddr_in sin;
 153         int s, i;
 154
 155         bzero((char *)&sin, sizeof(sin));
 156         sin.sin_family = AF_INET;
 157         sin.sin_addr.s_addr = INADDR_ANY;
 158
 159         if (port_number == 0) {
 160                 lprintf(1, "citserver: No port number specified.  Run setup again.\n");
 161                 exit(1);
 162                 }
 163
 164         sin.sin_port = htons((u_short)port_number);
 165
 166         s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
 167         if (s < 0) {
 168                 lprintf(1, "citserver: Can't create a socket: %s\n",
 169                         strerror(errno));
 170                 exit(errno);
 171                 }
 172
 173         /* Set the SO_REUSEADDR socket option, because it makes sense. */
 174         i = 1;
 175         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
 176
 177         if (bind(s, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
 178                 lprintf(1, "citserver: Can't bind: %s\n", strerror(errno));
 179                 exit(errno);
 180                 }
 181
 182         if (listen(s, queue_len) < 0) {
 183                 lprintf(1, "citserver: Can't listen: %s\n", strerror(errno));
 184                 exit(errno);
 185                 }
 186
 187         return(s);
 188         }
 189
 190
 191 /*
 192  * Return a pointer to a thread's own CitContext structure (old)
 193  * NOTE: this version of MyContext() is commented out because it is no longer
 194  * in use.  It was written before I discovered TSD keys.  This
 195  * version pounds through the context list until it finds the one matching
 196  * the currently running thread.  It remains here, commented out, in case it
 197  * is needed for future ports to threading libraries which have the equivalent
 198  * of pthread_self() but not pthread_key_create() and its ilk.
 199  *
 200  * struct CitContext *MyContext() {
 201  *      struct CitContext *ptr;
 202  *      THREAD me;
 203  *
 204  *      me = pthread_self();
 205  *      for (ptr=ContextList; ptr!=NULL; ptr=ptr->next) {
 206  *              if (ptr->mythread == me) return(ptr);
 207  *              }
 208  *      return(NULL);
 209  *      }
 210  */
 211
 212 /*
 213  * Return a pointer to a thread's own CitContext structure (new)
 214  */
 215 struct CitContext *MyContext(void) {
 216         return (struct CitContext *) pthread_getspecific(MyConKey);
 217         }
 218
 219
 220 /*
 221  * Wedge our way into the context list.
 222  */
 223 struct CitContext *CreateNewContext(void) {
 224         struct CitContext *me;
 225
 226         lprintf(9, "CreateNewContext: calling malloc()\n");
 227         me = (struct CitContext *) malloc(sizeof(struct CitContext));
 228         if (me == NULL) {
 229                 lprintf(1, "citserver: can't allocate memory!!\n");
 230                 pthread_exit(NULL);
 231                 }
 232
 233         begin_critical_section(S_SESSION_TABLE);
 234         me->next = ContextList;
 235         ContextList = me;
 236         end_critical_section(S_SESSION_TABLE);
 237         return(me);
 238         }
 239
 240 /*
 241  * Add a thread's thread ID to the context
 242  */
 243 void InitMyContext(struct CitContext *con)
 244 {
 245         int oldval;
 246
 247         con->mythread = pthread_self();
 248         pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldval);
 249         pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldval);
 250         if (pthread_setspecific(MyConKey, (void *)con) != 0) {
 251                 lprintf(1, "ERROR!  pthread_setspecific() failed: %s\n",
 252                         strerror(errno));
 253                 }
 254         }
 255
 256 /*
 257  * Remove a context from the context list.
 258  */
 259 void RemoveContext(struct CitContext *con)
 260 {
 261         struct CitContext *ptr;
 262
 263         lprintf(7, "Starting RemoveContext()\n");
 264         lprintf(9, "session count before RemoveContext is %d\n", session_count());
 265         if (con==NULL) {
 266                 lprintf(7, "WARNING: RemoveContext() called with null!\n");
 267                 return;
 268                 }
 269
 270         begin_critical_section(S_SESSION_TABLE);
 271         lprintf(7, "Closing socket %d\n", con->client_socket);
 272         close(con->client_socket);
 273
 274         if (ContextList==con) {
 275                 ContextList = ContextList->next;
 276                 }
 277         else {
 278                 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 279                         if (ptr->next == con) {
 280                                 ptr->next = ptr->next->next;
 281                                 }
 282                         }
 283                 }
 284
 285         free(con);
 286
 287         lprintf(9, "session count after RemoveContext is %d\n", session_count());
 288
 289         lprintf(7, "Done with RemoveContext\n");
 290         end_critical_section(S_SESSION_TABLE);
 291         }
 292
 293
 294 /*
 295  * Return the number of sessions currently running.
 296  * (This should probably be moved out of sysdep.c)
 297  */
 298 int session_count(void) {
 299         struct CitContext *ptr;
 300         int TheCount = 0;
 301
 302         lprintf(9, "session_count() starting\n");
 303         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 304                 ++TheCount;
 305                 lprintf(9, "Counted session %3d (%d)\n", ptr->cs_pid, TheCount);
 306                 }
 307
 308         lprintf(9, "session_count() finishing\n");
 309         return(TheCount);
 310         }
 311
 312
 313 /*
 314  * client_write()   ...    Send binary data to the client.
 315  */
 316 void client_write(char *buf, int nbytes)
 317 {
 318         int bytes_written = 0;
 319         int retval;
 320         while (bytes_written < nbytes) {
 321                 retval = write(CC->client_socket, &buf[bytes_written],
 322                         nbytes - bytes_written);
 323                 if (retval < 1) {
 324                         lprintf(2, "client_write() failed: %s\n",
 325                                 strerror(errno));
 326                         cleanup(errno);
 327                         }
 328                 bytes_written = bytes_written + retval;
 329                 }
 330         }
 331
 332
 333 /*
 334  * cprintf()  ...   Send formatted printable data to the client.   It is
 335  *                  implemented in terms of client_write() but remains in
 336  *                  sysdep.c in case we port to somewhere without va_args...
 337  */
 338 void cprintf(const char *format, ...) {
 339         va_list arg_ptr;
 340         char buf[256];
 341         int rc;
 342
 343         va_start(arg_ptr, format);
 344         rc = vsprintf(buf, format, arg_ptr);
 345         va_end(arg_ptr);
 346
 347         client_write(buf, strlen(buf));
 348         }
 349
 350
 351 /*
 352  * Read data from the client socket.
 353  * Return values are:
 354  *      1       Requested number of bytes has been read.
 355  *      0       Request timed out.
 356  * If the socket breaks, the session is immediately terminated.
 357  */
 358 int client_read_to(char *buf, int bytes, int timeout)
 359 {
 360         int len,rlen;
 361         fd_set rfds;
 362         struct timeval tv;
 363         int retval;
 364
 365         len = 0;
 366         while(len<bytes) {
 367                 FD_ZERO(&rfds);
 368                 FD_SET(CC->client_socket, &rfds);
 369                 tv.tv_sec = timeout;
 370                 tv.tv_usec = 0;
 371
 372                 retval = select( (CC->client_socket)+1,
 373                                         &rfds, NULL, NULL, &tv);
 374                 if (FD_ISSET(CC->client_socket, &rfds) == 0) {
 375                         return(0);
 376                         }
 377
 378                 rlen = read(CC->client_socket, &buf[len], bytes-len);
 379                 if (rlen<1) {
 380                         lprintf(2, "client_read() failed: %s\n",
 381                                 strerror(errno));
 382                         cleanup(errno);
 383                         }
 384                 len = len + rlen;
 385                 }
 386         return(1);
 387         }
 388
 389 /*
 390  * Read data from the client socket with default timeout.
 391  * (This is implemented in terms of client_read_to() and could be
 392  * justifiably moved out of sysdep.c)
 393  */
 394 int client_read(char *buf, int bytes)
 395 {
 396         return(client_read_to(buf, bytes, config.c_sleeping));
 397         }
 398
 399
 400 /*
 401  * client_gets()   ...   Get a LF-terminated line of text from the client.
 402  * (This is implemented in terms of client_read() and could be
 403  * justifiably moved out of sysdep.c)
 404  */
 405 int client_gets(char *buf)
 406 {
 407         int retval = 0;
 408
 409         /* Clear the buffer, and read one character at a time.
 410          */
 411         buf[0] = 0;
 412         do {
 413                 if (strlen(buf)<255) {
 414                         buf[strlen(buf) + 1] = 0;
 415                         retval = client_read(&buf[strlen(buf)], 1);
 416                         }
 417                 } while ( (buf[strlen(buf)-1] != 10) && (retval==1) );
 418
 419         /* Strip the trailing newline.
 420          */
 421         if (strlen(buf) > 0) buf[strlen(buf)-1] = 0;
 422         return(retval);
 423         }
 424
 425
 426
 427 /*
 428  * The system-dependent part of master_cleanup() - close the master socket.
 429  */
 430 void sysdep_master_cleanup(void) {
 431         lprintf(3, "Closing master socket %d\n", msock);
 432         close(msock);
 433         lprintf(7, "Closing databases\n");
 434         close_databases();
 435         }
 436
 437 /*
 438  * Cleanup routine to be called when one thread is shutting down.
 439  */
 440 void cleanup(int exit_code)
 441 {
 442         /* Terminate the thread.
 443          * Its cleanup handler will call cleanup_stuff()
 444          */
 445         lprintf(7, "Calling pthread_exit()\n");
 446         pthread_exit(NULL);
 447         }
 448
 449 /*
 450  * Terminate another session.
 451  */
 452 void kill_session(int session_to_kill) {
 453         struct CitContext *ptr;
 454
 455         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 456                 if (ptr->cs_pid == session_to_kill) {
 457                         pthread_cancel(ptr->mythread);
 458                         }
 459                 }
 460         }
 461
 462
 463 /*
 464  * The system-dependent wrapper around the main context loop.
 465  */
 466 void sd_context_loop(struct CitContext *con) {
 467         pthread_cleanup_push(*cleanup_stuff, NULL);
 468         context_loop(con);
 469         pthread_cleanup_pop(0);
 470         }
 471
 472
 473 /*
 474  * Start running as a daemon.  Only close stdio if do_close_stdio is set.
 475  */
 476 void start_daemon(int do_close_stdio) {
 477         if (do_close_stdio) {
 478                 /* close(0); */
 479                 close(1);
 480                 close(2);
 481                 }
 482         signal(SIGHUP,SIG_IGN);
 483         signal(SIGINT,SIG_IGN);
 484         signal(SIGQUIT,SIG_IGN);
 485         if (fork()!=0) exit(0);
 486         }
 487
 488
 489
 490 /*
 491  * Tie in to the 'netsetup' program.
 492  *
 493  * (We're going to hope that netsetup never feeds more than 4096 bytes back.)
 494  */
 495 void cmd_nset(char *cmdbuf)
 496 {
 497         int retcode;
 498         char fbuf[4096];
 499         FILE *netsetup;
 500         int ch;
 501         int a, b;
 502         char netsetup_args[3][256];
 503
 504         if (CC->usersupp.axlevel < 6) {
 505                 cprintf("%d Higher access required.\n",
 506                         ERROR + HIGHER_ACCESS_REQUIRED);
 507                 return;
 508                 }
 509
 510         for (a=1; a<=3; ++a) {
 511                 if (num_parms(cmdbuf) >= a) {
 512                         extract(netsetup_args[a-1], cmdbuf, a-1);
 513                         for (b=0; b<strlen(netsetup_args[a-1]); ++b) {
 514                                 if (netsetup_args[a-1][b] == 34) {
 515                                         netsetup_args[a-1][b] = '_';
 516                                         }
 517                                 }
 518                         }
 519                 else {
 520                         netsetup_args[a-1][0] = 0;
 521                         }
 522                 }
 523
 524         sprintf(fbuf, "./netsetup \"%s\" \"%s\" \"%s\" </dev/null 2>&1",
 525                 netsetup_args[0], netsetup_args[1], netsetup_args[2]);
 526         netsetup = popen(fbuf, "r");
 527         if (netsetup == NULL) {
 528                 cprintf("%d %s\n", ERROR, strerror(errno));
 529                 return;
 530                 }
 531
 532         fbuf[0] = 0;
 533         while (ch = getc(netsetup), (ch > 0)) {
 534                 fbuf[strlen(fbuf)+1] = 0;
 535                 fbuf[strlen(fbuf)] = ch;
 536                 }
 537
 538         retcode = pclose(netsetup);
 539
 540         if (retcode != 0) {
 541                 for (a=0; a<strlen(fbuf); ++a) {
 542                         if (fbuf[a] < 32) fbuf[a] = 32;
 543                         }
 544                 fbuf[245] = 0;
 545                 cprintf("%d %s\n", ERROR, fbuf);
 546                 return;
 547                 }
 548
 549         cprintf("%d Command succeeded.  Output follows:\n", LISTING_FOLLOWS);
 550         cprintf("%s", fbuf);
 551         if (fbuf[strlen(fbuf)-1] != 10) cprintf("\n");
 552         cprintf("000\n");
 553         }
 554
 555
 556
 557 /*
 558  * Generic routine to convert a login name to a full name (gecos)
 559  * Returns nonzero if a conversion took place
 560  */
 561 int convert_login(char NameToConvert[]) {
 562         struct passwd *pw;
 563         int a;
 564
 565         pw = getpwnam(NameToConvert);
 566         if (pw == NULL) {
 567                 return(0);
 568                 }
 569         else {
 570                 strcpy(NameToConvert, pw->pw_gecos);
 571                 for (a=0; a<strlen(NameToConvert); ++a) {
 572                         if (NameToConvert[a] == ',') NameToConvert[a] = 0;
 573                         }
 574                 return(1);
 575                 }
 576         }
 577
 578
 579
 580
 581
 582
 583 /*
 584  * Here's where it all begins.
 585  */
 586 int main(int argc, char **argv)
 587 {
 588         struct sockaddr_in fsin;        /* Data for master socket */
 589         int alen;                       /* Data for master socket */
 590         int ssock;                      /* Descriptor for master socket */
 591         THREAD SessThread;              /* Thread descriptor */
 592         pthread_attr_t attr;            /* Thread attributes */
 593         struct CitContext *con;         /* Temporary context pointer */
 594         char tracefile[128];            /* Name of file to log traces to */
 595         int a, i;                       /* General-purpose variables */
 596         char convbuf[128];
 597
 598         /* specify default port name and trace file */
 599         strcpy(tracefile, "");
 600
 601         /* parse command-line arguments */
 602         for (a=1; a<argc; ++a) {
 603
 604                 /* -t specifies where to log trace messages to */
 605                 if (!strncmp(argv[a], "-t", 2)) {
 606                         strcpy(tracefile, argv[a]);
 607                         strcpy(tracefile, &tracefile[2]);
 608                         freopen(tracefile, "r", stdin);
 609                         freopen(tracefile, "w", stdout);
 610                         freopen(tracefile, "w", stderr);
 611                         }
 612
 613                 /* run in the background if -d was specified */
 614                 else if (!strcmp(argv[a], "-d")) {
 615                         start_daemon( (strlen(tracefile) > 0) ? 0 : 1 ) ;
 616                         }
 617
 618                 /* -x specifies the desired logging level */
 619                 else if (!strncmp(argv[a], "-x", 2)) {
 620                         strcpy(convbuf, argv[a]);
 621                         verbosity = atoi(&convbuf[2]);
 622                         }
 623
 624                 else if (!strncmp(argv[a], "-h", 2)) {
 625                         strcpy(convbuf, argv[a]);
 626                         strcpy(bbs_home_directory, &convbuf[2]);
 627                         home_specified = 1;
 628                         }
 629
 630                 /* any other parameter makes it crash and burn */
 631                 else {
 632                         lprintf(1, "citserver: usage: ");
 633                         lprintf(1, "citserver [-tTraceFile]");
 634                         lprintf(1, " [-d] [-xLogLevel] [-hHomeDir]\n");
 635                         exit(1);
 636                         }
 637
 638                 }
 639
 640         /* Tell 'em who's in da house */
 641         lprintf(1, "Multithreaded message server for %s\n", CITADEL);
 642         lprintf(1, "Copyright (C) 1987-1998 by Art Cancro.  ");
 643         lprintf(1, "All rights reserved.\n\n");
 644
 645         /* Initialize... */
 646         init_sysdep();
 647         openlog("citserver",LOG_PID,LOG_USER);
 648
 649         /* Load site-specific parameters */
 650         lprintf(7, "Loading citadel.config\n");
 651         get_config();
 652         hook_init();
 653
 654         /* Databases must be opened *after* config is loaded, otherwise we might
 655          * end up working in the wrong directory.
 656          */
 657         lprintf(7, "Opening databases\n");
 658         open_databases();
 659
 660         /*
 661          * Bind the server to our favourite port.
 662          * There is no need to check for errors, because ig_tcp_server()
 663          * exits if it doesn't succeed.
 664          */
 665         lprintf(7, "Attempting to bind to port %d...\n", config.c_port_number);
 666         msock = ig_tcp_server(config.c_port_number, 5);
 667         lprintf(7, "Listening on socket %d\n", msock);
 668
 669         /*
 670          * Now that we've bound the socket, change to the BBS user id
 671         lprintf(7, "Changing uid to %d\n", BBSUID);
 672         if (setuid(BBSUID) != 0) {
 673                 lprintf(3, "setuid() failed: %s", strerror(errno));
 674                 }
 675          */
 676
 677         /*
 678          * Endless loop.  Listen on the master socket.  When a connection
 679          * comes in, create a socket, a context, and a thread.
 680          */
 681         while (1) {
 682                 ssock = accept(msock, (struct sockaddr *)&fsin, &alen);
 683                 if (ssock < 0) {
 684                         lprintf(2, "citserver: accept() failed: %s\n",
 685                                 strerror(errno));
 686                         }
 687                 else {
 688                         lprintf(7, "citserver: Client socket %d\n", ssock);
 689                         lprintf(9, "creating context\n");
 690                         con = CreateNewContext();
 691                         con->client_socket = ssock;
 692
 693                         /* Set the SO_REUSEADDR socket option */
 694                         lprintf(9, "setting socket options\n");
 695                         i = 1;
 696                         setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
 697                                 &i, sizeof(i));
 698
 699                         /* set attributes for the new thread */
 700                         lprintf(9, "setting thread attributes\n");
 701                         pthread_attr_init(&attr);
 702                         pthread_attr_setdetachstate(&attr,
 703                                 PTHREAD_CREATE_DETACHED);
 704
 705                         /* now create the thread */
 706                         lprintf(9, "creating thread\n");
 707                         if (pthread_create(&SessThread, &attr, (void *)sd_context_loop,
 708                            con) != 0) {
 709                                 lprintf(1,
 710                                         "citserver: can't create thread: %s\n",
 711                                         strerror(errno));
 712                                 }
 713
 714                         /* detach the thread
 715                          * (defunct -- now done at thread creation time)
 716                          * if (pthread_detach(&SessThread) != 0) {
 717                          *      lprintf(1,
 718                          *              "citserver: can't detach thread: %s\n",
 719                          *              strerror(errno));
 720                          *      }
 721                          */
 722                         lprintf(9, "done!\n");
 723                         }
 724                 }
 725         }
 726