webcit/webserver.c

   1 /*
   2  * Copyright (c) 1996-2021 by the citadel.org team
   3  *
   4  * This program is open source software.  You can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License version 3.
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  * GNU General Public License for more details.
  11  */
  12
  13 #include "webcit.h"
  14 #include "webserver.h"
  15
  16 #include "modules_init.h"
  17
  18 extern int msock;                               /* master listening socket */
  19 extern char static_icon_dir[PATH_MAX];          /* where should we find our mime icons */
  20 int is_https = 0;                               /* Nonzero if I am an HTTPS service */
  21 int follow_xff = 0;                             /* Follow X-Forwarded-For: header? */
  22 int DisableGzip = 0;
  23 char *default_landing_page = NULL;
  24 extern pthread_mutex_t SessionListMutex;
  25
  26 extern void *housekeeping_loop(void);
  27 extern int webcit_tcp_server(char *ip_addr, int port_number, int queue_len);
  28 extern int webcit_uds_server(char *sockpath, int queue_len);
  29 extern void graceful_shutdown_watcher(int signum);
  30 extern void graceful_shutdown(int signum);
  31 extern void start_daemon(char *pid_file);
  32 extern void webcit_calc_dirs_n_files(int relh, const char *basedir, int home, char *webcitdir, char *relhome);
  33 extern void worker_entry(void);
  34 extern void drop_root(uid_t UID);
  35
  36 char socket_dir[PATH_MAX];      /* where to talk to our citadel server */
  37 char *server_cookie = NULL;     /* our Cookie connection to the client */
  38 int http_port = PORT_NUM;       /* Port to listen on */
  39 char *ctdlhost = DEFAULT_HOST;  /* Host name or IP address of Citadel server */
  40 char *ctdlport = DEFAULT_PORT;  /* Port number of Citadel server */
  41 int setup_wizard = 0;           /* should we run the setup wizard? */
  42 char wizard_filename[PATH_MAX]; /* location of file containing the last webcit version against which we ran setup wizard */
  43 int running_as_daemon = 0;      /* should we deamonize on startup? */
  44
  45 /* #define DBG_PRINNT_HOOKS_AT_START */
  46 #ifdef DBG_PRINNT_HOOKS_AT_START
  47 extern HashList *HandlerHash;
  48 const char foobuf[32];
  49 const char *nix(void *vptr) {snprintf(foobuf, 32, "%0x", (long) vptr); return foobuf;}
  50 #endif
  51 extern int verbose;
  52 extern int dbg_analyze_msg;
  53 extern int dbg_backtrace_template_errors;
  54 extern int DumpTemplateI18NStrings;
  55 extern StrBuf *I18nDump;
  56 void InitTemplateCache(void);
  57 extern int LoadTemplates;
  58
  59 void LoadMimeBlacklist(void);
  60
  61 /*
  62  * Here's where it all begins.
  63  */
  64 int main(int argc, char **argv)
  65 {
  66         uid_t UID = -1;
  67         pthread_t SessThread;           /* Thread descriptor */
  68         pthread_attr_t attr;            /* Thread attributes */
  69         int a;                          /* General-purpose variable */
  70         char ip_addr[256]="*";
  71         int relh=0;
  72         int home=0;
  73         char relhome[PATH_MAX]="";
  74         char webcitdir[PATH_MAX] = DATADIR;
  75         char *pidfile = NULL;
  76         char *hdir;
  77         const char *basedir = NULL;
  78         char uds_listen_path[PATH_MAX]; /* listen on a unix domain socket? */
  79         const char *I18nDumpFile = NULL;
  80         int max_log_level = LOG_INFO;
  81
  82         WildFireInitBacktrace(argv[0], 2);
  83
  84         start_modules();
  85
  86 #ifdef DBG_PRINNT_HOOKS_AT_START
  87 /*      dbg_PrintHash(HandlerHash, nix, NULL);*/
  88 #endif
  89
  90         /* Ensure that we are linked to the correct version of libcitadel */
  91         if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
  92                 fprintf(stderr, " You are running libcitadel version %d\n", libcitadel_version_number() );
  93                 fprintf(stderr, "WebCit was compiled against version %d\n", LIBCITADEL_VERSION_NUMBER );
  94                 return(1);
  95         }
  96
  97         strcpy(uds_listen_path, "");
  98
  99         /* Parse command line */
 100 #ifdef HAVE_OPENSSL
 101         while ((a = getopt(argc, argv, "u:h:i:p:t:T:B:x:g:dD:G:cfsS:Z:v:")) != EOF)
 102 #else
 103         while ((a = getopt(argc, argv, "u:h:i:p:t:T:B:x:g:dD:G:cfZ:v:")) != EOF)
 104 #endif
 105                 switch (a) {
 106                 case 'u':
 107                         UID = atol(optarg);
 108                         break;
 109                 case 'h':
 110                         hdir = strdup(optarg);
 111                         relh=hdir[0]!='/';
 112                         if (!relh) {
 113                                 safestrncpy(webcitdir, hdir, sizeof webcitdir);
 114                         }
 115                         else {
 116                                 safestrncpy(relhome, relhome, sizeof relhome);
 117                         }
 118                         /* free(hdir); TODO: SHOULD WE DO THIS? */
 119                         home=1;
 120                         break;
 121                 case 'd':
 122                         running_as_daemon = 1;
 123                         break;
 124                 case 'D':
 125                         pidfile = strdup(optarg);
 126                         running_as_daemon = 1;
 127                         break;
 128                 case 'g':
 129                         default_landing_page = strdup(optarg);
 130                         break;
 131                 case 'B': /* deprecated */
 132                         break;
 133                 case 'i':
 134                         safestrncpy(ip_addr, optarg, sizeof ip_addr);
 135                         break;
 136                 case 'p':
 137                         http_port = atoi(optarg);
 138                         if (http_port == 0) {
 139                                 safestrncpy(uds_listen_path, optarg, sizeof uds_listen_path);
 140                         }
 141                         break;
 142                 case 't':
 143                         /* no longer used, but ignored so old scripts don't break */
 144                         break;
 145                 case 'T':
 146                         LoadTemplates = atoi(optarg);
 147                         dbg_analyze_msg = (LoadTemplates & (1<<1)) != 0;
 148                         dbg_backtrace_template_errors = (LoadTemplates & (1<<2)) != 0;
 149                         break;
 150                 case 'Z':
 151                         DisableGzip = 1;
 152                         break;
 153                 case 'x':
 154                         max_log_level = atoi(optarg);
 155                         break;
 156                 case 'f':
 157                         follow_xff = 1;
 158                         break;
 159                 case 'c':
 160                         server_cookie = malloc(256);
 161                         if (server_cookie != NULL) {
 162                                 safestrncpy(server_cookie,
 163                                        "Set-cookie: wcserver=",
 164                                         256);
 165                                 if (gethostname
 166                                     (&server_cookie[strlen(server_cookie)],
 167                                      200) != 0) {
 168                                         syslog(LOG_INFO, "gethostname: %s", strerror(errno));
 169                                         free(server_cookie);
 170                                 }
 171                         }
 172                         break;
 173 #ifdef HAVE_OPENSSL
 174                 case 's':
 175                         is_https = 1;
 176                         break;
 177                 case 'S':
 178                         is_https = 1;
 179                         ssl_cipher_list = strdup(optarg);
 180                         break;
 181 #endif
 182                 case 'G':
 183                         DumpTemplateI18NStrings = 1;
 184                         I18nDump = NewStrBufPlain(HKEY("int templatestrings(void)\n{\n"));
 185                         I18nDumpFile = optarg;
 186                         break;
 187                 case 'v':
 188                         verbose=1;
 189                         break;
 190                 default:
 191                         fprintf(stderr, "usage:\nwebcit "
 192                                 "[-i ip_addr] [-p http_port] "
 193                                 "[-c] [-f] "
 194                                 "[-T Templatedebuglevel] "
 195                                 "[-d] [-Z] [-G i18ndumpfile] "
 196                                 "[-u uid] [-h homedirectory] "
 197                                 "[-D daemonizepid] [-v] "
 198                                 "[-g defaultlandingpage] "
 199 #ifdef HAVE_OPENSSL
 200                                 "[-s] [-S cipher_suites]"
 201 #endif
 202                                 "[remotehost [remoteport]]\n");
 203                         return 1;
 204                 }
 205
 206         /* Start the logger */
 207         setlogmask(LOG_UPTO(max_log_level));
 208         openlog("webcit",
 209                 ( running_as_daemon ? (LOG_PID) : (LOG_PID | LOG_PERROR) ),
 210                 LOG_DAEMON
 211         );
 212
 213         if (optind < argc) {
 214                 ctdlhost = argv[optind];
 215                 if (++optind < argc)
 216                         ctdlport = argv[optind];
 217         }
 218
 219         /* daemonize, if we were asked to */
 220         if (!DumpTemplateI18NStrings && running_as_daemon) {
 221                 start_daemon(pidfile);
 222         }
 223         else {
 224                 signal(SIGINT, graceful_shutdown);
 225                 signal(SIGHUP, graceful_shutdown);
 226         }
 227
 228         webcit_calc_dirs_n_files(relh, basedir, home, webcitdir, relhome);
 229         LoadMimeBlacklist();
 230         LoadIconDir(static_icon_dir);
 231
 232         /* Tell 'em who's in da house */
 233         syslog(LOG_NOTICE, "%s", PACKAGE_STRING);
 234         syslog(LOG_NOTICE, "Copyright (C) 1996-2020 by the citadel.org team");
 235         syslog(LOG_NOTICE, " ");
 236         syslog(LOG_NOTICE, "This program is open source software: you can redistribute it and/or");
 237         syslog(LOG_NOTICE, "modify it under the terms of the GNU General Public License, version 3.");
 238         syslog(LOG_NOTICE, " ");
 239         syslog(LOG_NOTICE, "This program is distributed in the hope that it will be useful,");
 240         syslog(LOG_NOTICE, "but WITHOUT ANY WARRANTY; without even the implied warranty of");
 241         syslog(LOG_NOTICE, "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the");
 242         syslog(LOG_NOTICE, "GNU General Public License for more details.");
 243         syslog(LOG_NOTICE, " ");
 244
 245         /* run from the webcit home directory */
 246         if (chdir(webcitdir) != 0) {
 247                 syslog(LOG_ERR, "webcit: %s: %m", webcitdir);
 248                 exit(errno);
 249         }
 250
 251         /* initialize various subsystems */
 252         initialise_modules();
 253         initialise2_modules();
 254         InitTemplateCache();
 255         if (DumpTemplateI18NStrings) {
 256                 FILE *fd;
 257                 StrBufAppendBufPlain(I18nDump, HKEY("}\n"), 0);
 258                 if (StrLength(I18nDump) < 50) {
 259                         syslog(LOG_INFO, "*******************************************************************\n");
 260                         syslog(LOG_INFO, "*   No strings found in templates!  Are you sure they're there?   *\n");
 261                         syslog(LOG_INFO, "*******************************************************************\n");
 262                         return -1;
 263                 }
 264                 fd = fopen(I18nDumpFile, "w");
 265                 if (fd == NULL) {
 266                         syslog(LOG_INFO, "***********************************************\n");
 267                         syslog(LOG_INFO, "*   unable to open I18N dumpfile [%s]         *\n", I18nDumpFile);
 268                         syslog(LOG_INFO, "***********************************************\n");
 269                         return -1;
 270                 }
 271                 fwrite(ChrPtr(I18nDump), 1, StrLength(I18nDump), fd);
 272                 fclose(fd);
 273                 return 0;
 274         }
 275
 276         /* Tell libical to return an error instead of aborting if it sees badly formed iCalendar data. */
 277
 278 #ifdef LIBICAL_ICAL_EXPORT      // cheap and sleazy way to detect libical >=2.0
 279                 icalerror_set_errors_are_fatal(0);
 280 #else
 281                 icalerror_errors_are_fatal = 0;
 282 #endif
 283
 284         /* Use our own prefix on tzid's generated from system tzdata */
 285         icaltimezone_set_tzid_prefix("/citadel.org/");
 286
 287         /*
 288          * Set up a place to put thread-specific data.
 289          * We only need a single pointer per thread - it points to the
 290          * wcsession struct to which the thread is currently bound.
 291          */
 292         if (pthread_key_create(&MyConKey, NULL) != 0) {
 293                 syslog(LOG_ERR, "Can't create TSD key: %s", strerror(errno));
 294         }
 295         InitialiseSemaphores();
 296
 297         /*
 298          * Set up a place to put thread-specific SSL data.
 299          * We don't stick this in the wcsession struct because SSL starts
 300          * up before the session is bound, and it gets torn down between
 301          * transactions.
 302          */
 303 #ifdef HAVE_OPENSSL
 304         if (pthread_key_create(&ThreadSSL, NULL) != 0) {
 305                 syslog(LOG_ERR, "Can't create TSD key: %s", strerror(errno));
 306         }
 307 #endif
 308
 309         /*
 310          * Bind the server to our favorite port.
 311          * There is no need to check for errors, because webcit_tcp_server()
 312          * exits if it doesn't succeed.
 313          */
 314
 315         if (!IsEmptyStr(uds_listen_path)) {
 316                 syslog(LOG_DEBUG, "Attempting to create listener socket at %s...", uds_listen_path);
 317                 msock = webcit_uds_server(uds_listen_path, LISTEN_QUEUE_LENGTH);
 318         }
 319         else {
 320                 syslog(LOG_DEBUG, "Attempting to bind to port %d...", http_port);
 321                 msock = webcit_tcp_server(ip_addr, http_port, LISTEN_QUEUE_LENGTH);
 322         }
 323         if (msock < 0)
 324         {
 325                 ShutDownWebcit();
 326                 return -msock;
 327         }
 328
 329         syslog(LOG_INFO, "Listening on socket %d", msock);
 330         signal(SIGPIPE, SIG_IGN);
 331
 332         pthread_mutex_init(&SessionListMutex, NULL);
 333
 334         /*
 335          * Start up the housekeeping thread
 336          */
 337         pthread_attr_init(&attr);
 338         pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
 339         pthread_create(&SessThread, &attr, (void *(*)(void *)) housekeeping_loop, NULL);
 340
 341         /*
 342          * If this is an HTTPS server, fire up SSL
 343          */
 344 #ifdef HAVE_OPENSSL
 345         if (is_https) {
 346                 init_ssl();
 347         }
 348 #endif
 349         drop_root(UID);
 350
 351         /* Become a worker thread.  More worker threads will be spawned as they are needed. */
 352         worker_entry();
 353         ShutDownLibCitadel();
 354         return 0;
 355 }
 356
 357
 358
 359
 360
 361
 362