citadel/config.c

   1 /*
   2  * Read and write the citadel.config file
   3  *
   4  * Copyright (c) 1987-2015 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 <stdio.h>
  17 #include <sys/utsname.h>
  18 #include <libcitadel.h>
  19 #include "config.h"
  20 #include "ctdl_module.h"
  21
  22 struct config config;           // legacy configuration
  23 HashList *ctdlconfig = NULL;    // new configuration
  24
  25 #define STR_NOT_EMPTY(CFG_FIELDNAME) if (IsEmptyStr(config.CFG_FIELDNAME)) \
  26                 syslog(LOG_EMERG, "configuration setting "#CFG_FIELDNAME" is empty, but must not - check your config!");
  27
  28 #define TEST_PORT(CFG_PORT, DEFAULTPORT)                        \
  29         if ((config.CFG_PORT < -1) ||           \
  30             (config.CFG_PORT == 0) ||           \
  31             (config.CFG_PORT > UINT16_MAX))     \
  32                 syslog(LOG_EMERG, "configuration setting "#CFG_PORT" is not -1 (disabled) or a valid TCP-Port - check your config! Default setting is: "#DEFAULTPORT);
  33
  34
  35 void validate_config(void) {
  36 /* these shouldn't be empty: */
  37         STR_NOT_EMPTY(c_fqdn);
  38
  39         STR_NOT_EMPTY(c_baseroom);
  40         STR_NOT_EMPTY(c_aideroom);
  41         STR_NOT_EMPTY(c_twitroom);
  42         STR_NOT_EMPTY(c_nodename);
  43         STR_NOT_EMPTY(c_default_cal_zone);
  44
  45 /* we bind a lot of ports: */
  46         TEST_PORT(c_smtp_port, 25);
  47         TEST_PORT(c_pop3_port, 110);
  48         TEST_PORT(c_imap_port, 143);
  49         TEST_PORT(c_msa_port, 587);
  50         TEST_PORT(c_port_number, 504);
  51         TEST_PORT(c_smtps_port, 465);
  52         TEST_PORT(c_pop3s_port, 995);
  53         TEST_PORT(c_imaps_port, 993);
  54         TEST_PORT(c_pftcpdict_port, -1);
  55         TEST_PORT(c_managesieve_port, 2020);
  56         TEST_PORT(c_xmpp_c2s_port, 5222);
  57         TEST_PORT(c_xmpp_s2s_port, 5269);
  58         TEST_PORT(c_nntp_port, 119);
  59         TEST_PORT(c_nntps_port, 563);
  60
  61         if (getpwuid(ctdluid) == NULL) {
  62                 syslog(LOG_EMERG, "The UID (%d) citadel is configured to use is not defined in your system (/etc/passwd?)!", ctdluid);
  63         }
  64
  65 }
  66
  67 /*
  68  * Put some sane default values into our configuration.  Some will be overridden when we run setup.
  69  */
  70 void brand_new_installation_set_defaults(void) {
  71
  72         struct utsname my_utsname;
  73         struct hostent *he;
  74
  75         /* Determine our host name, in case we need to use it as a default */
  76         uname(&my_utsname);
  77
  78         /* set some sample/default values in place of blanks... */
  79         extract_token(config.c_nodename, my_utsname.nodename, 0, '.', sizeof config.c_nodename);
  80         if (IsEmptyStr(config.c_fqdn) ) {
  81                 if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
  82                         safestrncpy(config.c_fqdn, he->h_name, sizeof config.c_fqdn);
  83                 }
  84                 else {
  85                         safestrncpy(config.c_fqdn, my_utsname.nodename, sizeof config.c_fqdn);
  86                 }
  87         }
  88
  89         safestrncpy(config.c_humannode, "Citadel Server", sizeof config.c_humannode);
  90         safestrncpy(config.c_phonenum, "US 800 555 1212", sizeof config.c_phonenum);
  91         config.c_initax = 4;
  92         safestrncpy(config.c_moreprompt, "<more>", sizeof config.c_moreprompt);
  93         safestrncpy(config.c_twitroom, "Trashcan", sizeof config.c_twitroom);
  94         safestrncpy(config.c_baseroom, BASEROOM, sizeof config.c_baseroom);
  95         safestrncpy(config.c_aideroom, "Aide", sizeof config.c_aideroom);
  96         config.c_port_number = 504;
  97         config.c_sleeping = 900;
  98
  99         if (config.c_createax == 0) {
 100                 config.c_createax = 3;
 101         }
 102
 103         /*
 104          * Default port numbers for various services
 105          */
 106         config.c_smtp_port = 25;
 107         config.c_pop3_port = 110;
 108         config.c_imap_port = 143;
 109         config.c_msa_port = 587;
 110         config.c_smtps_port = 465;
 111         config.c_pop3s_port = 995;
 112         config.c_imaps_port = 993;
 113         config.c_pftcpdict_port = -1 ;
 114         config.c_managesieve_port = 2020;
 115         config.c_xmpp_c2s_port = 5222;
 116         config.c_xmpp_s2s_port = 5269;
 117         config.c_nntp_port = 119;
 118         config.c_nntps_port = 563;
 119 }
 120
 121
 122
 123 /*
 124  * Called during the initialization of Citadel server.
 125  * It verifies the system's integrity and reads citadel.config into memory.
 126  */
 127 void initialize_config_system(void) {
 128         FILE *cfp;
 129         int rv;
 130
 131         if (chdir(ctdl_bbsbase_dir) != 0) {
 132                 fprintf(stderr,
 133                         "This program could not be started.\nUnable to change directory to %s\nError: %s\n",
 134                         ctdl_bbsbase_dir,
 135                         strerror(errno)
 136                 );
 137                 exit(CTDLEXIT_HOME);
 138         }
 139
 140         memset(&config, 0, sizeof(struct config));
 141         cfp = fopen(file_citadel_config, "rb");
 142         if (cfp != NULL) {
 143                 rv = fread((char *) &config, sizeof(struct config), 1, cfp);
 144                 if (rv != 1)
 145                 {
 146                         fprintf(stderr,
 147                                 "Warning: The config file %s has unexpected size. \n",
 148                                 file_citadel_config
 149                         );
 150                 }
 151                 fclose(cfp);
 152         }
 153         else {
 154                 brand_new_installation_set_defaults();
 155         }
 156
 157         /* Ensure that we are linked to the correct version of libcitadel */
 158         if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
 159                 fprintf(stderr, "    You are running libcitadel version %d.%02d\n",
 160                         (libcitadel_version_number() / 100), (libcitadel_version_number() % 100));
 161                 fprintf(stderr, "citserver was compiled against version %d.%02d\n",
 162                         (LIBCITADEL_VERSION_NUMBER / 100), (LIBCITADEL_VERSION_NUMBER % 100));
 163                 exit(CTDLEXIT_LIBCITADEL);
 164         }
 165
 166         /* Only allow LDAP auth mode if we actually have LDAP support */
 167 #ifndef HAVE_LDAP
 168         if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
 169                 fprintf(stderr, "Your system is configured for LDAP authentication,\n"
 170                                 "but you are running a server built without OpenLDAP support.\n");
 171                 exit(CTDL_EXIT_UNSUP_AUTH);
 172         }
 173 #endif
 174
 175         /* Default maximum message length is 10 megabytes.  This is site
 176          * configurable.  Also check to make sure the limit has not been
 177          * set below 8192 bytes.
 178          */
 179         if (config.c_maxmsglen <= 0)
 180                 config.c_maxmsglen = 10485760;
 181         if (config.c_maxmsglen < 8192)
 182                 config.c_maxmsglen = 8192;
 183
 184         /* Default lower and upper limits on number of worker threads */
 185
 186         if (config.c_min_workers < 3)           /* no less than 3 */
 187                 config.c_min_workers = 5;
 188
 189         if (config.c_max_workers == 0)                  /* default maximum */
 190                 config.c_max_workers = 256;
 191
 192         if (config.c_max_workers < config.c_min_workers)   /* max >= min */
 193                 config.c_max_workers = config.c_min_workers;
 194
 195         /* Networking more than once every five minutes just isn't sane */
 196         if (config.c_net_freq == 0L)
 197                 config.c_net_freq = 3600L;      /* once per hour default */
 198         if (config.c_net_freq < 300L)
 199                 config.c_net_freq = 300L;
 200
 201         /* Same goes for POP3 */
 202         if (config.c_pop3_fetch == 0L)
 203                 config.c_pop3_fetch = 3600L;    /* once per hour default */
 204         if (config.c_pop3_fetch < 300L)
 205                 config.c_pop3_fetch = 300L;
 206         if (config.c_pop3_fastest == 0L)
 207                 config.c_pop3_fastest = 3600L;  /* once per hour default */
 208         if (config.c_pop3_fastest < 300L)
 209                 config.c_pop3_fastest = 300L;
 210
 211         /* "create new user" only works with native authentication mode */
 212         if (config.c_auth_mode != AUTHMODE_NATIVE) {
 213                 config.c_disable_newu = 1;
 214         }
 215 }
 216
 217 long config_msgnum = 0;
 218
 219 /*
 220  * Occasionally, we will need to write the config file, because some operations
 221  * change site-wide parameters.
 222  */
 223 void put_config(void)
 224 {
 225         FILE *cfp;
 226         int blocks_written = 0;
 227
 228         cfp = fopen(file_citadel_config, "w");
 229         if (cfp != NULL) {
 230                 blocks_written = fwrite((char *) &config, sizeof(struct config), 1, cfp);
 231                 if (blocks_written == 1) {
 232                         chown(file_citadel_config, CTDLUID, (-1));
 233                         chmod(file_citadel_config, 0600);
 234                         fclose(cfp);
 235                         return;
 236                 }
 237                 fclose(cfp);
 238         }
 239         syslog(LOG_EMERG, "%s: %s", file_citadel_config, strerror(errno));
 240 }
 241
 242
 243
 244 /*
 245  * Called when Citadel server is shutting down.
 246  * Clears out the config hash table.
 247  */
 248 void shutdown_config_system(void)
 249 {
 250         DeleteHash(&ctdlconfig);
 251 }
 252
 253
 254
 255
 256
 257
 258
 259
 260 /**********************************************************************/
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271 void CtdlGetSysConfigBackend(long msgnum, void *userdata) {
 272         config_msgnum = msgnum;
 273 }
 274
 275
 276 char *CtdlGetSysConfig(char *sysconfname) {
 277         char hold_rm[ROOMNAMELEN];
 278         long msgnum;
 279         char *conf;
 280         struct CtdlMessage *msg;
 281         char buf[SIZ];
 282
 283         strcpy(hold_rm, CC->room.QRname);
 284         if (CtdlGetRoom(&CC->room, SYSCONFIGROOM) != 0) {
 285                 CtdlGetRoom(&CC->room, hold_rm);
 286                 return NULL;
 287         }
 288
 289
 290         /* We want the last (and probably only) config in this room */
 291         begin_critical_section(S_CONFIG);
 292         config_msgnum = (-1L);
 293         CtdlForEachMessage(MSGS_LAST, 1, NULL, sysconfname, NULL,
 294                            CtdlGetSysConfigBackend, NULL);
 295         msgnum = config_msgnum;
 296         end_critical_section(S_CONFIG);
 297
 298         if (msgnum < 0L) {
 299                 conf = NULL;
 300         }
 301         else {
 302                 msg = CtdlFetchMessage(msgnum, 1);
 303                 if (msg != NULL) {
 304                         conf = strdup(msg->cm_fields[eMesageText]);
 305                         CM_Free(msg);
 306                 }
 307                 else {
 308                         conf = NULL;
 309                 }
 310         }
 311
 312         CtdlGetRoom(&CC->room, hold_rm);
 313
 314         if (conf != NULL) do {
 315                         extract_token(buf, conf, 0, '\n', sizeof buf);
 316                         strcpy(conf, &conf[strlen(buf)+1]);
 317                 } while ( (!IsEmptyStr(conf)) && (!IsEmptyStr(buf)) );
 318
 319         return(conf);
 320 }
 321
 322
 323 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata) {
 324         CtdlWriteObject(SYSCONFIGROOM, sysconfname, sysconfdata, (strlen(sysconfdata)+1), NULL, 0, 1, 0);
 325 }
 326