Precisely report whats going wrong with the handling of the control file.
[citadel.git] / citadel / control.c
index 01d2e9d80e568601f837e51232589d2bdf6f8624..e71055c880492596fd8e5f404e1dc4169e8681f5 100644 (file)
@@ -1,14 +1,23 @@
 /*
- * $Id$
- *
  * This module handles states which are global to the entire server.
  *
+ * Copyright (c) 1987-2010 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 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
  */
 
-#ifdef DLL_EXPORT
-#define IN_LIBCIT
-#endif
-
 #include "sysdep.h"
 #include <stdlib.h>
 #include <unistd.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 "serv_extensions.h"
 #include "sysdep_decls.h"
 #include "support.h"
 #include "config.h"
 #include "msgbase.h"
 #include "citserver.h"
-#include "tools.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;
 FILE *control_fp = NULL;
+long control_highest_user = 0;
+
+
+/*
+ * lock_control  -  acquire a lock on the control record file.
+ *                  This keeps multiple citservers from running concurrently.
+ */
+void lock_control(void)
+{
+#if defined(LOCK_EX) && defined(LOCK_NB)
+       if (flock(fileno(control_fp), (LOCK_EX | LOCK_NB))) {
+               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
+}
+
+/*
+ * callback to get highest room number when rebuilding control file
+ */
+void control_find_highest(struct ctdlroom *qrbuf, void *data)
+{
+       struct ctdlroom room;
+       struct cdbdata *cdbfr;
+       long *msglist;
+       int num_msgs=0;
+       int c;
+       int room_fixed = 0;
+       int message_fixed = 0;
+       
+       if (qrbuf->QRnumber > CitControl.MMnextroom)
+       {
+               CitControl.MMnextroom = qrbuf->QRnumber;
+               room_fixed = 1;
+       }
+               
+       CtdlGetRoom (&room, qrbuf->QRname);
+       
+       /* Load the message list */
+       cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long));
+       if (cdbfr != NULL) {
+               msglist = (long *) cdbfr->ptr;
+               num_msgs = cdbfr->len / sizeof(long);
+       } else {
+               return; /* No messages at all?  No further action. */
+       }
+
+       if (num_msgs>0)
+       {
+               for (c=0; c<num_msgs; c++)
+               {
+                       if (msglist[c] > CitControl.MMhighest)
+                       {
+                               CitControl.MMhighest = msglist[c];
+                               message_fixed = 1;
+                       }
+               }
+       }
+       cdb_free(cdbfr);
+       if (room_fixed)
+               syslog(LOG_INFO, "Control record checking....Fixed room counter\n");
+       if (message_fixed)
+               syslog(LOG_INFO, "Control record checking....Fixed message count\n");
+       return;
+}
+
+
+/*
+ * Callback to get highest user number.
+ */
+void control_find_user (struct ctdluser *EachUser, void *out_data)
+{
+       int user_fixed = 0;
+       
+       if (EachUser->usernum > CitControl.MMnextuser)
+       {
+               CitControl.MMnextuser = EachUser->usernum;
+               user_fixed = 1;
+       }
+       if(user_fixed)
+               syslog(LOG_INFO, "Control record checking....Fixed user count\n");
+}
+
 
 /*
  * get_control  -  read the control record into memory.
  */
 void get_control(void)
 {
+       static int already_have_control = 0;
+       int rv = 0;
+
+       /*
+        * If we already have the control record in memory, there's no point
+        * in reading it from disk again.
+        */
+       if (already_have_control) return;
 
        /* Zero it out.  If the control record on disk is missing or short,
         * the system functions with all control record fields initialized
@@ -64,29 +172,56 @@ void get_control(void)
         */
        memset(&CitControl, 0, sizeof(struct CitControl));
        if (control_fp == NULL) {
-               control_fp = fopen("citadel.control", "rb+");
+               control_fp = fopen(file_citadel_control, "rb+");
                if (control_fp != NULL) {
-                       fchown(fileno(control_fp), config.c_bbsuid, -1);
+                       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("citadel.control", "wb+");
+               control_fp = fopen(file_citadel_control, "wb+");
                if (control_fp != NULL) {
-                       fchown(fileno(control_fp), config.c_bbsuid, -1);
+                       lock_control();
                        memset(&CitControl, 0, sizeof(struct CitControl));
-                       fwrite(&CitControl, sizeof(struct CitControl),
-                              1, control_fp);
+
+                       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));
+                       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) {
-               lprintf(1, "ERROR opening citadel.control: %s\n",
-                       strerror(errno));
+               syslog(LOG_ALERT, "ERROR opening %s: %s\n", file_citadel_control, strerror(errno));
                return;
        }
 
        rewind(control_fp);
-       fread(&CitControl, sizeof(struct CitControl), 1, 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));  
 }
 
 /*
@@ -94,27 +229,73 @@ void get_control(void)
  */
 void put_control(void)
 {
+       int rv = 0;
 
        if (control_fp != NULL) {
                rewind(control_fp);
-               fwrite(&CitControl, sizeof(struct CitControl), 1,
-                      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);
        }
 }
 
 
+/*
+ * check_control   -  check the control record has sensible values for message, user and room numbers
+ */
+void check_control(void)
+{
+       syslog(LOG_INFO, "Checking/re-building control record\n");
+       get_control();
+       // Find highest room number and message number.
+       CtdlForEachRoom(control_find_highest, NULL);
+       ForEachUser(control_find_user, NULL);
+       put_control();
+}
+
+
+/*
+ * release_control - close our fd on exit
+ */
+void release_control(void)
+{
+       if (control_fp != NULL) {
+               fclose(control_fp);
+       }
+       control_fp = NULL;
+}
+
 /*
  * get_new_message_number()  -  Obtain a new, unique ID to be used for a message.
  */
 long get_new_message_number(void)
 {
+       long retval = 0L;
        begin_critical_section(S_CONTROL);
        get_control();
-       ++CitControl.MMhighest;
+       retval = ++CitControl.MMhighest;
        put_control();
        end_critical_section(S_CONTROL);
-       return (CitControl.MMhighest);
+       return(retval);
+}
+
+
+/*
+ * CtdlGetCurrentMessageNumber()  -  Obtain the current highest message number in the system
+ * This provides a quick way to initialise a variable that might be used to indicate
+ * messages that should not be processed. EG. a new Sieve script will use this
+ * to record determine that messages older than this should not be processed.
+ */
+long CtdlGetCurrentMessageNumber(void)
+{
+       long retval = 0L;
+       begin_critical_section(S_CONTROL);
+       get_control();
+       retval = CitControl.MMhighest;
+       end_critical_section(S_CONTROL);
+       return(retval);
 }
 
 
@@ -123,12 +304,13 @@ long get_new_message_number(void)
  */
 long get_new_user_number(void)
 {
+       long retval = 0L;
        begin_critical_section(S_CONTROL);
        get_control();
-       ++CitControl.MMnextuser;
+       retval = ++CitControl.MMnextuser;
        put_control();
        end_critical_section(S_CONTROL);
-       return (CitControl.MMnextuser);
+       return(retval);
 }
 
 
@@ -138,30 +320,35 @@ long get_new_user_number(void)
  */
 long get_new_room_number(void)
 {
+       long retval = 0L;
        begin_critical_section(S_CONTROL);
        get_control();
-       ++CitControl.MMnextroom;
+       retval = ++CitControl.MMnextroom;
        put_control();
        end_critical_section(S_CONTROL);
-       return (CitControl.MMnextroom);
+       return(retval);
 }
 
 
 
 /* 
  * 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/documentation:appproto:system_config
+ *
  */
 void cmd_conf(char *argbuf)
 {
-       char cmd[SIZ];
-       char buf[SIZ];
+       char cmd[16];
+       char buf[256];
        int a;
        char *confptr;
-       char confname[SIZ];
+       char confname[128];
 
        if (CtdlAccessCheck(ac_aide)) return;
 
-       extract(cmd, argbuf, 0);
+       extract_token(cmd, argbuf, 0, '|', sizeof cmd);
        if (!strcasecmp(cmd, "GET")) {
                cprintf("%d Configuration...\n", LISTING_FOLLOWS);
                cprintf("%s\n", config.c_nodename);
@@ -176,7 +363,7 @@ void cmd_conf(char *argbuf)
                cprintf("%s\n", config.c_twitroom);
                cprintf("%s\n", config.c_moreprompt);
                cprintf("%d\n", config.c_restrict);
-               cprintf("%s\n", config.c_bbs_city);
+               cprintf("%s\n", config.c_site_location);
                cprintf("%s\n", config.c_sysadm);
                cprintf("%d\n", config.c_maxsessions);
                cprintf("xxx\n"); /* placeholder -- field no longer in use */
@@ -194,15 +381,60 @@ void cmd_conf(char *argbuf)
                cprintf("%d\n", config.c_imap_port);
                cprintf("%ld\n", config.c_net_freq);
                cprintf("%d\n", config.c_disable_newu);
-               cprintf("%d\n", config.c_aide_mailboxes);
+               cprintf("1\n"); /* niu */
                cprintf("%d\n", config.c_purge_hour);
+#ifdef HAVE_LDAP
+               cprintf("%s\n", config.c_ldap_host);
+               cprintf("%d\n", config.c_ldap_port);
+               cprintf("%s\n", config.c_ldap_base_dn);
+               cprintf("%s\n", config.c_ldap_bind_dn);
+               cprintf("%s\n", config.c_ldap_bind_pw);
+#else
+               cprintf("\n");
+               cprintf("0\n");
+               cprintf("\n");
+               cprintf("\n");
+               cprintf("\n");
+#endif
+               cprintf("%s\n", config.c_ip_addr);
+               cprintf("%d\n", config.c_msa_port);
+               cprintf("%d\n", config.c_imaps_port);
+               cprintf("%d\n", config.c_pop3s_port);
+               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("%d\n", config.c_allow_spoofing);
+               cprintf("%d\n", config.c_journal_email);
+               cprintf("%d\n", config.c_journal_pubmsgs);
+               cprintf("%s\n", config.c_journal_dest);
+               cprintf("%s\n", config.c_default_cal_zone);
+               cprintf("%d\n", config.c_pftcpdict_port);
+               cprintf("%d\n", config.c_managesieve_port);
+               cprintf("%d\n", config.c_auth_mode);
+               cprintf("%s\n", config.c_funambol_host);
+               cprintf("%d\n", config.c_funambol_port);
+               cprintf("%s\n", config.c_funambol_source);
+               cprintf("%s\n", config.c_funambol_auth);
+               cprintf("%d\n", config.c_rbl_at_greeting);
+               cprintf("%s\n", config.c_master_user);
+               cprintf("%s\n", config.c_master_pass);
+               cprintf("%s\n", config.c_pager_program);
+               cprintf("%d\n", config.c_imap_keep_from);
+               cprintf("%d\n", config.c_xmpp_c2s_port);
+               cprintf("%d\n", config.c_xmpp_s2s_port);
+               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("000\n");
        }
 
        else if (!strcasecmp(cmd, "SET")) {
+               unbuffer_output();
                cprintf("%d Send configuration...\n", SEND_LISTING);
                a = 0;
-               while (client_gets(buf), strcmp(buf, "000")) {
+               while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
                        switch (a) {
                        case 0:
                                safestrncpy(config.c_nodename, buf,
@@ -257,8 +489,8 @@ void cmd_conf(char *argbuf)
                                        config.c_restrict = 1;
                                break;
                        case 12:
-                               safestrncpy(config.c_bbs_city, buf,
-                                           sizeof config.c_bbs_city);
+                               safestrncpy(config.c_site_location, buf,
+                                           sizeof config.c_site_location);
                                break;
                        case 13:
                                safestrncpy(config.c_sysadm, buf,
@@ -266,8 +498,8 @@ void cmd_conf(char *argbuf)
                                break;
                        case 14:
                                config.c_maxsessions = atoi(buf);
-                               if (config.c_maxsessions < 1)
-                                       config.c_maxsessions = 1;
+                               if (config.c_maxsessions < 0)
+                                       config.c_maxsessions = 0;
                                break;
                        case 15:
                                /* placeholder -- field no longer in use */
@@ -325,9 +557,7 @@ void cmd_conf(char *argbuf)
                                        config.c_disable_newu = 1;
                                break;
                        case 30:
-                               config.c_aide_mailboxes = atoi(buf);
-                               if (config.c_aide_mailboxes != 0)
-                                       config.c_aide_mailboxes = 1;
+                               /* niu */
                                break;
                        case 31:
                                if ((config.c_purge_hour >= 0)
@@ -335,29 +565,161 @@ void cmd_conf(char *argbuf)
                                        config.c_purge_hour = atoi(buf);
                                }
                                break;
+#ifdef HAVE_LDAP
+                       case 32:
+                               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);
+                               break;
+                       case 35:
+                               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);
+                               break;
+#endif
+                       case 37:
+                               safestrncpy(config.c_ip_addr, buf,
+                                               sizeof config.c_ip_addr);
+                       case 38:
+                               config.c_msa_port = atoi(buf);
+                               break;
+                       case 39:
+                               config.c_imaps_port = atoi(buf);
+                               break;
+                       case 40:
+                               config.c_pop3s_port = atoi(buf);
+                               break;
+                       case 41:
+                               config.c_smtps_port = atoi(buf);
+                               break;
+                       case 42:
+                               config.c_enable_fulltext = atoi(buf);
+                               break;
+                       case 43:
+                               config.c_auto_cull = atoi(buf);
+                               break;
+                       case 44:
+                               config.c_instant_expunge = atoi(buf);
+                               break;
+                       case 45:
+                               config.c_allow_spoofing = atoi(buf);
+                               break;
+                       case 46:
+                               config.c_journal_email = atoi(buf);
+                               break;
+                       case 47:
+                               config.c_journal_pubmsgs = atoi(buf);
+                               break;
+                       case 48:
+                               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);
+                               break;
+                       case 50:
+                               config.c_pftcpdict_port = atoi(buf);
+                               break;
+                       case 51:
+                               config.c_managesieve_port = atoi(buf);
+                               break;
+                       case 52:
+                               config.c_auth_mode = atoi(buf);
+                       case 53:
+                               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, 
+                                       sizeof config.c_funambol_source);
+                               break;
+                       case 56:
+                               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);
+                               break;
+                       case 59:
+                               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);
+                               break;
+                       case 61:
+                               config.c_imap_keep_from = atoi(buf);
+                               break;
+                       case 62:
+                               config.c_xmpp_c2s_port = atoi(buf);
+                               break;
+                       case 63:
+                               config.c_xmpp_s2s_port = atoi(buf);
+                               break;
+                       case 64:
+                               config.c_pop3_fetch = atol(buf);
+                               break;
+                       case 65:
+                               config.c_pop3_fastest = atol(buf);
+                               break;
+                       case 66:
+                               config.c_spam_flag_only = atoi(buf);
+                               break;
+                       case 67:
+                               config.c_guest_logins = atoi(buf);
+                               break;
                        }
                        ++a;
                }
                put_config();
                snprintf(buf, sizeof buf,
-                        "Global system configuration edited by %s\n",
+                        "The global system configuration has been edited by %s.\n",
                         CC->curr_user);
-               aide_message(buf);
+               CtdlAideMessage(buf,"Citadel Configuration Manager Message");
+
+               if (!IsEmptyStr(config.c_logpages))
+                       CtdlCreateRoom(config.c_logpages, 3, "", 0, 1, 1, VIEW_BBS);
 
-               if (strlen(config.c_logpages) > 0)
-                       create_room(config.c_logpages, 3, "", 0, 1, 1);
+               /* If full text indexing has been disabled, invalidate the
+                * index so it doesn't try to use it later.
+                */
+               if (config.c_enable_fulltext == 0) {
+                       CitControl.fulltext_wordbreaker = 0;
+                       put_control();
+               }
        }
 
        else if (!strcasecmp(cmd, "GETSYS")) {
-               extract(confname, argbuf, 1);
+               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");
-                       phree(confptr);
+                       free(confptr);
                } else {
                        cprintf("%d No such configuration.\n",
                                ERROR + ILLEGAL_VALUE);
@@ -365,12 +727,12 @@ void cmd_conf(char *argbuf)
        }
 
        else if (!strcasecmp(cmd, "PUTSYS")) {
-               extract(confname, argbuf, 1);
+               extract_token(confname, argbuf, 1, '|', sizeof confname);
+               unbuffer_output();
                cprintf("%d %s\n", SEND_LISTING, confname);
-               confptr = CtdlReadMessageBody("000",
-                               config.c_maxmsglen, NULL, 0);
+               confptr = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0);
                CtdlPutSysConfig(confname, confptr);
-               phree(confptr);
+               free(confptr);
        }
 
        else {
@@ -378,3 +740,18 @@ void cmd_conf(char *argbuf)
                        ERROR + ILLEGAL_VALUE);
        }
 }
+
+
+/*****************************************************************************/
+/*                      MODULE INITIALIZATION STUFF                          */
+/*****************************************************************************/
+
+
+CTDL_MODULE_INIT(control)
+{
+       if (!threading) {
+               CtdlRegisterProtoHook(cmd_conf, "CONF", "get/set system configuration");
+       }
+       /* return our id for the Log */
+       return "control";
+}