X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fconfig.c;h=34028abb0ee36b511a9fdcd7cbb9565b8f68ab37;hb=88c52d18e496b38205b30eff94c14eef59558f51;hp=6e1c6a9e8605abdb774f61ed8b5283b230151000;hpb=793a5f1f95421788902af90d10425706e601d001;p=citadel.git diff --git a/citadel/config.c b/citadel/config.c index 6e1c6a9e8..34028abb0 100644 --- a/citadel/config.c +++ b/citadel/config.c @@ -1,64 +1,347 @@ /* - * This function reads the citadel.config file. It should be called at - * the beginning of EVERY Citadel program. + * Read and write the citadel.config file + * + * Copyright (c) 1987-2014 by the citadel.org team + * + * This program is open source software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 3. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. */ #include "sysdep.h" -#include -#include #include -#include -#include -#include -#include "citadel.h" +#include +#include #include "config.h" +#include "ctdl_module.h" struct config config; -char bbs_home_directory[PATH_MAX]; -int home_specified = 0; +struct configlen configlen; -void get_config(void) { - FILE *cfp; +#define STR_NOT_EMPTY(CFG_FIELDNAME) if (IsEmptyStr(config.CFG_FIELDNAME)) \ + syslog(LOG_EMERG, "configuration setting "#CFG_FIELDNAME" is empty, but must not - check your config!"); + +#define TEST_PORT(CFG_PORT, DEFAULTPORT) \ + if ((config.CFG_PORT < -1) || \ + (config.CFG_PORT == 0) || \ + (config.CFG_PORT > UINT16_MAX)) \ + syslog(LOG_EMERG, "configuration setting "#CFG_PORT" is not -1 (disabled) or a valid TCP-Port - check your config! Default setting is: "#DEFAULTPORT); + + +void validate_config(void) { +/* these shouldn't be empty: */ + STR_NOT_EMPTY(c_fqdn); + + STR_NOT_EMPTY(c_baseroom); + STR_NOT_EMPTY(c_aideroom); + STR_NOT_EMPTY(c_twitroom); + STR_NOT_EMPTY(c_nodename); + STR_NOT_EMPTY(c_default_cal_zone); - if (chdir( home_specified ? bbs_home_directory : BBSDIR ) != 0) { - fprintf(stderr, "Cannot start.\nThere is no Citadel installation in %s\n%s\n", - (home_specified ? bbs_home_directory : BBSDIR), - strerror(errno)); - exit(errno); +/* we bind a lot of ports: */ + TEST_PORT(c_smtp_port, 25); + TEST_PORT(c_pop3_port, 110); + TEST_PORT(c_imap_port, 143); + TEST_PORT(c_msa_port, 587); + TEST_PORT(c_port_number, 504); + TEST_PORT(c_smtps_port, 465); + TEST_PORT(c_pop3s_port, 995); + TEST_PORT(c_imaps_port, 993); + TEST_PORT(c_pftcpdict_port, -1); + TEST_PORT(c_managesieve_port, 2020); + TEST_PORT(c_xmpp_c2s_port, 5222); + TEST_PORT(c_xmpp_s2s_port, 5269); + TEST_PORT(c_nntp_port, 119); + TEST_PORT(c_nntps_port, 563); + + if (config.c_ctdluid == 0) + syslog(LOG_EMERG, "citadel should not be configured to run as root! Check the value of c_ctdluid"); + else if (getpwuid(CTDLUID) == NULL) + syslog(LOG_EMERG, "The UID (%d) citadel is configured to use is not defined in your system (/etc/passwd?)! Check the value of c_ctdluid", CTDLUID); + +} + +/* + * Put some sane default values into our configuration. Some will be overridden when we run setup. + */ +void brand_new_installation_set_defaults(void) { + + struct passwd *pw; + struct utsname my_utsname; + struct hostent *he; + + /* Determine our host name, in case we need to use it as a default */ + uname(&my_utsname); + memset(&configlen, 0, sizeof(struct configlen)); + /* set some sample/default values in place of blanks... */ + configlen.c_nodename = extract_token(config.c_nodename, my_utsname.nodename, 0, '.', sizeof config.c_nodename); + if (IsEmptyStr(config.c_fqdn) ) { + if ((he = gethostbyname(my_utsname.nodename)) != NULL) { + configlen.c_fqdn = safestrncpy(config.c_fqdn, he->h_name, sizeof config.c_fqdn); } - cfp=fopen("citadel.config","rb"); - if (cfp==NULL) { - fprintf(stderr, "Cannot start.\n"); - fprintf(stderr, "There is no citadel.config in %s\n%s\n", - (home_specified ? bbs_home_directory : BBSDIR), - strerror(errno)); - exit(errno); + else { + configlen.c_fqdn = safestrncpy(config.c_fqdn, my_utsname.nodename, sizeof config.c_fqdn); } - fread((char *)&config,sizeof(struct config),1,cfp); - fclose(cfp); - if ( (config.c_setup_level / 10) != (REV_LEVEL/10) ) { - fprintf(stderr, "config: Your data files are out of date. "); - fprintf(stderr, "Run setup to update them.\n"); - fprintf(stderr, - " This program requires level %d.%02d\n", - (REV_LEVEL / 100), (REV_LEVEL % 100) ); + } + + configlen.c_humannode = safestrncpy(config.c_humannode, "Citadel Server", sizeof config.c_humannode); + configlen.c_phonenum = safestrncpy(config.c_phonenum, "US 800 555 1212", sizeof config.c_phonenum); + config.c_initax = 4; + configlen.c_moreprompt = safestrncpy(config.c_moreprompt, "", sizeof config.c_moreprompt); + configlen.c_twitroom = safestrncpy(config.c_twitroom, "Trashcan", sizeof config.c_twitroom); + configlen.c_baseroom = safestrncpy(config.c_baseroom, BASEROOM, sizeof config.c_baseroom); + configlen.c_aideroom = safestrncpy(config.c_aideroom, "Aide", sizeof config.c_aideroom); + config.c_port_number = 504; + config.c_sleeping = 900; + + if (config.c_ctdluid == 0) { + pw = getpwnam("citadel"); + if (pw != NULL) { + config.c_ctdluid = pw->pw_uid; + } + } + if (config.c_ctdluid == 0) { + pw = getpwnam("bbs"); + if (pw != NULL) { + config.c_ctdluid = pw->pw_uid; + } + } + if (config.c_ctdluid == 0) { + pw = getpwnam("guest"); + if (pw != NULL) { + config.c_ctdluid = pw->pw_uid; + } + } + if (config.c_createax == 0) { + config.c_createax = 3; + } + + /* + * Default port numbers for various services + */ + config.c_smtp_port = 25; + config.c_pop3_port = 110; + config.c_imap_port = 143; + config.c_msa_port = 587; + config.c_smtps_port = 465; + config.c_pop3s_port = 995; + config.c_imaps_port = 993; + config.c_pftcpdict_port = -1 ; + config.c_managesieve_port = 2020; + config.c_xmpp_c2s_port = 5222; + config.c_xmpp_s2s_port = 5269; + config.c_nntp_port = 119; + config.c_nntps_port = 563; +} + +void setcfglen(void) +{ + configlen.c_nodename = strlen(config.c_nodename); + configlen.c_fqdn = strlen(config.c_fqdn); + configlen.c_humannode = strlen(config.c_humannode); + configlen.c_phonenum = strlen(config.c_phonenum); + configlen.c_twitroom = strlen(config.c_twitroom); + configlen.c_moreprompt = strlen(config.c_moreprompt); + configlen.c_site_location = strlen(config.c_site_location); + configlen.c_sysadm = strlen(config.c_sysadm); + configlen.c_niu_2 = strlen(config.c_niu_2); + configlen.c_ip_addr = strlen(config.c_ip_addr); + configlen.c_logpages = strlen(config.c_logpages); + configlen.c_baseroom = strlen(config.c_baseroom); + configlen.c_aideroom = strlen(config.c_aideroom); + configlen.c_ldap_host = strlen(config.c_ldap_host); + configlen.c_ldap_base_dn = strlen(config.c_ldap_base_dn); + configlen.c_ldap_bind_dn = strlen(config.c_ldap_bind_dn); + configlen.c_ldap_bind_pw = strlen(config.c_ldap_bind_pw); + configlen.c_journal_dest = strlen(config.c_journal_dest); + configlen.c_default_cal_zone = strlen(config.c_default_cal_zone); + configlen.c_funambol_host = strlen(config.c_funambol_host); + configlen.c_funambol_source = strlen(config.c_funambol_source); + configlen.c_funambol_auth = strlen(config.c_funambol_auth); + configlen.c_master_user = strlen(config.c_master_user); + configlen.c_master_pass = strlen(config.c_master_pass); + configlen.c_pager_program = strlen(config.c_pager_program); +} + +/* + * get_config() is called during the initialization of Citadel server. + * It verifies the system's integrity and reads citadel.config into memory. + */ +void get_config(void) { + FILE *cfp; + int rv; + + if (chdir(ctdl_bbsbase_dir) != 0) { fprintf(stderr, - " Data files are currently at %d.%02d\n", - (config.c_setup_level / 100), - (config.c_setup_level % 100) ); - exit(1); + "This program could not be started.\nUnable to change directory to %s\nError: %s\n", + ctdl_bbsbase_dir, + strerror(errno) + ); + exit(CTDLEXIT_HOME); + } + + memset(&config, 0, sizeof(struct config)); + cfp = fopen(file_citadel_config, "rb"); + if (cfp != NULL) { + rv = fread((char *) &config, sizeof(struct config), 1, cfp); + if (rv != 1) + { + fprintf(stderr, + "Warning: The config file %s has unexpected size. \n", + file_citadel_config + ); } + fclose(cfp); + setcfglen(); + } + else { + brand_new_installation_set_defaults(); } + /* Ensure that we are linked to the correct version of libcitadel */ + if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) { + fprintf(stderr, " You are running libcitadel version %d.%02d\n", + (libcitadel_version_number() / 100), (libcitadel_version_number() % 100)); + fprintf(stderr, "citserver was compiled against version %d.%02d\n", + (LIBCITADEL_VERSION_NUMBER / 100), (LIBCITADEL_VERSION_NUMBER % 100)); + exit(CTDLEXIT_LIBCITADEL); + } + + /* Only allow LDAP auth mode if we actually have LDAP support */ +#ifndef HAVE_LDAP + if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) { + fprintf(stderr, "Your system is configured for LDAP authentication,\n" + "but you are running a server built without OpenLDAP support.\n"); + exit(CTDL_EXIT_UNSUP_AUTH); + } +#endif + + /* Default maximum message length is 10 megabytes. This is site + * configurable. Also check to make sure the limit has not been + * set below 8192 bytes. + */ + if (config.c_maxmsglen <= 0) + config.c_maxmsglen = 10485760; + if (config.c_maxmsglen < 8192) + config.c_maxmsglen = 8192; + + /* Default lower and upper limits on number of worker threads */ + + if (config.c_min_workers < 3) /* no less than 3 */ + config.c_min_workers = 5; + + if (config.c_max_workers == 0) /* default maximum */ + config.c_max_workers = 256; + + if (config.c_max_workers < config.c_min_workers) /* max >= min */ + config.c_max_workers = config.c_min_workers; + + /* Networking more than once every five minutes just isn't sane */ + if (config.c_net_freq == 0L) + config.c_net_freq = 3600L; /* once per hour default */ + if (config.c_net_freq < 300L) + config.c_net_freq = 300L; + + /* Same goes for POP3 */ + if (config.c_pop3_fetch == 0L) + config.c_pop3_fetch = 3600L; /* once per hour default */ + if (config.c_pop3_fetch < 300L) + config.c_pop3_fetch = 300L; + if (config.c_pop3_fastest == 0L) + config.c_pop3_fastest = 3600L; /* once per hour default */ + if (config.c_pop3_fastest < 300L) + config.c_pop3_fastest = 300L; + + /* "create new user" only works with native authentication mode */ + if (config.c_auth_mode != AUTHMODE_NATIVE) { + config.c_disable_newu = 1; + } +} + +long config_msgnum = 0; /* * Occasionally, we will need to write the config file, because some operations * change site-wide parameters. */ -void put_config(void) { +void put_config(void) +{ FILE *cfp; + int blocks_written = 0; + + cfp = fopen(file_citadel_config, "w"); + if (cfp != NULL) { + blocks_written = fwrite((char *) &config, sizeof(struct config), 1, cfp); + if (blocks_written == 1) { + chown(file_citadel_config, CTDLUID, (-1)); + chmod(file_citadel_config, 0600); + fclose(cfp); + return; + } + fclose(cfp); + } + syslog(LOG_EMERG, "%s: %s", file_citadel_config, strerror(errno)); +} + + + +void CtdlGetSysConfigBackend(long msgnum, void *userdata) { + config_msgnum = msgnum; +} + + +char *CtdlGetSysConfig(char *sysconfname) { + char hold_rm[ROOMNAMELEN]; + long msgnum; + char *conf; + struct CtdlMessage *msg; + char buf[SIZ]; - cfp = fopen("citadel.config", "rb+"); - fwrite((char *)&config, sizeof(struct config), 1, cfp); - fclose(cfp); + strcpy(hold_rm, CC->room.QRname); + if (CtdlGetRoom(&CC->room, SYSCONFIGROOM) != 0) { + CtdlGetRoom(&CC->room, hold_rm); + return NULL; } + + + /* We want the last (and probably only) config in this room */ + begin_critical_section(S_CONFIG); + config_msgnum = (-1L); + CtdlForEachMessage(MSGS_LAST, 1, NULL, sysconfname, NULL, + CtdlGetSysConfigBackend, NULL); + msgnum = config_msgnum; + end_critical_section(S_CONFIG); + + if (msgnum < 0L) { + conf = NULL; + } + else { + msg = CtdlFetchMessage(msgnum, 1); + if (msg != NULL) { + conf = strdup(msg->cm_fields[eMesageText]); + CM_Free(msg); + } + else { + conf = NULL; + } + } + + CtdlGetRoom(&CC->room, hold_rm); + + if (conf != NULL) do { + extract_token(buf, conf, 0, '\n', sizeof buf); + strcpy(conf, &conf[strlen(buf)+1]); + } while ( (!IsEmptyStr(conf)) && (!IsEmptyStr(buf)) ); + + return(conf); +} + + +void CtdlPutSysConfig(char *sysconfname, char *sysconfdata) { + CtdlWriteObject(SYSCONFIGROOM, sysconfname, sysconfdata, (strlen(sysconfdata)+1), NULL, 0, 1, 0); +} +