Completed the merge of a read-only, reader-only NNTP service into Citadel server.
[citadel.git] / citadel / control.c
index 8b57b698c11e06363723421816ec2233827846d6..0aba124044914bd9b1a2619d21933924ef5999f0 100644 (file)
@@ -1,69 +1,25 @@
 /*
- * $Id$
- *
  * This module handles states which are global to the entire server.
  *
- * Copyright (c) 1987-2009 by the citadel.org team
+ * Copyright (c) 1987-2014 by the citadel.org team
  *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 3 of the License, or
- *  (at your option) any later version.
+ *  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.
- *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
-#include "sysdep.h"
-#include <stdlib.h>
-#include <unistd.h>
 #include <stdio.h>
-#include <fcntl.h>
-#include <signal.h>
-
-#if TIME_WITH_SYS_TIME
-# include <sys/time.h>
-# include <time.h>
-#else
-# if HAVE_SYS_TIME_H
-#  include <sys/time.h>
-# else
-#  include <time.h>
-# endif
-#endif
-
-#include <ctype.h>
-#include <string.h>
-#include <errno.h>
-#include <limits.h>
-#include <sys/types.h>
 #include <sys/file.h>
-#include <sys/stat.h>
 #include <libcitadel.h>
-#include "citadel.h"
-#include "server.h"
-#include "control.h"
-#include "sysdep_decls.h"
-#include "support.h"
+
+#include "ctdl_module.h"
 #include "config.h"
-#include "msgbase.h"
 #include "citserver.h"
-#include "room_ops.h"
 #include "user_ops.h"
-#include "database.h"
-#include "threads.h"
-
-#ifndef HAVE_SNPRINTF
-#include "snprintf.h"
-#endif
-
-#include "ctdl_module.h"
 
 struct CitControl CitControl;
 extern struct config config;
@@ -77,15 +33,10 @@ long control_highest_user = 0;
  */
 void lock_control(void)
 {
-#ifdef HAVE_FLOCK
-/*
- * TODO: solaris manpages describe this function, but the headers
- * don't show it! 
- */
-
+#if defined(LOCK_EX) && defined(LOCK_NB)
        if (flock(fileno(control_fp), (LOCK_EX | LOCK_NB))) {
-               CtdlLogPrintf(CTDL_EMERG, "citserver: unable to lock %s.\n", file_citadel_control);
-               CtdlLogPrintf(CTDL_EMERG, "Is another citserver already running?\n");
+               syslog(LOG_EMERG, "citserver: unable to lock %s.\n", file_citadel_control);
+               syslog(LOG_EMERG, "Is another citserver already running?\n");
                exit(CTDLEXIT_CONTROL);
        }
 #endif
@@ -134,9 +85,9 @@ void control_find_highest(struct ctdlroom *qrbuf, void *data)
        }
        cdb_free(cdbfr);
        if (room_fixed)
-               CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed room counter\n");
+               syslog(LOG_INFO, "Control record checking....Fixed room counter\n");
        if (message_fixed)
-               CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed message count\n");
+               syslog(LOG_INFO, "Control record checking....Fixed message count\n");
        return;
 }
 
@@ -155,7 +106,7 @@ void control_find_user (struct ctdluser *EachUser, void *out_data)
                user_fixed = 1;
        }
        if(user_fixed)
-               CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed user count\n");
+               syslog(LOG_INFO, "Control record checking....Fixed user count\n");
 }
 
 
@@ -183,30 +134,52 @@ void get_control(void)
                if (control_fp != NULL) {
                        lock_control();
                        rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
+                       if (rv == -1)
+                               syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n", 
+                                      file_citadel_control, strerror(errno));
                        rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
+                       if (rv == -1)
+                               syslog(LOG_EMERG, "Failed to adjust accessrights of: %s [%s]\n", 
+                                      file_citadel_control, strerror(errno));
                }
        }
        if (control_fp == NULL) {
                control_fp = fopen(file_citadel_control, "wb+");
                if (control_fp != NULL) {
                        lock_control();
+                       memset(&CitControl, 0, sizeof(struct CitControl));
+
                        rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
+                       if (rv == -1)
+                               syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n", 
+                                      file_citadel_control, strerror(errno));
+
                        rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
-                       memset(&CitControl, 0, sizeof(struct CitControl));
+                       if (rv == -1)
+                               syslog(LOG_EMERG, "Failed to adjust accessrights of: %s [%s]\n", 
+                                      file_citadel_control, strerror(errno));
                        rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
+                       if (rv == -1)
+                               syslog(LOG_EMERG, "Failed to write: %s [%s]\n", 
+                                      file_citadel_control, strerror(errno));
                        rewind(control_fp);
                }
        }
        if (control_fp == NULL) {
-               CtdlLogPrintf(CTDL_ALERT, "ERROR opening %s: %s\n", file_citadel_control, strerror(errno));
+               syslog(LOG_ALERT, "ERROR opening %s: %s\n", file_citadel_control, strerror(errno));
                return;
        }
 
        rewind(control_fp);
        rv = fread(&CitControl, sizeof(struct CitControl), 1, control_fp);
+       if (rv == -1)
+               syslog(LOG_EMERG, "Failed to read Controlfile: %s [%s]\n", 
+                      file_citadel_control, strerror(errno));
        already_have_control = 1;
        rv = chown(file_citadel_control, config.c_ctdluid, (-1));
-       
+       if (rv == -1)
+               syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n", 
+                      file_citadel_control, strerror(errno));  
 }
 
 /*
@@ -219,6 +192,9 @@ void put_control(void)
        if (control_fp != NULL) {
                rewind(control_fp);
                rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
+               if (rv == -1)
+                       syslog(LOG_EMERG, "Failed to write: %s [%s]\n", 
+                              file_citadel_control, strerror(errno));
                fflush(control_fp);
        }
 }
@@ -229,7 +205,7 @@ void put_control(void)
  */
 void check_control(void)
 {
-       CtdlLogPrintf(CTDL_INFO, "Checking/re-building control record\n");
+       syslog(LOG_INFO, "Checking/re-building control record\n");
        get_control();
        // Find highest room number and message number.
        CtdlForEachRoom(control_find_highest, NULL);
@@ -238,13 +214,14 @@ void check_control(void)
 }
 
 
-/**
+/*
  * release_control - close our fd on exit
  */
 void release_control(void)
 {
-       if (control_fp != NULL)
+       if (control_fp != NULL) {
                fclose(control_fp);
+       }
        control_fp = NULL;
 }
 
@@ -314,6 +291,10 @@ long get_new_room_number(void)
 
 /* 
  * Get or set global configuration options
+ *
+ * IF YOU ADD OR CHANGE FIELDS HERE, YOU *MUST* DOCUMENT YOUR CHANGES AT:
+ * http://www.citadel.org/doku.php?id=documentation:applicationprotocol
+ *
  */
 void cmd_conf(char *argbuf)
 {
@@ -380,7 +361,7 @@ void cmd_conf(char *argbuf)
                cprintf("%d\n", config.c_smtps_port);
                cprintf("%d\n", config.c_enable_fulltext);
                cprintf("%d\n", config.c_auto_cull);
-               cprintf("%d\n", config.c_instant_expunge);
+               cprintf("1\n");
                cprintf("%d\n", config.c_allow_spoofing);
                cprintf("%d\n", config.c_journal_email);
                cprintf("%d\n", config.c_journal_pubmsgs);
@@ -403,6 +384,11 @@ void cmd_conf(char *argbuf)
                cprintf("%ld\n", config.c_pop3_fetch);
                cprintf("%ld\n", config.c_pop3_fastest);
                cprintf("%d\n", config.c_spam_flag_only);
+               cprintf("%d\n", config.c_guest_logins);
+               cprintf("%d\n", config.c_port_number);
+               cprintf("%d\n", config.c_ctdluid);
+               cprintf("%d\n", config.c_nntp_port);
+               cprintf("%d\n", config.c_nntps_port);
                cprintf("000\n");
        }
 
@@ -413,20 +399,20 @@ void cmd_conf(char *argbuf)
                while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
                        switch (a) {
                        case 0:
-                               safestrncpy(config.c_nodename, buf,
-                                           sizeof config.c_nodename);
+                               configlen.c_nodename = safestrncpy(config.c_nodename, buf,
+                                                                  sizeof config.c_nodename);
                                break;
                        case 1:
-                               safestrncpy(config.c_fqdn, buf,
-                                           sizeof config.c_fqdn);
+                               configlen.c_fqdn = safestrncpy(config.c_fqdn, buf,
+                                                              sizeof config.c_fqdn);
                                break;
                        case 2:
-                               safestrncpy(config.c_humannode, buf,
-                                           sizeof config.c_humannode);
+                               configlen.c_humannode = safestrncpy(config.c_humannode, buf,
+                                                                   sizeof config.c_humannode);
                                break;
                        case 3:
-                               safestrncpy(config.c_phonenum, buf,
-                                           sizeof config.c_phonenum);
+                               configlen.c_phonenum = safestrncpy(config.c_phonenum, buf,
+                                                                  sizeof config.c_phonenum);
                                break;
                        case 4:
                                config.c_creataide = atoi(buf);
@@ -452,12 +438,12 @@ void cmd_conf(char *argbuf)
                                        config.c_twitdetect = 1;
                                break;
                        case 9:
-                               safestrncpy(config.c_twitroom, buf,
-                                           sizeof config.c_twitroom);
+                               configlen.c_twitroom = safestrncpy(config.c_twitroom, buf,
+                                                                  sizeof config.c_twitroom);
                                break;
                        case 10:
-                               safestrncpy(config.c_moreprompt, buf,
-                                           sizeof config.c_moreprompt);
+                               configlen.c_moreprompt = safestrncpy(config.c_moreprompt, buf,
+                                                                    sizeof config.c_moreprompt);
                                break;
                        case 11:
                                config.c_restrict = atoi(buf);
@@ -465,12 +451,13 @@ void cmd_conf(char *argbuf)
                                        config.c_restrict = 1;
                                break;
                        case 12:
-                               safestrncpy(config.c_site_location, buf,
-                                           sizeof config.c_site_location);
+                               configlen.c_site_location = safestrncpy(
+                                       config.c_site_location, buf,
+                                       sizeof config.c_site_location);
                                break;
                        case 13:
-                               safestrncpy(config.c_sysadm, buf,
-                                           sizeof config.c_sysadm);
+                               configlen.c_sysadm = safestrncpy(config.c_sysadm, buf,
+                                                                sizeof config.c_sysadm);
                                break;
                        case 14:
                                config.c_maxsessions = atoi(buf);
@@ -487,8 +474,8 @@ void cmd_conf(char *argbuf)
                                config.c_roompurge = atoi(buf);
                                break;
                        case 18:
-                               safestrncpy(config.c_logpages, buf,
-                                           sizeof config.c_logpages);
+                               configlen.c_logpages = safestrncpy(config.c_logpages, buf,
+                                                                  sizeof config.c_logpages);
                                break;
                        case 19:
                                config.c_createax = atoi(buf);
@@ -537,34 +524,34 @@ void cmd_conf(char *argbuf)
                                break;
                        case 31:
                                if ((config.c_purge_hour >= 0)
-                                  && (config.c_purge_hour <= 23)) {
+                                   && (config.c_purge_hour <= 23)) {
                                        config.c_purge_hour = atoi(buf);
                                }
                                break;
 #ifdef HAVE_LDAP
                        case 32:
-                               safestrncpy(config.c_ldap_host, buf,
-                                           sizeof config.c_ldap_host);
+                               configlen.c_ldap_host = safestrncpy(config.c_ldap_host, buf,
+                                                                   sizeof config.c_ldap_host);
                                break;
                        case 33:
                                config.c_ldap_port = atoi(buf);
                                break;
                        case 34:
-                               safestrncpy(config.c_ldap_base_dn, buf,
-                                           sizeof config.c_ldap_base_dn);
+                               configlen.c_ldap_base_dn = safestrncpy(config.c_ldap_base_dn, buf,
+                                                                      sizeof config.c_ldap_base_dn);
                                break;
                        case 35:
-                               safestrncpy(config.c_ldap_bind_dn, buf,
-                                           sizeof config.c_ldap_bind_dn);
+                               configlen.c_ldap_bind_dn = safestrncpy(config.c_ldap_bind_dn, buf,
+                                                                      sizeof config.c_ldap_bind_dn);
                                break;
                        case 36:
-                               safestrncpy(config.c_ldap_bind_pw, buf,
-                                           sizeof config.c_ldap_bind_pw);
+                               configlen.c_ldap_bind_pw = safestrncpy(config.c_ldap_bind_pw, buf,
+                                                                      sizeof config.c_ldap_bind_pw);
                                break;
 #endif
                        case 37:
-                               safestrncpy(config.c_ip_addr, buf,
-                                               sizeof config.c_ip_addr);
+                               configlen.c_ip_addr = safestrncpy(config.c_ip_addr, buf,
+                                                                 sizeof config.c_ip_addr);
                        case 38:
                                config.c_msa_port = atoi(buf);
                                break;
@@ -584,7 +571,7 @@ void cmd_conf(char *argbuf)
                                config.c_auto_cull = atoi(buf);
                                break;
                        case 44:
-                               config.c_instant_expunge = atoi(buf);
+                               /* niu */
                                break;
                        case 45:
                                config.c_allow_spoofing = atoi(buf);
@@ -596,11 +583,12 @@ void cmd_conf(char *argbuf)
                                config.c_journal_pubmsgs = atoi(buf);
                                break;
                        case 48:
-                               safestrncpy(config.c_journal_dest, buf,
-                                               sizeof config.c_journal_dest);
+                               configlen.c_journal_dest = safestrncpy(config.c_journal_dest, buf,
+                                                                      sizeof config.c_journal_dest);
                        case 49:
-                               safestrncpy(config.c_default_cal_zone, buf,
-                                               sizeof config.c_default_cal_zone);
+                               configlen.c_default_cal_zone = safestrncpy(
+                                       config.c_default_cal_zone, buf,
+                                       sizeof config.c_default_cal_zone);
                                break;
                        case 50:
                                config.c_pftcpdict_port = atoi(buf);
@@ -611,35 +599,38 @@ void cmd_conf(char *argbuf)
                        case 52:
                                config.c_auth_mode = atoi(buf);
                        case 53:
-                               safestrncpy(config.c_funambol_host, buf,
+                               configlen.c_funambol_host = safestrncpy(
+                                       config.c_funambol_host, buf,
                                        sizeof config.c_funambol_host);
                                break;
                        case 54:
                                config.c_funambol_port = atoi(buf);
                                break;
                        case 55:
-                               safestrncpy(config.c_funambol_source,
-                                       buf, 
+                               configlen.c_funambol_source = safestrncpy(
+                                       config.c_funambol_source, buf, 
                                        sizeof config.c_funambol_source);
                                break;
                        case 56:
-                               safestrncpy(config.c_funambol_auth,
-                                       buf,
+                               configlen.c_funambol_auth = safestrncpy(
+                                       config.c_funambol_auth, buf,
                                        sizeof config.c_funambol_auth);
                                break;
                        case 57:
                                config.c_rbl_at_greeting = atoi(buf);
                                break;
                        case 58:
-                               safestrncpy(config.c_master_user, buf, sizeof config.c_master_user);
+                               configlen.c_master_user = safestrncpy(
+                                       config.c_master_user,
+                                       buf, sizeof config.c_master_user);
                                break;
                        case 59:
-                               safestrncpy(config.c_master_pass, buf, sizeof config.c_master_pass);
+                               configlen.c_master_pass = safestrncpy(
+                                       config.c_master_pass, buf, sizeof config.c_master_pass);
                                break;
                        case 60:
-                               safestrncpy(config.c_pager_program,
-                                       buf,
-                                       sizeof config.c_pager_program);
+                               configlen.c_pager_program = safestrncpy(
+                                       config.c_pager_program, buf, sizeof config.c_pager_program);
                                break;
                        case 61:
                                config.c_imap_keep_from = atoi(buf);
@@ -659,13 +650,29 @@ void cmd_conf(char *argbuf)
                        case 66:
                                config.c_spam_flag_only = atoi(buf);
                                break;
+                       case 67:
+                               config.c_guest_logins = atoi(buf);
+                               break;
+                       case 68:
+                               config.c_port_number = atoi(buf);
+                               break;
+                       case 69:
+                               config.c_ctdluid = atoi(buf);
+                               break;
+                       case 70:
+                               config.c_nntp_port = atoi(buf);
+                               break;
+                       case 71:
+                               config.c_nntp_port = atoi(buf);
+                               break;
                        }
                        ++a;
                }
                put_config();
                snprintf(buf, sizeof buf,
-                        "The global system configuration has been edited by %s.\n",
-                        CC->curr_user);
+                       "The global system configuration has been edited by %s.\n",
+                        (CC->logged_in ? CC->curr_user : "an administrator")
+               );
                CtdlAideMessage(buf,"Citadel Configuration Manager Message");
 
                if (!IsEmptyStr(config.c_logpages))
@@ -684,9 +691,12 @@ void cmd_conf(char *argbuf)
                extract_token(confname, argbuf, 1, '|', sizeof confname);
                confptr = CtdlGetSysConfig(confname);
                if (confptr != NULL) {
+                       long len; 
+
+                       len = strlen(confptr);
                        cprintf("%d %s\n", LISTING_FOLLOWS, confname);
-                       client_write(confptr, strlen(confptr));
-                       if (confptr[strlen(confptr) - 1] != 10)
+                       client_write(confptr, len);
+                       if ((len > 0) && (confptr[len - 1] != 10))
                                client_write("\n", 1);
                        cprintf("000\n");
                        free(confptr);
@@ -711,17 +721,111 @@ void cmd_conf(char *argbuf)
        }
 }
 
+typedef struct __ConfType {
+       ConstStr Name;
+       long Type;
+}ConfType;
+
+ConfType CfgNames[] = {
+       { {HKEY("localhost") },    0},
+       { {HKEY("directory") },    0},
+       { {HKEY("smarthost") },    2},
+       { {HKEY("fallbackhost") }, 2},
+       { {HKEY("rbl") },          3},
+       { {HKEY("spamassassin") }, 3},
+       { {HKEY("masqdomain") },   1},
+       { {HKEY("clamav") },       3},
+       { {HKEY("notify") },       3},
+       { {NULL, 0}, 0}
+};
+
+HashList *CfgNameHash = NULL;
+void cmd_gvdn(char *argbuf)
+{
+       const ConfType *pCfg;
+       char *confptr;
+       long min = atol(argbuf);
+       const char *Pos = NULL;
+       const char *PPos = NULL;
+       const char *HKey;
+       long HKLen;
+       StrBuf *Line;
+       StrBuf *Config;
+       StrBuf *Cfg;
+       StrBuf *CfgToken;
+       HashList *List;
+       HashPos *It;
+       void *vptr;
+       
+       List = NewHash(1, NULL);
+       Cfg = NewStrBufPlain(config.c_fqdn, -1);
+       Put(List, SKEY(Cfg), Cfg, HFreeStrBuf);
+       Cfg = NULL;
+
+       confptr = CtdlGetSysConfig(INTERNETCFG);
+       Config = NewStrBufPlain(confptr, -1);
+       free(confptr);
+
+       Line = NewStrBufPlain(NULL, StrLength(Config));
+       CfgToken = NewStrBufPlain(NULL, StrLength(Config));
+       while (StrBufSipLine(Line, Config, &Pos))
+       {
+               if (Cfg == NULL)
+                       Cfg = NewStrBufPlain(NULL, StrLength(Line));
+               PPos = NULL;
+               StrBufExtract_NextToken(Cfg, Line, &PPos, '|');
+               StrBufExtract_NextToken(CfgToken, Line, &PPos, '|');
+               if (GetHash(CfgNameHash, SKEY(CfgToken), &vptr) &&
+                   (vptr != NULL))
+               {
+                       pCfg = (ConfType *) vptr;
+                       if (pCfg->Type <= min)
+                       {
+                               Put(List, SKEY(Cfg), Cfg, HFreeStrBuf);
+                               Cfg = NULL;
+                       }
+               }
+       }
+
+       cprintf("%d Valid Domains\n", LISTING_FOLLOWS);
+       It = GetNewHashPos(List, 1);
+       while (GetNextHashPos(List, It, &HKLen, &HKey, &vptr))
+       {
+               cputbuf(vptr);
+               cprintf("\n");
+       }
+       cprintf("000\n");
+
+       DeleteHashPos(&It);
+       DeleteHash(&List);
+       FreeStrBuf(&Cfg);
+       FreeStrBuf(&Line);
+       FreeStrBuf(&CfgToken);
+       FreeStrBuf(&Config);
+}
 
 /*****************************************************************************/
 /*                      MODULE INITIALIZATION STUFF                          */
 /*****************************************************************************/
 
-
+void control_cleanup(void)
+{
+       DeleteHash(&CfgNameHash);
+}
 CTDL_MODULE_INIT(control)
 {
        if (!threading) {
-               CtdlRegisterProtoHook(cmd_conf, "CONF", "Autoconverted. TODO: document me.");
+               int i;
+
+               CfgNameHash = NewHash(1, NULL);
+               for (i = 0; CfgNames[i].Name.Key != NULL; i++)
+                       Put(CfgNameHash, CKEY(CfgNames[i].Name), &CfgNames[i], reference_free_handler);
+
+               CtdlRegisterProtoHook(cmd_gvdn, "GVDN", "get valid domain names");
+               CtdlRegisterProtoHook(cmd_conf, "CONF", "get/set system configuration");
+               CtdlRegisterCleanupHook(control_cleanup);
+
        }
-       /* return our Subversion id for the Log */
-       return "$Id$";
+       /* return our id for the Log */
+       return "control";
 }