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