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