webcit/webserver.c

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