citadel/config.c

   1 /*
   2  * Read and write the citadel.config file
   3  *
   4  * Copyright (c) 1987-2012 by the citadel.org team
   5  *
   6  * This program is open source software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 3.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14
  15 #include "sysdep.h"
  16 #include <stdlib.h>
  17 #include <sys/stat.h>
  18 #include <unistd.h>
  19 #include <stdio.h>
  20 #include <errno.h>
  21 #include <string.h>
  22 #include <limits.h>
  23 #include <sys/utsname.h>
  24 #include <libcitadel.h>
  25 #include "citadel.h"
  26 #include "server.h"
  27 #include "config.h"
  28 #include "ctdl_module.h"
  29
  30 struct config config;
  31
  32 /*
  33  * Put some sane default values into our configuration.  Some will be overridden when we run setup.
  34  */
  35 void brand_new_installation_set_defaults(void) {
  36
  37         struct passwd *pw;
  38         struct utsname my_utsname;
  39         struct hostent *he;
  40
  41         /* Determine our host name, in case we need to use it as a default */
  42         uname(&my_utsname);
  43
  44         /* set some sample/default values in place of blanks... */
  45         extract_token(config.c_nodename, my_utsname.nodename, 0, '.', sizeof config.c_nodename);
  46         if (IsEmptyStr(config.c_fqdn) ) {
  47                 if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
  48                         safestrncpy(config.c_fqdn, he->h_name, sizeof config.c_fqdn);
  49                 }
  50                 else {
  51                         safestrncpy(config.c_fqdn, my_utsname.nodename, sizeof config.c_fqdn);
  52                 }
  53         }
  54
  55         safestrncpy(config.c_humannode, "Citadel Server", sizeof config.c_humannode);
  56         safestrncpy(config.c_phonenum, "US 800 555 1212", sizeof config.c_phonenum);
  57         config.c_initax = 4;
  58         safestrncpy(config.c_moreprompt, "<more>", sizeof config.c_moreprompt);
  59         safestrncpy(config.c_twitroom, "Trashcan", sizeof config.c_twitroom);
  60         safestrncpy(config.c_baseroom, BASEROOM, sizeof config.c_baseroom);
  61         safestrncpy(config.c_aideroom, "Aide", sizeof config.c_aideroom);
  62         config.c_port_number = 504;
  63         config.c_sleeping = 900;
  64         config.c_instant_expunge = 1;
  65
  66         if (config.c_ctdluid == 0) {
  67                 pw = getpwnam("citadel");
  68                 if (pw != NULL) {
  69                         config.c_ctdluid = pw->pw_uid;
  70                 }
  71         }
  72         if (config.c_ctdluid == 0) {
  73                 pw = getpwnam("bbs");
  74                 if (pw != NULL) {
  75                         config.c_ctdluid = pw->pw_uid;
  76                 }
  77         }
  78         if (config.c_ctdluid == 0) {
  79                 pw = getpwnam("guest");
  80                 if (pw != NULL) {
  81                         config.c_ctdluid = pw->pw_uid;
  82                 }
  83         }
  84         if (config.c_createax == 0) {
  85                 config.c_createax = 3;
  86         }
  87
  88         /*
  89          * Default port numbers for various services
  90          */
  91         config.c_smtp_port = 25;
  92         config.c_pop3_port = 110;
  93         config.c_imap_port = 143;
  94         config.c_msa_port = 587;
  95         config.c_smtps_port = 465;
  96         config.c_pop3s_port = 995;
  97         config.c_imaps_port = 993;
  98         config.c_pftcpdict_port = -1 ;
  99         config.c_managesieve_port = 2020;
 100         config.c_xmpp_c2s_port = 5222;
 101         config.c_xmpp_s2s_port = 5269;
 102 }
 103
 104
 105
 106 /*
 107  * get_config() is called during the initialization of Citadel server.
 108  * It verifies the system's integrity and reads citadel.config into memory.
 109  */
 110 void get_config(void) {
 111         FILE *cfp;
 112         int rv;
 113
 114         if (chdir(ctdl_bbsbase_dir) != 0) {
 115                 fprintf(stderr,
 116                         "This program could not be started.\nUnable to change directory to %s\nError: %s\n",
 117                         ctdl_bbsbase_dir,
 118                         strerror(errno)
 119                 );
 120                 exit(CTDLEXIT_HOME);
 121         }
 122
 123         memset(&config, 0, sizeof(struct config));
 124         cfp = fopen(file_citadel_config, "rb");
 125         if (cfp != NULL) {
 126                 rv = fread((char *) &config, sizeof(struct config), 1, cfp);
 127                 if (rv != 1)
 128                 {
 129                         fprintf(stderr,
 130                                 "Warning: The config file %s has unexpected size. \n",
 131                                 file_citadel_config
 132                         );
 133                 }
 134                 fclose(cfp);
 135         }
 136         else {
 137                 brand_new_installation_set_defaults();
 138         }
 139
 140         /* Ensure that we are linked to the correct version of libcitadel */
 141         if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
 142                 fprintf(stderr, "    You are running libcitadel version %d.%02d\n",
 143                         (libcitadel_version_number() / 100), (libcitadel_version_number() % 100));
 144                 fprintf(stderr, "citserver was compiled against version %d.%02d\n",
 145                         (LIBCITADEL_VERSION_NUMBER / 100), (LIBCITADEL_VERSION_NUMBER % 100));
 146                 exit(CTDLEXIT_LIBCITADEL);
 147         }
 148
 149         /* Only allow LDAP auth mode if we actually have LDAP support */
 150 #ifndef HAVE_LDAP
 151         if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
 152                 fprintf(stderr, "Your system is configured for LDAP authentication,\n"
 153                                 "but you are running a server built without OpenLDAP support.\n");
 154                 exit(CTDL_EXIT_UNSUP_AUTH);
 155         }
 156 #endif
 157
 158         /* Default maximum message length is 10 megabytes.  This is site
 159          * configurable.  Also check to make sure the limit has not been
 160          * set below 8192 bytes.
 161          */
 162         if (config.c_maxmsglen <= 0)
 163                 config.c_maxmsglen = 10485760;
 164         if (config.c_maxmsglen < 8192)
 165                 config.c_maxmsglen = 8192;
 166
 167         /* Default lower and upper limits on number of worker threads */
 168
 169         if (config.c_min_workers < 3)           /* no less than 3 */
 170                 config.c_min_workers = 5;
 171
 172         if (config.c_max_workers == 0)                  /* default maximum */
 173                 config.c_max_workers = 256;
 174
 175         if (config.c_max_workers < config.c_min_workers)   /* max >= min */
 176                 config.c_max_workers = config.c_min_workers;
 177
 178         /* Networking more than once every five minutes just isn't sane */
 179         if (config.c_net_freq == 0L)
 180                 config.c_net_freq = 3600L;      /* once per hour default */
 181         if (config.c_net_freq < 300L)
 182                 config.c_net_freq = 300L;
 183
 184         /* Same goes for POP3 */
 185         if (config.c_pop3_fetch == 0L)
 186                 config.c_pop3_fetch = 3600L;    /* once per hour default */
 187         if (config.c_pop3_fetch < 300L)
 188                 config.c_pop3_fetch = 300L;
 189         if (config.c_pop3_fastest == 0L)
 190                 config.c_pop3_fastest = 3600L;  /* once per hour default */
 191         if (config.c_pop3_fastest < 300L)
 192                 config.c_pop3_fastest = 300L;
 193
 194         /* "create new user" only works with native authentication mode */
 195         if (config.c_auth_mode != AUTHMODE_NATIVE) {
 196                 config.c_disable_newu = 1;
 197         }
 198 }
 199
 200
 201 /*
 202  * Occasionally, we will need to write the config file, because some operations
 203  * change site-wide parameters.
 204  */
 205 void put_config(void)
 206 {
 207         FILE *cfp;
 208         int blocks_written = 0;
 209
 210         if ((cfp = fopen(file_citadel_config, "w")) != NULL) {
 211                 blocks_written = fwrite((char *) &config, sizeof(struct config), 1, cfp);
 212                 if (blocks_written == 1) {
 213                         fclose(cfp);
 214                         chown(file_citadel_config, CTDLUID, (-1));
 215                         chmod(file_citadel_config, 0600);
 216                         return;
 217                 }
 218         }
 219         syslog(LOG_EMERG, "%s: %s", file_citadel_config, strerror(errno));
 220 }