citadel/config.c

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